aws_sdk_imagebuilder/client/
start_resource_state_update.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StartResourceStateUpdate`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`resource_arn(impl Into<String>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::resource_arn) / [`set_resource_arn(Option<String>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::set_resource_arn):<br>required: **true**<br><p>The ARN of the Image Builder resource that is updated. The state update might also impact associated resources.</p><br>
7    ///   - [`state(ResourceState)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::state) / [`set_state(Option<ResourceState>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::set_state):<br>required: **true**<br><p>Indicates the lifecycle action to take for this request.</p><br>
8    ///   - [`execution_role(impl Into<String>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::execution_role) / [`set_execution_role(Option<String>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::set_execution_role):<br>required: **false**<br><p>The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.</p><br>
9    ///   - [`include_resources(ResourceStateUpdateIncludeResources)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::include_resources) / [`set_include_resources(Option<ResourceStateUpdateIncludeResources>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::set_include_resources):<br>required: **false**<br><p>A list of image resources to update state for.</p><br>
10    ///   - [`exclusion_rules(ResourceStateUpdateExclusionRules)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::exclusion_rules) / [`set_exclusion_rules(Option<ResourceStateUpdateExclusionRules>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::set_exclusion_rules):<br>required: **false**<br><p>Skip action on the image resource and associated resources if specified exclusion rules are met.</p><br>
11    ///   - [`update_at(DateTime)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::update_at) / [`set_update_at(Option<DateTime>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::set_update_at):<br>required: **false**<br><p>The timestamp that indicates when resources are updated by a lifecycle action.</p><br>
12    ///   - [`client_token(impl Into<String>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::set_client_token):<br>required: **true**<br><p>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</p><br>
13    /// - On success, responds with [`StartResourceStateUpdateOutput`](crate::operation::start_resource_state_update::StartResourceStateUpdateOutput) with field(s):
14    ///   - [`lifecycle_execution_id(Option<String>)`](crate::operation::start_resource_state_update::StartResourceStateUpdateOutput::lifecycle_execution_id): <p>Identifies the lifecycle runtime instance that started the resource state update.</p>
15    ///   - [`resource_arn(Option<String>)`](crate::operation::start_resource_state_update::StartResourceStateUpdateOutput::resource_arn): <p>The requested ARN of the Image Builder resource for the asynchronous update.</p>
16    /// - On failure, responds with [`SdkError<StartResourceStateUpdateError>`](crate::operation::start_resource_state_update::StartResourceStateUpdateError)
17    pub fn start_resource_state_update(&self) -> crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder {
18        crate::operation::start_resource_state_update::builders::StartResourceStateUpdateFluentBuilder::new(self.handle.clone())
19    }
20}