« blib/lib/Paws/SageMaker/UpdateMonitoringScheduleResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/UpdateNotebookInstanceLifecycleConfig.pm »
| 1 | |||
| 2 | package Paws::SageMaker::UpdateNotebookInstance; | ||
| 3 | use Moose; | ||
| 4 | has AcceleratorTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has AdditionalCodeRepositories => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has DefaultCodeRepository => (is => 'ro', isa => 'Str'); | ||
| 7 | has DisassociateAcceleratorTypes => (is => 'ro', isa => 'Bool'); | ||
| 8 | has DisassociateAdditionalCodeRepositories => (is => 'ro', isa => 'Bool'); | ||
| 9 | has DisassociateDefaultCodeRepository => (is => 'ro', isa => 'Bool'); | ||
| 10 | has DisassociateLifecycleConfig => (is => 'ro', isa => 'Bool'); | ||
| 11 | has InstanceType => (is => 'ro', isa => 'Str'); | ||
| 12 | has LifecycleConfigName => (is => 'ro', isa => 'Str'); | ||
| 13 | has NotebookInstanceName => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 15 | has RootAccess => (is => 'ro', isa => 'Str'); | ||
| 16 | has VolumeSizeInGB => (is => 'ro', isa => 'Int'); | ||
| 17 | |||
| 18 | use MooseX::ClassAttribute; | ||
| 19 | |||
| 20 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateNotebookInstance'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::UpdateNotebookInstanceOutput'); | ||
| 22 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::SageMaker::UpdateNotebookInstance - Arguments for method UpdateNotebookInstance on L<Paws::SageMaker> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method UpdateNotebookInstance on the | ||
| 34 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 35 | as arguments to method UpdateNotebookInstance. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateNotebookInstance. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 42 | my $UpdateNotebookInstanceOutput = $api . sagemaker->UpdateNotebookInstance( | ||
| 43 | NotebookInstanceName => 'MyNotebookInstanceName', | ||
| 44 | AcceleratorTypes => [ | ||
| 45 | 'ml.eia1.medium', | ||
| 46 | ... # values: ml.eia1.medium, ml.eia1.large, ml.eia1.xlarge, ml.eia2.medium, ml.eia2.large, ml.eia2.xlarge | ||
| 47 | ], # OPTIONAL | ||
| 48 | AdditionalCodeRepositories => [ | ||
| 49 | 'MyCodeRepositoryNameOrUrl', ... # min: 1, max: 1024 | ||
| 50 | ], # OPTIONAL | ||
| 51 | DefaultCodeRepository => 'MyCodeRepositoryNameOrUrl', # OPTIONAL | ||
| 52 | DisassociateAcceleratorTypes => 1, # OPTIONAL | ||
| 53 | DisassociateAdditionalCodeRepositories => 1, # OPTIONAL | ||
| 54 | DisassociateDefaultCodeRepository => 1, # OPTIONAL | ||
| 55 | DisassociateLifecycleConfig => 1, # OPTIONAL | ||
| 56 | InstanceType => 'ml.t2.medium', # OPTIONAL | ||
| 57 | LifecycleConfigName => 'MyNotebookInstanceLifecycleConfigName', # OPTIONAL | ||
| 58 | RoleArn => 'MyRoleArn', # OPTIONAL | ||
| 59 | RootAccess => 'Enabled', # OPTIONAL | ||
| 60 | VolumeSizeInGB => 1, # OPTIONAL | ||
| 61 | ); | ||
| 62 | |||
| 63 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/UpdateNotebookInstance> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 AcceleratorTypes => ArrayRef[Str|Undef] | ||
| 70 | |||
| 71 | A list of the Elastic Inference (EI) instance types to associate with | ||
| 72 | this notebook instance. Currently only one EI instance type can be | ||
| 73 | associated with a notebook instance. For more information, see Using | ||
| 74 | Elastic Inference in Amazon SageMaker | ||
| 75 | (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 AdditionalCodeRepositories => ArrayRef[Str|Undef] | ||
| 80 | |||
| 81 | An array of up to three Git repositories to associate with the notebook | ||
| 82 | instance. These can be either the names of Git repositories stored as | ||
| 83 | resources in your account, or the URL of Git repositories in Amazon Web | ||
| 84 | Services CodeCommit | ||
| 85 | (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) | ||
| 86 | or in any other Git repository. These repositories are cloned at the | ||
| 87 | same level as the default repository of your notebook instance. For | ||
| 88 | more information, see Associating Git Repositories with Amazon | ||
| 89 | SageMaker Notebook Instances | ||
| 90 | (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 DefaultCodeRepository => Str | ||
| 95 | |||
| 96 | The Git repository to associate with the notebook instance as its | ||
| 97 | default code repository. This can be either the name of a Git | ||
| 98 | repository stored as a resource in your account, or the URL of a Git | ||
| 99 | repository in Amazon Web Services CodeCommit | ||
| 100 | (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) | ||
| 101 | or in any other Git repository. When you open a notebook instance, it | ||
| 102 | opens in the directory that contains this repository. For more | ||
| 103 | information, see Associating Git Repositories with Amazon SageMaker | ||
| 104 | Notebook Instances | ||
| 105 | (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 DisassociateAcceleratorTypes => Bool | ||
| 110 | |||
| 111 | A list of the Elastic Inference (EI) instance types to remove from this | ||
| 112 | notebook instance. This operation is idempotent. If you specify an | ||
| 113 | accelerator type that is not associated with the notebook instance when | ||
| 114 | you call this method, it does not throw an error. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 DisassociateAdditionalCodeRepositories => Bool | ||
| 119 | |||
| 120 | A list of names or URLs of the default Git repositories to remove from | ||
| 121 | this notebook instance. This operation is idempotent. If you specify a | ||
| 122 | Git repository that is not associated with the notebook instance when | ||
| 123 | you call this method, it does not throw an error. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 DisassociateDefaultCodeRepository => Bool | ||
| 128 | |||
| 129 | The name or URL of the default Git repository to remove from this | ||
| 130 | notebook instance. This operation is idempotent. If you specify a Git | ||
| 131 | repository that is not associated with the notebook instance when you | ||
| 132 | call this method, it does not throw an error. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 DisassociateLifecycleConfig => Bool | ||
| 137 | |||
| 138 | Set to C<true> to remove the notebook instance lifecycle configuration | ||
| 139 | currently associated with the notebook instance. This operation is | ||
| 140 | idempotent. If you specify a lifecycle configuration that is not | ||
| 141 | associated with the notebook instance when you call this method, it | ||
| 142 | does not throw an error. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 InstanceType => Str | ||
| 147 | |||
| 148 | The Amazon ML compute instance type. | ||
| 149 | |||
| 150 | 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"> | ||
| 151 | |||
| 152 | =head2 LifecycleConfigName => Str | ||
| 153 | |||
| 154 | The name of a lifecycle configuration to associate with the notebook | ||
| 155 | instance. For information about lifestyle configurations, see Step 2.1: | ||
| 156 | (Optional) Customize a Notebook Instance | ||
| 157 | (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 B<REQUIRED> NotebookInstanceName => Str | ||
| 162 | |||
| 163 | The name of the notebook instance to update. | ||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head2 RoleArn => Str | ||
| 168 | |||
| 169 | The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker | ||
| 170 | can assume to access the notebook instance. For more information, see | ||
| 171 | Amazon SageMaker Roles | ||
| 172 | (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). | ||
| 173 | |||
| 174 | To be able to pass this role to Amazon SageMaker, the caller of this | ||
| 175 | API must have the C<iam:PassRole> permission. | ||
| 176 | |||
| 177 | |||
| 178 | |||
| 179 | =head2 RootAccess => Str | ||
| 180 | |||
| 181 | Whether root access is enabled or disabled for users of the notebook | ||
| 182 | instance. The default value is C<Enabled>. | ||
| 183 | |||
| 184 | If you set this to C<Disabled>, users don't have root access on the | ||
| 185 | notebook instance, but lifecycle configuration scripts still run with | ||
| 186 | root permissions. | ||
| 187 | |||
| 188 | Valid values are: C<"Enabled">, C<"Disabled"> | ||
| 189 | |||
| 190 | =head2 VolumeSizeInGB => Int | ||
| 191 | |||
| 192 | The size, in GB, of the ML storage volume to attach to the notebook | ||
| 193 | instance. The default value is 5 GB. ML storage volumes are encrypted, | ||
| 194 | so Amazon SageMaker can't determine the amount of available free space | ||
| 195 | on the volume. Because of this, you can increase the volume size when | ||
| 196 | you update a notebook instance, but you can't decrease the volume size. | ||
| 197 | If you want to decrease the size of the ML storage volume in use, | ||
| 198 | create a new notebook instance with the desired size. | ||
| 199 | |||
| 200 | |||
| 201 | |||
| 202 | |||
| 203 | =head1 SEE ALSO | ||
| 204 | |||
| 205 | This class forms part of L<Paws>, documenting arguments for method UpdateNotebookInstance in L<Paws::SageMaker> | ||
| 206 | |||
| 207 | =head1 BUGS and CONTRIBUTIONS | ||
| 208 | |||
| 209 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 210 | |||
| 211 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 212 | |||
| 213 | =cut | ||
| 214 |