aws-sdk-batch 1.117.0 → 1.118.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -253,6 +253,37 @@ module Aws::Batch
253
253
  #
254
254
  class CancelJobResponse < Aws::EmptyStructure; end
255
255
 
256
+ # Defines the capacity limit for a service environment. This structure
257
+ # specifies the maximum amount of resources that can be used by service
258
+ # jobs in the environment.
259
+ #
260
+ # @!attribute [rw] max_capacity
261
+ # The maximum capacity available for the service environment. This
262
+ # value represents the maximum amount of resources that can be
263
+ # allocated to service jobs.
264
+ #
265
+ # For example, `maxCapacity=50`, `capacityUnit=NUM_INSTANCES`. This
266
+ # indicates that the maximum number of instances that can be run on
267
+ # this service environment is 50. You could then run 5 SageMaker
268
+ # Training jobs that each use 10 instances. However, if you submit
269
+ # another job that requires 10 instances, it will wait in the queue.
270
+ # @return [Integer]
271
+ #
272
+ # @!attribute [rw] capacity_unit
273
+ # The unit of measure for the capacity limit. This defines how the
274
+ # maxCapacity value should be interpreted. For `SAGEMAKER_TRAINING`
275
+ # jobs, use `NUM_INSTANCES`.
276
+ # @return [String]
277
+ #
278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CapacityLimit AWS API Documentation
279
+ #
280
+ class CapacityLimit < Struct.new(
281
+ :max_capacity,
282
+ :capacity_unit)
283
+ SENSITIVE = []
284
+ include Aws::Structure
285
+ end
286
+
256
287
  # These errors are usually caused by a client action. One example cause
257
288
  # is using an action or resource on behalf of a user that doesn't have
258
289
  # permissions to use the action or resource. Another cause is specifying
@@ -2466,6 +2497,20 @@ module Aws::Batch
2466
2497
  # </note>
2467
2498
  # @return [Array<Types::ComputeEnvironmentOrder>]
2468
2499
  #
2500
+ # @!attribute [rw] service_environment_order
2501
+ # A list of service environments that this job queue can use to
2502
+ # allocate jobs. All serviceEnvironments must have the same type. A
2503
+ # job queue can't have both a serviceEnvironmentOrder and a
2504
+ # computeEnvironmentOrder field.
2505
+ # @return [Array<Types::ServiceEnvironmentOrder>]
2506
+ #
2507
+ # @!attribute [rw] job_queue_type
2508
+ # The type of job queue. For service jobs that run on SageMaker
2509
+ # Training, this value is `SAGEMAKER_TRAINING`. For regular container
2510
+ # jobs, this value is `EKS`, `ECS`, or `ECS_FARGATE` depending on the
2511
+ # compute environment.
2512
+ # @return [String]
2513
+ #
2469
2514
  # @!attribute [rw] tags
2470
2515
  # The tags that you apply to the job queue to help you categorize and
2471
2516
  # organize your resources. Each tag consists of a key and an optional
@@ -2493,6 +2538,8 @@ module Aws::Batch
2493
2538
  :scheduling_policy_arn,
2494
2539
  :priority,
2495
2540
  :compute_environment_order,
2541
+ :service_environment_order,
2542
+ :job_queue_type,
2496
2543
  :tags,
2497
2544
  :job_state_time_limit_actions)
2498
2545
  SENSITIVE = []
@@ -2574,6 +2621,68 @@ module Aws::Batch
2574
2621
  include Aws::Structure
2575
2622
  end
2576
2623
 
2624
+ # @!attribute [rw] service_environment_name
2625
+ # The name for the service environment. It can be up to 128 characters
2626
+ # long and can contain letters, numbers, hyphens (-), and underscores
2627
+ # (\_).
2628
+ # @return [String]
2629
+ #
2630
+ # @!attribute [rw] service_environment_type
2631
+ # The type of service environment. For SageMaker Training jobs,
2632
+ # specify `SAGEMAKER_TRAINING`.
2633
+ # @return [String]
2634
+ #
2635
+ # @!attribute [rw] state
2636
+ # The state of the service environment. Valid values are `ENABLED` and
2637
+ # `DISABLED`. The default value is `ENABLED`.
2638
+ # @return [String]
2639
+ #
2640
+ # @!attribute [rw] capacity_limits
2641
+ # The capacity limits for the service environment. The number of
2642
+ # instances a job consumes is the total number of instances requested
2643
+ # in the submit training job request resource configuration.
2644
+ # @return [Array<Types::CapacityLimit>]
2645
+ #
2646
+ # @!attribute [rw] tags
2647
+ # The tags that you apply to the service environment to help you
2648
+ # categorize and organize your resources. Each tag consists of a key
2649
+ # and an optional value. For more information, see [Tagging your Batch
2650
+ # resources][1].
2651
+ #
2652
+ #
2653
+ #
2654
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
2655
+ # @return [Hash<String,String>]
2656
+ #
2657
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateServiceEnvironmentRequest AWS API Documentation
2658
+ #
2659
+ class CreateServiceEnvironmentRequest < Struct.new(
2660
+ :service_environment_name,
2661
+ :service_environment_type,
2662
+ :state,
2663
+ :capacity_limits,
2664
+ :tags)
2665
+ SENSITIVE = []
2666
+ include Aws::Structure
2667
+ end
2668
+
2669
+ # @!attribute [rw] service_environment_name
2670
+ # The name of the service environment.
2671
+ # @return [String]
2672
+ #
2673
+ # @!attribute [rw] service_environment_arn
2674
+ # The Amazon Resource Name (ARN) of the service environment.
2675
+ # @return [String]
2676
+ #
2677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateServiceEnvironmentResponse AWS API Documentation
2678
+ #
2679
+ class CreateServiceEnvironmentResponse < Struct.new(
2680
+ :service_environment_name,
2681
+ :service_environment_arn)
2682
+ SENSITIVE = []
2683
+ include Aws::Structure
2684
+ end
2685
+
2577
2686
  # Contains the parameters for `DeleteComputeEnvironment`.
2578
2687
  #
2579
2688
  # @!attribute [rw] compute_environment
@@ -2646,6 +2755,22 @@ module Aws::Batch
2646
2755
  #
2647
2756
  class DeleteSchedulingPolicyResponse < Aws::EmptyStructure; end
2648
2757
 
2758
+ # @!attribute [rw] service_environment
2759
+ # The name or ARN of the service environment to delete.
2760
+ # @return [String]
2761
+ #
2762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteServiceEnvironmentRequest AWS API Documentation
2763
+ #
2764
+ class DeleteServiceEnvironmentRequest < Struct.new(
2765
+ :service_environment)
2766
+ SENSITIVE = []
2767
+ include Aws::Structure
2768
+ end
2769
+
2770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteServiceEnvironmentResponse AWS API Documentation
2771
+ #
2772
+ class DeleteServiceEnvironmentResponse < Aws::EmptyStructure; end
2773
+
2649
2774
  # @!attribute [rw] job_definition
2650
2775
  # The name and revision (`name:revision`) or full Amazon Resource Name
2651
2776
  # (ARN) of the job definition to deregister.
@@ -2999,6 +3124,196 @@ module Aws::Batch
2999
3124
  include Aws::Structure
3000
3125
  end
3001
3126
 
3127
+ # @!attribute [rw] service_environments
3128
+ # An array of service environment names or ARN entries.
3129
+ # @return [Array<String>]
3130
+ #
3131
+ # @!attribute [rw] max_results
3132
+ # The maximum number of results returned by
3133
+ # `DescribeServiceEnvironments` in paginated output. When this
3134
+ # parameter is used, `DescribeServiceEnvironments` only returns
3135
+ # `maxResults` results in a single page and a `nextToken` response
3136
+ # element. The remaining results of the initial request can be seen by
3137
+ # sending another `DescribeServiceEnvironments` request with the
3138
+ # returned `nextToken` value. This value can be between 1 and 100. If
3139
+ # this parameter isn't used, then `DescribeServiceEnvironments`
3140
+ # returns up to 100 results and a `nextToken` value if applicable.
3141
+ # @return [Integer]
3142
+ #
3143
+ # @!attribute [rw] next_token
3144
+ # The `nextToken` value returned from a previous paginated
3145
+ # `DescribeServiceEnvironments` request where `maxResults` was used
3146
+ # and the results exceeded the value of that parameter. Pagination
3147
+ # continues from the end of the previous results that returned the
3148
+ # `nextToken` value. This value is `null` when there are no more
3149
+ # results to return.
3150
+ #
3151
+ # <note markdown="1"> Treat this token as an opaque identifier that's only used to
3152
+ # retrieve the next items in a list and not for other programmatic
3153
+ # purposes.
3154
+ #
3155
+ # </note>
3156
+ # @return [String]
3157
+ #
3158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeServiceEnvironmentsRequest AWS API Documentation
3159
+ #
3160
+ class DescribeServiceEnvironmentsRequest < Struct.new(
3161
+ :service_environments,
3162
+ :max_results,
3163
+ :next_token)
3164
+ SENSITIVE = []
3165
+ include Aws::Structure
3166
+ end
3167
+
3168
+ # @!attribute [rw] service_environments
3169
+ # The list of service environments that match the request.
3170
+ # @return [Array<Types::ServiceEnvironmentDetail>]
3171
+ #
3172
+ # @!attribute [rw] next_token
3173
+ # The `nextToken` value to include in a future
3174
+ # `DescribeServiceEnvironments` request. When the results of a
3175
+ # `DescribeServiceEnvironments` request exceed `maxResults`, this
3176
+ # value can be used to retrieve the next page of results. This value
3177
+ # is `null` when there are no more results to return.
3178
+ # @return [String]
3179
+ #
3180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeServiceEnvironmentsResponse AWS API Documentation
3181
+ #
3182
+ class DescribeServiceEnvironmentsResponse < Struct.new(
3183
+ :service_environments,
3184
+ :next_token)
3185
+ SENSITIVE = []
3186
+ include Aws::Structure
3187
+ end
3188
+
3189
+ # @!attribute [rw] job_id
3190
+ # The job ID for the service job to describe.
3191
+ # @return [String]
3192
+ #
3193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeServiceJobRequest AWS API Documentation
3194
+ #
3195
+ class DescribeServiceJobRequest < Struct.new(
3196
+ :job_id)
3197
+ SENSITIVE = []
3198
+ include Aws::Structure
3199
+ end
3200
+
3201
+ # @!attribute [rw] attempts
3202
+ # A list of job attempts associated with the service job.
3203
+ # @return [Array<Types::ServiceJobAttemptDetail>]
3204
+ #
3205
+ # @!attribute [rw] created_at
3206
+ # The Unix timestamp (in milliseconds) for when the service job was
3207
+ # created.
3208
+ # @return [Integer]
3209
+ #
3210
+ # @!attribute [rw] is_terminated
3211
+ # Indicates whether the service job has been terminated.
3212
+ # @return [Boolean]
3213
+ #
3214
+ # @!attribute [rw] job_arn
3215
+ # The Amazon Resource Name (ARN) of the service job.
3216
+ # @return [String]
3217
+ #
3218
+ # @!attribute [rw] job_id
3219
+ # The job ID for the service job.
3220
+ # @return [String]
3221
+ #
3222
+ # @!attribute [rw] job_name
3223
+ # The name of the service job.
3224
+ # @return [String]
3225
+ #
3226
+ # @!attribute [rw] job_queue
3227
+ # The ARN of the job queue that the service job is associated with.
3228
+ # @return [String]
3229
+ #
3230
+ # @!attribute [rw] latest_attempt
3231
+ # The latest attempt associated with the service job.
3232
+ # @return [Types::LatestServiceJobAttempt]
3233
+ #
3234
+ # @!attribute [rw] retry_strategy
3235
+ # The retry strategy to use for failed service jobs that are submitted
3236
+ # with this service job.
3237
+ # @return [Types::ServiceJobRetryStrategy]
3238
+ #
3239
+ # @!attribute [rw] scheduling_priority
3240
+ # The scheduling priority of the service job.
3241
+ # @return [Integer]
3242
+ #
3243
+ # @!attribute [rw] service_request_payload
3244
+ # The request, in JSON, for the service that the `SubmitServiceJob`
3245
+ # operation is queueing.
3246
+ # @return [String]
3247
+ #
3248
+ # @!attribute [rw] service_job_type
3249
+ # The type of service job. For SageMaker Training jobs, this value is
3250
+ # `SAGEMAKER_TRAINING`.
3251
+ # @return [String]
3252
+ #
3253
+ # @!attribute [rw] share_identifier
3254
+ # The share identifier for the service job. This is used for
3255
+ # fair-share scheduling.
3256
+ # @return [String]
3257
+ #
3258
+ # @!attribute [rw] started_at
3259
+ # The Unix timestamp (in milliseconds) for when the service job was
3260
+ # started.
3261
+ # @return [Integer]
3262
+ #
3263
+ # @!attribute [rw] status
3264
+ # The current status of the service job.
3265
+ # @return [String]
3266
+ #
3267
+ # @!attribute [rw] status_reason
3268
+ # A short, human-readable string to provide more details for the
3269
+ # current status of the service job.
3270
+ # @return [String]
3271
+ #
3272
+ # @!attribute [rw] stopped_at
3273
+ # The Unix timestamp (in milliseconds) for when the service job
3274
+ # stopped running.
3275
+ # @return [Integer]
3276
+ #
3277
+ # @!attribute [rw] tags
3278
+ # The tags that are associated with the service job. Each tag consists
3279
+ # of a key and an optional value. For more information, see [Tagging
3280
+ # your Batch resources][1].
3281
+ #
3282
+ #
3283
+ #
3284
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
3285
+ # @return [Hash<String,String>]
3286
+ #
3287
+ # @!attribute [rw] timeout_config
3288
+ # The timeout configuration for the service job.
3289
+ # @return [Types::ServiceJobTimeout]
3290
+ #
3291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeServiceJobResponse AWS API Documentation
3292
+ #
3293
+ class DescribeServiceJobResponse < Struct.new(
3294
+ :attempts,
3295
+ :created_at,
3296
+ :is_terminated,
3297
+ :job_arn,
3298
+ :job_id,
3299
+ :job_name,
3300
+ :job_queue,
3301
+ :latest_attempt,
3302
+ :retry_strategy,
3303
+ :scheduling_priority,
3304
+ :service_request_payload,
3305
+ :service_job_type,
3306
+ :share_identifier,
3307
+ :started_at,
3308
+ :status,
3309
+ :status_reason,
3310
+ :stopped_at,
3311
+ :tags,
3312
+ :timeout_config)
3313
+ SENSITIVE = []
3314
+ include Aws::Structure
3315
+ end
3316
+
3002
3317
  # An object that represents a container instance host device.
3003
3318
  #
3004
3319
  # <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
@@ -5642,6 +5957,19 @@ module Aws::Batch
5642
5957
  # selected for job placement in ascending order.
5643
5958
  # @return [Array<Types::ComputeEnvironmentOrder>]
5644
5959
  #
5960
+ # @!attribute [rw] service_environment_order
5961
+ # The order of the service environment associated with the job queue.
5962
+ # Job queues with a higher priority are evaluated first when
5963
+ # associated with the same service environment.
5964
+ # @return [Array<Types::ServiceEnvironmentOrder>]
5965
+ #
5966
+ # @!attribute [rw] job_queue_type
5967
+ # The type of job queue. For service jobs that run on SageMaker
5968
+ # Training, this value is `SAGEMAKER_TRAINING`. For regular container
5969
+ # jobs, this value is `EKS`, `ECS`, or `ECS_FARGATE` depending on the
5970
+ # compute environment.
5971
+ # @return [String]
5972
+ #
5645
5973
  # @!attribute [rw] tags
5646
5974
  # The tags that are applied to the job queue. For more information,
5647
5975
  # see [Tagging your Batch resources][1] in *Batch User Guide*.
@@ -5669,6 +5997,8 @@ module Aws::Batch
5669
5997
  :status_reason,
5670
5998
  :priority,
5671
5999
  :compute_environment_order,
6000
+ :service_environment_order,
6001
+ :job_queue_type,
5672
6002
  :tags,
5673
6003
  :job_state_time_limit_actions)
5674
6004
  SENSITIVE = []
@@ -5865,6 +6195,23 @@ module Aws::Batch
5865
6195
  include Aws::Structure
5866
6196
  end
5867
6197
 
6198
+ # Information about the latest attempt of a service job. A Service job
6199
+ # can transition from `SCHEDULED` back to `RUNNABLE` state when they
6200
+ # encounter capacity constraints.
6201
+ #
6202
+ # @!attribute [rw] service_resource_id
6203
+ # The service resource identifier associated with the service job
6204
+ # attempt.
6205
+ # @return [Types::ServiceResourceId]
6206
+ #
6207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/LatestServiceJobAttempt AWS API Documentation
6208
+ #
6209
+ class LatestServiceJobAttempt < Struct.new(
6210
+ :service_resource_id)
6211
+ SENSITIVE = []
6212
+ include Aws::Structure
6213
+ end
6214
+
5868
6215
  # An object that represents a launch template that's associated with a
5869
6216
  # compute resource. You must specify either the launch template ID or
5870
6217
  # launch template name in the request, but not both.
@@ -6664,6 +7011,89 @@ module Aws::Batch
6664
7011
  include Aws::Structure
6665
7012
  end
6666
7013
 
7014
+ # @!attribute [rw] job_queue
7015
+ # The name or ARN of the job queue with which to list service jobs.
7016
+ # @return [String]
7017
+ #
7018
+ # @!attribute [rw] job_status
7019
+ # The job status with which to filter service jobs.
7020
+ # @return [String]
7021
+ #
7022
+ # @!attribute [rw] max_results
7023
+ # The maximum number of results returned by `ListServiceJobs` in
7024
+ # paginated output. When this parameter is used, `ListServiceJobs`
7025
+ # only returns `maxResults` results in a single page and a `nextToken`
7026
+ # response element. The remaining results of the initial request can
7027
+ # be seen by sending another `ListServiceJobs` request with the
7028
+ # returned `nextToken` value. This value can be between 1 and 100. If
7029
+ # this parameter isn't used, then `ListServiceJobs` returns up to 100
7030
+ # results and a `nextToken` value if applicable.
7031
+ # @return [Integer]
7032
+ #
7033
+ # @!attribute [rw] next_token
7034
+ # The `nextToken` value returned from a previous paginated
7035
+ # `ListServiceJobs` request where `maxResults` was used and the
7036
+ # results exceeded the value of that parameter. Pagination continues
7037
+ # from the end of the previous results that returned the `nextToken`
7038
+ # value. This value is `null` when there are no more results to
7039
+ # return.
7040
+ #
7041
+ # <note markdown="1"> Treat this token as an opaque identifier that's only used to
7042
+ # retrieve the next items in a list and not for other programmatic
7043
+ # purposes.
7044
+ #
7045
+ # </note>
7046
+ # @return [String]
7047
+ #
7048
+ # @!attribute [rw] filters
7049
+ # The filters to apply to the service job list query. The filter names
7050
+ # and values can be:
7051
+ #
7052
+ # * name: `JOB_STATUS`
7053
+ #
7054
+ # values: `SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING |
7055
+ # SUCCEEDED | FAILED | SCHEDULED`
7056
+ #
7057
+ # * name: `JOB_NAME`
7058
+ #
7059
+ # values: case-insensitive matches for the job name. If a filter
7060
+ # value ends with an asterisk (*), it matches any job name that
7061
+ # begins with the string before the '*'.
7062
+ # @return [Array<Types::KeyValuesPair>]
7063
+ #
7064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListServiceJobsRequest AWS API Documentation
7065
+ #
7066
+ class ListServiceJobsRequest < Struct.new(
7067
+ :job_queue,
7068
+ :job_status,
7069
+ :max_results,
7070
+ :next_token,
7071
+ :filters)
7072
+ SENSITIVE = []
7073
+ include Aws::Structure
7074
+ end
7075
+
7076
+ # @!attribute [rw] job_summary_list
7077
+ # A list of service job summaries.
7078
+ # @return [Array<Types::ServiceJobSummary>]
7079
+ #
7080
+ # @!attribute [rw] next_token
7081
+ # The `nextToken` value to include in a future `ListServiceJobs`
7082
+ # request. When the results of a `ListServiceJobs` request exceed
7083
+ # `maxResults`, this value can be used to retrieve the next page of
7084
+ # results. This value is `null` when there are no more results to
7085
+ # return.
7086
+ # @return [String]
7087
+ #
7088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListServiceJobsResponse AWS API Documentation
7089
+ #
7090
+ class ListServiceJobsResponse < Struct.new(
7091
+ :job_summary_list,
7092
+ :next_token)
7093
+ SENSITIVE = []
7094
+ include Aws::Structure
7095
+ end
7096
+
6667
7097
  # Contains the parameters for `ListTagsForResource`.
6668
7098
  #
6669
7099
  # @!attribute [rw] resource_arn
@@ -7729,7 +8159,275 @@ module Aws::Batch
7729
8159
  include Aws::Structure
7730
8160
  end
7731
8161
 
7732
- # Specifies the weights for the share identifiers for the fair-share
8162
+ # Detailed information about a service environment, including its
8163
+ # configuration, state, and capacity limits.
8164
+ #
8165
+ # @!attribute [rw] service_environment_name
8166
+ # The name of the service environment.
8167
+ # @return [String]
8168
+ #
8169
+ # @!attribute [rw] service_environment_arn
8170
+ # The Amazon Resource Name (ARN) of the service environment.
8171
+ # @return [String]
8172
+ #
8173
+ # @!attribute [rw] service_environment_type
8174
+ # The type of service environment. For SageMaker Training jobs, this
8175
+ # value is `SAGEMAKER_TRAINING`.
8176
+ # @return [String]
8177
+ #
8178
+ # @!attribute [rw] state
8179
+ # The state of the service environment. Valid values are `ENABLED` and
8180
+ # `DISABLED`.
8181
+ # @return [String]
8182
+ #
8183
+ # @!attribute [rw] status
8184
+ # The current status of the service environment.
8185
+ # @return [String]
8186
+ #
8187
+ # @!attribute [rw] capacity_limits
8188
+ # The capacity limits for the service environment. This defines the
8189
+ # maximum resources that can be used by service jobs in this
8190
+ # environment.
8191
+ # @return [Array<Types::CapacityLimit>]
8192
+ #
8193
+ # @!attribute [rw] tags
8194
+ # The tags associated with the service environment. Each tag consists
8195
+ # of a key and an optional value. For more information, see [Tagging
8196
+ # your Batch resources][1].
8197
+ #
8198
+ #
8199
+ #
8200
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
8201
+ # @return [Hash<String,String>]
8202
+ #
8203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ServiceEnvironmentDetail AWS API Documentation
8204
+ #
8205
+ class ServiceEnvironmentDetail < Struct.new(
8206
+ :service_environment_name,
8207
+ :service_environment_arn,
8208
+ :service_environment_type,
8209
+ :state,
8210
+ :status,
8211
+ :capacity_limits,
8212
+ :tags)
8213
+ SENSITIVE = []
8214
+ include Aws::Structure
8215
+ end
8216
+
8217
+ # Specifies the order of a service environment for a job queue. This
8218
+ # determines the priority order when multiple service environments are
8219
+ # associated with the same job queue.
8220
+ #
8221
+ # @!attribute [rw] order
8222
+ # The order of the service environment. Job queues with a higher
8223
+ # priority are evaluated first when associated with the same service
8224
+ # environment.
8225
+ # @return [Integer]
8226
+ #
8227
+ # @!attribute [rw] service_environment
8228
+ # The name or ARN of the service environment.
8229
+ # @return [String]
8230
+ #
8231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ServiceEnvironmentOrder AWS API Documentation
8232
+ #
8233
+ class ServiceEnvironmentOrder < Struct.new(
8234
+ :order,
8235
+ :service_environment)
8236
+ SENSITIVE = []
8237
+ include Aws::Structure
8238
+ end
8239
+
8240
+ # Detailed information about an attempt to run a service job.
8241
+ #
8242
+ # @!attribute [rw] service_resource_id
8243
+ # The service resource identifier associated with the service job
8244
+ # attempt.
8245
+ # @return [Types::ServiceResourceId]
8246
+ #
8247
+ # @!attribute [rw] started_at
8248
+ # The Unix timestamp (in milliseconds) for when the service job
8249
+ # attempt was started.
8250
+ # @return [Integer]
8251
+ #
8252
+ # @!attribute [rw] stopped_at
8253
+ # The Unix timestamp (in milliseconds) for when the service job
8254
+ # attempt stopped running.
8255
+ # @return [Integer]
8256
+ #
8257
+ # @!attribute [rw] status_reason
8258
+ # A string that provides additional details for the current status of
8259
+ # the service job attempt.
8260
+ # @return [String]
8261
+ #
8262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ServiceJobAttemptDetail AWS API Documentation
8263
+ #
8264
+ class ServiceJobAttemptDetail < Struct.new(
8265
+ :service_resource_id,
8266
+ :started_at,
8267
+ :stopped_at,
8268
+ :status_reason)
8269
+ SENSITIVE = []
8270
+ include Aws::Structure
8271
+ end
8272
+
8273
+ # Specifies conditions for when to exit or retry a service job based on
8274
+ # the exit status or status reason.
8275
+ #
8276
+ # @!attribute [rw] action
8277
+ # The action to take if the service job exits with the specified
8278
+ # condition. Valid values are `RETRY` and `EXIT`.
8279
+ # @return [String]
8280
+ #
8281
+ # @!attribute [rw] on_status_reason
8282
+ # Contains a glob pattern to match against the StatusReason returned
8283
+ # for a job. The pattern can contain up to 512 characters and can
8284
+ # contain all printable characters. It can optionally end with an
8285
+ # asterisk (*) so that only the start of the string needs to be an
8286
+ # exact match.
8287
+ # @return [String]
8288
+ #
8289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ServiceJobEvaluateOnExit AWS API Documentation
8290
+ #
8291
+ class ServiceJobEvaluateOnExit < Struct.new(
8292
+ :action,
8293
+ :on_status_reason)
8294
+ SENSITIVE = []
8295
+ include Aws::Structure
8296
+ end
8297
+
8298
+ # The retry strategy for service jobs. This defines how many times to
8299
+ # retry a failed service job and under what conditions. For more
8300
+ # information, see [Service job retry strategies][1] in the *Batch User
8301
+ # Guide*.
8302
+ #
8303
+ #
8304
+ #
8305
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/service-job-retries.html
8306
+ #
8307
+ # @!attribute [rw] attempts
8308
+ # The number of times to move a service job to `RUNNABLE` status. You
8309
+ # can specify between 1 and 10 attempts.
8310
+ # @return [Integer]
8311
+ #
8312
+ # @!attribute [rw] evaluate_on_exit
8313
+ # Array of `ServiceJobEvaluateOnExit` objects that specify conditions
8314
+ # under which the service job should be retried or failed.
8315
+ # @return [Array<Types::ServiceJobEvaluateOnExit>]
8316
+ #
8317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ServiceJobRetryStrategy AWS API Documentation
8318
+ #
8319
+ class ServiceJobRetryStrategy < Struct.new(
8320
+ :attempts,
8321
+ :evaluate_on_exit)
8322
+ SENSITIVE = []
8323
+ include Aws::Structure
8324
+ end
8325
+
8326
+ # Summary information about a service job.
8327
+ #
8328
+ # @!attribute [rw] latest_attempt
8329
+ # Information about the latest attempt for the service job.
8330
+ # @return [Types::LatestServiceJobAttempt]
8331
+ #
8332
+ # @!attribute [rw] created_at
8333
+ # The Unix timestamp (in milliseconds) for when the service job was
8334
+ # created.
8335
+ # @return [Integer]
8336
+ #
8337
+ # @!attribute [rw] job_arn
8338
+ # The Amazon Resource Name (ARN) of the service job.
8339
+ # @return [String]
8340
+ #
8341
+ # @!attribute [rw] job_id
8342
+ # The job ID for the service job.
8343
+ # @return [String]
8344
+ #
8345
+ # @!attribute [rw] job_name
8346
+ # The name of the service job.
8347
+ # @return [String]
8348
+ #
8349
+ # @!attribute [rw] service_job_type
8350
+ # The type of service job. For SageMaker Training jobs, this value is
8351
+ # `SAGEMAKER_TRAINING`.
8352
+ # @return [String]
8353
+ #
8354
+ # @!attribute [rw] share_identifier
8355
+ # The share identifier for the job.
8356
+ # @return [String]
8357
+ #
8358
+ # @!attribute [rw] status
8359
+ # The current status of the service job.
8360
+ # @return [String]
8361
+ #
8362
+ # @!attribute [rw] status_reason
8363
+ # A short string to provide more details on the current status of the
8364
+ # service job.
8365
+ # @return [String]
8366
+ #
8367
+ # @!attribute [rw] started_at
8368
+ # The Unix timestamp (in milliseconds) for when the service job was
8369
+ # started.
8370
+ # @return [Integer]
8371
+ #
8372
+ # @!attribute [rw] stopped_at
8373
+ # The Unix timestamp (in milliseconds) for when the service job
8374
+ # stopped running.
8375
+ # @return [Integer]
8376
+ #
8377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ServiceJobSummary AWS API Documentation
8378
+ #
8379
+ class ServiceJobSummary < Struct.new(
8380
+ :latest_attempt,
8381
+ :created_at,
8382
+ :job_arn,
8383
+ :job_id,
8384
+ :job_name,
8385
+ :service_job_type,
8386
+ :share_identifier,
8387
+ :status,
8388
+ :status_reason,
8389
+ :started_at,
8390
+ :stopped_at)
8391
+ SENSITIVE = []
8392
+ include Aws::Structure
8393
+ end
8394
+
8395
+ # The timeout configuration for service jobs.
8396
+ #
8397
+ # @!attribute [rw] attempt_duration_seconds
8398
+ # The maximum duration in seconds that a service job attempt can run.
8399
+ # After this time is reached, Batch terminates the service job
8400
+ # attempt.
8401
+ # @return [Integer]
8402
+ #
8403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ServiceJobTimeout AWS API Documentation
8404
+ #
8405
+ class ServiceJobTimeout < Struct.new(
8406
+ :attempt_duration_seconds)
8407
+ SENSITIVE = []
8408
+ include Aws::Structure
8409
+ end
8410
+
8411
+ # The Batch unique identifier.
8412
+ #
8413
+ # @!attribute [rw] name
8414
+ # The name of the resource identifier.
8415
+ # @return [String]
8416
+ #
8417
+ # @!attribute [rw] value
8418
+ # The value of the resource identifier.
8419
+ # @return [String]
8420
+ #
8421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ServiceResourceId AWS API Documentation
8422
+ #
8423
+ class ServiceResourceId < Struct.new(
8424
+ :name,
8425
+ :value)
8426
+ SENSITIVE = []
8427
+ include Aws::Structure
8428
+ end
8429
+
8430
+ # Specifies the weights for the share identifiers for the fair-share
7733
8431
  # policy. Share identifiers that aren't included have a default weight
7734
8432
  # of `1.0`.
7735
8433
  #
@@ -7971,6 +8669,111 @@ module Aws::Batch
7971
8669
  include Aws::Structure
7972
8670
  end
7973
8671
 
8672
+ # @!attribute [rw] job_name
8673
+ # The name of the service job. It can be up to 128 characters long. It
8674
+ # can contain uppercase and lowercase letters, numbers, hyphens (-),
8675
+ # and underscores (\_).
8676
+ # @return [String]
8677
+ #
8678
+ # @!attribute [rw] job_queue
8679
+ # The job queue into which the service job is submitted. You can
8680
+ # specify either the name or the ARN of the queue. The job queue must
8681
+ # have the type `SAGEMAKER_TRAINING`.
8682
+ # @return [String]
8683
+ #
8684
+ # @!attribute [rw] retry_strategy
8685
+ # The retry strategy to use for failed service jobs that are submitted
8686
+ # with this service job request.
8687
+ # @return [Types::ServiceJobRetryStrategy]
8688
+ #
8689
+ # @!attribute [rw] scheduling_priority
8690
+ # The scheduling priority of the service job. Valid values are
8691
+ # integers between 0 and 9999.
8692
+ # @return [Integer]
8693
+ #
8694
+ # @!attribute [rw] service_request_payload
8695
+ # The request, in JSON, for the service that the SubmitServiceJob
8696
+ # operation is queueing.
8697
+ # @return [String]
8698
+ #
8699
+ # @!attribute [rw] service_job_type
8700
+ # The type of service job. For SageMaker Training jobs, specify
8701
+ # `SAGEMAKER_TRAINING`.
8702
+ # @return [String]
8703
+ #
8704
+ # @!attribute [rw] share_identifier
8705
+ # The share identifier for the service job. Don't specify this
8706
+ # parameter if the job queue doesn't have a fair- share scheduling
8707
+ # policy. If the job queue has a fair-share scheduling policy, then
8708
+ # this parameter must be specified.
8709
+ # @return [String]
8710
+ #
8711
+ # @!attribute [rw] timeout_config
8712
+ # The timeout configuration for the service job. If none is specified,
8713
+ # Batch defers to the default timeout of the underlying service
8714
+ # handling the job.
8715
+ # @return [Types::ServiceJobTimeout]
8716
+ #
8717
+ # @!attribute [rw] tags
8718
+ # The tags that you apply to the service job request. Each tag
8719
+ # consists of a key and an optional value. For more information, see
8720
+ # [Tagging your Batch resources][1].
8721
+ #
8722
+ #
8723
+ #
8724
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
8725
+ # @return [Hash<String,String>]
8726
+ #
8727
+ # @!attribute [rw] client_token
8728
+ # A unique identifier for the request. This token is used to ensure
8729
+ # idempotency of requests. If this parameter is specified and two
8730
+ # submit requests with identical payloads and `clientToken`s are
8731
+ # received, these requests are considered the same request and the
8732
+ # second request is rejected.
8733
+ #
8734
+ # **A suitable default value is auto-generated.** You should normally
8735
+ # not need to pass this option.
8736
+ # @return [String]
8737
+ #
8738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitServiceJobRequest AWS API Documentation
8739
+ #
8740
+ class SubmitServiceJobRequest < Struct.new(
8741
+ :job_name,
8742
+ :job_queue,
8743
+ :retry_strategy,
8744
+ :scheduling_priority,
8745
+ :service_request_payload,
8746
+ :service_job_type,
8747
+ :share_identifier,
8748
+ :timeout_config,
8749
+ :tags,
8750
+ :client_token)
8751
+ SENSITIVE = []
8752
+ include Aws::Structure
8753
+ end
8754
+
8755
+ # @!attribute [rw] job_arn
8756
+ # The Amazon Resource Name (ARN) for the service job.
8757
+ # @return [String]
8758
+ #
8759
+ # @!attribute [rw] job_name
8760
+ # The name of the service job.
8761
+ # @return [String]
8762
+ #
8763
+ # @!attribute [rw] job_id
8764
+ # The unique identifier for the service job.
8765
+ # @return [String]
8766
+ #
8767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitServiceJobResponse AWS API Documentation
8768
+ #
8769
+ class SubmitServiceJobResponse < Struct.new(
8770
+ :job_arn,
8771
+ :job_name,
8772
+ :job_id)
8773
+ SENSITIVE = []
8774
+ include Aws::Structure
8775
+ end
8776
+
7974
8777
  # Contains the parameters for `TagResource`.
7975
8778
  #
7976
8779
  # @!attribute [rw] resource_arn
@@ -8785,6 +9588,29 @@ module Aws::Batch
8785
9588
  #
8786
9589
  class TerminateJobResponse < Aws::EmptyStructure; end
8787
9590
 
9591
+ # @!attribute [rw] job_id
9592
+ # The service job ID of the service job to terminate.
9593
+ # @return [String]
9594
+ #
9595
+ # @!attribute [rw] reason
9596
+ # A message to attach to the service job that explains the reason for
9597
+ # canceling it. This message is returned by `DescribeServiceJob`
9598
+ # operations on the service job.
9599
+ # @return [String]
9600
+ #
9601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateServiceJobRequest AWS API Documentation
9602
+ #
9603
+ class TerminateServiceJobRequest < Struct.new(
9604
+ :job_id,
9605
+ :reason)
9606
+ SENSITIVE = []
9607
+ include Aws::Structure
9608
+ end
9609
+
9610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateServiceJobResponse AWS API Documentation
9611
+ #
9612
+ class TerminateServiceJobResponse < Aws::EmptyStructure; end
9613
+
8788
9614
  # The container path, mount options, and size of the `tmpfs` mount.
8789
9615
  #
8790
9616
  # <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
@@ -9157,6 +9983,12 @@ module Aws::Batch
9157
9983
  # </note>
9158
9984
  # @return [Array<Types::ComputeEnvironmentOrder>]
9159
9985
  #
9986
+ # @!attribute [rw] service_environment_order
9987
+ # The order of the service environment associated with the job queue.
9988
+ # Job queues with a higher priority are evaluated first when
9989
+ # associated with the same service environment.
9990
+ # @return [Array<Types::ServiceEnvironmentOrder>]
9991
+ #
9160
9992
  # @!attribute [rw] job_state_time_limit_actions
9161
9993
  # The set of actions that Batch perform on jobs that remain at the
9162
9994
  # head of the job queue in the specified state longer than specified
@@ -9173,6 +10005,7 @@ module Aws::Batch
9173
10005
  :scheduling_policy_arn,
9174
10006
  :priority,
9175
10007
  :compute_environment_order,
10008
+ :service_environment_order,
9176
10009
  :job_state_time_limit_actions)
9177
10010
  SENSITIVE = []
9178
10011
  include Aws::Structure
@@ -9245,6 +10078,48 @@ module Aws::Batch
9245
10078
  #
9246
10079
  class UpdateSchedulingPolicyResponse < Aws::EmptyStructure; end
9247
10080
 
10081
+ # @!attribute [rw] service_environment
10082
+ # The name or ARN of the service environment to update.
10083
+ # @return [String]
10084
+ #
10085
+ # @!attribute [rw] state
10086
+ # The state of the service environment.
10087
+ # @return [String]
10088
+ #
10089
+ # @!attribute [rw] capacity_limits
10090
+ # The capacity limits for the service environment. This defines the
10091
+ # maximum resources that can be used by service jobs in this
10092
+ # environment.
10093
+ # @return [Array<Types::CapacityLimit>]
10094
+ #
10095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateServiceEnvironmentRequest AWS API Documentation
10096
+ #
10097
+ class UpdateServiceEnvironmentRequest < Struct.new(
10098
+ :service_environment,
10099
+ :state,
10100
+ :capacity_limits)
10101
+ SENSITIVE = []
10102
+ include Aws::Structure
10103
+ end
10104
+
10105
+ # @!attribute [rw] service_environment_name
10106
+ # The name of the service environment that was updated.
10107
+ # @return [String]
10108
+ #
10109
+ # @!attribute [rw] service_environment_arn
10110
+ # The Amazon Resource Name (ARN) of the service environment that was
10111
+ # updated.
10112
+ # @return [String]
10113
+ #
10114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateServiceEnvironmentResponse AWS API Documentation
10115
+ #
10116
+ class UpdateServiceEnvironmentResponse < Struct.new(
10117
+ :service_environment_name,
10118
+ :service_environment_arn)
10119
+ SENSITIVE = []
10120
+ include Aws::Structure
10121
+ end
10122
+
9248
10123
  # A data volume that's used in a job's container properties.
9249
10124
  #
9250
10125
  # @!attribute [rw] host