aws_sdk_deadline/client/
update_queue.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateQueue`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`client_token(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_client_token):<br>required: **false**<br><p>The idempotency token to update in the queue.</p><br>
    ///   - [`farm_id(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID to update in the queue.</p><br>
    ///   - [`queue_id(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::queue_id) / [`set_queue_id(Option<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_queue_id):<br>required: **true**<br><p>The queue ID to update.</p><br>
    ///   - [`display_name(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_display_name):<br>required: **false**<br><p>The display name of the queue to update.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_description):<br>required: **false**<br><p>The description of the queue to update.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important><br>
    ///   - [`default_budget_action(DefaultQueueBudgetAction)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::default_budget_action) / [`set_default_budget_action(Option<DefaultQueueBudgetAction>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_default_budget_action):<br>required: **false**<br><p>The default action to take for a queue update if a budget isn't configured.</p><br>
    ///   - [`job_attachment_settings(JobAttachmentSettings)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::job_attachment_settings) / [`set_job_attachment_settings(Option<JobAttachmentSettings>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_job_attachment_settings):<br>required: **false**<br><p>The job attachment settings to update for the queue.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_role_arn):<br>required: **false**<br><p>The IAM role ARN that's used to run jobs from this queue.</p><br>
    ///   - [`job_run_as_user(JobRunAsUser)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::job_run_as_user) / [`set_job_run_as_user(Option<JobRunAsUser>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_job_run_as_user):<br>required: **false**<br><p>Update the jobs in the queue to run as a specified POSIX user.</p><br>
    ///   - [`required_file_system_location_names_to_add(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::required_file_system_location_names_to_add) / [`set_required_file_system_location_names_to_add(Option<Vec::<String>>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_required_file_system_location_names_to_add):<br>required: **false**<br><p>The required file system location names to add to the queue.</p><br>
    ///   - [`required_file_system_location_names_to_remove(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::required_file_system_location_names_to_remove) / [`set_required_file_system_location_names_to_remove(Option<Vec::<String>>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_required_file_system_location_names_to_remove):<br>required: **false**<br><p>The required file system location names to remove from the queue.</p><br>
    ///   - [`allowed_storage_profile_ids_to_add(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::allowed_storage_profile_ids_to_add) / [`set_allowed_storage_profile_ids_to_add(Option<Vec::<String>>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_allowed_storage_profile_ids_to_add):<br>required: **false**<br><p>The storage profile IDs to add.</p><br>
    ///   - [`allowed_storage_profile_ids_to_remove(impl Into<String>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::allowed_storage_profile_ids_to_remove) / [`set_allowed_storage_profile_ids_to_remove(Option<Vec::<String>>)`](crate::operation::update_queue::builders::UpdateQueueFluentBuilder::set_allowed_storage_profile_ids_to_remove):<br>required: **false**<br><p>The storage profile ID to remove.</p><br>
    /// - On success, responds with [`UpdateQueueOutput`](crate::operation::update_queue::UpdateQueueOutput)
    /// - On failure, responds with [`SdkError<UpdateQueueError>`](crate::operation::update_queue::UpdateQueueError)
    pub fn update_queue(&self) -> crate::operation::update_queue::builders::UpdateQueueFluentBuilder {
        crate::operation::update_queue::builders::UpdateQueueFluentBuilder::new(self.handle.clone())
    }
}