aws_sdk_networkflowmonitor/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_id(impl Into<String>)`](crate::operation::get_scope::builders::GetScopeFluentBuilder::scope_id) / [`set_scope_id(Option<String>)`](crate::operation::get_scope::builders::GetScopeFluentBuilder::set_scope_id):<br>required: **true**<br><p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</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 identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>
9    ///   - [`status(ScopeStatus)`](crate::operation::get_scope::GetScopeOutput::status): <p>The status for a scope. The status can be one of the following: <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, <code>FAILED</code>, <code>DEACTIVATING</code>, or <code>DEACTIVATED</code>.</p> <p>A status of <code>DEACTIVATING</code> means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of <code>DEACTIVATED</code> means that the deactivating process is complete.</p>
10    ///   - [`scope_arn(String)`](crate::operation::get_scope::GetScopeOutput::scope_arn): <p>The Amazon Resource Name (ARN) of the scope.</p>
11    ///   - [`targets(Vec::<TargetResource>)`](crate::operation::get_scope::GetScopeOutput::targets): <p>The targets for a scope</p>
12    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_scope::GetScopeOutput::tags): <p>The tags for a scope.</p>
13    /// - On failure, responds with [`SdkError<GetScopeError>`](crate::operation::get_scope::GetScopeError)
14    pub fn get_scope(&self) -> crate::operation::get_scope::builders::GetScopeFluentBuilder {
15        crate::operation::get_scope::builders::GetScopeFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_networkflowmonitor/client/get_scope.rs

aws_sdk_networkflowmonitor/client/
get_scope.rs
