/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the lookoutvision-2020-11-20.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.LookoutforVision.Model
{
///
/// Container for the parameters to the CreateDataset operation.
/// Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset
/// can create a training or a test dataset from a valid dataset source (DatasetSource
).
///
///
///
/// If you want a single dataset project, specify train
for the value of
/// DatasetType
.
///
///
///
/// To have a project with separate training and test datasets, call CreateDataset
/// twice. On the first call, specify train
for the value of DatasetType
.
/// On the second call, specify test
for the value of DatasetType
.
///
///
///
///
/// This operation requires permissions to perform the lookoutvision:CreateDataset
/// operation.
///
///
public partial class CreateDatasetRequest : AmazonLookoutforVisionRequest
{
private string _clientToken;
private DatasetSource _datasetSource;
private string _datasetType;
private string _projectName;
///
/// Gets and sets the property ClientToken.
///
/// ClientToken is an idempotency token that ensures a call to CreateDataset
/// completes only once. You choose the value to pass. For example, An issue 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.
///
///
///
/// If you don't supply a value for ClientToken
, the AWS SDK you are using
/// inserts a value for you. This prevents retries after a network error from making multiple
/// dataset creation requests. You'll need to provide your own value for other use cases.
///
///
///
///
/// 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.
///
///
[AWSProperty(Min=1, Max=64)]
public string ClientToken
{
get { return this._clientToken; }
set { this._clientToken = value; }
}
// Check to see if ClientToken property is set
internal bool IsSetClientToken()
{
return this._clientToken != null;
}
///
/// Gets and sets the property 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.
///
///
public DatasetSource DatasetSource
{
get { return this._datasetSource; }
set { this._datasetSource = value; }
}
// Check to see if DatasetSource property is set
internal bool IsSetDatasetSource()
{
return this._datasetSource != null;
}
///
/// Gets and sets the property DatasetType.
///
/// The type of the dataset. Specify train
for a training dataset. Specify
/// test
for a test dataset.
///
///
[AWSProperty(Required=true, Min=1, Max=10)]
public string DatasetType
{
get { return this._datasetType; }
set { this._datasetType = value; }
}
// Check to see if DatasetType property is set
internal bool IsSetDatasetType()
{
return this._datasetType != null;
}
///
/// Gets and sets the property ProjectName.
///
/// The name of the project in which you want to create a dataset.
///
///
[AWSProperty(Required=true, Min=1, Max=255)]
public string ProjectName
{
get { return this._projectName; }
set { this._projectName = value; }
}
// Check to see if ProjectName property is set
internal bool IsSetProjectName()
{
return this._projectName != null;
}
}
}