Class: Aws::LookoutforVision::Types::ListDatasetEntriesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb

Overview

Note:

When making an API call, you may pass ListDatasetEntriesRequest data as a hash:

{
  project_name: "ProjectName", # required
  dataset_type: "DatasetType", # required
  labeled: false,
  anomaly_class: "AnomalyClassFilter",
  before_creation_date: Time.now,
  after_creation_date: Time.now,
  next_token: "PaginationToken",
  max_results: 1,
  source_ref_contains: "QueryString",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#after_creation_dateTime

Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.

Returns:

  • (Time)


901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 901

class ListDatasetEntriesRequest < Struct.new(
  :project_name,
  :dataset_type,
  :labeled,
  :anomaly_class,
  :before_creation_date,
  :after_creation_date,
  :next_token,
  :max_results,
  :source_ref_contains)
  SENSITIVE = []
  include Aws::Structure
end

#anomaly_classString

Specify normal to include only normal images. Specify anomaly to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 901

class ListDatasetEntriesRequest < Struct.new(
  :project_name,
  :dataset_type,
  :labeled,
  :anomaly_class,
  :before_creation_date,
  :after_creation_date,
  :next_token,
  :max_results,
  :source_ref_contains)
  SENSITIVE = []
  include Aws::Structure
end

#before_creation_dateTime

Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.

Returns:

  • (Time)


901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 901

class ListDatasetEntriesRequest < Struct.new(
  :project_name,
  :dataset_type,
  :labeled,
  :anomaly_class,
  :before_creation_date,
  :after_creation_date,
  :next_token,
  :max_results,
  :source_ref_contains)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_typeString

The type of the dataset that you want to list. Specify train to list the training dataset. Specify test to list the test dataset. If you have a single dataset project, specify train.

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 901

class ListDatasetEntriesRequest < Struct.new(
  :project_name,
  :dataset_type,
  :labeled,
  :anomaly_class,
  :before_creation_date,
  :after_creation_date,
  :next_token,
  :max_results,
  :source_ref_contains)
  SENSITIVE = []
  include Aws::Structure
end

#labeledBoolean

Specify true to include labeled entries, otherwise specify false. If you don't specify a value, Lookout for Vision returns all entries.

Returns:

  • (Boolean)


901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 901

class ListDatasetEntriesRequest < Struct.new(
  :project_name,
  :dataset_type,
  :labeled,
  :anomaly_class,
  :before_creation_date,
  :after_creation_date,
  :next_token,
  :max_results,
  :source_ref_contains)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Returns:

  • (Integer)


901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 901

class ListDatasetEntriesRequest < Struct.new(
  :project_name,
  :dataset_type,
  :labeled,
  :anomaly_class,
  :before_creation_date,
  :after_creation_date,
  :next_token,
  :max_results,
  :source_ref_contains)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 901

class ListDatasetEntriesRequest < Struct.new(
  :project_name,
  :dataset_type,
  :labeled,
  :anomaly_class,
  :before_creation_date,
  :after_creation_date,
  :next_token,
  :max_results,
  :source_ref_contains)
  SENSITIVE = []
  include Aws::Structure
end

#project_nameString

The name of the project that contains the dataset that you want to list.

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 901

class ListDatasetEntriesRequest < Struct.new(
  :project_name,
  :dataset_type,
  :labeled,
  :anomaly_class,
  :before_creation_date,
  :after_creation_date,
  :next_token,
  :max_results,
  :source_ref_contains)
  SENSITIVE = []
  include Aws::Structure
end

#source_ref_containsString

Perform a "contains" search on the values of the source-ref key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the source-ref key value matches IMG_17.

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 901

class ListDatasetEntriesRequest < Struct.new(
  :project_name,
  :dataset_type,
  :labeled,
  :anomaly_class,
  :before_creation_date,
  :after_creation_date,
  :next_token,
  :max_results,
  :source_ref_contains)
  SENSITIVE = []
  include Aws::Structure
end