aws_sdk_networksecuritymanager/client/
get_scope.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 [`GetScope`](crate::operation::get_scope::builders::GetScopeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`scope_identifier(impl Into<String>)`](crate::operation::get_scope::builders::GetScopeFluentBuilder::scope_identifier) / [`set_scope_identifier(Option<String>)`](crate::operation::get_scope::builders::GetScopeFluentBuilder::set_scope_identifier):<br>required: **true**<br><p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p><br>
7    /// - On success, responds with [`GetScopeOutput`](crate::operation::get_scope::GetScopeOutput) with field(s):
8    ///   - [`scope_id(String)`](crate::operation::get_scope::GetScopeOutput::scope_id): <p>The service-generated id of the scope.</p>
9    ///   - [`scope_arn(String)`](crate::operation::get_scope::GetScopeOutput::scope_arn): <p>The Amazon Resource Name (ARN) of the scope.</p>
10    ///   - [`scope_name(String)`](crate::operation::get_scope::GetScopeOutput::scope_name): <p>The name of the scope.</p>
11    ///   - [`scope_description(Option<String>)`](crate::operation::get_scope::GetScopeOutput::scope_description): <p>A description of the scope.</p>
12    ///   - [`scope_configuration(Option<ScopeConfiguration>)`](crate::operation::get_scope::GetScopeOutput::scope_configuration): <p>The configuration that defines which accounts and resources are in scope.</p>
13    ///   - [`status(EntityStatus)`](crate::operation::get_scope::GetScopeOutput::status): <p>The current status of the resource: <code>DRAFT</code> (unpublished, editable), <code>ACTIVE</code> (published, in use), or <code>DISABLED</code> (deactivated; changes cannot be published until the resource is re-enabled).</p>
14    ///   - [`version(String)`](crate::operation::get_scope::GetScopeOutput::version): <p>The version of the resource.</p>
15    ///   - [`update_token(Option<String>)`](crate::operation::get_scope::GetScopeOutput::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>
16    ///   - [`is_snapshot(Option<bool>)`](crate::operation::get_scope::GetScopeOutput::is_snapshot): <p>Specifies whether the resource is a snapshot of a published version.</p>
17    ///   - [`has_published_version(Option<bool>)`](crate::operation::get_scope::GetScopeOutput::has_published_version): <p>Specifies whether a published version of the resource exists.</p>
18    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_scope::GetScopeOutput::updated_at): <p>The time when the resource was last updated.</p>
19    /// - On failure, responds with [`SdkError<GetScopeError>`](crate::operation::get_scope::GetScopeError)
20    pub fn get_scope(&self) -> crate::operation::get_scope::builders::GetScopeFluentBuilder {
21        crate::operation::get_scope::builders::GetScopeFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_networksecuritymanager/client/get_scope.rs

aws_sdk_networksecuritymanager/client/
get_scope.rs
