Struct Client

pub struct Client { /* private fields */ }

Client for AWSDeadlineCloud

Client for invoking operations on AWSDeadlineCloud. Each operation on AWSDeadlineCloud is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_deadline::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_deadline::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateQueueFleetAssociation operation has a Client::create_queue_fleet_association, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_queue_fleet_association()
    .farm_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn associate_member_to_farm(&self) -> AssociateMemberToFarmFluentBuilder

Constructs a fluent builder for the AssociateMemberToFarm operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The ID of the farm to associate with the member.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    The member’s principal ID to associate with the farm.

    
    
  • principal_type(DeadlinePrincipalType) / set_principal_type(Option<DeadlinePrincipalType>):
    required: true
    

    The principal type of the member to associate with the farm.

    
    
  • identity_store_id(impl Into<String>) / set_identity_store_id(Option<String>):
    required: true
    

    The identity store ID of the member to associate with the farm.

    
    
  • membership_level(MembershipLevel) / set_membership_level(Option<MembershipLevel>):
    required: true
    

    The principal’s membership level for the associated farm.

    
    
• On success, responds with AssociateMemberToFarmOutput
• On failure, responds with SdkError<AssociateMemberToFarmError>

impl Client

pub fn associate_member_to_fleet(&self) -> AssociateMemberToFleetFluentBuilder

Constructs a fluent builder for the AssociateMemberToFleet operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the fleet to associate with the member.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The ID of the fleet to associate with a member.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    The member’s principal ID to associate with a fleet.

    
    
  • principal_type(DeadlinePrincipalType) / set_principal_type(Option<DeadlinePrincipalType>):
    required: true
    

    The member’s principal type to associate with the fleet.

    
    
  • identity_store_id(impl Into<String>) / set_identity_store_id(Option<String>):
    required: true
    

    The member’s identity store ID to associate with the fleet.

    
    
  • membership_level(MembershipLevel) / set_membership_level(Option<MembershipLevel>):
    required: true
    

    The principal’s membership level for the associated fleet.

    
    
• On success, responds with AssociateMemberToFleetOutput
• On failure, responds with SdkError<AssociateMemberToFleetError>

impl Client

pub fn associate_member_to_job(&self) -> AssociateMemberToJobFluentBuilder

Constructs a fluent builder for the AssociateMemberToJob operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the job to associate with the member.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to associate to the member.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to associate with the member.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    The member’s principal ID to associate with the job.

    
    
  • principal_type(DeadlinePrincipalType) / set_principal_type(Option<DeadlinePrincipalType>):
    required: true
    

    The member’s principal type to associate with the job.

    
    
  • identity_store_id(impl Into<String>) / set_identity_store_id(Option<String>):
    required: true
    

    The member’s identity store ID to associate with the job.

    
    
  • membership_level(MembershipLevel) / set_membership_level(Option<MembershipLevel>):
    required: true
    

    The principal’s membership level for the associated job.

    
    
• On success, responds with AssociateMemberToJobOutput
• On failure, responds with SdkError<AssociateMemberToJobError>

impl Client

pub fn associate_member_to_queue(&self) -> AssociateMemberToQueueFluentBuilder

Constructs a fluent builder for the AssociateMemberToQueue operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the queue to associate with the member.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The ID of the queue to associate to the member.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    The member’s principal ID to associate with the queue.

    
    
  • principal_type(DeadlinePrincipalType) / set_principal_type(Option<DeadlinePrincipalType>):
    required: true
    

    The member’s principal type to associate with the queue.

    
    
  • identity_store_id(impl Into<String>) / set_identity_store_id(Option<String>):
    required: true
    

    The member’s identity store ID to associate with the queue.

    
    
  • membership_level(MembershipLevel) / set_membership_level(Option<MembershipLevel>):
    required: true
    

    The principal’s membership level for the associated queue.

    
    
• On success, responds with AssociateMemberToQueueOutput
• On failure, responds with SdkError<AssociateMemberToQueueError>

impl Client

pub fn assume_fleet_role_for_read(&self) -> AssumeFleetRoleForReadFluentBuilder

Constructs a fluent builder for the AssumeFleetRoleForRead operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the fleet’s farm.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID.

    
    
• On success, responds with AssumeFleetRoleForReadOutput with field(s):
  • credentials(Option<AwsCredentials>):

    The credentials for the fleet role.

• On failure, responds with SdkError<AssumeFleetRoleForReadError>

impl Client

pub fn assume_fleet_role_for_worker( &self, ) -> AssumeFleetRoleForWorkerFluentBuilder

Constructs a fluent builder for the AssumeFleetRoleForWorker operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the fleet’s farm.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID that contains the worker.

    
    
  • worker_id(impl Into<String>) / set_worker_id(Option<String>):
    required: true
    

    The ID of the worker assuming the fleet role.

    
    
• On success, responds with AssumeFleetRoleForWorkerOutput with field(s):
  • credentials(Option<AwsCredentials>):

    The credentials for the worker.

• On failure, responds with SdkError<AssumeFleetRoleForWorkerError>

impl Client

pub fn assume_queue_role_for_read(&self) -> AssumeQueueRoleForReadFluentBuilder

Constructs a fluent builder for the AssumeQueueRoleForRead operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm containing the queue.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID.

    
    
• On success, responds with AssumeQueueRoleForReadOutput with field(s):
  • credentials(Option<AwsCredentials>):

    The credentials for the queue role.

• On failure, responds with SdkError<AssumeQueueRoleForReadError>

impl Client

pub fn assume_queue_role_for_user(&self) -> AssumeQueueRoleForUserFluentBuilder

Constructs a fluent builder for the AssumeQueueRoleForUser operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the queue that the user assumes the role for.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID of the queue that the user assumes the role for.

    
    
• On success, responds with AssumeQueueRoleForUserOutput with field(s):
  • credentials(Option<AwsCredentials>):

    The credentials for the queue role that a user has access to.

• On failure, responds with SdkError<AssumeQueueRoleForUserError>

impl Client

pub fn assume_queue_role_for_worker( &self, ) -> AssumeQueueRoleForWorkerFluentBuilder

Constructs a fluent builder for the AssumeQueueRoleForWorker operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the worker assuming the queue role.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID of the worker assuming the queue role.

    
    
  • worker_id(impl Into<String>) / set_worker_id(Option<String>):
    required: true
    

    The worker ID of the worker assuming the queue role.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID of the worker assuming the queue role.

    
    
• On success, responds with AssumeQueueRoleForWorkerOutput with field(s):
  • credentials(Option<AwsCredentials>):

    The Amazon Web Services credentials for the role that the worker is assuming.

• On failure, responds with SdkError<AssumeQueueRoleForWorkerError>

impl Client

pub fn batch_get_job_entity(&self) -> BatchGetJobEntityFluentBuilder

Constructs a fluent builder for the BatchGetJobEntity operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    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(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID of the worker that’s fetching job details. The worker must have an assignment on a job to fetch job details.

    
    
  • worker_id(impl Into<String>) / set_worker_id(Option<String>):
    required: true
    

    The worker ID of the worker containing the job details to get.

    
    
  • identifiers(JobEntityIdentifiersUnion) / set_identifiers(Option<Vec::<JobEntityIdentifiersUnion>>):
    required: true
    

    The job identifiers to include within the job entity batch details.

    
    
• On success, responds with BatchGetJobEntityOutput with field(s):
  • entities(Vec::<JobEntity>):

    A list of the job entities, or details, in the batch.

  • errors(Vec::<GetJobEntityError>):

    A list of errors from the job error logs for the batch.

• On failure, responds with SdkError<BatchGetJobEntityError>

impl Client

pub fn copy_job_template(&self) -> CopyJobTemplateFluentBuilder

Constructs a fluent builder for the CopyJobTemplate operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to copy.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to copy.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to copy.

    
    
  • target_s3_location(S3Location) / set_target_s3_location(Option<S3Location>):
    required: true
    

    The Amazon S3 bucket name and key where you would like to add a copy of the job template.

    
    
• On success, responds with CopyJobTemplateOutput with field(s):
  • template_type(JobTemplateType):

    The format of the job template, either JSON or YAML.

• On failure, responds with SdkError<CopyJobTemplateError>

impl Client

pub fn create_budget(&self) -> CreateBudgetFluentBuilder

Constructs a fluent builder for the CreateBudget operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to include in this budget.

    
    
  • usage_tracking_resource(UsageTrackingResource) / set_usage_tracking_resource(Option<UsageTrackingResource>):
    required: true
    

    The queue ID provided to this budget to track usage.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The display name of the budget.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the budget.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • approximate_dollar_limit(f32) / set_approximate_dollar_limit(Option<f32>):
    required: true
    

    The dollar limit based on consumed usage.

    
    
  • actions(BudgetActionToAdd) / set_actions(Option<Vec::<BudgetActionToAdd>>):
    required: true
    

    The budget actions to specify what happens when the budget runs out.

    
    
  • schedule(BudgetSchedule) / set_schedule(Option<BudgetSchedule>):
    required: true
    

    The schedule to associate with this budget.

    
    
• On success, responds with CreateBudgetOutput with field(s):
  • budget_id(String):

    The budget ID.

• On failure, responds with SdkError<CreateBudgetError>

impl Client

pub fn create_farm(&self) -> CreateFarmFluentBuilder

Constructs a fluent builder for the CreateFarm operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The display name of the farm.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the farm.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The ARN of the KMS key to use on the farm.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
• On success, responds with CreateFarmOutput with field(s):
  • farm_id(String):

    The farm ID.

• On failure, responds with SdkError<CreateFarmError>

impl Client

pub fn create_fleet(&self) -> CreateFleetFluentBuilder

Constructs a fluent builder for the CreateFleet operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to connect to the fleet.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The display name of the fleet.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the fleet.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The IAM role ARN for the role that the fleet’s workers will use.

    
    
  • min_worker_count(i32) / set_min_worker_count(Option<i32>):
    required: false
    

    The minimum number of workers for the fleet.

    
    
  • max_worker_count(i32) / set_max_worker_count(Option<i32>):
    required: true
    

    The maximum number of workers for the fleet.

    
    
  • configuration(FleetConfiguration) / set_configuration(Option<FleetConfiguration>):
    required: true
    

    The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
• On success, responds with CreateFleetOutput with field(s):
  • fleet_id(String):

    The fleet ID.

• On failure, responds with SdkError<CreateFleetError>

impl Client

pub fn create_job(&self) -> CreateJobFluentBuilder

Constructs a fluent builder for the CreateJob operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to connect to the job.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The ID of the queue that the job is submitted to.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • template(impl Into<String>) / set_template(Option<String>):
    required: false
    

    The job template to use for this job.

    
    
  • template_type(JobTemplateType) / set_template_type(Option<JobTemplateType>):
    required: false
    

    The file type for the job template.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: true
    

    The priority of the job on a scale of 0 to 100. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

    
    
  • parameters(impl Into<String>, JobParameter) / set_parameters(Option<HashMap::<String, JobParameter>>):
    required: false
    

    The parameters for the job.

    
    
  • attachments(Attachments) / set_attachments(Option<Attachments>):
    required: false
    

    The attachments for the job. Attach files required for the job to run to a render job.

    
    
  • storage_profile_id(impl Into<String>) / set_storage_profile_id(Option<String>):
    required: false
    

    The storage profile ID for the storage profile to connect to the job.

    
    
  • target_task_run_status(CreateJobTargetTaskRunStatus) / set_target_task_run_status(Option<CreateJobTargetTaskRunStatus>):
    required: false
    

    The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

    
    
  • max_failed_tasks_count(i32) / set_max_failed_tasks_count(Option<i32>):
    required: false
    

    The number of task failures before the job stops running and is marked as FAILED.

    
    
  • max_retries_per_task(i32) / set_max_retries_per_task(Option<i32>):
    required: false
    

    The maximum number of retries for each task.

    
    
  • source_job_id(impl Into<String>) / set_source_job_id(Option<String>):
    required: false
    

    The job ID for the source job.

    
    
• On success, responds with CreateJobOutput with field(s):
  • job_id(String):

    The job ID.

• On failure, responds with SdkError<CreateJobError>

impl Client

pub fn create_license_endpoint(&self) -> CreateLicenseEndpointFluentBuilder

Constructs a fluent builder for the CreateLicenseEndpoint operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
    required: true
    

    The VPC (virtual private cloud) ID to use with the license endpoint.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    The subnet IDs.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: true
    

    The security group IDs.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
• On success, responds with CreateLicenseEndpointOutput with field(s):
  • license_endpoint_id(String):

    The license endpoint ID.

• On failure, responds with SdkError<CreateLicenseEndpointError>

impl Client

pub fn create_monitor(&self) -> CreateMonitorFluentBuilder

Constructs a fluent builder for the CreateMonitor operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The name that you give the monitor that is displayed in the Deadline Cloud console.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • identity_center_instance_arn(impl Into<String>) / set_identity_center_instance_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users.

    
    
  • subdomain(impl Into<String>) / set_subdomain(Option<String>):
    required: true
    

    The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreateMonitorOutput with field(s):
  • monitor_id(String):

    The unique identifier of the monitor.

  • identity_center_application_arn(String):

    The Amazon Resource Name (ARN) that IAM Identity Center assigns to the monitor.

• On failure, responds with SdkError<CreateMonitorError>

impl Client

pub fn create_queue(&self) -> CreateQueueFluentBuilder

Constructs a fluent builder for the CreateQueue operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to connect to the queue.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The display name of the queue.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the queue.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • default_budget_action(DefaultQueueBudgetAction) / set_default_budget_action(Option<DefaultQueueBudgetAction>):
    required: false
    

    The default action to take on a queue if a budget isn’t configured.

    
    
  • job_attachment_settings(JobAttachmentSettings) / set_job_attachment_settings(Option<JobAttachmentSettings>):
    required: false
    

    The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The IAM role ARN that workers will use while running jobs for this queue.

    
    
  • job_run_as_user(JobRunAsUser) / set_job_run_as_user(Option<JobRunAsUser>):
    required: false
    

    The jobs in the queue run as the specified POSIX user.

    
    
  • required_file_system_location_names(impl Into<String>) / set_required_file_system_location_names(Option<Vec::<String>>):
    required: false
    

    The file system location name to include in the queue.

    
    
  • allowed_storage_profile_ids(impl Into<String>) / set_allowed_storage_profile_ids(Option<Vec::<String>>):
    required: false
    

    The storage profile IDs to include in the queue.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
• On success, responds with CreateQueueOutput with field(s):
  • queue_id(String):

    The queue ID.

• On failure, responds with SdkError<CreateQueueError>

impl Client

pub fn create_queue_environment(&self) -> CreateQueueEnvironmentFluentBuilder

Constructs a fluent builder for the CreateQueueEnvironment operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to connect to the environment.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to connect the queue and environment.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: true
    

    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.

    
    
  • template_type(EnvironmentTemplateType) / set_template_type(Option<EnvironmentTemplateType>):
    required: true
    

    The template’s file type, JSON or YAML.

    
    
  • template(impl Into<String>) / set_template(Option<String>):
    required: true
    

    The environment template to use in the queue.

    
    
• On success, responds with CreateQueueEnvironmentOutput with field(s):
  • queue_environment_id(String):

    The queue environment ID.

• On failure, responds with SdkError<CreateQueueEnvironmentError>

impl Client

pub fn create_queue_fleet_association( &self, ) -> CreateQueueFleetAssociationFluentBuilder

Constructs a fluent builder for the CreateQueueFleetAssociation operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The ID of the farm that the queue and fleet belong to.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID.

    
    
• On success, responds with CreateQueueFleetAssociationOutput
• On failure, responds with SdkError<CreateQueueFleetAssociationError>

impl Client

pub fn create_storage_profile(&self) -> CreateStorageProfileFluentBuilder

Constructs a fluent builder for the CreateStorageProfile operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to connect to the storage profile.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The display name of the storage profile.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • os_family(StorageProfileOperatingSystemFamily) / set_os_family(Option<StorageProfileOperatingSystemFamily>):
    required: true
    

    The type of operating system (OS) for the storage profile.

    
    
  • file_system_locations(FileSystemLocation) / set_file_system_locations(Option<Vec::<FileSystemLocation>>):
    required: false
    

    File system paths to include in the storage profile.

    
    
• On success, responds with CreateStorageProfileOutput with field(s):
  • storage_profile_id(String):

    The storage profile ID.

• On failure, responds with SdkError<CreateStorageProfileError>

impl Client

pub fn create_worker(&self) -> CreateWorkerFluentBuilder

Constructs a fluent builder for the CreateWorker operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to connect to the worker.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID to connect to the worker.

    
    
  • host_properties(HostPropertiesRequest) / set_host_properties(Option<HostPropertiesRequest>):
    required: false
    

    The IP address and host name of the worker.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with CreateWorkerOutput with field(s):
  • worker_id(String):

    The worker ID.

• On failure, responds with SdkError<CreateWorkerError>

impl Client

pub fn delete_budget(&self) -> DeleteBudgetFluentBuilder

Constructs a fluent builder for the DeleteBudget operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to remove from the budget.

    
    
  • budget_id(impl Into<String>) / set_budget_id(Option<String>):
    required: true
    

    The budget ID of the budget to delete.

    
    
• On success, responds with DeleteBudgetOutput
• On failure, responds with SdkError<DeleteBudgetError>

impl Client

pub fn delete_farm(&self) -> DeleteFarmFluentBuilder

Constructs a fluent builder for the DeleteFarm operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to delete.

    
    
• On success, responds with DeleteFarmOutput
• On failure, responds with SdkError<DeleteFarmError>

impl Client

pub fn delete_fleet(&self) -> DeleteFleetFluentBuilder

Constructs a fluent builder for the DeleteFleet operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to remove from the fleet.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID of the fleet to delete.

    
    
• On success, responds with DeleteFleetOutput
• On failure, responds with SdkError<DeleteFleetError>

impl Client

pub fn delete_license_endpoint(&self) -> DeleteLicenseEndpointFluentBuilder

Constructs a fluent builder for the DeleteLicenseEndpoint operation.

• The fluent builder is configurable:
  • license_endpoint_id(impl Into<String>) / set_license_endpoint_id(Option<String>):
    required: true
    

    The license endpoint ID of the license endpoint to delete.

    
    
• On success, responds with DeleteLicenseEndpointOutput
• On failure, responds with SdkError<DeleteLicenseEndpointError>

impl Client

pub fn delete_metered_product(&self) -> DeleteMeteredProductFluentBuilder

Constructs a fluent builder for the DeleteMeteredProduct operation.

• The fluent builder is configurable:
  • license_endpoint_id(impl Into<String>) / set_license_endpoint_id(Option<String>):
    required: true
    

    The ID of the license endpoint from which to remove the metered product.

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product ID to remove from the license endpoint.

    
    
• On success, responds with DeleteMeteredProductOutput
• On failure, responds with SdkError<DeleteMeteredProductError>

impl Client

pub fn delete_monitor(&self) -> DeleteMonitorFluentBuilder

Constructs a fluent builder for the DeleteMonitor operation.

• The fluent builder is configurable:
  • monitor_id(impl Into<String>) / set_monitor_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteMonitorOutput
• On failure, responds with SdkError<DeleteMonitorError>

impl Client

pub fn delete_queue(&self) -> DeleteQueueFluentBuilder

Constructs a fluent builder for the DeleteQueue operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The ID of the farm from which to remove the queue.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID of the queue to delete.

    
    
• On success, responds with DeleteQueueOutput
• On failure, responds with SdkError<DeleteQueueError>

impl Client

pub fn delete_queue_environment(&self) -> DeleteQueueEnvironmentFluentBuilder

Constructs a fluent builder for the DeleteQueueEnvironment operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm from which to remove the queue environment.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID of the queue environment to delete.

    
    
  • queue_environment_id(impl Into<String>) / set_queue_environment_id(Option<String>):
    required: true
    

    The queue environment ID of the queue environment to delete.

    
    
• On success, responds with DeleteQueueEnvironmentOutput
• On failure, responds with SdkError<DeleteQueueEnvironmentError>

impl Client

pub fn delete_queue_fleet_association( &self, ) -> DeleteQueueFleetAssociationFluentBuilder

Constructs a fluent builder for the DeleteQueueFleetAssociation operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm that holds the queue-fleet association.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID of the queue-fleet association.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID of the queue-fleet association.

    
    
• On success, responds with DeleteQueueFleetAssociationOutput
• On failure, responds with SdkError<DeleteQueueFleetAssociationError>

impl Client

pub fn delete_storage_profile(&self) -> DeleteStorageProfileFluentBuilder

Constructs a fluent builder for the DeleteStorageProfile operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm from which to remove the storage profile.

    
    
  • storage_profile_id(impl Into<String>) / set_storage_profile_id(Option<String>):
    required: true
    

    The storage profile ID of the storage profile to delete.

    
    
• On success, responds with DeleteStorageProfileOutput
• On failure, responds with SdkError<DeleteStorageProfileError>

impl Client

pub fn delete_worker(&self) -> DeleteWorkerFluentBuilder

Constructs a fluent builder for the DeleteWorker operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the worker to delete.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID of the worker to delete.

    
    
  • worker_id(impl Into<String>) / set_worker_id(Option<String>):
    required: true
    

    The worker ID of the worker to delete.

    
    
• On success, responds with DeleteWorkerOutput
• On failure, responds with SdkError<DeleteWorkerError>

impl Client

pub fn disassociate_member_from_farm( &self, ) -> DisassociateMemberFromFarmFluentBuilder

Constructs a fluent builder for the DisassociateMemberFromFarm operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm to disassociate from the member.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    A member’s principal ID to disassociate from a farm.

    
    
• On success, responds with DisassociateMemberFromFarmOutput
• On failure, responds with SdkError<DisassociateMemberFromFarmError>

impl Client

pub fn disassociate_member_from_fleet( &self, ) -> DisassociateMemberFromFleetFluentBuilder

Constructs a fluent builder for the DisassociateMemberFromFleet operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the fleet to disassociate a member from.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID of the fleet to from which to disassociate a member.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    A member’s principal ID to disassociate from a fleet.

    
    
• On success, responds with DisassociateMemberFromFleetOutput
• On failure, responds with SdkError<DisassociateMemberFromFleetError>

impl Client

pub fn disassociate_member_from_job( &self, ) -> DisassociateMemberFromJobFluentBuilder

Constructs a fluent builder for the DisassociateMemberFromJob operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the job to disassociate from the member.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID connected to a job for which you’re disassociating a member.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to disassociate from a member in a job.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    A member’s principal ID to disassociate from a job.

    
    
• On success, responds with DisassociateMemberFromJobOutput
• On failure, responds with SdkError<DisassociateMemberFromJobError>

impl Client

pub fn disassociate_member_from_queue( &self, ) -> DisassociateMemberFromQueueFluentBuilder

Constructs a fluent builder for the DisassociateMemberFromQueue operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the queue to disassociate from a member.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID of the queue in which you’re disassociating from a member.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    A member’s principal ID to disassociate from a queue.

    
    
• On success, responds with DisassociateMemberFromQueueOutput
• On failure, responds with SdkError<DisassociateMemberFromQueueError>

impl Client

pub fn get_budget(&self) -> GetBudgetFluentBuilder

Constructs a fluent builder for the GetBudget operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm connected to the budget.

    
    
  • budget_id(impl Into<String>) / set_budget_id(Option<String>):
    required: true
    

    The budget ID.

    
    
• On success, responds with GetBudgetOutput with field(s):
  • budget_id(String):

    The budget ID.

  • usage_tracking_resource(Option<UsageTrackingResource>):

    The resource that the budget is tracking usage for.

  • status(BudgetStatus):

    The status of the budget.

    • ACTIVE–Get a budget being evaluated.

    • INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.

  • display_name(String):

    The display name of the budget.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description(Option<String>):

    The description of the budget.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • approximate_dollar_limit(f32):

    The consumed usage limit for the budget.

  • usages(Option<ConsumedUsages>):

    The usages of the budget.

  • actions(Vec::<ResponseBudgetAction>):

    The budget actions for the budget.

  • schedule(Option<BudgetSchedule>):

    The budget schedule.

  • created_by(String):

    The user or system that created this resource.

  • created_at(DateTime):

    The date and time the resource was created.

  • updated_by(Option<String>):

    The user or system that updated this resource.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • queue_stopped_at(Option<DateTime>):

    The date and time the queue stopped.

• On failure, responds with SdkError<GetBudgetError>

impl Client

pub fn get_farm(&self) -> GetFarmFluentBuilder

Constructs a fluent builder for the GetFarm operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm.

    
    
• On success, responds with GetFarmOutput with field(s):
  • farm_id(String):

    The farm ID of the farm to get.

  • display_name(String):

    The display name of the farm.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description(Option<String>):

    The description of the farm.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • kms_key_arn(String):

    The ARN of the KMS key used on the farm.

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

• On failure, responds with SdkError<GetFarmError>

impl Client

pub fn get_fleet(&self) -> GetFleetFluentBuilder

Constructs a fluent builder for the GetFleet operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm in the fleet.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID of the fleet to get.

    
    
• On success, responds with GetFleetOutput with field(s):
  • fleet_id(String):

    The fleet ID.

  • farm_id(String):

    The farm ID of the farm in the fleet.

  • display_name(String):

    The display name of the fleet.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description(Option<String>):

    The description of the fleet.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • status(FleetStatus):

    The Auto Scaling status of the fleet.

  • auto_scaling_status(Option<AutoScalingStatus>):

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

  • target_worker_count(Option<i32>):

    The number of target workers in the fleet.

  • worker_count(i32):

    The number of workers in the fleet.

  • min_worker_count(i32):

    The minimum number of workers specified in the fleet.

  • max_worker_count(i32):

    The maximum number of workers specified in the fleet.

  • configuration(Option<FleetConfiguration>):

    The configuration setting for the fleet.

  • capabilities(Option<FleetCapabilities>):

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

  • role_arn(String):

    The IAM role ARN.

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

• On failure, responds with SdkError<GetFleetError>

impl Client

pub fn get_job(&self) -> GetJobFluentBuilder

Constructs a fluent builder for the GetJob operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm in the job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID associated with the job.

    
    
• On success, responds with GetJobOutput with field(s):
  • job_id(String):

    The job ID.

  • name(String):

    The name of the job.

  • lifecycle_status(JobLifecycleStatus):

    The life cycle status for the job.

  • lifecycle_status_message(String):

    A message that communicates the status of the life cycle for the job.

  • priority(i32):

    The job priority.

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

  • started_at(Option<DateTime>):

    The date and time the resource started running.

  • ended_at(Option<DateTime>):

    The date and time the resource ended running.

  • task_run_status(Option<TaskRunStatus>):

    The task run status for the job.

  • target_task_run_status(Option<JobTargetTaskRunStatus>):

    The task status with which the job started.

  • task_run_status_counts(Option<HashMap::<TaskRunStatus, i32>>):

    The number of tasks running on the job.

  • storage_profile_id(Option<String>):

    The storage profile ID associated with the job.

  • max_failed_tasks_count(Option<i32>):

    The number of task failures before the job stops running and is marked as FAILED.

  • max_retries_per_task(Option<i32>):

    The maximum number of retries per failed tasks.

  • parameters(Option<HashMap::<String, JobParameter>>):

    The parameters for the job.

  • attachments(Option<Attachments>):

    The attachments for the job.

  • description(Option<String>):

    The description of the job.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • source_job_id(Option<String>):

    The job ID for the source job.

• On failure, responds with SdkError<GetJobError>

impl Client

pub fn get_license_endpoint(&self) -> GetLicenseEndpointFluentBuilder

Constructs a fluent builder for the GetLicenseEndpoint operation.

• The fluent builder is configurable:
  • license_endpoint_id(impl Into<String>) / set_license_endpoint_id(Option<String>):
    required: true
    

    The license endpoint ID.

    
    
• On success, responds with GetLicenseEndpointOutput with field(s):
  • license_endpoint_id(String):

    The license endpoint ID.

  • status(LicenseEndpointStatus):

    The status of the license endpoint.

  • status_message(String):

    The status message of the license endpoint.

  • vpc_id(Option<String>):

    The VCP(virtual private cloud) ID associated with the license endpoint.

  • dns_name(Option<String>):

    The DNS name.

  • subnet_ids(Option<Vec::<String>>):

    The subnet IDs.

  • security_group_ids(Option<Vec::<String>>):

    The security group IDs for the license endpoint.

• On failure, responds with SdkError<GetLicenseEndpointError>

impl Client

pub fn get_monitor(&self) -> GetMonitorFluentBuilder

Constructs a fluent builder for the GetMonitor operation.

• The fluent builder is configurable:
  • monitor_id(impl Into<String>) / set_monitor_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with GetMonitorOutput with field(s):
  • monitor_id(String):

    The unique identifier for the monitor.

  • display_name(String):

    The name used to identify the monitor on the Deadline Cloud console.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • subdomain(String):

    The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

  • url(String):

    The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

  • role_arn(String):

    The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

  • identity_center_instance_arn(String):

    The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.

  • identity_center_application_arn(String):

    The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.

  • created_at(DateTime):

    The UNIX timestamp of the date and time that the monitor was created.

  • created_by(String):

    The user name of the person that created the monitor.

  • updated_at(Option<DateTime>):

    The UNIX timestamp of the last date and time that the monitor was updated.

  • updated_by(Option<String>):

    The user name of the person that last updated the monitor.

• On failure, responds with SdkError<GetMonitorError>

impl Client

pub fn get_queue(&self) -> GetQueueFluentBuilder

Constructs a fluent builder for the GetQueue operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm in the queue.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the queue to retrieve.

    
    
• On success, responds with GetQueueOutput with field(s):
  • queue_id(String):

    The queue ID.

  • display_name(String):

    The display name of the queue.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description(Option<String>):

    The description of the queue.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • farm_id(String):

    The farm ID for the queue.

  • status(QueueStatus):

    The status of the queue.

    • ACTIVE–The queue is active.

    • SCHEDULING–The queue is scheduling.

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

  • default_budget_action(DefaultQueueBudgetAction):

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

  • blocked_reason(Option<QueueBlockedReason>):

    The reason the queue was blocked.

  • job_attachment_settings(Option<JobAttachmentSettings>):

    The job attachment settings for the queue.

  • role_arn(Option<String>):

    The IAM role ARN.

  • required_file_system_location_names(Option<Vec::<String>>):

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

  • allowed_storage_profile_ids(Option<Vec::<String>>):

    The storage profile IDs for the queue.

  • job_run_as_user(Option<JobRunAsUser>):

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

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

• On failure, responds with SdkError<GetQueueError>

impl Client

pub fn get_queue_environment(&self) -> GetQueueEnvironmentFluentBuilder

Constructs a fluent builder for the GetQueueEnvironment operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the queue environment.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the queue environment.

    
    
  • queue_environment_id(impl Into<String>) / set_queue_environment_id(Option<String>):
    required: true
    

    The queue environment ID.

    
    
• On success, responds with GetQueueEnvironmentOutput with field(s):
  • queue_environment_id(String):

    The queue environment ID.

  • name(String):

    The name of the queue environment.

  • priority(i32):

    The priority of the queue environment.

  • template_type(EnvironmentTemplateType):

    The type of template for the queue environment.

  • template(String):

    The template for the queue environment.

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.>

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

• On failure, responds with SdkError<GetQueueEnvironmentError>

impl Client

pub fn get_queue_fleet_association( &self, ) -> GetQueueFleetAssociationFluentBuilder

Constructs a fluent builder for the GetQueueFleetAssociation operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm that contains the queue-fleet association.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the queue-fleet association.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID for the queue-fleet association.

    
    
• On success, responds with GetQueueFleetAssociationOutput with field(s):
  • queue_id(String):

    The queue ID for the queue-fleet association.

  • fleet_id(String):

    The fleet ID for the queue-fleet association.

  • status(QueueFleetAssociationStatus):

    The status of the queue-fleet association.

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

• On failure, responds with SdkError<GetQueueFleetAssociationError>

impl Client

pub fn get_session(&self) -> GetSessionFluentBuilder

Constructs a fluent builder for the GetSession operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the session.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the session.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID for the session.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The session ID.

    
    
• On success, responds with GetSessionOutput with field(s):
  • session_id(String):

    The session ID.

  • fleet_id(String):

    The fleet ID for the session.

  • worker_id(String):

    The worker ID for the session.

  • started_at(DateTime):

    The date and time the resource started running.

  • log(Option<LogConfiguration>):

    The session log.

  • lifecycle_status(SessionLifecycleStatus):

    The life cycle status of the session.

  • ended_at(Option<DateTime>):

    The date and time the resource ended running.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

  • target_lifecycle_status(Option<SessionLifecycleTargetStatus>):

    The life cycle status with which the session started.

  • host_properties(Option<HostPropertiesResponse>):

    Provides the Amazon EC2 properties of the host.

  • worker_log(Option<LogConfiguration>):

    The worker log for the session.

• On failure, responds with SdkError<GetSessionError>

impl Client

pub fn get_session_action(&self) -> GetSessionActionFluentBuilder

Constructs a fluent builder for the GetSessionAction operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the session action.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the session action.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID for the session.

    
    
  • session_action_id(impl Into<String>) / set_session_action_id(Option<String>):
    required: true
    

    The session action ID for the session.

    
    
• On success, responds with GetSessionActionOutput with field(s):
  • session_action_id(String):

    The session action ID.

  • status(SessionActionStatus):

    The status of the session action.

  • started_at(Option<DateTime>):

    The date and time the resource started running.

  • ended_at(Option<DateTime>):

    The date and time the resource ended running.

  • worker_updated_at(Option<DateTime>):

    The Linux timestamp of the date and time the session action was last updated.

  • progress_percent(Option<f32>):

    The percentage completed for a session action.

  • session_id(String):

    The session ID for the session action.

  • process_exit_code(Option<i32>):

    The exit code to exit the session.

  • progress_message(Option<String>):

    The message that communicates the progress of the session action.

  • definition(Option<SessionActionDefinition>):

    The session action definition.

• On failure, responds with SdkError<GetSessionActionError>

impl Client

pub fn get_sessions_statistics_aggregation( &self, ) -> GetSessionsStatisticsAggregationFluentBuilder

Constructs a fluent builder for the GetSessionsStatisticsAggregation operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    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.

    
    
  • aggregation_id(impl Into<String>) / set_aggregation_id(Option<String>):
    required: true
    

    The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
• On success, responds with GetSessionsStatisticsAggregationOutput with field(s):
  • statistics(Option<Vec::<Statistics>>):

    The statistics for the specified fleets or queues.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

  • status(SessionsStatisticsAggregationStatus):

    The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the StartSessionsStatisticsAggregation operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.

    If you call the StartSessionsStatisticsAggregation operation when the status is IN_PROGRESS, you will receive a ThrottlingException.

  • status_message(Option<String>):

    A message that describes the status.

• On failure, responds with SdkError<GetSessionsStatisticsAggregationError>

impl Client

pub fn get_step(&self) -> GetStepFluentBuilder

Constructs a fluent builder for the GetStep operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the step.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the step.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID for the step.

    
    
  • step_id(impl Into<String>) / set_step_id(Option<String>):
    required: true
    

    The step ID.

    
    
• On success, responds with GetStepOutput with field(s):
  • step_id(String):

    The step ID.

  • name(String):

    The name of the step.

  • lifecycle_status(StepLifecycleStatus):

    The life cycle status of the step.

  • lifecycle_status_message(Option<String>):

    A message that describes the lifecycle status of the step.

  • task_run_status(TaskRunStatus):

    The task run status for the job.

  • task_run_status_counts(HashMap::<TaskRunStatus, i32>):

    The number of tasks running on the job.

  • target_task_run_status(Option<StepTargetTaskRunStatus>):

    The task status with which the job started.

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

  • started_at(Option<DateTime>):

    The date and time the resource started running.

  • ended_at(Option<DateTime>):

    The date and time the resource ended running.

  • dependency_counts(Option<DependencyCounts>):

    The number of dependencies in the step.

  • required_capabilities(Option<StepRequiredCapabilities>):

    The required capabilities of the step.

  • parameter_space(Option<ParameterSpace>):

    A list of step parameters and the combination expression for the step.

  • description(Option<String>):

    The description of the step.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

• On failure, responds with SdkError<GetStepError>

impl Client

pub fn get_storage_profile(&self) -> GetStorageProfileFluentBuilder

Constructs a fluent builder for the GetStorageProfile operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the storage profile.

    
    
  • storage_profile_id(impl Into<String>) / set_storage_profile_id(Option<String>):
    required: true
    

    The storage profile ID.

    
    
• On success, responds with GetStorageProfileOutput with field(s):
  • storage_profile_id(String):

    The storage profile ID.

  • display_name(String):

    The display name of the storage profile.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • os_family(StorageProfileOperatingSystemFamily):

    The operating system (OS) for the storage profile.

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

  • file_system_locations(Option<Vec::<FileSystemLocation>>):

    The location of the files for the storage profile.

• On failure, responds with SdkError<GetStorageProfileError>

impl Client

pub fn get_storage_profile_for_queue( &self, ) -> GetStorageProfileForQueueFluentBuilder

Constructs a fluent builder for the GetStorageProfileForQueue operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the queue in storage profile.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID the queue in the storage profile.

    
    
  • storage_profile_id(impl Into<String>) / set_storage_profile_id(Option<String>):
    required: true
    

    The storage profile ID for the storage profile in the queue.

    
    
• On success, responds with GetStorageProfileForQueueOutput with field(s):
  • storage_profile_id(String):

    The storage profile ID.

  • display_name(String):

    The display name of the storage profile connected to a queue.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • os_family(StorageProfileOperatingSystemFamily):

    The operating system of the storage profile in the queue.

  • file_system_locations(Option<Vec::<FileSystemLocation>>):

    The location of the files for the storage profile within the queue.

• On failure, responds with SdkError<GetStorageProfileForQueueError>

impl Client

pub fn get_task(&self) -> GetTaskFluentBuilder

Constructs a fluent builder for the GetTask operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the farm connected to the task.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the queue connected to the task.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID of the job connected to the task.

    
    
  • step_id(impl Into<String>) / set_step_id(Option<String>):
    required: true
    

    The step ID for the step connected to the task.

    
    
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The task ID.

    
    
• On success, responds with GetTaskOutput with field(s):
  • task_id(String):

    The task ID.

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.

  • run_status(TaskRunStatus):

    The run status for the task.

  • target_run_status(Option<TaskTargetRunStatus>):

    The run status with which to start the task.

  • failure_retry_count(Option<i32>):

    The number of times that the task failed and was retried.

  • parameters(Option<HashMap::<String, TaskParameterValue>>):

    The parameters for the task.

  • started_at(Option<DateTime>):

    The date and time the resource started running.

  • ended_at(Option<DateTime>):

    The date and time the resource ended running.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

  • latest_session_action_id(Option<String>):

    The latest session ID for the task.

• On failure, responds with SdkError<GetTaskError>

impl Client

pub fn get_worker(&self) -> GetWorkerFluentBuilder

Constructs a fluent builder for the GetWorker operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the worker.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID of the worker.

    
    
  • worker_id(impl Into<String>) / set_worker_id(Option<String>):
    required: true
    

    The worker ID.

    
    
• On success, responds with GetWorkerOutput with field(s):
  • worker_id(String):

    The worker ID.

  • farm_id(String):

    The farm ID.

  • fleet_id(String):

    The fleet ID.

  • host_properties(Option<HostPropertiesResponse>):

    The host properties for the worker.

  • status(WorkerStatus):

    The status of the worker.

  • log(Option<LogConfiguration>):

    The logs for the associated worker.

  • created_at(DateTime):

    The date and time the resource was created.

  • created_by(String):

    The user or system that created this resource.

  • updated_at(Option<DateTime>):

    The date and time the resource was updated.

  • updated_by(Option<String>):

    The user or system that updated this resource.

• On failure, responds with SdkError<GetWorkerError>

impl Client

pub fn list_available_metered_products( &self, ) -> ListAvailableMeteredProductsFluentBuilder

Constructs a fluent builder for the ListAvailableMeteredProducts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListAvailableMeteredProductsOutput with field(s):
  • metered_products(Vec::<MeteredProductSummary>):

    The metered products.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListAvailableMeteredProductsError>

impl Client

pub fn list_budgets(&self) -> ListBudgetsFluentBuilder

Constructs a fluent builder for the ListBudgets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID associated with the budgets.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
  • status(BudgetStatus) / set_status(Option<BudgetStatus>):
    required: false
    

    The status to list for the budgets.

    
    
• On success, responds with ListBudgetsOutput with field(s):
  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

  • budgets(Vec::<BudgetSummary>):

    The budgets to include on the list.

• On failure, responds with SdkError<ListBudgetsError>

impl Client

pub fn list_farm_members(&self) -> ListFarmMembersFluentBuilder

Constructs a fluent builder for the ListFarmMembers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListFarmMembersOutput with field(s):
  • members(Vec::<FarmMember>):

    The members on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListFarmMembersError>

impl Client

pub fn list_farms(&self) -> ListFarmsFluentBuilder

Constructs a fluent builder for the ListFarms operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: false
    

    The principal ID of the member to list on the farm.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListFarmsOutput with field(s):
  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

  • farms(Vec::<FarmSummary>):

    Farms on the list.

• On failure, responds with SdkError<ListFarmsError>

impl Client

pub fn list_fleet_members(&self) -> ListFleetMembersFluentBuilder

Constructs a fluent builder for the ListFleetMembers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the fleet.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID to include on the list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListFleetMembersOutput with field(s):
  • members(Vec::<FleetMember>):

    The members on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListFleetMembersError>

impl Client

pub fn list_fleets(&self) -> ListFleetsFluentBuilder

Constructs a fluent builder for the ListFleets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the fleets.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: false
    

    The principal ID of the members to include in the fleet.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display names of a list of fleets.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • status(FleetStatus) / set_status(Option<FleetStatus>):
    required: false
    

    The status of the fleet.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListFleetsOutput with field(s):
  • fleets(Vec::<FleetSummary>):

    The fleets on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListFleetsError>

impl Client

pub fn list_job_members(&self) -> ListJobMembersFluentBuilder

Constructs a fluent builder for the ListJobMembers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the job to list.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to include on the list.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to include on the list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListJobMembersOutput with field(s):
  • members(Vec::<JobMember>):

    The members on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListJobMembersError>

impl Client

pub fn list_job_parameter_definitions( &self, ) -> ListJobParameterDefinitionsFluentBuilder

Constructs a fluent builder for the ListJobParameterDefinitions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the job to list.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to include on the list.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to include on the list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListJobParameterDefinitionsOutput with field(s):
  • job_parameter_definitions(Vec::<Document>):

    Lists parameter definitions of a job.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListJobParameterDefinitionsError>

impl Client

pub fn list_jobs(&self) -> ListJobsFluentBuilder

Constructs a fluent builder for the ListJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the jobs.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: false
    

    The principal ID of the members on the jobs.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the job.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListJobsOutput with field(s):
  • jobs(Vec::<JobSummary>):

    The jobs on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListJobsError>

impl Client

pub fn list_license_endpoints(&self) -> ListLicenseEndpointsFluentBuilder

Constructs a fluent builder for the ListLicenseEndpoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListLicenseEndpointsOutput with field(s):
  • license_endpoints(Vec::<LicenseEndpointSummary>):

    The license endpoints.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListLicenseEndpointsError>

impl Client

pub fn list_metered_products(&self) -> ListMeteredProductsFluentBuilder

Constructs a fluent builder for the ListMeteredProducts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • license_endpoint_id(impl Into<String>) / set_license_endpoint_id(Option<String>):
    required: true
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListMeteredProductsOutput with field(s):
  • metered_products(Vec::<MeteredProductSummary>):

    The metered products to list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListMeteredProductsError>

impl Client

pub fn list_monitors(&self) -> ListMonitorsFluentBuilder

Constructs a fluent builder for the ListMonitors operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListMonitorsOutput with field(s):
  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

  • monitors(Vec::<MonitorSummary>):

    A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.

• On failure, responds with SdkError<ListMonitorsError>

impl Client

pub fn list_queue_environments(&self) -> ListQueueEnvironmentsFluentBuilder

Constructs a fluent builder for the ListQueueEnvironments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the queue environment list.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the queue environment list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListQueueEnvironmentsOutput with field(s):
  • environments(Vec::<QueueEnvironmentSummary>):

    The environments to include in the queue environments list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListQueueEnvironmentsError>

impl Client

pub fn list_queue_fleet_associations( &self, ) -> ListQueueFleetAssociationsFluentBuilder

Constructs a fluent builder for the ListQueueFleetAssociations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the queue-fleet association list.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: false
    

    The queue ID for the queue-fleet association list.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: false
    

    The fleet ID for the queue-fleet association list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListQueueFleetAssociationsOutput with field(s):
  • queue_fleet_associations(Vec::<QueueFleetAssociationSummary>):

    The queue-fleet associations on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListQueueFleetAssociationsError>

impl Client

pub fn list_queue_members(&self) -> ListQueueMembersFluentBuilder

Constructs a fluent builder for the ListQueueMembers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the queue.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to include on the list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListQueueMembersOutput with field(s):
  • members(Vec::<QueueMember>):

    The members on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListQueueMembersError>

impl Client

pub fn list_queues(&self) -> ListQueuesFluentBuilder

Constructs a fluent builder for the ListQueues operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the queue.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: false
    

    The principal IDs to include in the list of queues.

    
    
  • status(QueueStatus) / set_status(Option<QueueStatus>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListQueuesOutput with field(s):
  • queues(Vec::<QueueSummary>):

    The queues on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListQueuesError>

impl Client

pub fn list_session_actions(&self) -> ListSessionActionsFluentBuilder

Constructs a fluent builder for the ListSessionActions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the session actions list.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the session actions list.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID for the session actions list.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: false
    

    The session ID to include on the sessions action list.

    
    
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: false
    

    The task ID for the session actions list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListSessionActionsOutput with field(s):
  • session_actions(Vec::<SessionActionSummary>):

    The session actions.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListSessionActionsError>

impl Client

pub fn list_sessions(&self) -> ListSessionsFluentBuilder

Constructs a fluent builder for the ListSessions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the list of sessions.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the list of sessions

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID for the list of sessions.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListSessionsOutput with field(s):
  • sessions(Vec::<SessionSummary>):

    The sessions on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListSessionsError>

impl Client

pub fn list_sessions_for_worker(&self) -> ListSessionsForWorkerFluentBuilder

Constructs a fluent builder for the ListSessionsForWorker operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the session.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID for the session.

    
    
  • worker_id(impl Into<String>) / set_worker_id(Option<String>):
    required: true
    

    The worker ID for the session.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListSessionsForWorkerOutput with field(s):
  • sessions(Vec::<WorkerSessionSummary>):

    The sessions in the response.

  • next_token(Option<String>):

    The token for the next set of results, or null to start from the beginning.

• On failure, responds with SdkError<ListSessionsForWorkerError>

impl Client

pub fn list_step_consumers(&self) -> ListStepConsumersFluentBuilder

Constructs a fluent builder for the ListStepConsumers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the list of step consumers.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the step consumer.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID for the step consumer.

    
    
  • step_id(impl Into<String>) / set_step_id(Option<String>):
    required: true
    

    The step ID to include on the list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListStepConsumersOutput with field(s):
  • consumers(Vec::<StepConsumer>):

    The consumers on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListStepConsumersError>

impl Client

pub fn list_step_dependencies(&self) -> ListStepDependenciesFluentBuilder

Constructs a fluent builder for the ListStepDependencies operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID for the step dependencies list.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the step dependencies list.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID for the step dependencies list.

    
    
  • step_id(impl Into<String>) / set_step_id(Option<String>):
    required: true
    

    The step ID to include on the list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListStepDependenciesOutput with field(s):
  • dependencies(Vec::<StepDependency>):

    The dependencies on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListStepDependenciesError>

impl Client

pub fn list_steps(&self) -> ListStepsFluentBuilder

Constructs a fluent builder for the ListSteps operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to include on the list of steps.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to include on the list of steps.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to include on the list of steps.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListStepsOutput with field(s):
  • steps(Vec::<StepSummary>):

    The steps on the list.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListStepsError>

impl Client

pub fn list_storage_profiles(&self) -> ListStorageProfilesFluentBuilder

Constructs a fluent builder for the ListStorageProfiles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the storage profile.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListStorageProfilesOutput with field(s):
  • storage_profiles(Vec::<StorageProfileSummary>):

    The storage profiles.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListStorageProfilesError>

impl Client

pub fn list_storage_profiles_for_queue( &self, ) -> ListStorageProfilesForQueueFluentBuilder

Constructs a fluent builder for the ListStorageProfilesForQueue operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the queue’s storage profile.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID for the storage profile.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListStorageProfilesForQueueOutput with field(s):
  • storage_profiles(Vec::<StorageProfileSummary>):

    The storage profiles in the queue.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListStorageProfilesForQueueError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource ARN to list tags for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    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.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_tasks(&self) -> ListTasksFluentBuilder

Constructs a fluent builder for the ListTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID connected to the tasks.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID connected to the tasks.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID for the tasks.

    
    
  • step_id(impl Into<String>) / set_step_id(Option<String>):
    required: true
    

    The step ID for the tasks.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListTasksOutput with field(s):
  • tasks(Vec::<TaskSummary>):

    Tasks for the job.

  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

• On failure, responds with SdkError<ListTasksError>

impl Client

pub fn list_workers(&self) -> ListWorkersFluentBuilder

Constructs a fluent builder for the ListWorkers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID connected to the workers.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID of the workers.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null to start from the beginning.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    
    
• On success, responds with ListWorkersOutput with field(s):
  • next_token(Option<String>):

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

  • workers(Vec::<WorkerSummary>):

    The workers on the list.

• On failure, responds with SdkError<ListWorkersError>

impl Client

pub fn put_metered_product(&self) -> PutMeteredProductFluentBuilder

Constructs a fluent builder for the PutMeteredProduct operation.

• The fluent builder is configurable:
  • license_endpoint_id(impl Into<String>) / set_license_endpoint_id(Option<String>):
    required: true
    

    The license endpoint ID to add to the metered product.

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product ID to add to the metered product.

    
    
• On success, responds with PutMeteredProductOutput
• On failure, responds with SdkError<PutMeteredProductError>

impl Client

pub fn search_jobs(&self) -> SearchJobsFluentBuilder

Constructs a fluent builder for the SearchJobs operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the job.

    
    
  • queue_ids(impl Into<String>) / set_queue_ids(Option<Vec::<String>>):
    required: true
    

    The queue ID to use in the job search.

    
    
  • filter_expressions(SearchGroupedFilterExpressions) / set_filter_expressions(Option<SearchGroupedFilterExpressions>):
    required: false
    

    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 ().

    
    
  • sort_expressions(SearchSortExpression) / set_sort_expressions(Option<Vec::<SearchSortExpression>>):
    required: false
    

    The search terms for a resource.

    
    
  • item_offset(i32) / set_item_offset(Option<i32>):
    required: true
    

    Defines how far into the scrollable list to start the return of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    Specifies the number of items per page for the resource.

    
    
• On success, responds with SearchJobsOutput with field(s):
  • jobs(Vec::<JobSearchSummary>):

    The jobs in the search.

  • next_item_offset(Option<i32>):

    The next incremental starting point after the defined itemOffset.

  • total_results(i32):

    The total number of results in the search.

• On failure, responds with SdkError<SearchJobsError>

impl Client

pub fn search_steps(&self) -> SearchStepsFluentBuilder

Constructs a fluent builder for the SearchSteps operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to use for the step search.

    
    
  • queue_ids(impl Into<String>) / set_queue_ids(Option<Vec::<String>>):
    required: true
    

    The queue IDs in the step search.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: false
    

    The job ID to use in the step search.

    
    
  • filter_expressions(SearchGroupedFilterExpressions) / set_filter_expressions(Option<SearchGroupedFilterExpressions>):
    required: false
    

    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 ().

    
    
  • sort_expressions(SearchSortExpression) / set_sort_expressions(Option<Vec::<SearchSortExpression>>):
    required: false
    

    The search terms for a resource.

    
    
  • item_offset(i32) / set_item_offset(Option<i32>):
    required: true
    

    Defines how far into the scrollable list to start the return of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    Specifies the number of items per page for the resource.

    
    
• On success, responds with SearchStepsOutput with field(s):
  • steps(Vec::<StepSearchSummary>):

    The steps in the search.

  • next_item_offset(Option<i32>):

    The next incremental starting point after the defined itemOffset.

  • total_results(i32):

    The total number of results in the search.

• On failure, responds with SdkError<SearchStepsError>

impl Client

pub fn search_tasks(&self) -> SearchTasksFluentBuilder

Constructs a fluent builder for the SearchTasks operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the task.

    
    
  • queue_ids(impl Into<String>) / set_queue_ids(Option<Vec::<String>>):
    required: true
    

    The queue IDs to include in the search.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: false
    

    The job ID for the task search.

    
    
  • filter_expressions(SearchGroupedFilterExpressions) / set_filter_expressions(Option<SearchGroupedFilterExpressions>):
    required: false
    

    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 ().

    
    
  • sort_expressions(SearchSortExpression) / set_sort_expressions(Option<Vec::<SearchSortExpression>>):
    required: false
    

    The search terms for a resource.

    
    
  • item_offset(i32) / set_item_offset(Option<i32>):
    required: true
    

    Defines how far into the scrollable list to start the return of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    Specifies the number of items per page for the resource.

    
    
• On success, responds with SearchTasksOutput with field(s):
  • tasks(Vec::<TaskSearchSummary>):

    Tasks in the search.

  • next_item_offset(Option<i32>):

    The next incremental starting point after the defined itemOffset.

  • total_results(i32):

    The total number of results in the search.

• On failure, responds with SdkError<SearchTasksError>

impl Client

pub fn search_workers(&self) -> SearchWorkersFluentBuilder

Constructs a fluent builder for the SearchWorkers operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID in the workers search.

    
    
  • fleet_ids(impl Into<String>) / set_fleet_ids(Option<Vec::<String>>):
    required: true
    

    The fleet ID of the workers to search for.

    
    
  • filter_expressions(SearchGroupedFilterExpressions) / set_filter_expressions(Option<SearchGroupedFilterExpressions>):
    required: false
    

    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 ().

    
    
  • sort_expressions(SearchSortExpression) / set_sort_expressions(Option<Vec::<SearchSortExpression>>):
    required: false
    

    The search terms for a resource.

    
    
  • item_offset(i32) / set_item_offset(Option<i32>):
    required: true
    

    Defines how far into the scrollable list to start the return of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    Specifies the number of items per page for the resource.

    
    
• On success, responds with SearchWorkersOutput with field(s):
  • workers(Vec::<WorkerSearchSummary>):

    The workers for the search.

  • next_item_offset(Option<i32>):

    The next incremental starting point after the defined itemOffset.

  • total_results(i32):

    The total number of results in the search.

• On failure, responds with SdkError<SearchWorkersError>

impl Client

pub fn start_sessions_statistics_aggregation( &self, ) -> StartSessionsStatisticsAggregationFluentBuilder

Constructs a fluent builder for the StartSessionsStatisticsAggregation operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The identifier of the farm that contains queues or fleets to return statistics for.

    
    
  • resource_ids(SessionsStatisticsResources) / set_resource_ids(Option<SessionsStatisticsResources>):
    required: true
    

    A list of fleet IDs or queue IDs to gather statistics for.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The Linux timestamp of the date and time that the statistics start.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The Linux timestamp of the date and time that the statistics end.

    
    
  • timezone(impl Into<String>) / set_timezone(Option<String>):
    required: false
    

    The timezone to use for the statistics. Use UTC notation such as “UTC+8.”

    
    
  • period(Period) / set_period(Option<Period>):
    required: false
    

    The period to aggregate the statistics.

    
    
  • group_by(UsageGroupByField) / set_group_by(Option<Vec::<UsageGroupByField>>):
    required: true
    

    The field to use to group the statistics.

    
    
  • statistics(UsageStatistic) / set_statistics(Option<Vec::<UsageStatistic>>):
    required: true
    

    One to four statistics to return.

    
    
• On success, responds with StartSessionsStatisticsAggregationOutput with field(s):
  • aggregation_id(String):

    A unique identifier for the aggregated statistics. Use this identifier with the GetAggregatedStatisticsForSessions operation to return the statistics.

• On failure, responds with SdkError<StartSessionsStatisticsAggregationError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource to apply tags to.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource to remove the tag from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    They keys of the tag.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_budget(&self) -> UpdateBudgetFluentBuilder

Constructs a fluent builder for the UpdateBudget operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the budget to update.

    
    
  • budget_id(impl Into<String>) / set_budget_id(Option<String>):
    required: true
    

    The budget ID to update.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display name of the budget to update.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the budget to update.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • status(BudgetStatus) / set_status(Option<BudgetStatus>):
    required: false
    

    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.

    
    
  • approximate_dollar_limit(f32) / set_approximate_dollar_limit(Option<f32>):
    required: false
    

    The dollar limit to update on the budget. Based on consumed usage.

    
    
  • actions_to_add(BudgetActionToAdd) / set_actions_to_add(Option<Vec::<BudgetActionToAdd>>):
    required: false
    

    The budget actions to add. Budget actions specify what happens when the budget runs out.

    
    
  • actions_to_remove(BudgetActionToRemove) / set_actions_to_remove(Option<Vec::<BudgetActionToRemove>>):
    required: false
    

    The budget actions to remove from the budget.

    
    
  • schedule(BudgetSchedule) / set_schedule(Option<BudgetSchedule>):
    required: false
    

    The schedule to update.

    
    
• On success, responds with UpdateBudgetOutput
• On failure, responds with SdkError<UpdateBudgetError>

impl Client

pub fn update_farm(&self) -> UpdateFarmFluentBuilder

Constructs a fluent builder for the UpdateFarm operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display name of the farm to update.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the farm to update.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
• On success, responds with UpdateFarmOutput
• On failure, responds with SdkError<UpdateFarmError>

impl Client

pub fn update_fleet(&self) -> UpdateFleetFluentBuilder

Constructs a fluent builder for the UpdateFleet operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID to update.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display name of the fleet to update.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the fleet to update.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

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

    
    
  • min_worker_count(i32) / set_min_worker_count(Option<i32>):
    required: false
    

    The minimum number of workers in the fleet.

    
    
  • max_worker_count(i32) / set_max_worker_count(Option<i32>):
    required: false
    

    The maximum number of workers in the fleet.

    
    
  • configuration(FleetConfiguration) / set_configuration(Option<FleetConfiguration>):
    required: false
    

    The fleet configuration to update.

    
    
• On success, responds with UpdateFleetOutput
• On failure, responds with SdkError<UpdateFleetError>

impl Client

pub fn update_job(&self) -> UpdateJobFluentBuilder

Constructs a fluent builder for the UpdateJob operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the job to update.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID of the job to update.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to update.

    
    
  • target_task_run_status(JobTargetTaskRunStatus) / set_target_task_run_status(Option<JobTargetTaskRunStatus>):
    required: false
    

    The task status to update the job’s tasks to.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

    The job priority to update.

    
    
  • max_failed_tasks_count(i32) / set_max_failed_tasks_count(Option<i32>):
    required: false
    

    The number of task failures before the job stops running and is marked as FAILED.

    
    
  • max_retries_per_task(i32) / set_max_retries_per_task(Option<i32>):
    required: false
    

    The maximum number of retries for a job.

    
    
  • lifecycle_status(UpdateJobLifecycleStatus) / set_lifecycle_status(Option<UpdateJobLifecycleStatus>):
    required: false
    

    The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can’t be scheduled or archived.

    An archived jobs and its steps and tasks are deleted after 120 days. The job can’t be recovered.

    
    
• On success, responds with UpdateJobOutput
• On failure, responds with SdkError<UpdateJobError>

impl Client

pub fn update_monitor(&self) -> UpdateMonitorFluentBuilder

Constructs a fluent builder for the UpdateMonitor operation.

• The fluent builder is configurable:
  • monitor_id(impl Into<String>) / set_monitor_id(Option<String>):
    required: true
    

    The unique identifier of the monitor to update.

    
    
  • subdomain(impl Into<String>) / set_subdomain(Option<String>):
    required: false
    

    The new value of the subdomain to use when forming the monitor URL.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The new value to use for the monitor’s display name.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.

    
    
• On success, responds with UpdateMonitorOutput
• On failure, responds with SdkError<UpdateMonitorError>

impl Client

pub fn update_queue(&self) -> UpdateQueueFluentBuilder

Constructs a fluent builder for the UpdateQueue operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token to update in the queue.

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update in the queue.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to update.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display name of the queue to update.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the queue to update.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • default_budget_action(DefaultQueueBudgetAction) / set_default_budget_action(Option<DefaultQueueBudgetAction>):
    required: false
    

    The default action to take for a queue update if a budget isn’t configured.

    
    
  • job_attachment_settings(JobAttachmentSettings) / set_job_attachment_settings(Option<JobAttachmentSettings>):
    required: false
    

    The job attachment settings to update for the queue.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The IAM role ARN that’s used to run jobs from this queue.

    
    
  • job_run_as_user(JobRunAsUser) / set_job_run_as_user(Option<JobRunAsUser>):
    required: false
    

    Update the jobs in the queue to run as a specified POSIX user.

    
    
  • required_file_system_location_names_to_add(impl Into<String>) / set_required_file_system_location_names_to_add(Option<Vec::<String>>):
    required: false
    

    The required file system location names to add to the queue.

    
    
  • required_file_system_location_names_to_remove(impl Into<String>) / set_required_file_system_location_names_to_remove(Option<Vec::<String>>):
    required: false
    

    The required file system location names to remove from the queue.

    
    
  • allowed_storage_profile_ids_to_add(impl Into<String>) / set_allowed_storage_profile_ids_to_add(Option<Vec::<String>>):
    required: false
    

    The storage profile IDs to add.

    
    
  • allowed_storage_profile_ids_to_remove(impl Into<String>) / set_allowed_storage_profile_ids_to_remove(Option<Vec::<String>>):
    required: false
    

    The storage profile ID to remove.

    
    
• On success, responds with UpdateQueueOutput
• On failure, responds with SdkError<UpdateQueueError>

impl Client

pub fn update_queue_environment(&self) -> UpdateQueueEnvironmentFluentBuilder

Constructs a fluent builder for the UpdateQueueEnvironment operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID of the queue environment to update.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID of the queue environment to update.

    
    
  • queue_environment_id(impl Into<String>) / set_queue_environment_id(Option<String>):
    required: true
    

    The queue environment ID to update.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

    The priority to update.

    
    
  • template_type(EnvironmentTemplateType) / set_template_type(Option<EnvironmentTemplateType>):
    required: false
    

    The template type to update.

    
    
  • template(impl Into<String>) / set_template(Option<String>):
    required: false
    

    The template to update.

    
    
• On success, responds with UpdateQueueEnvironmentOutput
• On failure, responds with SdkError<UpdateQueueEnvironmentError>

impl Client

pub fn update_queue_fleet_association( &self, ) -> UpdateQueueFleetAssociationFluentBuilder

Constructs a fluent builder for the UpdateQueueFleetAssociation operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to update.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID to update.

    
    
  • status(UpdateQueueFleetAssociationStatus) / set_status(Option<UpdateQueueFleetAssociationStatus>):
    required: true
    

    The status to update.

    
    
• On success, responds with UpdateQueueFleetAssociationOutput
• On failure, responds with SdkError<UpdateQueueFleetAssociationError>

impl Client

pub fn update_session(&self) -> UpdateSessionFluentBuilder

Constructs a fluent builder for the UpdateSession operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update in the session.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to update in the session.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to update in the session.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The session ID to update.

    
    
  • target_lifecycle_status(SessionLifecycleTargetStatus) / set_target_lifecycle_status(Option<SessionLifecycleTargetStatus>):
    required: true
    

    The life cycle status to update in the session.

    
    
• On success, responds with UpdateSessionOutput
• On failure, responds with SdkError<UpdateSessionError>

impl Client

pub fn update_step(&self) -> UpdateStepFluentBuilder

Constructs a fluent builder for the UpdateStep operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to update.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to update.

    
    
  • step_id(impl Into<String>) / set_step_id(Option<String>):
    required: true
    

    The step ID to update.

    
    
  • target_task_run_status(StepTargetTaskRunStatus) / set_target_task_run_status(Option<StepTargetTaskRunStatus>):
    required: true
    

    The task status to update the step’s tasks to.

    
    
• On success, responds with UpdateStepOutput
• On failure, responds with SdkError<UpdateStepError>

impl Client

pub fn update_storage_profile(&self) -> UpdateStorageProfileFluentBuilder

Constructs a fluent builder for the UpdateStorageProfile operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update.

    
    
  • storage_profile_id(impl Into<String>) / set_storage_profile_id(Option<String>):
    required: true
    

    The storage profile ID to update.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display name of the storage profile to update.

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    
    
  • os_family(StorageProfileOperatingSystemFamily) / set_os_family(Option<StorageProfileOperatingSystemFamily>):
    required: false
    

    The OS system to update.

    
    
  • file_system_locations_to_add(FileSystemLocation) / set_file_system_locations_to_add(Option<Vec::<FileSystemLocation>>):
    required: false
    

    The file system location names to add.

    
    
  • file_system_locations_to_remove(FileSystemLocation) / set_file_system_locations_to_remove(Option<Vec::<FileSystemLocation>>):
    required: false
    

    The file system location names to remove.

    
    
• On success, responds with UpdateStorageProfileOutput
• On failure, responds with SdkError<UpdateStorageProfileError>

impl Client

pub fn update_task(&self) -> UpdateTaskFluentBuilder

Constructs a fluent builder for the UpdateTask operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

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

    
    
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The queue ID to update.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID to update.

    
    
  • step_id(impl Into<String>) / set_step_id(Option<String>):
    required: true
    

    The step ID to update.

    
    
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The task ID to update.

    
    
  • target_run_status(TaskTargetRunStatus) / set_target_run_status(Option<TaskTargetRunStatus>):
    required: true
    

    The run status with which to start the task.

    
    
• On success, responds with UpdateTaskOutput
• On failure, responds with SdkError<UpdateTaskError>

impl Client

pub fn update_worker(&self) -> UpdateWorkerFluentBuilder

Constructs a fluent builder for the UpdateWorker operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID to update.

    
    
  • worker_id(impl Into<String>) / set_worker_id(Option<String>):
    required: true
    

    The worker ID to update.

    
    
  • status(UpdatedWorkerStatus) / set_status(Option<UpdatedWorkerStatus>):
    required: false
    

    The worker status to update.

    
    
  • capabilities(WorkerCapabilities) / set_capabilities(Option<WorkerCapabilities>):
    required: false
    

    The worker capabilities to update.

    
    
  • host_properties(HostPropertiesRequest) / set_host_properties(Option<HostPropertiesRequest>):
    required: false
    

    The host properties to update.

    
    
• On success, responds with UpdateWorkerOutput with field(s):
  • log(Option<LogConfiguration>):

    The worker log to update.

• On failure, responds with SdkError<UpdateWorkerError>

impl Client

pub fn update_worker_schedule(&self) -> UpdateWorkerScheduleFluentBuilder

Constructs a fluent builder for the UpdateWorkerSchedule operation.

• The fluent builder is configurable:
  • farm_id(impl Into<String>) / set_farm_id(Option<String>):
    required: true
    

    The farm ID to update.

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The fleet ID to update.

    
    
  • worker_id(impl Into<String>) / set_worker_id(Option<String>):
    required: true
    

    The worker ID to update.

    
    
  • updated_session_actions(impl Into<String>, UpdatedSessionActionInfo) / set_updated_session_actions(Option<HashMap::<String, UpdatedSessionActionInfo>>):
    required: false
    

    The session actions associated with the worker schedule to update.

    
    
• On success, responds with UpdateWorkerScheduleOutput with field(s):
  • assigned_sessions(HashMap::<String, AssignedSession>):

    The assigned sessions to update.

  • cancel_session_actions(HashMap::<String, Vec::<String>>):

    The session actions associated with the worker schedule to cancel.

  • desired_worker_status(Option<DesiredWorkerStatus>):

    The status to update the worker to.

  • update_interval_seconds(i32):

    Updates the time interval (in seconds) for the schedule.

• On failure, responds with SdkError<UpdateWorkerScheduleError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_fleet_active(&self) -> FleetActiveFluentBuilder

Wait until a Fleet is activated. Use this after invoking CreateFleet or UpdateFleet.

fn wait_until_job_create_complete(&self) -> JobCreateCompleteFluentBuilder

Wait until a Job is created. Use this after invoking CreateJob.

fn wait_until_license_endpoint_valid(&self) -> LicenseEndpointValidFluentBuilder

Wait until a LicenseEndpoint is Ready. Use this after invoking CreateLicenseEndpoint.

fn wait_until_license_endpoint_deleted( &self, ) -> LicenseEndpointDeletedFluentBuilder

Wait until a LicenseEndpoint is Deleted. Use this after invoking DeleteLicenseEndpoint.

fn wait_until_queue_scheduling_blocked( &self, ) -> QueueSchedulingBlockedFluentBuilder

Wait for queue_scheduling_blocked

fn wait_until_queue_scheduling(&self) -> QueueSchedulingFluentBuilder

Wait for queue_scheduling

fn wait_until_queue_fleet_association_stopped( &self, ) -> QueueFleetAssociationStoppedFluentBuilder

Wait until a QueueFleetAssociation is stopped. Use this after setting the status to STOP_SCHEDULING_AND_COMPLETE_TASKS or STOP_SCHEDULING_AND_CANCEL_TASKS to wait for a QueueFleetAssociation to reach STOPPED