« blib/lib/Paws/SageMaker/DescribeNotebookInstanceLifecycleConfigOutput.pm
↑ Summary
blib/lib/Paws/SageMaker/DescribePipeline.pm »
| 1 | |||
| 2 | package Paws::SageMaker::DescribeNotebookInstanceOutput; | ||
| 3 | use Moose; | ||
| 4 | has AcceleratorTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has AdditionalCodeRepositories => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has DefaultCodeRepository => (is => 'ro', isa => 'Str'); | ||
| 8 | has DirectInternetAccess => (is => 'ro', isa => 'Str'); | ||
| 9 | has FailureReason => (is => 'ro', isa => 'Str'); | ||
| 10 | has InstanceType => (is => 'ro', isa => 'Str'); | ||
| 11 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 12 | has LastModifiedTime => (is => 'ro', isa => 'Str'); | ||
| 13 | has NetworkInterfaceId => (is => 'ro', isa => 'Str'); | ||
| 14 | has NotebookInstanceArn => (is => 'ro', isa => 'Str'); | ||
| 15 | has NotebookInstanceLifecycleConfigName => (is => 'ro', isa => 'Str'); | ||
| 16 | has NotebookInstanceName => (is => 'ro', isa => 'Str'); | ||
| 17 | has NotebookInstanceStatus => (is => 'ro', isa => 'Str'); | ||
| 18 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 19 | has RootAccess => (is => 'ro', isa => 'Str'); | ||
| 20 | has SecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 21 | has SubnetId => (is => 'ro', isa => 'Str'); | ||
| 22 | has Url => (is => 'ro', isa => 'Str'); | ||
| 23 | has VolumeSizeInGB => (is => 'ro', isa => 'Int'); | ||
| 24 | |||
| 25 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::SageMaker::DescribeNotebookInstanceOutput | ||
| 32 | |||
| 33 | =head1 ATTRIBUTES | ||
| 34 | |||
| 35 | |||
| 36 | =head2 AcceleratorTypes => ArrayRef[Str|Undef] | ||
| 37 | |||
| 38 | A list of the Elastic Inference (EI) instance types associated with | ||
| 39 | this notebook instance. Currently only one EI instance type can be | ||
| 40 | associated with a notebook instance. For more information, see Using | ||
| 41 | Elastic Inference in Amazon SageMaker | ||
| 42 | (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). | ||
| 43 | |||
| 44 | |||
| 45 | =head2 AdditionalCodeRepositories => ArrayRef[Str|Undef] | ||
| 46 | |||
| 47 | An array of up to three Git repositories associated with the notebook | ||
| 48 | instance. These can be either the names of Git repositories stored as | ||
| 49 | resources in your account, or the URL of Git repositories in Amazon Web | ||
| 50 | Services CodeCommit | ||
| 51 | (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) | ||
| 52 | or in any other Git repository. These repositories are cloned at the | ||
| 53 | same level as the default repository of your notebook instance. For | ||
| 54 | more information, see Associating Git Repositories with Amazon | ||
| 55 | SageMaker Notebook Instances | ||
| 56 | (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). | ||
| 57 | |||
| 58 | |||
| 59 | =head2 CreationTime => Str | ||
| 60 | |||
| 61 | A timestamp. Use this parameter to return the time when the notebook | ||
| 62 | instance was created | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DefaultCodeRepository => Str | ||
| 66 | |||
| 67 | The Git repository associated with the notebook instance as its default | ||
| 68 | code repository. This can be either the name of a Git repository stored | ||
| 69 | as a resource in your account, or the URL of a Git repository in Amazon | ||
| 70 | Web Services CodeCommit | ||
| 71 | (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) | ||
| 72 | or in any other Git repository. When you open a notebook instance, it | ||
| 73 | opens in the directory that contains this repository. For more | ||
| 74 | information, see Associating Git Repositories with Amazon SageMaker | ||
| 75 | Notebook Instances | ||
| 76 | (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). | ||
| 77 | |||
| 78 | |||
| 79 | =head2 DirectInternetAccess => Str | ||
| 80 | |||
| 81 | Describes whether Amazon SageMaker provides internet access to the | ||
| 82 | notebook instance. If this value is set to I<Disabled>, the notebook | ||
| 83 | instance does not have internet access, and cannot connect to Amazon | ||
| 84 | SageMaker training and endpoint services. | ||
| 85 | |||
| 86 | For more information, see Notebook Instances Are Internet-Enabled by | ||
| 87 | Default | ||
| 88 | (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). | ||
| 89 | |||
| 90 | Valid values are: C<"Enabled">, C<"Disabled"> | ||
| 91 | =head2 FailureReason => Str | ||
| 92 | |||
| 93 | If status is C<Failed>, the reason it failed. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 InstanceType => Str | ||
| 97 | |||
| 98 | The type of ML compute instance running on the notebook instance. | ||
| 99 | |||
| 100 | Valid values are: C<"ml.t2.medium">, C<"ml.t2.large">, C<"ml.t2.xlarge">, C<"ml.t2.2xlarge">, C<"ml.t3.medium">, C<"ml.t3.large">, C<"ml.t3.xlarge">, C<"ml.t3.2xlarge">, C<"ml.m4.xlarge">, C<"ml.m4.2xlarge">, C<"ml.m4.4xlarge">, C<"ml.m4.10xlarge">, C<"ml.m4.16xlarge">, C<"ml.m5.xlarge">, C<"ml.m5.2xlarge">, C<"ml.m5.4xlarge">, C<"ml.m5.12xlarge">, C<"ml.m5.24xlarge">, C<"ml.c4.xlarge">, C<"ml.c4.2xlarge">, C<"ml.c4.4xlarge">, C<"ml.c4.8xlarge">, C<"ml.c5.xlarge">, C<"ml.c5.2xlarge">, C<"ml.c5.4xlarge">, C<"ml.c5.9xlarge">, C<"ml.c5.18xlarge">, C<"ml.c5d.xlarge">, C<"ml.c5d.2xlarge">, C<"ml.c5d.4xlarge">, C<"ml.c5d.9xlarge">, C<"ml.c5d.18xlarge">, C<"ml.p2.xlarge">, C<"ml.p2.8xlarge">, C<"ml.p2.16xlarge">, C<"ml.p3.2xlarge">, C<"ml.p3.8xlarge">, C<"ml.p3.16xlarge"> | ||
| 101 | =head2 KmsKeyId => Str | ||
| 102 | |||
| 103 | The Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt | ||
| 104 | data when storing it on the ML storage volume attached to the instance. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 LastModifiedTime => Str | ||
| 108 | |||
| 109 | A timestamp. Use this parameter to retrieve the time when the notebook | ||
| 110 | instance was last modified. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 NetworkInterfaceId => Str | ||
| 114 | |||
| 115 | The network interface IDs that Amazon SageMaker created at the time of | ||
| 116 | creating the instance. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 NotebookInstanceArn => Str | ||
| 120 | |||
| 121 | The Amazon Resource Name (ARN) of the notebook instance. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 NotebookInstanceLifecycleConfigName => Str | ||
| 125 | |||
| 126 | Returns the name of a notebook instance lifecycle configuration. | ||
| 127 | |||
| 128 | For information about notebook instance lifestyle configurations, see | ||
| 129 | Step 2.1: (Optional) Customize a Notebook Instance | ||
| 130 | (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) | ||
| 131 | |||
| 132 | |||
| 133 | =head2 NotebookInstanceName => Str | ||
| 134 | |||
| 135 | The name of the Amazon SageMaker notebook instance. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 NotebookInstanceStatus => Str | ||
| 139 | |||
| 140 | The status of the notebook instance. | ||
| 141 | |||
| 142 | Valid values are: C<"Pending">, C<"InService">, C<"Stopping">, C<"Stopped">, C<"Failed">, C<"Deleting">, C<"Updating"> | ||
| 143 | =head2 RoleArn => Str | ||
| 144 | |||
| 145 | The Amazon Resource Name (ARN) of the IAM role associated with the | ||
| 146 | instance. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 RootAccess => Str | ||
| 150 | |||
| 151 | Whether root access is enabled or disabled for users of the notebook | ||
| 152 | instance. | ||
| 153 | |||
| 154 | Lifecycle configurations need root access to be able to set up a | ||
| 155 | notebook instance. Because of this, lifecycle configurations associated | ||
| 156 | with a notebook instance always run with root access even if you | ||
| 157 | disable root access for users. | ||
| 158 | |||
| 159 | Valid values are: C<"Enabled">, C<"Disabled"> | ||
| 160 | =head2 SecurityGroups => ArrayRef[Str|Undef] | ||
| 161 | |||
| 162 | The IDs of the VPC security groups. | ||
| 163 | |||
| 164 | |||
| 165 | =head2 SubnetId => Str | ||
| 166 | |||
| 167 | The ID of the VPC subnet. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 Url => Str | ||
| 171 | |||
| 172 | The URL that you use to connect to the Jupyter notebook that is running | ||
| 173 | in your notebook instance. | ||
| 174 | |||
| 175 | |||
| 176 | =head2 VolumeSizeInGB => Int | ||
| 177 | |||
| 178 | The size, in GB, of the ML storage volume attached to the notebook | ||
| 179 | instance. | ||
| 180 | |||
| 181 | |||
| 182 | =head2 _request_id => Str | ||
| 183 | |||
| 184 | |||
| 185 | =cut | ||
| 186 | |||
| 187 | 1; |