AWS Batch for SageMaker Training jobs feature support. Includes new APIs for service job submission (e.g., SubmitServiceJob) and managing service environments (e.g., CreateServiceEnvironment) that enable queueing SageMaker Training jobs.

Author: aws-sdk-dotnet-automation

generator/ServiceModels/batch/batch-2016-08-10.api.json

@@ -18,6 +18,12 @@
       "limit_key": "maxResults",
       "result_key": "jobQueues"
     },
+    "DescribeServiceEnvironments": {
+      "input_token": "nextToken",
+      "output_token": "nextToken",
+      "limit_key": "maxResults",
+      "result_key": "serviceEnvironments"
+    },
     "ListConsumableResources": {
       "input_token": "nextToken",
       "output_token": "nextToken",
@@ -41,6 +47,12 @@
       "output_token": "nextToken",
       "limit_key": "maxResults",
       "result_key": "schedulingPolicies"
+    },
+    "ListServiceJobs": {
+      "input_token": "nextToken",
+      "output_token": "nextToken",
+      "limit_key": "maxResults",
+      "result_key": "jobSummaryList"
     }
   }
 }

generator/ServiceModels/batch/batch-2016-08-10.docs.json

@@ -1,5 +1,10 @@
 <?xml version="1.0" encoding="utf-16"?>
 <property-value-rules>
+  <property-value-rule>
+    <property>Amazon.Batch.Model.SubmitServiceJobRequest.ClientToken</property>
+    <min>1</min>
+    <max>64</max>
+  </property-value-rule>
   <property-value-rule>
     <property>Amazon.Batch.Model.UpdateConsumableResourceRequest.ClientToken</property>
     <min>1</min>

generator/ServiceModels/batch/batch-2016-08-10.normal.json

@@ -0,0 +1,87 @@
+/*
+ * 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 batch-2016-08-10.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;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.Batch.Model
+{
+    /// <summary>
+    /// Defines the capacity limit for a service environment. This structure specifies the
+    /// maximum amount of resources that can be used by service jobs in the environment.
+    /// </summary>
+    public partial class CapacityLimit
+    {
+        private string _capacityUnit;
+        private int? _maxCapacity;
+
+        /// <summary>
+        /// Gets and sets the property CapacityUnit. 
+        /// <para>
+        /// The unit of measure for the capacity limit. This defines how the maxCapacity value
+        /// should be interpreted. For <c>SAGEMAKER_TRAINING</c> jobs, use <c>NUM_INSTANCES</c>.
+        /// </para>
+        /// </summary>
+        public string CapacityUnit
+        {
+            get { return this._capacityUnit; }
+            set { this._capacityUnit = value; }
+        }
+
+        // Check to see if CapacityUnit property is set
+        internal bool IsSetCapacityUnit()
+        {
+            return this._capacityUnit != null;
+        }
+
+        /// <summary>
+        /// Gets and sets the property MaxCapacity. 
+        /// <para>
+        /// The maximum capacity available for the service environment. This value represents
+        /// the maximum amount of resources that can be allocated to service jobs.
+        /// </para>
+        ///  
+        /// <para>
+        /// For example, <c>maxCapacity=50</c>, <c>capacityUnit=NUM_INSTANCES</c>. This indicates
+        /// that the maximum number of instances that can be run on this service environment is
+        /// 50. You could then run 5 SageMaker Training jobs that each use 10 instances. However,
+        /// if you submit another job that requires 10 instances, it will wait in the queue.
+        /// </para>
+        /// </summary>
+        public int? MaxCapacity
+        {
+            get { return this._maxCapacity; }
+            set { this._maxCapacity = value; }
+        }
+
+        // Check to see if MaxCapacity property is set
+        internal bool IsSetMaxCapacity()
+        {
+            return this._maxCapacity.HasValue; 
+        }
+
+    }
+}

generator/ServiceModels/batch/batch-2016-08-10.paginators.json

@@ -47,9 +47,11 @@ public partial class CreateJobQueueRequest : AmazonBatchRequest
     {
         private List<ComputeEnvironmentOrder> _computeEnvironmentOrder = AWSConfigs.InitializeCollections ? new List<ComputeEnvironmentOrder>() : null;
         private string _jobQueueName;
+        private JobQueueType _jobQueueType;
         private List<JobStateTimeLimitAction> _jobStateTimeLimitActions = AWSConfigs.InitializeCollections ? new List<JobStateTimeLimitAction>() : null;
         private int? _priority;
         private string _schedulingPolicyArn;
+        private List<ServiceEnvironmentOrder> _serviceEnvironmentOrder = AWSConfigs.InitializeCollections ? new List<ServiceEnvironmentOrder>() : null;
         private JQState _state;
         private Dictionary<string, string> _tags = AWSConfigs.InitializeCollections ? new Dictionary<string, string>() : null;
 
@@ -77,7 +79,6 @@ public partial class CreateJobQueueRequest : AmazonBatchRequest
         /// to distinguish between a property not set or a property being empty to clear out a value. To retain the previous
         /// SDK behavior set the AWSConfigs.InitializeCollections static property to true.
         /// </summary>
-        [AWSProperty(Required=true)]
         public List<ComputeEnvironmentOrder> ComputeEnvironmentOrder
         {
             get { return this._computeEnvironmentOrder; }
@@ -110,6 +111,26 @@ internal bool IsSetJobQueueName()
             return this._jobQueueName != null;
         }
 
+        /// <summary>
+        /// Gets and sets the property JobQueueType. 
+        /// <para>
+        /// The type of job queue. For service jobs that run on SageMaker Training, this value
+        /// is <c>SAGEMAKER_TRAINING</c>. For regular container jobs, this value is <c>EKS</c>,
+        /// <c>ECS</c>, or <c>ECS_FARGATE</c> depending on the compute environment.
+        /// </para>
+        /// </summary>
+        public JobQueueType JobQueueType
+        {
+            get { return this._jobQueueType; }
+            set { this._jobQueueType = value; }
+        }
+
+        // Check to see if JobQueueType property is set
+        internal bool IsSetJobQueueType()
+        {
+            return this._jobQueueType != null;
+        }
+
         /// <summary>
         /// Gets and sets the property JobStateTimeLimitActions. 
         /// <para>
@@ -198,6 +219,31 @@ internal bool IsSetSchedulingPolicyArn()
             return this._schedulingPolicyArn != null;
         }
 
+        /// <summary>
+        /// Gets and sets the property ServiceEnvironmentOrder. 
+        /// <para>
+        /// A list of service environments that this job queue can use to allocate jobs. All serviceEnvironments
+        /// must have the same type. A job queue can't have both a serviceEnvironmentOrder and
+        /// a computeEnvironmentOrder field.
+        /// </para>
+        /// <para />
+        /// Starting with version 4 of the SDK this property will default to null. If no data for this property is returned
+        /// from the service the property will also be null. This was changed to improve performance and allow the SDK and caller
+        /// to distinguish between a property not set or a property being empty to clear out a value. To retain the previous
+        /// SDK behavior set the AWSConfigs.InitializeCollections static property to true.
+        /// </summary>
+        public List<ServiceEnvironmentOrder> ServiceEnvironmentOrder
+        {
+            get { return this._serviceEnvironmentOrder; }
+            set { this._serviceEnvironmentOrder = value; }
+        }
+
+        // Check to see if ServiceEnvironmentOrder property is set
+        internal bool IsSetServiceEnvironmentOrder()
+        {
+            return this._serviceEnvironmentOrder != null && (this._serviceEnvironmentOrder.Count > 0 || !AWSConfigs.InitializeCollections); 
+        }
+
         /// <summary>
         /// Gets and sets the property State. 
         /// <para>

sdk/code-analysis/ServiceAnalysis/Batch/Generated/PropertyValueRules.xml

@@ -0,0 +1,157 @@
+/*
+ * 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 batch-2016-08-10.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;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.Batch.Model
+{
+    /// <summary>
+    /// Container for the parameters to the CreateServiceEnvironment operation.
+    /// Creates a service environment for running service jobs. Service environments define
+    /// capacity limits for specific service types such as SageMaker Training jobs.
+    /// </summary>
+    public partial class CreateServiceEnvironmentRequest : AmazonBatchRequest
+    {
+        private List<CapacityLimit> _capacityLimits = AWSConfigs.InitializeCollections ? new List<CapacityLimit>() : null;
+        private string _serviceEnvironmentName;
+        private ServiceEnvironmentType _serviceEnvironmentType;
+        private ServiceEnvironmentState _state;
+        private Dictionary<string, string> _tags = AWSConfigs.InitializeCollections ? new Dictionary<string, string>() : null;
+
+        /// <summary>
+        /// Gets and sets the property CapacityLimits. 
+        /// <para>
+        /// The capacity limits for the service environment. The number of instances a job consumes
+        /// is the total number of instances requested in the submit training job request resource
+        /// configuration.
+        /// </para>
+        /// <para />
+        /// Starting with version 4 of the SDK this property will default to null. If no data for this property is returned
+        /// from the service the property will also be null. This was changed to improve performance and allow the SDK and caller
+        /// to distinguish between a property not set or a property being empty to clear out a value. To retain the previous
+        /// SDK behavior set the AWSConfigs.InitializeCollections static property to true.
+        /// </summary>
+        [AWSProperty(Required=true)]
+        public List<CapacityLimit> CapacityLimits
+        {
+            get { return this._capacityLimits; }
+            set { this._capacityLimits = value; }
+        }
+
+        // Check to see if CapacityLimits property is set
+        internal bool IsSetCapacityLimits()
+        {
+            return this._capacityLimits != null && (this._capacityLimits.Count > 0 || !AWSConfigs.InitializeCollections); 
+        }
+
+        /// <summary>
+        /// Gets and sets the property ServiceEnvironmentName. 
+        /// <para>
+        /// The name for the service environment. It can be up to 128 characters long and can
+        /// contain letters, numbers, hyphens (-), and underscores (_).
+        /// </para>
+        /// </summary>
+        [AWSProperty(Required=true)]
+        public string ServiceEnvironmentName
+        {
+            get { return this._serviceEnvironmentName; }
+            set { this._serviceEnvironmentName = value; }
+        }
+
+        // Check to see if ServiceEnvironmentName property is set
+        internal bool IsSetServiceEnvironmentName()
+        {
+            return this._serviceEnvironmentName != null;
+        }
+
+        /// <summary>
+        /// Gets and sets the property ServiceEnvironmentType. 
+        /// <para>
+        /// The type of service environment. For SageMaker Training jobs, specify <c>SAGEMAKER_TRAINING</c>.
+        /// </para>
+        /// </summary>
+        [AWSProperty(Required=true)]
+        public ServiceEnvironmentType ServiceEnvironmentType
+        {
+            get { return this._serviceEnvironmentType; }
+            set { this._serviceEnvironmentType = value; }
+        }
+
+        // Check to see if ServiceEnvironmentType property is set
+        internal bool IsSetServiceEnvironmentType()
+        {
+            return this._serviceEnvironmentType != null;
+        }
+
+        /// <summary>
+        /// Gets and sets the property State. 
+        /// <para>
+        /// The state of the service environment. Valid values are <c>ENABLED</c> and <c>DISABLED</c>.
+        /// The default value is <c>ENABLED</c>.
+        /// </para>
+        /// </summary>
+        public ServiceEnvironmentState State
+        {
+            get { return this._state; }
+            set { this._state = value; }
+        }
+
+        // Check to see if State property is set
+        internal bool IsSetState()
+        {
+            return this._state != null;
+        }
+
+        /// <summary>
+        /// Gets and sets the property Tags. 
+        /// <para>
+        /// The tags that you apply to the service environment to help you categorize and organize
+        /// your resources. Each tag consists of a key and an optional value. For more information,
+        /// see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging
+        /// your Batch resources</a>.
+        /// </para>
+        /// <para />
+        /// Starting with version 4 of the SDK this property will default to null. If no data for this property is returned
+        /// from the service the property will also be null. This was changed to improve performance and allow the SDK and caller
+        /// to distinguish between a property not set or a property being empty to clear out a value. To retain the previous
+        /// SDK behavior set the AWSConfigs.InitializeCollections static property to true.
+        /// </summary>
+        [AWSProperty(Min=1, Max=50)]
+        public Dictionary<string, string> Tags
+        {
+            get { return this._tags; }
+            set { this._tags = value; }
+        }
+
+        // Check to see if Tags property is set
+        internal bool IsSetTags()
+        {
+            return this._tags != null && (this._tags.Count > 0 || !AWSConfigs.InitializeCollections); 
+        }
+
+    }
+}