« blib/lib/Paws/SageMaker/CreateMonitoringScheduleResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateNotebookInstanceLifecycleConfig.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateNotebookInstance; | ||
| 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 DirectInternetAccess => (is => 'ro', isa => 'Str'); | ||
| 8 | has InstanceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 10 | has LifecycleConfigName => (is => 'ro', isa => 'Str'); | ||
| 11 | has NotebookInstanceName => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has RootAccess => (is => 'ro', isa => 'Str'); | ||
| 14 | has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 15 | has SubnetId => (is => 'ro', isa => 'Str'); | ||
| 16 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 17 | has VolumeSizeInGB => (is => 'ro', isa => 'Int'); | ||
| 18 | |||
| 19 | use MooseX::ClassAttribute; | ||
| 20 | |||
| 21 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateNotebookInstance'); | ||
| 22 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateNotebookInstanceOutput'); | ||
| 23 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 24 | 1; | ||
| 25 | |||
| 26 | ### main pod documentation begin ### | ||
| 27 | |||
| 28 | =head1 NAME | ||
| 29 | |||
| 30 | Paws::SageMaker::CreateNotebookInstance - Arguments for method CreateNotebookInstance on L<Paws::SageMaker> | ||
| 31 | |||
| 32 | =head1 DESCRIPTION | ||
| 33 | |||
| 34 | This class represents the parameters used for calling the method CreateNotebookInstance on the | ||
| 35 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 36 | as arguments to method CreateNotebookInstance. | ||
| 37 | |||
| 38 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNotebookInstance. | ||
| 39 | |||
| 40 | =head1 SYNOPSIS | ||
| 41 | |||
| 42 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 43 | my $CreateNotebookInstanceOutput = $api . sagemaker->CreateNotebookInstance( | ||
| 44 | InstanceType => 'ml.t2.medium', | ||
| 45 | NotebookInstanceName => 'MyNotebookInstanceName', | ||
| 46 | RoleArn => 'MyRoleArn', | ||
| 47 | AcceleratorTypes => [ | ||
| 48 | 'ml.eia1.medium', | ||
| 49 | ... # values: ml.eia1.medium, ml.eia1.large, ml.eia1.xlarge, ml.eia2.medium, ml.eia2.large, ml.eia2.xlarge | ||
| 50 | ], # OPTIONAL | ||
| 51 | AdditionalCodeRepositories => [ | ||
| 52 | 'MyCodeRepositoryNameOrUrl', ... # min: 1, max: 1024 | ||
| 53 | ], # OPTIONAL | ||
| 54 | DefaultCodeRepository => 'MyCodeRepositoryNameOrUrl', # OPTIONAL | ||
| 55 | DirectInternetAccess => 'Enabled', # OPTIONAL | ||
| 56 | KmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 57 | LifecycleConfigName => 'MyNotebookInstanceLifecycleConfigName', # OPTIONAL | ||
| 58 | RootAccess => 'Enabled', # OPTIONAL | ||
| 59 | SecurityGroupIds => [ | ||
| 60 | 'MySecurityGroupId', ... # max: 32 | ||
| 61 | ], # OPTIONAL | ||
| 62 | SubnetId => 'MySubnetId', # OPTIONAL | ||
| 63 | Tags => [ | ||
| 64 | { | ||
| 65 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 66 | Value => 'MyTagValue', # max: 256 | ||
| 67 | |||
| 68 | }, | ||
| 69 | ... | ||
| 70 | ], # OPTIONAL | ||
| 71 | VolumeSizeInGB => 1, # OPTIONAL | ||
| 72 | ); | ||
| 73 | |||
| 74 | # Results: | ||
| 75 | my $NotebookInstanceArn = | ||
| 76 | $CreateNotebookInstanceOutput->NotebookInstanceArn; | ||
| 77 | |||
| 78 | # Returns a L<Paws::SageMaker::CreateNotebookInstanceOutput> object. | ||
| 79 | |||
| 80 | 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. | ||
| 81 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateNotebookInstance> | ||
| 82 | |||
| 83 | =head1 ATTRIBUTES | ||
| 84 | |||
| 85 | |||
| 86 | =head2 AcceleratorTypes => ArrayRef[Str|Undef] | ||
| 87 | |||
| 88 | A list of Elastic Inference (EI) instance types to associate with this | ||
| 89 | notebook instance. Currently, only one instance type can be associated | ||
| 90 | with a notebook instance. For more information, see Using Elastic | ||
| 91 | Inference in Amazon SageMaker | ||
| 92 | (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 AdditionalCodeRepositories => ArrayRef[Str|Undef] | ||
| 97 | |||
| 98 | An array of up to three Git repositories to associate with the notebook | ||
| 99 | instance. These can be either the names of Git repositories stored as | ||
| 100 | resources in your account, or the URL of Git repositories in Amazon Web | ||
| 101 | Services CodeCommit | ||
| 102 | (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) | ||
| 103 | or in any other Git repository. These repositories are cloned at the | ||
| 104 | same level as the default repository of your notebook instance. For | ||
| 105 | more information, see Associating Git Repositories with Amazon | ||
| 106 | SageMaker Notebook Instances | ||
| 107 | (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 DefaultCodeRepository => Str | ||
| 112 | |||
| 113 | A Git repository to associate with the notebook instance as its default | ||
| 114 | code repository. This can be either the name of a Git repository stored | ||
| 115 | as a resource in your account, or the URL of a Git repository in Amazon | ||
| 116 | Web Services CodeCommit | ||
| 117 | (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) | ||
| 118 | or in any other Git repository. When you open a notebook instance, it | ||
| 119 | opens in the directory that contains this repository. For more | ||
| 120 | information, see Associating Git Repositories with Amazon SageMaker | ||
| 121 | Notebook Instances | ||
| 122 | (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 DirectInternetAccess => Str | ||
| 127 | |||
| 128 | Sets whether Amazon SageMaker provides internet access to the notebook | ||
| 129 | instance. If you set this to C<Disabled> this notebook instance is able | ||
| 130 | to access resources only in your VPC, and is not be able to connect to | ||
| 131 | Amazon SageMaker training and endpoint services unless you configure a | ||
| 132 | NAT Gateway in your VPC. | ||
| 133 | |||
| 134 | For more information, see Notebook Instances Are Internet-Enabled by | ||
| 135 | Default | ||
| 136 | (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). | ||
| 137 | You can set the value of this parameter to C<Disabled> only if you set | ||
| 138 | a value for the C<SubnetId> parameter. | ||
| 139 | |||
| 140 | Valid values are: C<"Enabled">, C<"Disabled"> | ||
| 141 | |||
| 142 | =head2 B<REQUIRED> InstanceType => Str | ||
| 143 | |||
| 144 | The type of ML compute instance to launch for the notebook instance. | ||
| 145 | |||
| 146 | 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"> | ||
| 147 | |||
| 148 | =head2 KmsKeyId => Str | ||
| 149 | |||
| 150 | The Amazon Resource Name (ARN) of a Amazon Web Services Key Management | ||
| 151 | Service key that Amazon SageMaker uses to encrypt data on the storage | ||
| 152 | volume attached to your notebook instance. The KMS key you provide must | ||
| 153 | be enabled. For information, see Enabling and Disabling Keys | ||
| 154 | (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) | ||
| 155 | in the I<Amazon Web Services Key Management Service Developer Guide>. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 LifecycleConfigName => Str | ||
| 160 | |||
| 161 | The name of a lifecycle configuration to associate with the notebook | ||
| 162 | instance. For information about lifestyle configurations, see Step 2.1: | ||
| 163 | (Optional) Customize a Notebook Instance | ||
| 164 | (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | =head2 B<REQUIRED> NotebookInstanceName => Str | ||
| 169 | |||
| 170 | The name of the new notebook instance. | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head2 B<REQUIRED> RoleArn => Str | ||
| 175 | |||
| 176 | When you send any requests to Amazon Web Services resources from the | ||
| 177 | notebook instance, Amazon SageMaker assumes this role to perform tasks | ||
| 178 | on your behalf. You must grant this role necessary permissions so | ||
| 179 | Amazon SageMaker can perform these tasks. The policy must allow the | ||
| 180 | Amazon SageMaker service principal (sagemaker.amazonaws.com) | ||
| 181 | permissions to assume this role. For more information, see Amazon | ||
| 182 | SageMaker Roles | ||
| 183 | (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). | ||
| 184 | |||
| 185 | To be able to pass this role to Amazon SageMaker, the caller of this | ||
| 186 | API must have the C<iam:PassRole> permission. | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head2 RootAccess => Str | ||
| 191 | |||
| 192 | Whether root access is enabled or disabled for users of the notebook | ||
| 193 | instance. The default value is C<Enabled>. | ||
| 194 | |||
| 195 | Lifecycle configurations need root access to be able to set up a | ||
| 196 | notebook instance. Because of this, lifecycle configurations associated | ||
| 197 | with a notebook instance always run with root access even if you | ||
| 198 | disable root access for users. | ||
| 199 | |||
| 200 | Valid values are: C<"Enabled">, C<"Disabled"> | ||
| 201 | |||
| 202 | =head2 SecurityGroupIds => ArrayRef[Str|Undef] | ||
| 203 | |||
| 204 | The VPC security group IDs, in the form sg-xxxxxxxx. The security | ||
| 205 | groups must be for the same VPC as specified in the subnet. | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | =head2 SubnetId => Str | ||
| 210 | |||
| 211 | The ID of the subnet in a VPC to which you would like to have a | ||
| 212 | connectivity from your ML compute instance. | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 217 | |||
| 218 | An array of key-value pairs. You can use tags to categorize your Amazon | ||
| 219 | Web Services resources in different ways, for example, by purpose, | ||
| 220 | owner, or environment. For more information, see Tagging Amazon Web | ||
| 221 | Services Resources | ||
| 222 | (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). | ||
| 223 | |||
| 224 | |||
| 225 | |||
| 226 | =head2 VolumeSizeInGB => Int | ||
| 227 | |||
| 228 | The size, in GB, of the ML storage volume to attach to the notebook | ||
| 229 | instance. The default value is 5 GB. | ||
| 230 | |||
| 231 | |||
| 232 | |||
| 233 | |||
| 234 | =head1 SEE ALSO | ||
| 235 | |||
| 236 | This class forms part of L<Paws>, documenting arguments for method CreateNotebookInstance in L<Paws::SageMaker> | ||
| 237 | |||
| 238 | =head1 BUGS and CONTRIBUTIONS | ||
| 239 | |||
| 240 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 241 | |||
| 242 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 243 | |||
| 244 | =cut | ||
| 245 |