AWS SDK for C++

AWS SDK for C++ Version 1.11.612

Loading...
Searching...
No Matches
DescribeNotebookInstanceResult.h
1
6#pragma once
7#include <aws/sagemaker/SageMaker_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/sagemaker/model/NotebookInstanceStatus.h>
10#include <aws/sagemaker/model/InstanceType.h>
11#include <aws/core/utils/memory/stl/AWSVector.h>
12#include <aws/core/utils/DateTime.h>
13#include <aws/sagemaker/model/DirectInternetAccess.h>
14#include <aws/sagemaker/model/RootAccess.h>
15#include <aws/sagemaker/model/InstanceMetadataServiceConfiguration.h>
16#include <aws/sagemaker/model/NotebookInstanceAcceleratorType.h>
17#include <utility>
18
19namespace Aws
20{
21template<typename RESULT_TYPE>
22class AmazonWebServiceResult;
23
24namespace Utils
25{
26namespace Json
27{
28 class JsonValue;
29} // namespace Json
30} // namespace Utils
31namespace SageMaker
32{
33namespace Model
34{
36 {
37 public:
38 AWS_SAGEMAKER_API DescribeNotebookInstanceResult() = default;
41
42
44
47 inline const Aws::String& GetNotebookInstanceArn() const { return m_notebookInstanceArn; }
48 template<typename NotebookInstanceArnT = Aws::String>
49 void SetNotebookInstanceArn(NotebookInstanceArnT&& value) { m_notebookInstanceArnHasBeenSet = true; m_notebookInstanceArn = std::forward<NotebookInstanceArnT>(value); }
50 template<typename NotebookInstanceArnT = Aws::String>
51 DescribeNotebookInstanceResult& WithNotebookInstanceArn(NotebookInstanceArnT&& value) { SetNotebookInstanceArn(std::forward<NotebookInstanceArnT>(value)); return *this;}
53
55
58 inline const Aws::String& GetNotebookInstanceName() const { return m_notebookInstanceName; }
59 template<typename NotebookInstanceNameT = Aws::String>
60 void SetNotebookInstanceName(NotebookInstanceNameT&& value) { m_notebookInstanceNameHasBeenSet = true; m_notebookInstanceName = std::forward<NotebookInstanceNameT>(value); }
61 template<typename NotebookInstanceNameT = Aws::String>
62 DescribeNotebookInstanceResult& WithNotebookInstanceName(NotebookInstanceNameT&& value) { SetNotebookInstanceName(std::forward<NotebookInstanceNameT>(value)); return *this;}
64
66
69 inline NotebookInstanceStatus GetNotebookInstanceStatus() const { return m_notebookInstanceStatus; }
70 inline void SetNotebookInstanceStatus(NotebookInstanceStatus value) { m_notebookInstanceStatusHasBeenSet = true; m_notebookInstanceStatus = value; }
73
75
78 inline const Aws::String& GetFailureReason() const { return m_failureReason; }
79 template<typename FailureReasonT = Aws::String>
80 void SetFailureReason(FailureReasonT&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::forward<FailureReasonT>(value); }
81 template<typename FailureReasonT = Aws::String>
82 DescribeNotebookInstanceResult& WithFailureReason(FailureReasonT&& value) { SetFailureReason(std::forward<FailureReasonT>(value)); return *this;}
84
86
90 inline const Aws::String& GetUrl() const { return m_url; }
91 template<typename UrlT = Aws::String>
92 void SetUrl(UrlT&& value) { m_urlHasBeenSet = true; m_url = std::forward<UrlT>(value); }
93 template<typename UrlT = Aws::String>
94 DescribeNotebookInstanceResult& WithUrl(UrlT&& value) { SetUrl(std::forward<UrlT>(value)); return *this;}
96
98
101 inline InstanceType GetInstanceType() const { return m_instanceType; }
102 inline void SetInstanceType(InstanceType value) { m_instanceTypeHasBeenSet = true; m_instanceType = value; }
105
107
110 inline const Aws::String& GetSubnetId() const { return m_subnetId; }
111 template<typename SubnetIdT = Aws::String>
112 void SetSubnetId(SubnetIdT&& value) { m_subnetIdHasBeenSet = true; m_subnetId = std::forward<SubnetIdT>(value); }
113 template<typename SubnetIdT = Aws::String>
114 DescribeNotebookInstanceResult& WithSubnetId(SubnetIdT&& value) { SetSubnetId(std::forward<SubnetIdT>(value)); return *this;}
116
118
121 inline const Aws::Vector<Aws::String>& GetSecurityGroups() const { return m_securityGroups; }
122 template<typename SecurityGroupsT = Aws::Vector<Aws::String>>
123 void SetSecurityGroups(SecurityGroupsT&& value) { m_securityGroupsHasBeenSet = true; m_securityGroups = std::forward<SecurityGroupsT>(value); }
124 template<typename SecurityGroupsT = Aws::Vector<Aws::String>>
125 DescribeNotebookInstanceResult& WithSecurityGroups(SecurityGroupsT&& value) { SetSecurityGroups(std::forward<SecurityGroupsT>(value)); return *this;}
126 template<typename SecurityGroupsT = Aws::String>
127 DescribeNotebookInstanceResult& AddSecurityGroups(SecurityGroupsT&& value) { m_securityGroupsHasBeenSet = true; m_securityGroups.emplace_back(std::forward<SecurityGroupsT>(value)); return *this; }
129
131
135 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
136 template<typename RoleArnT = Aws::String>
137 void SetRoleArn(RoleArnT&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::forward<RoleArnT>(value); }
138 template<typename RoleArnT = Aws::String>
139 DescribeNotebookInstanceResult& WithRoleArn(RoleArnT&& value) { SetRoleArn(std::forward<RoleArnT>(value)); return *this;}
141
143
147 inline const Aws::String& GetKmsKeyId() const { return m_kmsKeyId; }
148 template<typename KmsKeyIdT = Aws::String>
149 void SetKmsKeyId(KmsKeyIdT&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::forward<KmsKeyIdT>(value); }
150 template<typename KmsKeyIdT = Aws::String>
151 DescribeNotebookInstanceResult& WithKmsKeyId(KmsKeyIdT&& value) { SetKmsKeyId(std::forward<KmsKeyIdT>(value)); return *this;}
153
155
159 inline const Aws::String& GetNetworkInterfaceId() const { return m_networkInterfaceId; }
160 template<typename NetworkInterfaceIdT = Aws::String>
161 void SetNetworkInterfaceId(NetworkInterfaceIdT&& value) { m_networkInterfaceIdHasBeenSet = true; m_networkInterfaceId = std::forward<NetworkInterfaceIdT>(value); }
162 template<typename NetworkInterfaceIdT = Aws::String>
163 DescribeNotebookInstanceResult& WithNetworkInterfaceId(NetworkInterfaceIdT&& value) { SetNetworkInterfaceId(std::forward<NetworkInterfaceIdT>(value)); return *this;}
165
167
171 inline const Aws::Utils::DateTime& GetLastModifiedTime() const { return m_lastModifiedTime; }
172 template<typename LastModifiedTimeT = Aws::Utils::DateTime>
173 void SetLastModifiedTime(LastModifiedTimeT&& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = std::forward<LastModifiedTimeT>(value); }
174 template<typename LastModifiedTimeT = Aws::Utils::DateTime>
175 DescribeNotebookInstanceResult& WithLastModifiedTime(LastModifiedTimeT&& value) { SetLastModifiedTime(std::forward<LastModifiedTimeT>(value)); return *this;}
177
179
183 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
184 template<typename CreationTimeT = Aws::Utils::DateTime>
185 void SetCreationTime(CreationTimeT&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::forward<CreationTimeT>(value); }
186 template<typename CreationTimeT = Aws::Utils::DateTime>
187 DescribeNotebookInstanceResult& WithCreationTime(CreationTimeT&& value) { SetCreationTime(std::forward<CreationTimeT>(value)); return *this;}
189
191
197 inline const Aws::String& GetNotebookInstanceLifecycleConfigName() const { return m_notebookInstanceLifecycleConfigName; }
198 template<typename NotebookInstanceLifecycleConfigNameT = Aws::String>
199 void SetNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT&& value) { m_notebookInstanceLifecycleConfigNameHasBeenSet = true; m_notebookInstanceLifecycleConfigName = std::forward<NotebookInstanceLifecycleConfigNameT>(value); }
200 template<typename NotebookInstanceLifecycleConfigNameT = Aws::String>
201 DescribeNotebookInstanceResult& WithNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT&& value) { SetNotebookInstanceLifecycleConfigName(std::forward<NotebookInstanceLifecycleConfigNameT>(value)); return *this;}
203
205
213 inline DirectInternetAccess GetDirectInternetAccess() const { return m_directInternetAccess; }
214 inline void SetDirectInternetAccess(DirectInternetAccess value) { m_directInternetAccessHasBeenSet = true; m_directInternetAccess = value; }
217
219
223 inline int GetVolumeSizeInGB() const { return m_volumeSizeInGB; }
224 inline void SetVolumeSizeInGB(int value) { m_volumeSizeInGBHasBeenSet = true; m_volumeSizeInGB = value; }
225 inline DescribeNotebookInstanceResult& WithVolumeSizeInGB(int value) { SetVolumeSizeInGB(value); return *this;}
227
229
234 inline const Aws::Vector<NotebookInstanceAcceleratorType>& GetAcceleratorTypes() const { return m_acceleratorTypes; }
235 template<typename AcceleratorTypesT = Aws::Vector<NotebookInstanceAcceleratorType>>
236 void SetAcceleratorTypes(AcceleratorTypesT&& value) { m_acceleratorTypesHasBeenSet = true; m_acceleratorTypes = std::forward<AcceleratorTypesT>(value); }
237 template<typename AcceleratorTypesT = Aws::Vector<NotebookInstanceAcceleratorType>>
238 DescribeNotebookInstanceResult& WithAcceleratorTypes(AcceleratorTypesT&& value) { SetAcceleratorTypes(std::forward<AcceleratorTypesT>(value)); return *this;}
239 inline DescribeNotebookInstanceResult& AddAcceleratorTypes(NotebookInstanceAcceleratorType value) { m_acceleratorTypesHasBeenSet = true; m_acceleratorTypes.push_back(value); return *this; }
241
243
254 inline const Aws::String& GetDefaultCodeRepository() const { return m_defaultCodeRepository; }
255 template<typename DefaultCodeRepositoryT = Aws::String>
256 void SetDefaultCodeRepository(DefaultCodeRepositoryT&& value) { m_defaultCodeRepositoryHasBeenSet = true; m_defaultCodeRepository = std::forward<DefaultCodeRepositoryT>(value); }
257 template<typename DefaultCodeRepositoryT = Aws::String>
258 DescribeNotebookInstanceResult& WithDefaultCodeRepository(DefaultCodeRepositoryT&& value) { SetDefaultCodeRepository(std::forward<DefaultCodeRepositoryT>(value)); return *this;}
260
262
273 inline const Aws::Vector<Aws::String>& GetAdditionalCodeRepositories() const { return m_additionalCodeRepositories; }
274 template<typename AdditionalCodeRepositoriesT = Aws::Vector<Aws::String>>
275 void SetAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) { m_additionalCodeRepositoriesHasBeenSet = true; m_additionalCodeRepositories = std::forward<AdditionalCodeRepositoriesT>(value); }
276 template<typename AdditionalCodeRepositoriesT = Aws::Vector<Aws::String>>
277 DescribeNotebookInstanceResult& WithAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) { SetAdditionalCodeRepositories(std::forward<AdditionalCodeRepositoriesT>(value)); return *this;}
278 template<typename AdditionalCodeRepositoriesT = Aws::String>
279 DescribeNotebookInstanceResult& AddAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) { m_additionalCodeRepositoriesHasBeenSet = true; m_additionalCodeRepositories.emplace_back(std::forward<AdditionalCodeRepositoriesT>(value)); return *this; }
281
283
290 inline RootAccess GetRootAccess() const { return m_rootAccess; }
291 inline void SetRootAccess(RootAccess value) { m_rootAccessHasBeenSet = true; m_rootAccess = value; }
294
296
299 inline const Aws::String& GetPlatformIdentifier() const { return m_platformIdentifier; }
300 template<typename PlatformIdentifierT = Aws::String>
301 void SetPlatformIdentifier(PlatformIdentifierT&& value) { m_platformIdentifierHasBeenSet = true; m_platformIdentifier = std::forward<PlatformIdentifierT>(value); }
302 template<typename PlatformIdentifierT = Aws::String>
303 DescribeNotebookInstanceResult& WithPlatformIdentifier(PlatformIdentifierT&& value) { SetPlatformIdentifier(std::forward<PlatformIdentifierT>(value)); return *this;}
305
307
310 inline const InstanceMetadataServiceConfiguration& GetInstanceMetadataServiceConfiguration() const { return m_instanceMetadataServiceConfiguration; }
311 template<typename InstanceMetadataServiceConfigurationT = InstanceMetadataServiceConfiguration>
312 void SetInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT&& value) { m_instanceMetadataServiceConfigurationHasBeenSet = true; m_instanceMetadataServiceConfiguration = std::forward<InstanceMetadataServiceConfigurationT>(value); }
313 template<typename InstanceMetadataServiceConfigurationT = InstanceMetadataServiceConfiguration>
314 DescribeNotebookInstanceResult& WithInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT&& value) { SetInstanceMetadataServiceConfiguration(std::forward<InstanceMetadataServiceConfigurationT>(value)); return *this;}
316
318
319 inline const Aws::String& GetRequestId() const { return m_requestId; }
320 template<typename RequestIdT = Aws::String>
321 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
322 template<typename RequestIdT = Aws::String>
323 DescribeNotebookInstanceResult& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
325 private:
326
327 Aws::String m_notebookInstanceArn;
328 bool m_notebookInstanceArnHasBeenSet = false;
329
330 Aws::String m_notebookInstanceName;
331 bool m_notebookInstanceNameHasBeenSet = false;
332
334 bool m_notebookInstanceStatusHasBeenSet = false;
335
336 Aws::String m_failureReason;
337 bool m_failureReasonHasBeenSet = false;
338
339 Aws::String m_url;
340 bool m_urlHasBeenSet = false;
341
342 InstanceType m_instanceType{InstanceType::NOT_SET};
343 bool m_instanceTypeHasBeenSet = false;
344
345 Aws::String m_subnetId;
346 bool m_subnetIdHasBeenSet = false;
347
348 Aws::Vector<Aws::String> m_securityGroups;
349 bool m_securityGroupsHasBeenSet = false;
350
351 Aws::String m_roleArn;
352 bool m_roleArnHasBeenSet = false;
353
354 Aws::String m_kmsKeyId;
355 bool m_kmsKeyIdHasBeenSet = false;
356
357 Aws::String m_networkInterfaceId;
358 bool m_networkInterfaceIdHasBeenSet = false;
359
360 Aws::Utils::DateTime m_lastModifiedTime{};
361 bool m_lastModifiedTimeHasBeenSet = false;
362
363 Aws::Utils::DateTime m_creationTime{};
364 bool m_creationTimeHasBeenSet = false;
365
366 Aws::String m_notebookInstanceLifecycleConfigName;
367 bool m_notebookInstanceLifecycleConfigNameHasBeenSet = false;
368
370 bool m_directInternetAccessHasBeenSet = false;
371
372 int m_volumeSizeInGB{0};
373 bool m_volumeSizeInGBHasBeenSet = false;
374
376 bool m_acceleratorTypesHasBeenSet = false;
377
378 Aws::String m_defaultCodeRepository;
379 bool m_defaultCodeRepositoryHasBeenSet = false;
380
381 Aws::Vector<Aws::String> m_additionalCodeRepositories;
382 bool m_additionalCodeRepositoriesHasBeenSet = false;
383
384 RootAccess m_rootAccess{RootAccess::NOT_SET};
385 bool m_rootAccessHasBeenSet = false;
386
387 Aws::String m_platformIdentifier;
388 bool m_platformIdentifierHasBeenSet = false;
389
390 InstanceMetadataServiceConfiguration m_instanceMetadataServiceConfiguration;
391 bool m_instanceMetadataServiceConfigurationHasBeenSet = false;
392
393 Aws::String m_requestId;
394 bool m_requestIdHasBeenSet = false;
395 };
396
397} // namespace Model
398} // namespace SageMaker
399} // 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)
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
DescribeNotebookInstanceResult & WithUrl(UrlT &&value)
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