Skip to content

DataSource

Source code in docs_src/capo_machine_learning/types/data_source.py
class DataSource(TypedDict, closed=True):
    data_source_id: NotRequired["capo_machine_learning.types.entity_id.EntityId"]
    """<p>The ID that is assigned to the <code>DataSource</code> during creation.</p>"""
    data_location_s3: NotRequired["capo_machine_learning.types.s3_url.S3Url"]
    """<p>The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a <code>DataSource</code>.</p>"""
    data_rearrangement: NotRequired[
        "capo_machine_learning.types.data_rearrangement.DataRearrangement"
    ]
    """<p>A JSON string that represents the splitting and rearrangement requirement used when this <code>DataSource</code> was created.</p>"""
    created_by_iam_user: NotRequired[
        "capo_machine_learning.types.aws_user_arn.AwsUserArn"
    ]
    """<p>The AWS user account from which the <code>DataSource</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>"""
    created_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]
    """<p>The time that the <code>DataSource</code> was created. The time is expressed in epoch time.</p>"""
    last_updated_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]
    """<p>The time of the most recent edit to the <code>BatchPrediction</code>. The time is expressed in epoch time.</p>"""
    data_size_in_bytes: NotRequired["capo_machine_learning.types.long_type.LongType"]
    """<p>The total number of observations contained in the data files that the <code>DataSource</code> references.</p>"""
    number_of_files: NotRequired["capo_machine_learning.types.long_type.LongType"]
    """<p>The number of data files referenced by the <code>DataSource</code>.</p>"""
    name: NotRequired["capo_machine_learning.types.entity_name.EntityName"]
    """<p>A user-supplied name or description of the <code>DataSource</code>.</p>"""
    status: NotRequired["capo_machine_learning.types.entity_status.EntityStatus"]
    """<p>The current status of the <code>DataSource</code>. This element can have one of the following values: </p> <ul> <li> <p>PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a <code>DataSource</code>.</p> </li> <li> <p>INPROGRESS - The creation process is underway.</p> </li> <li> <p>FAILED - The request to create a <code>DataSource</code> did not run to completion. It is not usable.</p> </li> <li> <p>COMPLETED - The creation process completed successfully.</p> </li> <li> <p>DELETED - The <code>DataSource</code> is marked as deleted. It is not usable.</p> </li> </ul>"""
    message: NotRequired["capo_machine_learning.types.message.Message"]
    """<p>A description of the most recent details about creating the <code>DataSource</code>.</p>"""
    redshift_metadata: NotRequired[
        "capo_machine_learning.types.redshift_metadata.RedshiftMetadata"
    ]
    rds_metadata: NotRequired["capo_machine_learning.types.rds_metadata.RDSMetadata"]
    role_arn: NotRequired["capo_machine_learning.types.role_arn.RoleARN"]
    compute_statistics: (
        "capo_machine_learning.types.compute_statistics.ComputeStatistics"
    )
    """<p> The parameter is <code>true</code> if statistics need to be generated from the observation data. </p>"""
    compute_time: NotRequired["capo_machine_learning.types.long_type.LongType"]
    finished_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]
    started_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]

compute_statistics instance-attribute

compute_statistics: ComputeStatistics

The parameter is true if statistics need to be generated from the observation data.

compute_time instance-attribute

compute_time: NotRequired[LongType]

created_at instance-attribute

created_at: NotRequired[EpochTime]

The time that the DataSource was created. The time is expressed in epoch time.

created_by_iam_user instance-attribute

created_by_iam_user: NotRequired[AwsUserArn]

The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

data_location_s3 instance-attribute

data_location_s3: NotRequired[S3Url]

The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.

data_rearrangement instance-attribute

data_rearrangement: NotRequired[DataRearrangement]

A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

data_size_in_bytes instance-attribute

data_size_in_bytes: NotRequired[LongType]

The total number of observations contained in the data files that the DataSource references.

data_source_id instance-attribute

data_source_id: NotRequired[EntityId]

The ID that is assigned to the DataSource during creation.

finished_at instance-attribute

finished_at: NotRequired[EpochTime]

last_updated_at instance-attribute

last_updated_at: NotRequired[EpochTime]

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

message instance-attribute

message: NotRequired[Message]

A description of the most recent details about creating the DataSource.

name instance-attribute

name: NotRequired[EntityName]

A user-supplied name or description of the DataSource.

number_of_files instance-attribute

number_of_files: NotRequired[LongType]

The number of data files referenced by the DataSource.

rds_metadata instance-attribute

rds_metadata: NotRequired[RDSMetadata]

redshift_metadata instance-attribute

redshift_metadata: NotRequired[RedshiftMetadata]

role_arn instance-attribute

role_arn: NotRequired[RoleARN]

started_at instance-attribute

started_at: NotRequired[EpochTime]

status instance-attribute

status: NotRequired[EntityStatus]

The current status of the DataSource. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.

  • INPROGRESS - The creation process is underway.

  • FAILED - The request to create a DataSource did not run to completion. It is not usable.

  • COMPLETED - The creation process completed successfully.

  • DELETED - The DataSource is marked as deleted. It is not usable.