aws_sdk_networksecuritymanager/client/

update_scope.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateScope`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`scope_identifier(impl Into<String>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::scope_identifier) / [`set_scope_identifier(Option<String>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::set_scope_identifier):<br>required: **true**<br><p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p><br>
    ///   - [`update_token(impl Into<String>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::update_token) / [`set_update_token(Option<String>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::set_update_token):<br>required: **true**<br><p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p><br>
    ///   - [`scope_description(impl Into<String>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::scope_description) / [`set_scope_description(Option<String>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::set_scope_description):<br>required: **false**<br><p>A description of the scope.</p><br>
    ///   - [`scope_configuration(ScopeConfiguration)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::scope_configuration) / [`set_scope_configuration(Option<ScopeConfiguration>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::set_scope_configuration):<br>required: **false**<br><p>The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.</p> <p>A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.</p><br>
    ///   - [`is_published(bool)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::is_published) / [`set_is_published(Option<bool>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::set_is_published):<br>required: **true**<br><p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>).</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::update_scope::builders::UpdateScopeFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p><br>
    /// - On success, responds with [`UpdateScopeOutput`](crate::operation::update_scope::UpdateScopeOutput) with field(s):
    ///   - [`scope_id(String)`](crate::operation::update_scope::UpdateScopeOutput::scope_id): <p>The service-generated id of the scope.</p>
    ///   - [`scope_arn(String)`](crate::operation::update_scope::UpdateScopeOutput::scope_arn): <p>The Amazon Resource Name (ARN) of the scope.</p>
    ///   - [`scope_name(String)`](crate::operation::update_scope::UpdateScopeOutput::scope_name): <p>The name of the scope.</p>
    ///   - [`scope_description(Option<String>)`](crate::operation::update_scope::UpdateScopeOutput::scope_description): <p>A description of the scope.</p>
    ///   - [`scope_configuration(Option<ScopeConfiguration>)`](crate::operation::update_scope::UpdateScopeOutput::scope_configuration): <p>The configuration that defines which accounts and resources are in scope.</p>
    ///   - [`status(EntityStatus)`](crate::operation::update_scope::UpdateScopeOutput::status): <p>The current status of the resource: <code>DRAFT</code> (unpublished, editable) or <code>ACTIVE</code> (published, in use).</p>
    ///   - [`version(String)`](crate::operation::update_scope::UpdateScopeOutput::version): <p>The version of the resource.</p>
    ///   - [`update_token(Option<String>)`](crate::operation::update_scope::UpdateScopeOutput::update_token): <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    ///   - [`is_snapshot(Option<bool>)`](crate::operation::update_scope::UpdateScopeOutput::is_snapshot): <p>Specifies whether the resource is a snapshot of a published version.</p>
    ///   - [`has_published_version(Option<bool>)`](crate::operation::update_scope::UpdateScopeOutput::has_published_version): <p>Specifies whether a published version of the resource exists.</p>
    ///   - [`updated_at(Option<DateTime>)`](crate::operation::update_scope::UpdateScopeOutput::updated_at): <p>The time when the resource was last updated.</p>
    /// - On failure, responds with [`SdkError<UpdateScopeError>`](crate::operation::update_scope::UpdateScopeError)
    pub fn update_scope(&self) -> crate::operation::update_scope::builders::UpdateScopeFluentBuilder {
        crate::operation::update_scope::builders::UpdateScopeFluentBuilder::new(self.handle.clone())
    }
}