/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SageMaker::ListNotebookInstances

NAME

Paws::SageMaker::ListNotebookInstances - Arguments for method ListNotebookInstances on Paws::SageMaker

DESCRIPTION

This class represents the parameters used for calling the method ListNotebookInstances on the Amazon SageMaker Service service. Use the attributes of this class as arguments to method ListNotebookInstances.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListNotebookInstances.

SYNOPSIS

my $api.sagemaker = Paws->service('SageMaker');
my $ListNotebookInstancesOutput = $api . sagemaker->ListNotebookInstances(
  AdditionalCodeRepositoryEquals => 'MyCodeRepositoryNameOrUrl',  # OPTIONAL
  CreationTimeAfter              => '1970-01-01T01:00:00',        # OPTIONAL
  CreationTimeBefore             => '1970-01-01T01:00:00',        # OPTIONAL
  DefaultCodeRepositoryContains  => 'MyCodeRepositoryContains',   # OPTIONAL
  LastModifiedTimeAfter          => '1970-01-01T01:00:00',        # OPTIONAL
  LastModifiedTimeBefore         => '1970-01-01T01:00:00',        # OPTIONAL
  MaxResults                     => 1,                            # OPTIONAL
  NameContains => 'MyNotebookInstanceNameContains',               # OPTIONAL
  NextToken    => 'MyNextToken',                                  # OPTIONAL
  NotebookInstanceLifecycleConfigNameContains =>
    'MyNotebookInstanceLifecycleConfigName',                      # OPTIONAL
  SortBy       => 'Name',                                         # OPTIONAL
  SortOrder    => 'Ascending',                                    # OPTIONAL
  StatusEquals => 'Pending',                                      # OPTIONAL
);

# Results:
my $NextToken         = $ListNotebookInstancesOutput->NextToken;
my $NotebookInstances = $ListNotebookInstancesOutput->NotebookInstances;

# Returns a L<Paws::SageMaker::ListNotebookInstancesOutput> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/ListNotebookInstances

ATTRIBUTES

AdditionalCodeRepositoryEquals => Str

A filter that returns only notebook instances with associated with the specified git repository.

CreationTimeAfter => Str

A filter that returns only notebook instances that were created after the specified time (timestamp).

CreationTimeBefore => Str

A filter that returns only notebook instances that were created before the specified time (timestamp).

DefaultCodeRepositoryContains => Str

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

LastModifiedTimeAfter => Str

A filter that returns only notebook instances that were modified after the specified time (timestamp).

LastModifiedTimeBefore => Str

A filter that returns only notebook instances that were modified before the specified time (timestamp).

MaxResults => Int

The maximum number of notebook instances to return.

NameContains => Str

A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

NextToken => Str

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

NotebookInstanceLifecycleConfigNameContains => Str

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

SortBy => Str

The field to sort results by. The default is Name.

Valid values are: "Name", "CreationTime", "Status"

SortOrder => Str

The sort order for results.

Valid values are: "Ascending", "Descending"

StatusEquals => Str

A filter that returns only notebook instances with the specified status.

Valid values are: "Pending", "InService", "Stopping", "Stopped", "Failed", "Deleting", "Updating"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListNotebookInstances in Paws::SageMaker

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues