AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::LookoutforVision::Types::CreateDatasetRequest

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 CreateDatasetRequest data as a hash:

{
  project_name: "ProjectName", # required
  dataset_type: "DatasetType", # required
  dataset_source: {
    ground_truth_manifest: {
      s3_object: {
        bucket: "S3BucketName", # required
        key: "S3ObjectKey", # required
        version_id: "S3ObjectVersion",
      },
    },
  },
  client_token: "ClientToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from CreateDataset. In this case, safely retry your call to CreateDataset by using the same ClientToken parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateDataset. An idempotency token is active for 8 hours.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 108

class CreateDatasetRequest < Struct.new(
  :project_name,
  :dataset_type,
  :dataset_source,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_sourceTypes::DatasetSource

The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.

If you don't specify DatasetSource, an empty dataset is created and the operation synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.

If you specify a value for DataSource, the manifest at the S3 location is validated and used to create the dataset. The call to CreateDataset is asynchronous and might take a while to complete. To find out the current status, Check the value of Status returned in a call to DescribeDataset.



108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 108

class CreateDatasetRequest < Struct.new(
  :project_name,
  :dataset_type,
  :dataset_source,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_typeString

The type of the dataset. Specify train for a training dataset. Specify test for a test dataset.

Returns:

  • (String)


108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 108

class CreateDatasetRequest < Struct.new(
  :project_name,
  :dataset_type,
  :dataset_source,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#project_nameString

The name of the project in which you want to create a dataset.

Returns:

  • (String)


108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 108

class CreateDatasetRequest < Struct.new(
  :project_name,
  :dataset_type,
  :dataset_source,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end