NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $api.sagemaker = Paws->service('SageMaker');
    my $SearchResponse = $api . sagemaker->Search(
      Resource         => 'TrainingJob',
      MaxResults       => 1,                # OPTIONAL
      NextToken        => 'MyNextToken',    # OPTIONAL
      SearchExpression => {
        Filters => [
          {
            Name     => 'MyResourcePropertyName',    # min: 1, max: 255
            Operator => 'Equals'
            , # values: Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, Contains; OPTIONAL
            Value => 'MyFilterValue',    # min: 1, max: 1024; OPTIONAL
          },
          ...
        ],                               # min: 1, max: 20
        NestedFilters => [
          {
            Filters => [
              {
                Name     => 'MyResourcePropertyName',    # min: 1, max: 255
                Operator => 'Equals'
                , # values: Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, Contains; OPTIONAL
                Value => 'MyFilterValue',    # min: 1, max: 1024; OPTIONAL
              },
              ...
            ],                               # min: 1, max: 20
            NestedPropertyName => 'MyResourcePropertyName',   # min: 1, max: 255

          },
          ...
        ],    # min: 1, max: 20; OPTIONAL
        Operator => 'And',                           # values: And, Or; OPTIONAL
        SubExpressions => [ <SearchExpression>, ... ]
        ,                                            # min: 1, max: 20; OPTIONAL
      },    # OPTIONAL
      SortBy    => 'MyResourcePropertyName',    # OPTIONAL
      SortOrder => 'Ascending',                 # OPTIONAL
    );

    # Results:
    my $NextToken = $SearchResponse->NextToken;
    my $Results   = $SearchResponse->Results;

    # Returns a L<Paws::SageMaker::SearchResponse> 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/Search

ATTRIBUTES

MaxResults => Int

The maximum number of results to return in a SearchResponse.

NextToken => Str

If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

REQUIRED Resource => Str

The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Valid values are: "TrainingJob"

SearchExpression => Paws::SageMaker::SearchExpression

A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

SortBy => Str

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

SortOrder => Str

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Valid values are: "Ascending", "Descending"

SEE ALSO

This class forms part of Paws, documenting arguments for method Search 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