/*
 * 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 sagemaker-2017-07-24.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.SageMaker.Model
{
    /// <summary>
    /// Describes the S3 data source.
    /// 
    ///  
    /// <para>
    /// Your input bucket must be in the same Amazon Web Services region as your training
    /// job.
    /// </para>
    /// </summary>
    public partial class S3DataSource
    {
        private List<string> _attributeNames = new List<string>();
        private List<string> _instanceGroupNames = new List<string>();
        private S3DataDistribution _s3DataDistributionType;
        private S3DataType _s3DataType;
        private string _s3Uri;

        /// <summary>
        /// Gets and sets the property AttributeNames. 
        /// <para>
        /// A list of one or more attribute names to use that are found in a specified augmented
        /// manifest file.
        /// </para>
        /// </summary>
        [AWSProperty(Max=16)]
        public List<string> AttributeNames
        {
            get { return this._attributeNames; }
            set { this._attributeNames = value; }
        }

        // Check to see if AttributeNames property is set
        internal bool IsSetAttributeNames()
        {
            return this._attributeNames != null && this._attributeNames.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property InstanceGroupNames. 
        /// <para>
        /// A list of names of instance groups that get data from the S3 data source.
        /// </para>
        /// </summary>
        [AWSProperty(Max=5)]
        public List<string> InstanceGroupNames
        {
            get { return this._instanceGroupNames; }
            set { this._instanceGroupNames = value; }
        }

        // Check to see if InstanceGroupNames property is set
        internal bool IsSetInstanceGroupNames()
        {
            return this._instanceGroupNames != null && this._instanceGroupNames.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property S3DataDistributionType. 
        /// <para>
        /// If you want SageMaker to replicate the entire dataset on each ML compute instance
        /// that is launched for model training, specify <code>FullyReplicated</code>. 
        /// </para>
        ///  
        /// <para>
        /// If you want SageMaker to replicate a subset of data on each ML compute instance that
        /// is launched for model training, specify <code>ShardedByS3Key</code>. If there are
        /// <i>n</i> ML compute instances launched for a training job, each instance gets approximately
        /// 1/<i>n</i> of the number of S3 objects. In this case, model training on each machine
        /// uses only the subset of training data. 
        /// </para>
        ///  
        /// <para>
        /// Don't choose more ML compute instances for training than available S3 objects. If
        /// you do, some nodes won't get any data and you will pay for nodes that aren't getting
        /// any training data. This applies in both File and Pipe modes. Keep this in mind when
        /// developing algorithms. 
        /// </para>
        ///  
        /// <para>
        /// In distributed training, where you use multiple ML compute EC2 instances, you might
        /// choose <code>ShardedByS3Key</code>. If the algorithm requires copying training data
        /// to the ML storage volume (when <code>TrainingInputMode</code> is set to <code>File</code>),
        /// this copies 1/<i>n</i> of the number of objects. 
        /// </para>
        /// </summary>
        public S3DataDistribution S3DataDistributionType
        {
            get { return this._s3DataDistributionType; }
            set { this._s3DataDistributionType = value; }
        }

        // Check to see if S3DataDistributionType property is set
        internal bool IsSetS3DataDistributionType()
        {
            return this._s3DataDistributionType != null;
        }

        /// <summary>
        /// Gets and sets the property S3DataType. 
        /// <para>
        /// If you choose <code>S3Prefix</code>, <code>S3Uri</code> identifies a key name prefix.
        /// SageMaker uses all objects that match the specified key name prefix for model training.
        /// 
        /// </para>
        ///  
        /// <para>
        /// If you choose <code>ManifestFile</code>, <code>S3Uri</code> identifies an object that
        /// is a manifest file containing a list of object keys that you want SageMaker to use
        /// for model training. 
        /// </para>
        ///  
        /// <para>
        /// If you choose <code>AugmentedManifestFile</code>, S3Uri identifies an object that
        /// is an augmented manifest file in JSON lines format. This file contains the data you
        /// want to use for model training. <code>AugmentedManifestFile</code> can only be used
        /// if the Channel's input mode is <code>Pipe</code>.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public S3DataType S3DataType
        {
            get { return this._s3DataType; }
            set { this._s3DataType = value; }
        }

        // Check to see if S3DataType property is set
        internal bool IsSetS3DataType()
        {
            return this._s3DataType != null;
        }

        /// <summary>
        /// Gets and sets the property S3Uri. 
        /// <para>
        /// Depending on the value specified for the <code>S3DataType</code>, identifies either
        /// a key name prefix or a manifest. For example: 
        /// </para>
        ///  <ul> <li> 
        /// <para>
        ///  A key name prefix might look like this: <code>s3://bucketname/exampleprefix</code>
        /// 
        /// </para>
        ///  </li> <li> 
        /// <para>
        ///  A manifest might look like this: <code>s3://bucketname/example.manifest</code> 
        /// </para>
        ///  
        /// <para>
        ///  A manifest is an S3 object which is a JSON file consisting of an array of elements.
        /// The first element is a prefix which is followed by one or more suffixes. SageMaker
        /// appends the suffix elements to the prefix to get a full set of <code>S3Uri</code>.
        /// Note that the prefix must be a valid non-empty <code>S3Uri</code> that precludes users
        /// from specifying a manifest whose individual <code>S3Uri</code> is sourced from different
        /// S3 buckets.
        /// </para>
        ///  
        /// <para>
        ///  The following code example shows a valid manifest format: 
        /// </para>
        ///  
        /// <para>
        ///  <code>[ {"prefix": "s3://customer_bucket/some/prefix/"},</code> 
        /// </para>
        ///  
        /// <para>
        ///  <code> "relative/path/to/custdata-1",</code> 
        /// </para>
        ///  
        /// <para>
        ///  <code> "relative/path/custdata-2",</code> 
        /// </para>
        ///  
        /// <para>
        ///  <code> ...</code> 
        /// </para>
        ///  
        /// <para>
        ///  <code> "relative/path/custdata-N"</code> 
        /// </para>
        ///  
        /// <para>
        ///  <code>]</code> 
        /// </para>
        ///  
        /// <para>
        ///  This JSON is equivalent to the following <code>S3Uri</code> list:
        /// </para>
        ///  
        /// <para>
        ///  <code>s3://customer_bucket/some/prefix/relative/path/to/custdata-1</code> 
        /// </para>
        ///  
        /// <para>
        ///  <code>s3://customer_bucket/some/prefix/relative/path/custdata-2</code> 
        /// </para>
        ///  
        /// <para>
        ///  <code>...</code> 
        /// </para>
        ///  
        /// <para>
        ///  <code>s3://customer_bucket/some/prefix/relative/path/custdata-N</code> 
        /// </para>
        ///  
        /// <para>
        /// The complete set of <code>S3Uri</code> in this manifest is the input data for the
        /// channel for this data source. The object that each <code>S3Uri</code> points to must
        /// be readable by the IAM role that SageMaker uses to perform tasks on your behalf. 
        /// </para>
        ///  </li> </ul> 
        /// <para>
        /// Your input bucket must be located in same Amazon Web Services region as your training
        /// job.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true, Max=1024)]
        public string S3Uri
        {
            get { return this._s3Uri; }
            set { this._s3Uri = value; }
        }

        // Check to see if S3Uri property is set
        internal bool IsSetS3Uri()
        {
            return this._s3Uri != null;
        }

    }
}