AWS SDK for C++

AWS SDK for C++ Version 1.11.781

Loading...
Searching...
No Matches
DescribeNotebookInstanceResult.h
1
6#pragma once
7#include <aws/core/http/HttpResponse.h>
8#include <aws/core/utils/DateTime.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/sagemaker/SageMaker_EXPORTS.h>
12#include <aws/sagemaker/model/DirectInternetAccess.h>
13#include <aws/sagemaker/model/IPAddressType.h>
14#include <aws/sagemaker/model/InstanceMetadataServiceConfiguration.h>
15#include <aws/sagemaker/model/InstanceType.h>
16#include <aws/sagemaker/model/NotebookInstanceAcceleratorType.h>
17#include <aws/sagemaker/model/NotebookInstanceStatus.h>
18#include <aws/sagemaker/model/RootAccess.h>
19
20#include <utility>
21
22namespace Aws {
23template <typename RESULT_TYPE>
24class AmazonWebServiceResult;
25
26namespace Utils {
27namespace Json {
28class JsonValue;
29} // namespace Json
30} // namespace Utils
31namespace SageMaker {
32namespace Model {
34 public:
35 AWS_SAGEMAKER_API DescribeNotebookInstanceResult() = default;
38
40
43 inline const Aws::String& GetNotebookInstanceArn() const { return m_notebookInstanceArn; }
44 template <typename NotebookInstanceArnT = Aws::String>
45 void SetNotebookInstanceArn(NotebookInstanceArnT&& value) {
46 m_notebookInstanceArnHasBeenSet = true;
47 m_notebookInstanceArn = std::forward<NotebookInstanceArnT>(value);
48 }
49 template <typename NotebookInstanceArnT = Aws::String>
51 SetNotebookInstanceArn(std::forward<NotebookInstanceArnT>(value));
52 return *this;
53 }
55
57
60 inline const Aws::String& GetNotebookInstanceName() const { return m_notebookInstanceName; }
61 template <typename NotebookInstanceNameT = Aws::String>
62 void SetNotebookInstanceName(NotebookInstanceNameT&& value) {
63 m_notebookInstanceNameHasBeenSet = true;
64 m_notebookInstanceName = std::forward<NotebookInstanceNameT>(value);
65 }
66 template <typename NotebookInstanceNameT = Aws::String>
68 SetNotebookInstanceName(std::forward<NotebookInstanceNameT>(value));
69 return *this;
70 }
72
74
77 inline NotebookInstanceStatus GetNotebookInstanceStatus() const { return m_notebookInstanceStatus; }
79 m_notebookInstanceStatusHasBeenSet = true;
80 m_notebookInstanceStatus = value;
81 }
84 return *this;
85 }
87
89
92 inline const Aws::String& GetFailureReason() const { return m_failureReason; }
93 template <typename FailureReasonT = Aws::String>
94 void SetFailureReason(FailureReasonT&& value) {
95 m_failureReasonHasBeenSet = true;
96 m_failureReason = std::forward<FailureReasonT>(value);
97 }
98 template <typename FailureReasonT = Aws::String>
100 SetFailureReason(std::forward<FailureReasonT>(value));
101 return *this;
102 }
104
106
110 inline const Aws::String& GetUrl() const { return m_url; }
111 template <typename UrlT = Aws::String>
112 void SetUrl(UrlT&& value) {
113 m_urlHasBeenSet = true;
114 m_url = std::forward<UrlT>(value);
115 }
116 template <typename UrlT = Aws::String>
118 SetUrl(std::forward<UrlT>(value));
119 return *this;
120 }
122
124
127 inline InstanceType GetInstanceType() const { return m_instanceType; }
128 inline void SetInstanceType(InstanceType value) {
129 m_instanceTypeHasBeenSet = true;
130 m_instanceType = value;
131 }
133 SetInstanceType(value);
134 return *this;
135 }
137
139
144 inline IPAddressType GetIpAddressType() const { return m_ipAddressType; }
145 inline void SetIpAddressType(IPAddressType value) {
146 m_ipAddressTypeHasBeenSet = true;
147 m_ipAddressType = value;
148 }
150 SetIpAddressType(value);
151 return *this;
152 }
154
156
159 inline const Aws::String& GetSubnetId() const { return m_subnetId; }
160 template <typename SubnetIdT = Aws::String>
161 void SetSubnetId(SubnetIdT&& value) {
162 m_subnetIdHasBeenSet = true;
163 m_subnetId = std::forward<SubnetIdT>(value);
164 }
165 template <typename SubnetIdT = Aws::String>
167 SetSubnetId(std::forward<SubnetIdT>(value));
168 return *this;
169 }
171
173
176 inline const Aws::Vector<Aws::String>& GetSecurityGroups() const { return m_securityGroups; }
177 template <typename SecurityGroupsT = Aws::Vector<Aws::String>>
178 void SetSecurityGroups(SecurityGroupsT&& value) {
179 m_securityGroupsHasBeenSet = true;
180 m_securityGroups = std::forward<SecurityGroupsT>(value);
181 }
182 template <typename SecurityGroupsT = Aws::Vector<Aws::String>>
184 SetSecurityGroups(std::forward<SecurityGroupsT>(value));
185 return *this;
186 }
187 template <typename SecurityGroupsT = Aws::String>
189 m_securityGroupsHasBeenSet = true;
190 m_securityGroups.emplace_back(std::forward<SecurityGroupsT>(value));
191 return *this;
192 }
194
196
200 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
201 template <typename RoleArnT = Aws::String>
202 void SetRoleArn(RoleArnT&& value) {
203 m_roleArnHasBeenSet = true;
204 m_roleArn = std::forward<RoleArnT>(value);
205 }
206 template <typename RoleArnT = Aws::String>
208 SetRoleArn(std::forward<RoleArnT>(value));
209 return *this;
210 }
212
214
218 inline const Aws::String& GetKmsKeyId() const { return m_kmsKeyId; }
219 template <typename KmsKeyIdT = Aws::String>
220 void SetKmsKeyId(KmsKeyIdT&& value) {
221 m_kmsKeyIdHasBeenSet = true;
222 m_kmsKeyId = std::forward<KmsKeyIdT>(value);
223 }
224 template <typename KmsKeyIdT = Aws::String>
226 SetKmsKeyId(std::forward<KmsKeyIdT>(value));
227 return *this;
228 }
230
232
236 inline const Aws::String& GetNetworkInterfaceId() const { return m_networkInterfaceId; }
237 template <typename NetworkInterfaceIdT = Aws::String>
238 void SetNetworkInterfaceId(NetworkInterfaceIdT&& value) {
239 m_networkInterfaceIdHasBeenSet = true;
240 m_networkInterfaceId = std::forward<NetworkInterfaceIdT>(value);
241 }
242 template <typename NetworkInterfaceIdT = Aws::String>
244 SetNetworkInterfaceId(std::forward<NetworkInterfaceIdT>(value));
245 return *this;
246 }
248
250
254 inline const Aws::Utils::DateTime& GetLastModifiedTime() const { return m_lastModifiedTime; }
255 template <typename LastModifiedTimeT = Aws::Utils::DateTime>
256 void SetLastModifiedTime(LastModifiedTimeT&& value) {
257 m_lastModifiedTimeHasBeenSet = true;
258 m_lastModifiedTime = std::forward<LastModifiedTimeT>(value);
259 }
260 template <typename LastModifiedTimeT = Aws::Utils::DateTime>
262 SetLastModifiedTime(std::forward<LastModifiedTimeT>(value));
263 return *this;
264 }
266
268
272 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
273 template <typename CreationTimeT = Aws::Utils::DateTime>
274 void SetCreationTime(CreationTimeT&& value) {
275 m_creationTimeHasBeenSet = true;
276 m_creationTime = std::forward<CreationTimeT>(value);
277 }
278 template <typename CreationTimeT = Aws::Utils::DateTime>
280 SetCreationTime(std::forward<CreationTimeT>(value));
281 return *this;
282 }
284
286
292 inline const Aws::String& GetNotebookInstanceLifecycleConfigName() const { return m_notebookInstanceLifecycleConfigName; }
293 template <typename NotebookInstanceLifecycleConfigNameT = Aws::String>
294 void SetNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT&& value) {
295 m_notebookInstanceLifecycleConfigNameHasBeenSet = true;
296 m_notebookInstanceLifecycleConfigName = std::forward<NotebookInstanceLifecycleConfigNameT>(value);
297 }
298 template <typename NotebookInstanceLifecycleConfigNameT = Aws::String>
299 DescribeNotebookInstanceResult& WithNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT&& value) {
300 SetNotebookInstanceLifecycleConfigName(std::forward<NotebookInstanceLifecycleConfigNameT>(value));
301 return *this;
302 }
304
306
314 inline DirectInternetAccess GetDirectInternetAccess() const { return m_directInternetAccess; }
316 m_directInternetAccessHasBeenSet = true;
317 m_directInternetAccess = value;
318 }
321 return *this;
322 }
324
326
330 inline int GetVolumeSizeInGB() const { return m_volumeSizeInGB; }
331 inline void SetVolumeSizeInGB(int value) {
332 m_volumeSizeInGBHasBeenSet = true;
333 m_volumeSizeInGB = value;
334 }
336 SetVolumeSizeInGB(value);
337 return *this;
338 }
340
342
347 inline const Aws::Vector<NotebookInstanceAcceleratorType>& GetAcceleratorTypes() const { return m_acceleratorTypes; }
348 template <typename AcceleratorTypesT = Aws::Vector<NotebookInstanceAcceleratorType>>
349 void SetAcceleratorTypes(AcceleratorTypesT&& value) {
350 m_acceleratorTypesHasBeenSet = true;
351 m_acceleratorTypes = std::forward<AcceleratorTypesT>(value);
352 }
353 template <typename AcceleratorTypesT = Aws::Vector<NotebookInstanceAcceleratorType>>
355 SetAcceleratorTypes(std::forward<AcceleratorTypesT>(value));
356 return *this;
357 }
359 m_acceleratorTypesHasBeenSet = true;
360 m_acceleratorTypes.push_back(value);
361 return *this;
362 }
364
366
377 inline const Aws::String& GetDefaultCodeRepository() const { return m_defaultCodeRepository; }
378 template <typename DefaultCodeRepositoryT = Aws::String>
379 void SetDefaultCodeRepository(DefaultCodeRepositoryT&& value) {
380 m_defaultCodeRepositoryHasBeenSet = true;
381 m_defaultCodeRepository = std::forward<DefaultCodeRepositoryT>(value);
382 }
383 template <typename DefaultCodeRepositoryT = Aws::String>
385 SetDefaultCodeRepository(std::forward<DefaultCodeRepositoryT>(value));
386 return *this;
387 }
389
391
402 inline const Aws::Vector<Aws::String>& GetAdditionalCodeRepositories() const { return m_additionalCodeRepositories; }
403 template <typename AdditionalCodeRepositoriesT = Aws::Vector<Aws::String>>
404 void SetAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) {
405 m_additionalCodeRepositoriesHasBeenSet = true;
406 m_additionalCodeRepositories = std::forward<AdditionalCodeRepositoriesT>(value);
407 }
408 template <typename AdditionalCodeRepositoriesT = Aws::Vector<Aws::String>>
410 SetAdditionalCodeRepositories(std::forward<AdditionalCodeRepositoriesT>(value));
411 return *this;
412 }
413 template <typename AdditionalCodeRepositoriesT = Aws::String>
414 DescribeNotebookInstanceResult& AddAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) {
415 m_additionalCodeRepositoriesHasBeenSet = true;
416 m_additionalCodeRepositories.emplace_back(std::forward<AdditionalCodeRepositoriesT>(value));
417 return *this;
418 }
420
422
429 inline RootAccess GetRootAccess() const { return m_rootAccess; }
430 inline void SetRootAccess(RootAccess value) {
431 m_rootAccessHasBeenSet = true;
432 m_rootAccess = value;
433 }
435 SetRootAccess(value);
436 return *this;
437 }
439
441
444 inline const Aws::String& GetPlatformIdentifier() const { return m_platformIdentifier; }
445 template <typename PlatformIdentifierT = Aws::String>
446 void SetPlatformIdentifier(PlatformIdentifierT&& value) {
447 m_platformIdentifierHasBeenSet = true;
448 m_platformIdentifier = std::forward<PlatformIdentifierT>(value);
449 }
450 template <typename PlatformIdentifierT = Aws::String>
452 SetPlatformIdentifier(std::forward<PlatformIdentifierT>(value));
453 return *this;
454 }
456
458
462 return m_instanceMetadataServiceConfiguration;
463 }
464 template <typename InstanceMetadataServiceConfigurationT = InstanceMetadataServiceConfiguration>
465 void SetInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT&& value) {
466 m_instanceMetadataServiceConfigurationHasBeenSet = true;
467 m_instanceMetadataServiceConfiguration = std::forward<InstanceMetadataServiceConfigurationT>(value);
468 }
469 template <typename InstanceMetadataServiceConfigurationT = InstanceMetadataServiceConfiguration>
470 DescribeNotebookInstanceResult& WithInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT&& value) {
471 SetInstanceMetadataServiceConfiguration(std::forward<InstanceMetadataServiceConfigurationT>(value));
472 return *this;
473 }
475
477
478 inline const Aws::String& GetRequestId() const { return m_requestId; }
479 template <typename RequestIdT = Aws::String>
480 void SetRequestId(RequestIdT&& value) {
481 m_requestIdHasBeenSet = true;
482 m_requestId = std::forward<RequestIdT>(value);
483 }
484 template <typename RequestIdT = Aws::String>
486 SetRequestId(std::forward<RequestIdT>(value));
487 return *this;
488 }
490 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
491
492 private:
493 Aws::String m_notebookInstanceArn;
494
495 Aws::String m_notebookInstanceName;
496
498
499 Aws::String m_failureReason;
500
501 Aws::String m_url;
502
503 InstanceType m_instanceType{InstanceType::NOT_SET};
504
505 IPAddressType m_ipAddressType{IPAddressType::NOT_SET};
506
507 Aws::String m_subnetId;
508
509 Aws::Vector<Aws::String> m_securityGroups;
510
511 Aws::String m_roleArn;
512
513 Aws::String m_kmsKeyId;
514
515 Aws::String m_networkInterfaceId;
516
517 Aws::Utils::DateTime m_lastModifiedTime{};
518
519 Aws::Utils::DateTime m_creationTime{};
520
521 Aws::String m_notebookInstanceLifecycleConfigName;
522
524
525 int m_volumeSizeInGB{0};
526
528
529 Aws::String m_defaultCodeRepository;
530
531 Aws::Vector<Aws::String> m_additionalCodeRepositories;
532
533 RootAccess m_rootAccess{RootAccess::NOT_SET};
534
535 Aws::String m_platformIdentifier;
536
537 InstanceMetadataServiceConfiguration m_instanceMetadataServiceConfiguration;
538
539 Aws::String m_requestId;
540 Aws::Http::HttpResponseCode m_HttpResponseCode;
541 bool m_notebookInstanceArnHasBeenSet = false;
542 bool m_notebookInstanceNameHasBeenSet = false;
543 bool m_notebookInstanceStatusHasBeenSet = false;
544 bool m_failureReasonHasBeenSet = false;
545 bool m_urlHasBeenSet = false;
546 bool m_instanceTypeHasBeenSet = false;
547 bool m_ipAddressTypeHasBeenSet = false;
548 bool m_subnetIdHasBeenSet = false;
549 bool m_securityGroupsHasBeenSet = false;
550 bool m_roleArnHasBeenSet = false;
551 bool m_kmsKeyIdHasBeenSet = false;
552 bool m_networkInterfaceIdHasBeenSet = false;
553 bool m_lastModifiedTimeHasBeenSet = false;
554 bool m_creationTimeHasBeenSet = false;
555 bool m_notebookInstanceLifecycleConfigNameHasBeenSet = false;
556 bool m_directInternetAccessHasBeenSet = false;
557 bool m_volumeSizeInGBHasBeenSet = false;
558 bool m_acceleratorTypesHasBeenSet = false;
559 bool m_defaultCodeRepositoryHasBeenSet = false;
560 bool m_additionalCodeRepositoriesHasBeenSet = false;
561 bool m_rootAccessHasBeenSet = false;
562 bool m_platformIdentifierHasBeenSet = false;
563 bool m_instanceMetadataServiceConfigurationHasBeenSet = false;
564 bool m_requestIdHasBeenSet = false;
565};
566
567} // namespace Model
568} // namespace SageMaker
569} // 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