« blib/lib/Paws/SageMaker/ListNotebookInstanceLifecycleConfigsOutput.pm
↑ Summary
blib/lib/Paws/SageMaker/ListNotebookInstancesOutput.pm »
| 1 | |||
| 2 | package Paws::SageMaker::ListNotebookInstances; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalCodeRepositoryEquals => (is => 'ro', isa => 'Str'); | ||
| 5 | has CreationTimeAfter => (is => 'ro', isa => 'Str'); | ||
| 6 | has CreationTimeBefore => (is => 'ro', isa => 'Str'); | ||
| 7 | has DefaultCodeRepositoryContains => (is => 'ro', isa => 'Str'); | ||
| 8 | has LastModifiedTimeAfter => (is => 'ro', isa => 'Str'); | ||
| 9 | has LastModifiedTimeBefore => (is => 'ro', isa => 'Str'); | ||
| 10 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 11 | has NameContains => (is => 'ro', isa => 'Str'); | ||
| 12 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 13 | has NotebookInstanceLifecycleConfigNameContains => (is => 'ro', isa => 'Str'); | ||
| 14 | has SortBy => (is => 'ro', isa => 'Str'); | ||
| 15 | has SortOrder => (is => 'ro', isa => 'Str'); | ||
| 16 | has StatusEquals => (is => 'ro', isa => 'Str'); | ||
| 17 | |||
| 18 | use MooseX::ClassAttribute; | ||
| 19 | |||
| 20 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListNotebookInstances'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::ListNotebookInstancesOutput'); | ||
| 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::ListNotebookInstances - Arguments for method ListNotebookInstances on L<Paws::SageMaker> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method ListNotebookInstances on the | ||
| 34 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 35 | as arguments to method ListNotebookInstances. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListNotebookInstances. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 42 | my $ListNotebookInstancesOutput = $api . sagemaker->ListNotebookInstances( | ||
| 43 | AdditionalCodeRepositoryEquals => 'MyCodeRepositoryNameOrUrl', # OPTIONAL | ||
| 44 | CreationTimeAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 45 | CreationTimeBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 46 | DefaultCodeRepositoryContains => 'MyCodeRepositoryContains', # OPTIONAL | ||
| 47 | LastModifiedTimeAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 48 | LastModifiedTimeBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 49 | MaxResults => 1, # OPTIONAL | ||
| 50 | NameContains => 'MyNotebookInstanceNameContains', # OPTIONAL | ||
| 51 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 52 | NotebookInstanceLifecycleConfigNameContains => | ||
| 53 | 'MyNotebookInstanceLifecycleConfigName', # OPTIONAL | ||
| 54 | SortBy => 'Name', # OPTIONAL | ||
| 55 | SortOrder => 'Ascending', # OPTIONAL | ||
| 56 | StatusEquals => 'Pending', # OPTIONAL | ||
| 57 | ); | ||
| 58 | |||
| 59 | # Results: | ||
| 60 | my $NextToken = $ListNotebookInstancesOutput->NextToken; | ||
| 61 | my $NotebookInstances = $ListNotebookInstancesOutput->NotebookInstances; | ||
| 62 | |||
| 63 | # Returns a L<Paws::SageMaker::ListNotebookInstancesOutput> object. | ||
| 64 | |||
| 65 | 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. | ||
| 66 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/ListNotebookInstances> | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 AdditionalCodeRepositoryEquals => Str | ||
| 72 | |||
| 73 | A filter that returns only notebook instances with associated with the | ||
| 74 | specified git repository. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 CreationTimeAfter => Str | ||
| 79 | |||
| 80 | A filter that returns only notebook instances that were created after | ||
| 81 | the specified time (timestamp). | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 CreationTimeBefore => Str | ||
| 86 | |||
| 87 | A filter that returns only notebook instances that were created before | ||
| 88 | the specified time (timestamp). | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 DefaultCodeRepositoryContains => Str | ||
| 93 | |||
| 94 | A string in the name or URL of a Git repository associated with this | ||
| 95 | notebook instance. This filter returns only notebook instances | ||
| 96 | associated with a git repository with a name that contains the | ||
| 97 | specified string. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 LastModifiedTimeAfter => Str | ||
| 102 | |||
| 103 | A filter that returns only notebook instances that were modified after | ||
| 104 | the specified time (timestamp). | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 LastModifiedTimeBefore => Str | ||
| 109 | |||
| 110 | A filter that returns only notebook instances that were modified before | ||
| 111 | the specified time (timestamp). | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 MaxResults => Int | ||
| 116 | |||
| 117 | The maximum number of notebook instances to return. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 NameContains => Str | ||
| 122 | |||
| 123 | A string in the notebook instances' name. This filter returns only | ||
| 124 | notebook instances whose name contains the specified string. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 NextToken => Str | ||
| 129 | |||
| 130 | If the previous call to the C<ListNotebookInstances> is truncated, the | ||
| 131 | response includes a C<NextToken>. You can use this token in your | ||
| 132 | subsequent C<ListNotebookInstances> request to fetch the next set of | ||
| 133 | notebook instances. | ||
| 134 | |||
| 135 | You might specify a filter or a sort order in your request. When | ||
| 136 | response is truncated, you must use the same values for the filer and | ||
| 137 | sort order in the next request. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 NotebookInstanceLifecycleConfigNameContains => Str | ||
| 142 | |||
| 143 | A string in the name of a notebook instances lifecycle configuration | ||
| 144 | associated with this notebook instance. This filter returns only | ||
| 145 | notebook instances associated with a lifecycle configuration with a | ||
| 146 | name that contains the specified string. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 SortBy => Str | ||
| 151 | |||
| 152 | The field to sort results by. The default is C<Name>. | ||
| 153 | |||
| 154 | Valid values are: C<"Name">, C<"CreationTime">, C<"Status"> | ||
| 155 | |||
| 156 | =head2 SortOrder => Str | ||
| 157 | |||
| 158 | The sort order for results. | ||
| 159 | |||
| 160 | Valid values are: C<"Ascending">, C<"Descending"> | ||
| 161 | |||
| 162 | =head2 StatusEquals => Str | ||
| 163 | |||
| 164 | A filter that returns only notebook instances with the specified | ||
| 165 | status. | ||
| 166 | |||
| 167 | Valid values are: C<"Pending">, C<"InService">, C<"Stopping">, C<"Stopped">, C<"Failed">, C<"Deleting">, C<"Updating"> | ||
| 168 | |||
| 169 | |||
| 170 | =head1 SEE ALSO | ||
| 171 | |||
| 172 | This class forms part of L<Paws>, documenting arguments for method ListNotebookInstances in L<Paws::SageMaker> | ||
| 173 | |||
| 174 | =head1 BUGS and CONTRIBUTIONS | ||
| 175 | |||
| 176 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 177 | |||
| 178 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 179 | |||
| 180 | =cut | ||
| 181 |