Skip to content

SubmitServiceJobRequest

Source code in docs_src/capo_batch/types/submit_service_job_request.py
class SubmitServiceJobRequest(TypedDict, closed=True):
    job_name: NotRequired["capo_batch.types.string.String"]
    """<p>The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>"""
    job_queue: NotRequired["capo_batch.types.string.String"]
    """<p>The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type <code>SAGEMAKER_TRAINING</code>.</p>"""
    retry_strategy: NotRequired[
        "capo_batch.types.service_job_retry_strategy.ServiceJobRetryStrategy"
    ]
    """<p>The retry strategy to use for failed service jobs that are submitted with this service job request. </p>"""
    scheduling_priority: NotRequired["capo_batch.types.integer.Integer"]
    """<p>The scheduling priority of the service job. Valid values are integers between 0 and 9999.</p>"""
    service_request_payload: NotRequired["capo_batch.types.string.String"]
    """<p>The request, in JSON, for the service that the SubmitServiceJob operation is queueing. </p>"""
    service_job_type: NotRequired["capo_batch.types.service_job_type.ServiceJobType"]
    """<p>The type of service job. For SageMaker Training jobs, specify <code>SAGEMAKER_TRAINING</code>.</p>"""
    share_identifier: NotRequired["capo_batch.types.string.String"]
    """<p>The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.</p>"""
    quota_share_name: NotRequired["capo_batch.types.string.String"]
    """<p>The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.</p>"""
    preemption_configuration: NotRequired[
        "capo_batch.types.service_job_preemption_configuration.ServiceJobPreemptionConfiguration"
    ]
    """<p>Specifies the service job behavior when preempted.</p>"""
    timeout_config: NotRequired[
        "capo_batch.types.service_job_timeout.ServiceJobTimeout"
    ]
    """<p>The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.</p>"""
    tags: NotRequired["capo_batch.types.tagris_tags_map.TagrisTagsMap"]
    """<p>The tags that you apply to the service job request. 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>.</p>"""
    client_token: NotRequired[
        "capo_batch.types.client_request_token.ClientRequestToken"
    ]
    """<p>A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and <code>clientToken</code>s are received, these requests are considered the same request and the second request is rejected.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientRequestToken]

A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected.

job_name instance-attribute

job_name: NotRequired[String]

The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

job_queue instance-attribute

job_queue: NotRequired[String]

The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING.

preemption_configuration instance-attribute

preemption_configuration: NotRequired[ServiceJobPreemptionConfiguration]

Specifies the service job behavior when preempted.

quota_share_name instance-attribute

quota_share_name: NotRequired[String]

The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.

retry_strategy instance-attribute

retry_strategy: NotRequired[ServiceJobRetryStrategy]

The retry strategy to use for failed service jobs that are submitted with this service job request.

scheduling_priority instance-attribute

scheduling_priority: NotRequired[Integer]

The scheduling priority of the service job. Valid values are integers between 0 and 9999.

service_job_type instance-attribute

service_job_type: NotRequired[ServiceJobType]

The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

service_request_payload instance-attribute

service_request_payload: NotRequired[String]

The request, in JSON, for the service that the SubmitServiceJob operation is queueing.

share_identifier instance-attribute

share_identifier: NotRequired[String]

The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.

tags instance-attribute

tags: NotRequired[TagrisTagsMap]

The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

timeout_config instance-attribute

timeout_config: NotRequired[ServiceJobTimeout]

The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.