aws-sdk-batch 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c31ed08d003bae7730232620383a46c6f51582db
-  data.tar.gz: ed5db1bd2088b94af3b68ab453315b80f621d12c
+  metadata.gz: eba96dbbc913c50a87d5917a7870a3815f3e69dc
+  data.tar.gz: 8a1c09bc47ae9ff5b4f5f6489476fe6df5ff1514
 SHA512:
-  metadata.gz: f2d61139184126ff8736906a07734170e75cc3072f64eafb27efd6dc551bc2e31cda27805d4b49e6da8a6e6ae058c46676c5f97f99d67453cfb9a6245c9807e0
-  data.tar.gz: df2353599464f5a4a9274470ebecf757eab802dcc5ae8a4b4d979a3812b4bde751febe1c347f2ebf3f4ce138e19301593e35a246a142fc73c47d889e7107c168
+  metadata.gz: 5601ea79b2b8ee987e19d8d8d06e7bf521a9f882d51d50a29506a8178e5fc3b1f191aaddeb8d5aa62e2fe168a14e3cbc1c7a227a2053dd69c0ecbc850dc0cded
+  data.tar.gz: 2144ea53d25cb433412f4ed2fb5298d44b718c712893848a7770b0a43325c3d7e492018cd76016110dfcb5eabfe41add16fa0e541a551778c13907eabe707b8c

data/lib/aws-sdk-batch.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-batch/customizations'
 # @service
 module Aws::Batch
 
-  GEM_VERSION = '1.9.0'
+  GEM_VERSION = '1.10.0'
 
 end

data/lib/aws-sdk-batch/client.rb

@@ -15,6 +15,7 @@ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
 require 'aws-sdk-core/plugins/retry_errors.rb'
 require 'aws-sdk-core/plugins/global_configuration.rb'
 require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/endpoint_discovery.rb'
 require 'aws-sdk-core/plugins/response_paging.rb'
 require 'aws-sdk-core/plugins/stub_responses.rb'
 require 'aws-sdk-core/plugins/idempotency_token.rb'
@@ -45,6 +46,7 @@ module Aws::Batch
     add_plugin(Aws::Plugins::RetryErrors)
     add_plugin(Aws::Plugins::GlobalConfiguration)
     add_plugin(Aws::Plugins::RegionalEndpoint)
+    add_plugin(Aws::Plugins::EndpointDiscovery)
     add_plugin(Aws::Plugins::ResponsePaging)
     add_plugin(Aws::Plugins::StubResponses)
     add_plugin(Aws::Plugins::IdempotencyToken)
@@ -98,6 +100,10 @@ module Aws::Batch
     #
     #   @option options [String] :access_key_id
     #
+    #   @option options [Boolean] :active_endpoint_cache (false)
+    #     When set to `true`, a thread polling for endpoints will be running in
+    #     the background every 60 secs (default). Defaults to `false`.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -123,6 +129,21 @@ module Aws::Batch
     #     option. You should only configure an `:endpoint` when connecting
     #     to test endpoints. This should be avalid HTTP(S) URI.
     #
+    #   @option options [Integer] :endpoint_cache_max_entries (1000)
+    #     Used for the maximum size limit of the LRU cache storing endpoints data
+    #     for endpoint discovery enabled operations. Defaults to 1000.
+    #
+    #   @option options [Integer] :endpoint_cache_max_threads (10)
+    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
+    #
+    #   @option options [Integer] :endpoint_cache_poll_interval (60)
+    #     When :endpoint_discovery and :active_endpoint_cache is enabled,
+    #     Use this option to config the time interval in seconds for making
+    #     requests fetching endpoints information. Defaults to 60 sec.
+    #
+    #   @option options [Boolean] :endpoint_discovery (false)
+    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
     #
@@ -227,39 +248,63 @@ module Aws::Batch
     # Creates an AWS Batch compute environment. You can create `MANAGED` or
     # `UNMANAGED` compute environments.
     #
-    # In a managed compute environment, AWS Batch manages the compute
-    # resources within the environment, based on the compute resources that
-    # you specify. Instances launched into a managed compute environment use
-    # a recent, approved version of the Amazon ECS-optimized AMI. You can
-    # choose to use Amazon EC2 On-Demand Instances in your managed compute
-    # environment, or you can use Amazon EC2 Spot Instances that only launch
-    # when the Spot bid price is below a specified percentage of the
-    # On-Demand price.
+    # In a managed compute environment, AWS Batch manages the capacity and
+    # instance types of the compute resources within the environment, based
+    # on the compute resource specification that you define or [launch
+    # template][1] that you specify when you create the compute environment.
+    # You can choose to use Amazon EC2 On-Demand Instances or Spot Instances
+    # in your managed compute environment. You can optionally set a maximum
+    # price so that Spot Instances only launch when the Spot Instance price
+    # is below a specified percentage of the On-Demand price.
     #
     # In an unmanaged compute environment, you can manage your own compute
     # resources. This provides more compute resource configuration options,
     # such as using a custom AMI, but you must ensure that your AMI meets
     # the Amazon ECS container instance AMI specification. For more
-    # information, see [Container Instance AMIs][1] in the *Amazon Elastic
+    # information, see [Container Instance AMIs][2] in the *Amazon Elastic
     # Container Service Developer Guide*. After you have created your
     # unmanaged compute environment, you can use the
     # DescribeComputeEnvironments operation to find the Amazon ECS cluster
     # that is associated with it and then manually launch your container
     # instances into that Amazon ECS cluster. For more information, see
-    # [Launching an Amazon ECS Container Instance][2] in the *Amazon Elastic
+    # [Launching an Amazon ECS Container Instance][3] in the *Amazon Elastic
     # Container Service Developer Guide*.
     #
+    # <note markdown="1"> AWS Batch does not upgrade the AMIs in a compute environment after it
+    # is created (for example, when a newer version of the Amazon
+    # ECS-optimized AMI is available). You are responsible for the
+    # management of the guest operating system (including updates and
+    # security patches) and any additional application software or utilities
+    # that you install on the compute resources. To use a new AMI for your
+    # AWS Batch jobs:
+    #
+    #  1.  Create a new compute environment with the new AMI.
+    #
+    # 2.  Add the compute environment to an existing job queue.
+    #
+    # 3.  Remove the old compute environment from your job queue.
     #
+    # 4.  Delete the old compute environment.
     #
-    # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html
-    # [2]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html
+    #  </note>
+    #
+    #
+    #
+    # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
+    # [2]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html
+    # [3]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html
     #
     # @option params [required, String] :compute_environment_name
     #   The name for your compute environment. Up to 128 letters (uppercase
     #   and lowercase), numbers, hyphens, and underscores are allowed.
     #
     # @option params [required, String] :type
-    #   The type of the compute environment.
+    #   The type of the compute environment. For more information, see
+    #   [Compute Environments][1] in the *AWS Batch User Guide*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
     #
     # @option params [String] :state
     #   The state of the compute environment. If the state is `ENABLED`, then
@@ -393,7 +438,7 @@ module Aws::Batch
     #       instance_types: ["String"], # required
     #       image_id: "String",
     #       subnets: ["String"], # required
-    #       security_group_ids: ["String"], # required
+    #       security_group_ids: ["String"],
     #       ec2_key_pair: "String",
     #       instance_role: "String", # required
     #       tags: {
@@ -401,6 +446,11 @@ module Aws::Batch
     #       },
     #       bid_percentage: 1,
     #       spot_iam_fleet_role: "String",
+    #       launch_template: {
+    #         launch_template_id: "String",
+    #         launch_template_name: "String",
+    #         version: "String",
+    #       },
     #     },
     #     service_role: "String", # required
     #   })
@@ -777,6 +827,9 @@ module Aws::Batch
     #   resp.compute_environments[0].compute_resources.tags["String"] #=> String
     #   resp.compute_environments[0].compute_resources.bid_percentage #=> Integer
     #   resp.compute_environments[0].compute_resources.spot_iam_fleet_role #=> String
+    #   resp.compute_environments[0].compute_resources.launch_template.launch_template_id #=> String
+    #   resp.compute_environments[0].compute_resources.launch_template.launch_template_name #=> String
+    #   resp.compute_environments[0].compute_resources.launch_template.version #=> String
     #   resp.compute_environments[0].service_role #=> String
     #   resp.next_token #=> String
     #
@@ -1157,17 +1210,24 @@ module Aws::Batch
       req.send_request(options)
     end
 
-    # Returns a list of task jobs for a specified job queue. You can filter
-    # the results by job status with the `jobStatus` parameter. If you do
-    # not specify a status, only `RUNNING` jobs are returned.
+    # Returns a list of AWS Batch jobs. You must specify either a job queue
+    # to return a list of jobs in that job queue, or an array job ID to
+    # return a list of that job's children. You cannot specify both a job
+    # queue and an array job ID.
+    #
+    # You can filter the results by job status with the `jobStatus`
+    # parameter. If you do not specify a status, only `RUNNING` jobs are
+    # returned.
     #
     # @option params [String] :job_queue
     #   The name or full Amazon Resource Name (ARN) of the job queue with
-    #   which to list jobs.
+    #   which to list jobs. You must specify either a job queue or an array
+    #   job ID.
     #
     # @option params [String] :array_job_id
     #   The job ID for an array job. Specifying an array job ID with this
-    #   parameter lists all child jobs from within the specified array.
+    #   parameter lists all child jobs from within the specified array. You
+    #   must specify either a job queue or an array job ID.
     #
     # @option params [String] :job_status
     #   The job status with which to filter jobs in the specified queue. If
@@ -1770,7 +1830,7 @@ module Aws::Batch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-batch'
-      context[:gem_version] = '1.9.0'
+      context[:gem_version] = '1.10.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-batch/client_api.rb

@@ -74,6 +74,7 @@ module Aws::Batch
     JobSummaryList = Shapes::ListShape.new(name: 'JobSummaryList')
     JobTimeout = Shapes::StructureShape.new(name: 'JobTimeout')
     KeyValuePair = Shapes::StructureShape.new(name: 'KeyValuePair')
+    LaunchTemplateSpecification = Shapes::StructureShape.new(name: 'LaunchTemplateSpecification')
     ListJobsRequest = Shapes::StructureShape.new(name: 'ListJobsRequest')
     ListJobsResponse = Shapes::StructureShape.new(name: 'ListJobsResponse')
     Long = Shapes::IntegerShape.new(name: 'Long')
@@ -162,12 +163,13 @@ module Aws::Batch
     ComputeResource.add_member(:instance_types, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "instanceTypes"))
     ComputeResource.add_member(:image_id, Shapes::ShapeRef.new(shape: String, location_name: "imageId"))
     ComputeResource.add_member(:subnets, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "subnets"))
-    ComputeResource.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "securityGroupIds"))
+    ComputeResource.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: StringList, location_name: "securityGroupIds"))
     ComputeResource.add_member(:ec2_key_pair, Shapes::ShapeRef.new(shape: String, location_name: "ec2KeyPair"))
     ComputeResource.add_member(:instance_role, Shapes::ShapeRef.new(shape: String, required: true, location_name: "instanceRole"))
     ComputeResource.add_member(:tags, Shapes::ShapeRef.new(shape: TagsMap, location_name: "tags"))
     ComputeResource.add_member(:bid_percentage, Shapes::ShapeRef.new(shape: Integer, location_name: "bidPercentage"))
     ComputeResource.add_member(:spot_iam_fleet_role, Shapes::ShapeRef.new(shape: String, location_name: "spotIamFleetRole"))
+    ComputeResource.add_member(:launch_template, Shapes::ShapeRef.new(shape: LaunchTemplateSpecification, location_name: "launchTemplate"))
     ComputeResource.struct_class = Types::ComputeResource
 
     ComputeResourceUpdate.add_member(:minv_cpus, Shapes::ShapeRef.new(shape: Integer, location_name: "minvCpus"))
@@ -364,6 +366,11 @@ module Aws::Batch
     KeyValuePair.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
     KeyValuePair.struct_class = Types::KeyValuePair
 
+    LaunchTemplateSpecification.add_member(:launch_template_id, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateId"))
+    LaunchTemplateSpecification.add_member(:launch_template_name, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateName"))
+    LaunchTemplateSpecification.add_member(:version, Shapes::ShapeRef.new(shape: String, location_name: "version"))
+    LaunchTemplateSpecification.struct_class = Types::LaunchTemplateSpecification
+
     ListJobsRequest.add_member(:job_queue, Shapes::ShapeRef.new(shape: String, location_name: "jobQueue"))
     ListJobsRequest.add_member(:array_job_id, Shapes::ShapeRef.new(shape: String, location_name: "arrayJobId"))
     ListJobsRequest.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "jobStatus"))

data/lib/aws-sdk-batch/types.rb

@@ -202,9 +202,19 @@ module Aws::Batch
     #
     # @!attribute [rw] state
     #   The state of the compute environment. The valid values are `ENABLED`
-    #   or `DISABLED`. An `ENABLED` state indicates that you can register
-    #   instances with the compute environment and that the associated
-    #   instances can accept jobs.
+    #   or `DISABLED`.
+    #
+    #   If the state is `ENABLED`, then the AWS Batch scheduler can attempt
+    #   to place jobs from an associated job queue on the compute resources
+    #   within the environment. If the compute environment is managed, then
+    #   it can scale its instances out or in automatically, based on job
+    #   queue demand.
+    #
+    #   If the state is `DISABLED`, then the AWS Batch scheduler does not
+    #   attempt to place jobs within the environment. Jobs in a `STARTING`
+    #   or `RUNNING` state continue to progress normally. Managed compute
+    #   environments in the `DISABLED` state do not scale out; however, they
+    #   scale in to `minvCpus` value once instances become idle.
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -284,7 +294,7 @@ module Aws::Batch
     #         instance_types: ["String"], # required
     #         image_id: "String",
     #         subnets: ["String"], # required
-    #         security_group_ids: ["String"], # required
+    #         security_group_ids: ["String"],
     #         ec2_key_pair: "String",
     #         instance_role: "String", # required
     #         tags: {
@@ -292,6 +302,11 @@ module Aws::Batch
     #         },
     #         bid_percentage: 1,
     #         spot_iam_fleet_role: "String",
+    #         launch_template: {
+    #           launch_template_id: "String",
+    #           launch_template_name: "String",
+    #           version: "String",
+    #         },
     #       }
     #
     # @!attribute [rw] type
@@ -299,7 +314,8 @@ module Aws::Batch
     #   @return [String]
     #
     # @!attribute [rw] minv_cpus
-    #   The minimum number of EC2 vCPUs that an environment should maintain.
+    #   The minimum number of EC2 vCPUs that an environment should maintain
+    #   (even if the compute environment is `DISABLED`).
     #   @return [Integer]
     #
     # @!attribute [rw] maxv_cpus
@@ -358,11 +374,13 @@ module Aws::Batch
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] bid_percentage
-    #   The minimum percentage that a Spot Instance price must be when
+    #   The maximum percentage that a Spot Instance price can be when
     #   compared with the On-Demand price for that instance type before
-    #   instances are launched. For example, if your bid percentage is 20%,
-    #   then the Spot price must be below 20% of the current On-Demand price
-    #   for that EC2 instance.
+    #   instances are launched. For example, if your maximum percentage is
+    #   20%, then the Spot price must be below 20% of the current On-Demand
+    #   price for that EC2 instance. You always pay the lowest (market)
+    #   price and never more than your maximum percentage. If you leave this
+    #   field empty, the default value is 100% of the On-Demand price.
     #   @return [Integer]
     #
     # @!attribute [rw] spot_iam_fleet_role
@@ -370,6 +388,14 @@ module Aws::Batch
     #   applied to a `SPOT` compute environment.
     #   @return [String]
     #
+    # @!attribute [rw] launch_template
+    #   The launch template to use for your compute resources. Any other
+    #   compute resource parameters that you specify in a
+    #   CreateComputeEnvironment API operation override the same parameters
+    #   in the launch template. You must specify either the launch template
+    #   ID or launch template name in the request, but not both.
+    #   @return [Types::LaunchTemplateSpecification]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeResource AWS API Documentation
     #
     class ComputeResource < Struct.new(
@@ -385,7 +411,8 @@ module Aws::Batch
       :instance_role,
       :tags,
       :bid_percentage,
-      :spot_iam_fleet_role)
+      :spot_iam_fleet_role,
+      :launch_template)
       include Aws::Structure
     end
 
@@ -858,7 +885,7 @@ module Aws::Batch
     #           instance_types: ["String"], # required
     #           image_id: "String",
     #           subnets: ["String"], # required
-    #           security_group_ids: ["String"], # required
+    #           security_group_ids: ["String"],
     #           ec2_key_pair: "String",
     #           instance_role: "String", # required
     #           tags: {
@@ -866,6 +893,11 @@ module Aws::Batch
     #           },
     #           bid_percentage: 1,
     #           spot_iam_fleet_role: "String",
+    #           launch_template: {
+    #             launch_template_id: "String",
+    #             launch_template_name: "String",
+    #             version: "String",
+    #           },
     #         },
     #         service_role: "String", # required
     #       }
@@ -876,7 +908,12 @@ module Aws::Batch
     #   @return [String]
     #
     # @!attribute [rw] type
-    #   The type of the compute environment.
+    #   The type of the compute environment. For more information, see
+    #   [Compute Environments][1] in the *AWS Batch User Guide*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
     #   @return [String]
     #
     # @!attribute [rw] state
@@ -1456,6 +1493,16 @@ module Aws::Batch
     #
     # @!attribute [rw] status
     #   The current status for the job.
+    #
+    #   <note markdown="1"> If your jobs do not progress to `STARTING`, see [Jobs Stuck in
+    #   `RUNNABLE` Status][1] in the troubleshooting section of the *AWS
+    #   Batch User Guide*.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable
     #   @return [String]
     #
     # @!attribute [rw] attempts
@@ -1698,6 +1745,42 @@ module Aws::Batch
       include Aws::Structure
     end
 
+    # An object representing a launch template associated with a compute
+    # resource. You must specify either the launch template ID or launch
+    # template name in the request, but not both.
+    #
+    # @note When making an API call, you may pass LaunchTemplateSpecification
+    #   data as a hash:
+    #
+    #       {
+    #         launch_template_id: "String",
+    #         launch_template_name: "String",
+    #         version: "String",
+    #       }
+    #
+    # @!attribute [rw] launch_template_id
+    #   The ID of the launch template.
+    #   @return [String]
+    #
+    # @!attribute [rw] launch_template_name
+    #   The name of the launch template.
+    #   @return [String]
+    #
+    # @!attribute [rw] version
+    #   The version number of the launch template.
+    #
+    #   Default: The default version of the launch template.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/LaunchTemplateSpecification AWS API Documentation
+    #
+    class LaunchTemplateSpecification < Struct.new(
+      :launch_template_id,
+      :launch_template_name,
+      :version)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListJobsRequest
     #   data as a hash:
     #
@@ -1711,12 +1794,14 @@ module Aws::Batch
     #
     # @!attribute [rw] job_queue
     #   The name or full Amazon Resource Name (ARN) of the job queue with
-    #   which to list jobs.
+    #   which to list jobs. You must specify either a job queue or an array
+    #   job ID.
     #   @return [String]
     #
     # @!attribute [rw] array_job_id
     #   The job ID for an array job. Specifying an array job ID with this
-    #   parameter lists all child jobs from within the specified array.
+    #   parameter lists all child jobs from within the specified array. You
+    #   must specify either a job queue or an array job ID.
     #   @return [String]
     #
     # @!attribute [rw] job_status

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-batch
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core