Skip to content

CreateJobRequest

Source code in docs_src/capo_sagemaker/types/create_job_request.py
class CreateJobRequest(TypedDict, closed=True):
    job_name: NotRequired["capo_sagemaker.types.job_name.JobName"]
    """<p>The name of the job. The name must be unique within your account and Amazon Web Services Region.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration.</p>"""
    job_category: NotRequired["capo_sagemaker.types.job_category.JobCategory"]
    """<p>The category of the job. The category determines the type of workload that the job runs.</p>"""
    job_config_schema_version: NotRequired[
        "capo_sagemaker.types.job_schema_version.JobSchemaVersion"
    ]
    """<p>The version of the configuration schema to use for the job configuration document. Use <code>ListJobSchemaVersions</code> to get available schema versions for a job category.</p>"""
    job_config_document: NotRequired[
        "capo_sagemaker.types.job_config_document.JobConfigDocument"
    ]
    """<p>The JSON configuration document for the job. The document must conform to the schema specified by <code>JobConfigSchemaVersion</code>. Use <code>DescribeJobSchemaVersion</code> to retrieve the schema for validation.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>An array of key-value pairs to apply to the job as tags. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>"""

job_category instance-attribute

job_category: NotRequired[JobCategory]

The category of the job. The category determines the type of workload that the job runs.

job_config_document instance-attribute

job_config_document: NotRequired[JobConfigDocument]

The JSON configuration document for the job. The document must conform to the schema specified by JobConfigSchemaVersion. Use DescribeJobSchemaVersion to retrieve the schema for validation.

job_config_schema_version instance-attribute

job_config_schema_version: NotRequired[JobSchemaVersion]

The version of the configuration schema to use for the job configuration document. Use ListJobSchemaVersions to get available schema versions for a job category.

job_name instance-attribute

job_name: NotRequired[JobName]

The name of the job. The name must be unique within your account and Amazon Web Services Region.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration.

tags instance-attribute

tags: NotRequired[TagList]

An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.