AWS SDK for C++

AWS SDK for C++ Version 1.11.719

Loading...
Searching...
No Matches
DescribeNotebookInstanceResult.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/sagemaker/SageMaker_EXPORTS.h>
11#include <aws/sagemaker/model/DirectInternetAccess.h>
12#include <aws/sagemaker/model/IPAddressType.h>
13#include <aws/sagemaker/model/InstanceMetadataServiceConfiguration.h>
14#include <aws/sagemaker/model/InstanceType.h>
15#include <aws/sagemaker/model/NotebookInstanceAcceleratorType.h>
16#include <aws/sagemaker/model/NotebookInstanceStatus.h>
17#include <aws/sagemaker/model/RootAccess.h>
18
19#include <utility>
20
21namespace Aws {
22template <typename RESULT_TYPE>
23class AmazonWebServiceResult;
24
25namespace Utils {
26namespace Json {
27class JsonValue;
28} // namespace Json
29} // namespace Utils
30namespace SageMaker {
31namespace Model {
33 public:
34 AWS_SAGEMAKER_API DescribeNotebookInstanceResult() = default;
37
39
42 inline const Aws::String& GetNotebookInstanceArn() const { return m_notebookInstanceArn; }
43 template <typename NotebookInstanceArnT = Aws::String>
44 void SetNotebookInstanceArn(NotebookInstanceArnT&& value) {
45 m_notebookInstanceArnHasBeenSet = true;
46 m_notebookInstanceArn = std::forward<NotebookInstanceArnT>(value);
47 }
48 template <typename NotebookInstanceArnT = Aws::String>
50 SetNotebookInstanceArn(std::forward<NotebookInstanceArnT>(value));
51 return *this;
52 }
54
56
59 inline const Aws::String& GetNotebookInstanceName() const { return m_notebookInstanceName; }
60 template <typename NotebookInstanceNameT = Aws::String>
61 void SetNotebookInstanceName(NotebookInstanceNameT&& value) {
62 m_notebookInstanceNameHasBeenSet = true;
63 m_notebookInstanceName = std::forward<NotebookInstanceNameT>(value);
64 }
65 template <typename NotebookInstanceNameT = Aws::String>
67 SetNotebookInstanceName(std::forward<NotebookInstanceNameT>(value));
68 return *this;
69 }
71
73
76 inline NotebookInstanceStatus GetNotebookInstanceStatus() const { return m_notebookInstanceStatus; }
78 m_notebookInstanceStatusHasBeenSet = true;
79 m_notebookInstanceStatus = value;
80 }
83 return *this;
84 }
86
88
91 inline const Aws::String& GetFailureReason() const { return m_failureReason; }
92 template <typename FailureReasonT = Aws::String>
93 void SetFailureReason(FailureReasonT&& value) {
94 m_failureReasonHasBeenSet = true;
95 m_failureReason = std::forward<FailureReasonT>(value);
96 }
97 template <typename FailureReasonT = Aws::String>
99 SetFailureReason(std::forward<FailureReasonT>(value));
100 return *this;
101 }
103
105
109 inline const Aws::String& GetUrl() const { return m_url; }
110 template <typename UrlT = Aws::String>
111 void SetUrl(UrlT&& value) {
112 m_urlHasBeenSet = true;
113 m_url = std::forward<UrlT>(value);
114 }
115 template <typename UrlT = Aws::String>
117 SetUrl(std::forward<UrlT>(value));
118 return *this;
119 }
121
123
126 inline InstanceType GetInstanceType() const { return m_instanceType; }
127 inline void SetInstanceType(InstanceType value) {
128 m_instanceTypeHasBeenSet = true;
129 m_instanceType = value;
130 }
132 SetInstanceType(value);
133 return *this;
134 }
136
138
143 inline IPAddressType GetIpAddressType() const { return m_ipAddressType; }
144 inline void SetIpAddressType(IPAddressType value) {
145 m_ipAddressTypeHasBeenSet = true;
146 m_ipAddressType = value;
147 }
149 SetIpAddressType(value);
150 return *this;
151 }
153
155
158 inline const Aws::String& GetSubnetId() const { return m_subnetId; }
159 template <typename SubnetIdT = Aws::String>
160 void SetSubnetId(SubnetIdT&& value) {
161 m_subnetIdHasBeenSet = true;
162 m_subnetId = std::forward<SubnetIdT>(value);
163 }
164 template <typename SubnetIdT = Aws::String>
166 SetSubnetId(std::forward<SubnetIdT>(value));
167 return *this;
168 }
170
172
175 inline const Aws::Vector<Aws::String>& GetSecurityGroups() const { return m_securityGroups; }
176 template <typename SecurityGroupsT = Aws::Vector<Aws::String>>
177 void SetSecurityGroups(SecurityGroupsT&& value) {
178 m_securityGroupsHasBeenSet = true;
179 m_securityGroups = std::forward<SecurityGroupsT>(value);
180 }
181 template <typename SecurityGroupsT = Aws::Vector<Aws::String>>
183 SetSecurityGroups(std::forward<SecurityGroupsT>(value));
184 return *this;
185 }
186 template <typename SecurityGroupsT = Aws::String>
188 m_securityGroupsHasBeenSet = true;
189 m_securityGroups.emplace_back(std::forward<SecurityGroupsT>(value));
190 return *this;
191 }
193
195
199 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
200 template <typename RoleArnT = Aws::String>
201 void SetRoleArn(RoleArnT&& value) {
202 m_roleArnHasBeenSet = true;
203 m_roleArn = std::forward<RoleArnT>(value);
204 }
205 template <typename RoleArnT = Aws::String>
207 SetRoleArn(std::forward<RoleArnT>(value));
208 return *this;
209 }
211
213
217 inline const Aws::String& GetKmsKeyId() const { return m_kmsKeyId; }
218 template <typename KmsKeyIdT = Aws::String>
219 void SetKmsKeyId(KmsKeyIdT&& value) {
220 m_kmsKeyIdHasBeenSet = true;
221 m_kmsKeyId = std::forward<KmsKeyIdT>(value);
222 }
223 template <typename KmsKeyIdT = Aws::String>
225 SetKmsKeyId(std::forward<KmsKeyIdT>(value));
226 return *this;
227 }
229
231
235 inline const Aws::String& GetNetworkInterfaceId() const { return m_networkInterfaceId; }
236 template <typename NetworkInterfaceIdT = Aws::String>
237 void SetNetworkInterfaceId(NetworkInterfaceIdT&& value) {
238 m_networkInterfaceIdHasBeenSet = true;
239 m_networkInterfaceId = std::forward<NetworkInterfaceIdT>(value);
240 }
241 template <typename NetworkInterfaceIdT = Aws::String>
243 SetNetworkInterfaceId(std::forward<NetworkInterfaceIdT>(value));
244 return *this;
245 }
247
249
253 inline const Aws::Utils::DateTime& GetLastModifiedTime() const { return m_lastModifiedTime; }
254 template <typename LastModifiedTimeT = Aws::Utils::DateTime>
255 void SetLastModifiedTime(LastModifiedTimeT&& value) {
256 m_lastModifiedTimeHasBeenSet = true;
257 m_lastModifiedTime = std::forward<LastModifiedTimeT>(value);
258 }
259 template <typename LastModifiedTimeT = Aws::Utils::DateTime>
261 SetLastModifiedTime(std::forward<LastModifiedTimeT>(value));
262 return *this;
263 }
265
267
271 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
272 template <typename CreationTimeT = Aws::Utils::DateTime>
273 void SetCreationTime(CreationTimeT&& value) {
274 m_creationTimeHasBeenSet = true;
275 m_creationTime = std::forward<CreationTimeT>(value);
276 }
277 template <typename CreationTimeT = Aws::Utils::DateTime>
279 SetCreationTime(std::forward<CreationTimeT>(value));
280 return *this;
281 }
283
285
291 inline const Aws::String& GetNotebookInstanceLifecycleConfigName() const { return m_notebookInstanceLifecycleConfigName; }
292 template <typename NotebookInstanceLifecycleConfigNameT = Aws::String>
293 void SetNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT&& value) {
294 m_notebookInstanceLifecycleConfigNameHasBeenSet = true;
295 m_notebookInstanceLifecycleConfigName = std::forward<NotebookInstanceLifecycleConfigNameT>(value);
296 }
297 template <typename NotebookInstanceLifecycleConfigNameT = Aws::String>
298 DescribeNotebookInstanceResult& WithNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT&& value) {
299 SetNotebookInstanceLifecycleConfigName(std::forward<NotebookInstanceLifecycleConfigNameT>(value));
300 return *this;
301 }
303
305
313 inline DirectInternetAccess GetDirectInternetAccess() const { return m_directInternetAccess; }
315 m_directInternetAccessHasBeenSet = true;
316 m_directInternetAccess = value;
317 }
320 return *this;
321 }
323
325
329 inline int GetVolumeSizeInGB() const { return m_volumeSizeInGB; }
330 inline void SetVolumeSizeInGB(int value) {
331 m_volumeSizeInGBHasBeenSet = true;
332 m_volumeSizeInGB = value;
333 }
335 SetVolumeSizeInGB(value);
336 return *this;
337 }
339
341
346 inline const Aws::Vector<NotebookInstanceAcceleratorType>& GetAcceleratorTypes() const { return m_acceleratorTypes; }
347 template <typename AcceleratorTypesT = Aws::Vector<NotebookInstanceAcceleratorType>>
348 void SetAcceleratorTypes(AcceleratorTypesT&& value) {
349 m_acceleratorTypesHasBeenSet = true;
350 m_acceleratorTypes = std::forward<AcceleratorTypesT>(value);
351 }
352 template <typename AcceleratorTypesT = Aws::Vector<NotebookInstanceAcceleratorType>>
354 SetAcceleratorTypes(std::forward<AcceleratorTypesT>(value));
355 return *this;
356 }
358 m_acceleratorTypesHasBeenSet = true;
359 m_acceleratorTypes.push_back(value);
360 return *this;
361 }
363
365
376 inline const Aws::String& GetDefaultCodeRepository() const { return m_defaultCodeRepository; }
377 template <typename DefaultCodeRepositoryT = Aws::String>
378 void SetDefaultCodeRepository(DefaultCodeRepositoryT&& value) {
379 m_defaultCodeRepositoryHasBeenSet = true;
380 m_defaultCodeRepository = std::forward<DefaultCodeRepositoryT>(value);
381 }
382 template <typename DefaultCodeRepositoryT = Aws::String>
384 SetDefaultCodeRepository(std::forward<DefaultCodeRepositoryT>(value));
385 return *this;
386 }
388
390
401 inline const Aws::Vector<Aws::String>& GetAdditionalCodeRepositories() const { return m_additionalCodeRepositories; }
402 template <typename AdditionalCodeRepositoriesT = Aws::Vector<Aws::String>>
403 void SetAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) {
404 m_additionalCodeRepositoriesHasBeenSet = true;
405 m_additionalCodeRepositories = std::forward<AdditionalCodeRepositoriesT>(value);
406 }
407 template <typename AdditionalCodeRepositoriesT = Aws::Vector<Aws::String>>
409 SetAdditionalCodeRepositories(std::forward<AdditionalCodeRepositoriesT>(value));
410 return *this;
411 }
412 template <typename AdditionalCodeRepositoriesT = Aws::String>
413 DescribeNotebookInstanceResult& AddAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) {
414 m_additionalCodeRepositoriesHasBeenSet = true;
415 m_additionalCodeRepositories.emplace_back(std::forward<AdditionalCodeRepositoriesT>(value));
416 return *this;
417 }
419
421
428 inline RootAccess GetRootAccess() const { return m_rootAccess; }
429 inline void SetRootAccess(RootAccess value) {
430 m_rootAccessHasBeenSet = true;
431 m_rootAccess = value;
432 }
434 SetRootAccess(value);
435 return *this;
436 }
438
440
443 inline const Aws::String& GetPlatformIdentifier() const { return m_platformIdentifier; }
444 template <typename PlatformIdentifierT = Aws::String>
445 void SetPlatformIdentifier(PlatformIdentifierT&& value) {
446 m_platformIdentifierHasBeenSet = true;
447 m_platformIdentifier = std::forward<PlatformIdentifierT>(value);
448 }
449 template <typename PlatformIdentifierT = Aws::String>
451 SetPlatformIdentifier(std::forward<PlatformIdentifierT>(value));
452 return *this;
453 }
455
457
461 return m_instanceMetadataServiceConfiguration;
462 }
463 template <typename InstanceMetadataServiceConfigurationT = InstanceMetadataServiceConfiguration>
464 void SetInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT&& value) {
465 m_instanceMetadataServiceConfigurationHasBeenSet = true;
466 m_instanceMetadataServiceConfiguration = std::forward<InstanceMetadataServiceConfigurationT>(value);
467 }
468 template <typename InstanceMetadataServiceConfigurationT = InstanceMetadataServiceConfiguration>
469 DescribeNotebookInstanceResult& WithInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT&& value) {
470 SetInstanceMetadataServiceConfiguration(std::forward<InstanceMetadataServiceConfigurationT>(value));
471 return *this;
472 }
474
476
477 inline const Aws::String& GetRequestId() const { return m_requestId; }
478 template <typename RequestIdT = Aws::String>
479 void SetRequestId(RequestIdT&& value) {
480 m_requestIdHasBeenSet = true;
481 m_requestId = std::forward<RequestIdT>(value);
482 }
483 template <typename RequestIdT = Aws::String>
485 SetRequestId(std::forward<RequestIdT>(value));
486 return *this;
487 }
489 private:
490 Aws::String m_notebookInstanceArn;
491
492 Aws::String m_notebookInstanceName;
493
495
496 Aws::String m_failureReason;
497
498 Aws::String m_url;
499
500 InstanceType m_instanceType{InstanceType::NOT_SET};
501
502 IPAddressType m_ipAddressType{IPAddressType::NOT_SET};
503
504 Aws::String m_subnetId;
505
506 Aws::Vector<Aws::String> m_securityGroups;
507
508 Aws::String m_roleArn;
509
510 Aws::String m_kmsKeyId;
511
512 Aws::String m_networkInterfaceId;
513
514 Aws::Utils::DateTime m_lastModifiedTime{};
515
516 Aws::Utils::DateTime m_creationTime{};
517
518 Aws::String m_notebookInstanceLifecycleConfigName;
519
521
522 int m_volumeSizeInGB{0};
523
525
526 Aws::String m_defaultCodeRepository;
527
528 Aws::Vector<Aws::String> m_additionalCodeRepositories;
529
530 RootAccess m_rootAccess{RootAccess::NOT_SET};
531
532 Aws::String m_platformIdentifier;
533
534 InstanceMetadataServiceConfiguration m_instanceMetadataServiceConfiguration;
535
536 Aws::String m_requestId;
537 bool m_notebookInstanceArnHasBeenSet = false;
538 bool m_notebookInstanceNameHasBeenSet = false;
539 bool m_notebookInstanceStatusHasBeenSet = false;
540 bool m_failureReasonHasBeenSet = false;
541 bool m_urlHasBeenSet = false;
542 bool m_instanceTypeHasBeenSet = false;
543 bool m_ipAddressTypeHasBeenSet = false;
544 bool m_subnetIdHasBeenSet = false;
545 bool m_securityGroupsHasBeenSet = false;
546 bool m_roleArnHasBeenSet = false;
547 bool m_kmsKeyIdHasBeenSet = false;
548 bool m_networkInterfaceIdHasBeenSet = false;
549 bool m_lastModifiedTimeHasBeenSet = false;
550 bool m_creationTimeHasBeenSet = false;
551 bool m_notebookInstanceLifecycleConfigNameHasBeenSet = false;
552 bool m_directInternetAccessHasBeenSet = false;
553 bool m_volumeSizeInGBHasBeenSet = false;
554 bool m_acceleratorTypesHasBeenSet = false;
555 bool m_defaultCodeRepositoryHasBeenSet = false;
556 bool m_additionalCodeRepositoriesHasBeenSet = false;
557 bool m_rootAccessHasBeenSet = false;
558 bool m_platformIdentifierHasBeenSet = false;
559 bool m_instanceMetadataServiceConfigurationHasBeenSet = false;
560 bool m_requestIdHasBeenSet = false;
561};
562
563} // namespace Model
564} // namespace SageMaker
565} // namespace Aws
DescribeNotebookInstanceResult & WithNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT &&value)
DescribeNotebookInstanceResult & WithAdditionalCodeRepositories(AdditionalCodeRepositoriesT &&value)
void SetNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT &&value)
DescribeNotebookInstanceResult & WithKmsKeyId(KmsKeyIdT &&value)
DescribeNotebookInstanceResult & WithRequestId(RequestIdT &&value)
DescribeNotebookInstanceResult & WithSecurityGroups(SecurityGroupsT &&value)
DescribeNotebookInstanceResult & WithSubnetId(SubnetIdT &&value)
DescribeNotebookInstanceResult & WithPlatformIdentifier(PlatformIdentifierT &&value)
DescribeNotebookInstanceResult & WithDefaultCodeRepository(DefaultCodeRepositoryT &&value)
DescribeNotebookInstanceResult & WithLastModifiedTime(LastModifiedTimeT &&value)
DescribeNotebookInstanceResult & WithRoleArn(RoleArnT &&value)
DescribeNotebookInstanceResult & AddAdditionalCodeRepositories(AdditionalCodeRepositoriesT &&value)
DescribeNotebookInstanceResult & WithInstanceType(InstanceType value)
DescribeNotebookInstanceResult & WithNotebookInstanceArn(NotebookInstanceArnT &&value)
DescribeNotebookInstanceResult & WithIpAddressType(IPAddressType value)
void SetAdditionalCodeRepositories(AdditionalCodeRepositoriesT &&value)
DescribeNotebookInstanceResult & WithFailureReason(FailureReasonT &&value)
DescribeNotebookInstanceResult & WithNotebookInstanceStatus(NotebookInstanceStatus value)
DescribeNotebookInstanceResult & WithInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT &&value)
AWS_SAGEMAKER_API DescribeNotebookInstanceResult()=default
void SetInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT &&value)
DescribeNotebookInstanceResult & WithNotebookInstanceName(NotebookInstanceNameT &&value)
DescribeNotebookInstanceResult & AddAcceleratorTypes(NotebookInstanceAcceleratorType value)
const Aws::Vector< Aws::String > & GetAdditionalCodeRepositories() const
DescribeNotebookInstanceResult & WithNetworkInterfaceId(NetworkInterfaceIdT &&value)
DescribeNotebookInstanceResult & WithRootAccess(RootAccess value)
DescribeNotebookInstanceResult & WithVolumeSizeInGB(int value)
DescribeNotebookInstanceResult & WithAcceleratorTypes(AcceleratorTypesT &&value)
DescribeNotebookInstanceResult & WithDirectInternetAccess(DirectInternetAccess value)
AWS_SAGEMAKER_API DescribeNotebookInstanceResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
const InstanceMetadataServiceConfiguration & GetInstanceMetadataServiceConfiguration() const
DescribeNotebookInstanceResult & AddSecurityGroups(SecurityGroupsT &&value)
const Aws::Vector< NotebookInstanceAcceleratorType > & GetAcceleratorTypes() const
AWS_SAGEMAKER_API DescribeNotebookInstanceResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeNotebookInstanceResult & WithCreationTime(CreationTimeT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue