1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetScopeOutput {
/// <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>
pub scope_id: ::std::string::String,
/// <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>
pub status: crate::types::ScopeStatus,
/// <p>The Amazon Resource Name (ARN) of the scope.</p>
pub scope_arn: ::std::string::String,
/// <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
pub targets: ::std::vec::Vec<crate::types::TargetResource>,
/// <p>The tags for a scope.</p>
pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
_request_id: Option<String>,
}
impl GetScopeOutput {
/// <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>
pub fn scope_id(&self) -> &str {
use std::ops::Deref;
self.scope_id.deref()
}
/// <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>
pub fn status(&self) -> &crate::types::ScopeStatus {
&self.status
}
/// <p>The Amazon Resource Name (ARN) of the scope.</p>
pub fn scope_arn(&self) -> &str {
use std::ops::Deref;
self.scope_arn.deref()
}
/// <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
pub fn targets(&self) -> &[crate::types::TargetResource] {
use std::ops::Deref;
self.targets.deref()
}
/// <p>The tags for a scope.</p>
pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.tags.as_ref()
}
}
impl ::aws_types::request_id::RequestId for GetScopeOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl GetScopeOutput {
/// Creates a new builder-style object to manufacture [`GetScopeOutput`](crate::operation::get_scope::GetScopeOutput).
pub fn builder() -> crate::operation::get_scope::builders::GetScopeOutputBuilder {
crate::operation::get_scope::builders::GetScopeOutputBuilder::default()
}
}
/// A builder for [`GetScopeOutput`](crate::operation::get_scope::GetScopeOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetScopeOutputBuilder {
pub(crate) scope_id: ::std::option::Option<::std::string::String>,
pub(crate) status: ::std::option::Option<crate::types::ScopeStatus>,
pub(crate) scope_arn: ::std::option::Option<::std::string::String>,
pub(crate) targets: ::std::option::Option<::std::vec::Vec<crate::types::TargetResource>>,
pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
_request_id: Option<String>,
}
impl GetScopeOutputBuilder {
/// <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>
/// This field is required.
pub fn scope_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.scope_id = ::std::option::Option::Some(input.into());
self
}
/// <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>
pub fn set_scope_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.scope_id = input;
self
}
/// <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>
pub fn get_scope_id(&self) -> &::std::option::Option<::std::string::String> {
&self.scope_id
}
/// <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>
/// This field is required.
pub fn status(mut self, input: crate::types::ScopeStatus) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::ScopeStatus>) -> Self {
self.status = input;
self
}
/// <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>
pub fn get_status(&self) -> &::std::option::Option<crate::types::ScopeStatus> {
&self.status
}
/// <p>The Amazon Resource Name (ARN) of the scope.</p>
/// This field is required.
pub fn scope_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.scope_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the scope.</p>
pub fn set_scope_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.scope_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the scope.</p>
pub fn get_scope_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.scope_arn
}
/// Appends an item to `targets`.
///
/// To override the contents of this collection use [`set_targets`](Self::set_targets).
///
/// <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
pub fn targets(mut self, input: crate::types::TargetResource) -> Self {
let mut v = self.targets.unwrap_or_default();
v.push(input);
self.targets = ::std::option::Option::Some(v);
self
}
/// <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
pub fn set_targets(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TargetResource>>) -> Self {
self.targets = input;
self
}
/// <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
pub fn get_targets(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TargetResource>> {
&self.targets
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The tags for a scope.</p>
pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = ::std::option::Option::Some(hash_map);
self
}
/// <p>The tags for a scope.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.tags = input;
self
}
/// <p>The tags for a scope.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.tags
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`GetScopeOutput`](crate::operation::get_scope::GetScopeOutput).
/// This method will fail if any of the following fields are not set:
/// - [`scope_id`](crate::operation::get_scope::builders::GetScopeOutputBuilder::scope_id)
/// - [`status`](crate::operation::get_scope::builders::GetScopeOutputBuilder::status)
/// - [`scope_arn`](crate::operation::get_scope::builders::GetScopeOutputBuilder::scope_arn)
/// - [`targets`](crate::operation::get_scope::builders::GetScopeOutputBuilder::targets)
pub fn build(self) -> ::std::result::Result<crate::operation::get_scope::GetScopeOutput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::get_scope::GetScopeOutput {
scope_id: self.scope_id.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"scope_id",
"scope_id was not specified but it is required when building GetScopeOutput",
)
})?,
status: self.status.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"status",
"status was not specified but it is required when building GetScopeOutput",
)
})?,
scope_arn: self.scope_arn.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"scope_arn",
"scope_arn was not specified but it is required when building GetScopeOutput",
)
})?,
targets: self.targets.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"targets",
"targets was not specified but it is required when building GetScopeOutput",
)
})?,
tags: self.tags,
_request_id: self._request_id,
})
}
}