« blib/lib/Paws/SageMaker/NotebookInstanceLifecycleHook.pm
↑ Summary
blib/lib/Paws/SageMaker/NotificationConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::NotebookInstanceSummary; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalCodeRepositories => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has DefaultCodeRepository => (is => 'ro', isa => 'Str'); | ||
| 7 | has InstanceType => (is => 'ro', isa => 'Str'); | ||
| 8 | has LastModifiedTime => (is => 'ro', isa => 'Str'); | ||
| 9 | has NotebookInstanceArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has NotebookInstanceLifecycleConfigName => (is => 'ro', isa => 'Str'); | ||
| 11 | has NotebookInstanceName => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has NotebookInstanceStatus => (is => 'ro', isa => 'Str'); | ||
| 13 | has Url => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::SageMaker::NotebookInstanceSummary | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::SageMaker::NotebookInstanceSummary object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { AdditionalCodeRepositories => $value, ..., Url => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::NotebookInstanceSummary object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->AdditionalCodeRepositories | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Provides summary information for an Amazon SageMaker notebook instance. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 AdditionalCodeRepositories => ArrayRef[Str|Undef] | ||
| 51 | |||
| 52 | An array of up to three Git repositories associated with the notebook | ||
| 53 | instance. These can be either the names of Git repositories stored as | ||
| 54 | resources in your account, or the URL of Git repositories in Amazon Web | ||
| 55 | Services CodeCommit | ||
| 56 | (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) | ||
| 57 | or in any other Git repository. These repositories are cloned at the | ||
| 58 | same level as the default repository of your notebook instance. For | ||
| 59 | more information, see Associating Git Repositories with Amazon | ||
| 60 | SageMaker Notebook Instances | ||
| 61 | (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). | ||
| 62 | |||
| 63 | |||
| 64 | =head2 CreationTime => Str | ||
| 65 | |||
| 66 | A timestamp that shows when the notebook instance was created. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 DefaultCodeRepository => Str | ||
| 70 | |||
| 71 | The Git repository associated with the notebook instance as its default | ||
| 72 | code repository. This can be either the name of a Git repository stored | ||
| 73 | as a resource in your account, or the URL of a Git repository in Amazon | ||
| 74 | Web Services CodeCommit | ||
| 75 | (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) | ||
| 76 | or in any other Git repository. When you open a notebook instance, it | ||
| 77 | opens in the directory that contains this repository. For more | ||
| 78 | information, see Associating Git Repositories with Amazon SageMaker | ||
| 79 | Notebook Instances | ||
| 80 | (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). | ||
| 81 | |||
| 82 | |||
| 83 | =head2 InstanceType => Str | ||
| 84 | |||
| 85 | The type of ML compute instance that the notebook instance is running | ||
| 86 | on. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 LastModifiedTime => Str | ||
| 90 | |||
| 91 | A timestamp that shows when the notebook instance was last modified. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> NotebookInstanceArn => Str | ||
| 95 | |||
| 96 | The Amazon Resource Name (ARN) of the notebook instance. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 NotebookInstanceLifecycleConfigName => Str | ||
| 100 | |||
| 101 | The name of a notebook instance lifecycle configuration associated with | ||
| 102 | this notebook instance. | ||
| 103 | |||
| 104 | For information about notebook instance lifestyle configurations, see | ||
| 105 | Step 2.1: (Optional) Customize a Notebook Instance | ||
| 106 | (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). | ||
| 107 | |||
| 108 | |||
| 109 | =head2 B<REQUIRED> NotebookInstanceName => Str | ||
| 110 | |||
| 111 | The name of the notebook instance that you want a summary for. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 NotebookInstanceStatus => Str | ||
| 115 | |||
| 116 | The status of the notebook instance. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 Url => Str | ||
| 120 | |||
| 121 | The URL that you use to connect to the Jupyter instance running in your | ||
| 122 | notebook instance. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 129 | |||
| 130 | =head1 BUGS and CONTRIBUTIONS | ||
| 131 | |||
| 132 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 133 | |||
| 134 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 135 | |||
| 136 | =cut | ||
| 137 |