aws_sdk_networkflowmonitor/client/
create_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 [`CreateScope`](crate::operation::create_scope::builders::CreateScopeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`targets(TargetResource)`](crate::operation::create_scope::builders::CreateScopeFluentBuilder::targets) / [`set_targets(Option<Vec::<TargetResource>>)`](crate::operation::create_scope::builders::CreateScopeFluentBuilder::set_targets):<br>required: **true**<br><p>The targets to define the scope to be monitored. Currently, a target is an Amazon Web Services account.</p><br>
7    ///   - [`client_token(impl Into<String>)`](crate::operation::create_scope::builders::CreateScopeFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_scope::builders::CreateScopeFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</p><br>
8    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_scope::builders::CreateScopeFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_scope::builders::CreateScopeFluentBuilder::set_tags):<br>required: **false**<br><p>The tags for a scope. You can add a maximum of 200 tags.</p><br>
9    /// - On success, responds with [`CreateScopeOutput`](crate::operation::create_scope::CreateScopeOutput) with field(s):
10    ///   - [`scope_id(String)`](crate::operation::create_scope::CreateScopeOutput::scope_id): <p>The identifier for the scope that includes the resources you want to get metrics for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
11    ///   - [`status(ScopeStatus)`](crate::operation::create_scope::CreateScopeOutput::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>
12    ///   - [`scope_arn(String)`](crate::operation::create_scope::CreateScopeOutput::scope_arn): <p>The Amazon Resource Name (ARN) of the scope.</p>
13    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_scope::CreateScopeOutput::tags): <p>The tags for a scope.</p>
14    /// - On failure, responds with [`SdkError<CreateScopeError>`](crate::operation::create_scope::CreateScopeError)
15    pub fn create_scope(&self) -> crate::operation::create_scope::builders::CreateScopeFluentBuilder {
16        crate::operation::create_scope::builders::CreateScopeFluentBuilder::new(self.handle.clone())
17    }
18}