Skip to content

GetDataSourceOutput

Source code in docs_src/capo_machine_learning/types/get_data_source_output.py
class GetDataSourceOutput(TypedDict, closed=True):
    data_source_id: NotRequired["capo_machine_learning.types.entity_id.EntityId"]
    """<p>The ID assigned to the <code>DataSource</code> at creation. This value should be identical to the value of the <code>DataSourceId</code> in the request.</p>"""
    data_location_s3: NotRequired["capo_machine_learning.types.s3_url.S3Url"]
    """<p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</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>DataSource</code>. The time is expressed in epoch time.</p>"""
    data_size_in_bytes: NotRequired["capo_machine_learning.types.long_type.LongType"]
    """<p>The total size of observations in the data files.</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> <code>PENDING</code> - Amazon ML submitted a request to create a <code>DataSource</code>.</p> </li> <li> <p> <code>INPROGRESS</code> - The creation process is underway.</p> </li> <li> <p> <code>FAILED</code> - The request to create a <code>DataSource</code> did not run to completion. It is not usable.</p> </li> <li> <p> <code>COMPLETED</code> - The creation process completed successfully.</p> </li> <li> <p> <code>DELETED</code> - The <code>DataSource</code> is marked as deleted. It is not usable.</p> </li> </ul>"""
    log_uri: NotRequired["capo_machine_learning.types.presigned_s3_url.PresignedS3Url"]
    """<p>A link to the file containing logs of <code>CreateDataSourceFrom*</code> operations.</p>"""
    message: NotRequired["capo_machine_learning.types.message.Message"]
    """<p>The user-supplied 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"]
    """<p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>DataSource</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>DataSource</code> is in the <code>COMPLETED</code> state and the <code>ComputeStatistics</code> is set to true.</p>"""
    finished_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]
    """<p>The epoch time when Amazon Machine Learning marked the <code>DataSource</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>DataSource</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>"""
    started_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]
    """<p>The epoch time when Amazon Machine Learning marked the <code>DataSource</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>DataSource</code> is in the <code>PENDING</code> state.</p>"""
    data_source_schema: NotRequired[
        "capo_machine_learning.types.data_schema.DataSchema"
    ]
    """<p>The schema used by all of the data files of this <code>DataSource</code>.</p> <p> <b>Note:</b> This parameter is provided as part of the verbose format.</p>"""

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]

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource, normalized and scaled on computation resources. ComputeTime is only available if the DataSource is in the COMPLETED state and the ComputeStatistics is set to true.

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 of the data file or directory in Amazon Simple Storage Service (Amazon S3).

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 size of observations in the data files.

data_source_id instance-attribute

data_source_id: NotRequired[EntityId]

The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.

data_source_schema instance-attribute

data_source_schema: NotRequired[DataSchema]

The schema used by all of the data files of this DataSource.

Note: This parameter is provided as part of the verbose format.

finished_at instance-attribute

finished_at: NotRequired[EpochTime]

The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED or FAILED state.

last_updated_at instance-attribute

last_updated_at: NotRequired[EpochTime]

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

log_uri instance-attribute

log_uri: NotRequired[PresignedS3Url]

A link to the file containing logs of CreateDataSourceFrom* operations.

message instance-attribute

message: NotRequired[Message]

The user-supplied 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]

The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. StartedAt isn't available if the DataSource is in the PENDING state.

status instance-attribute

status: NotRequired[EntityStatus]

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

  • PENDING - 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.