CleanRoomsML / Client / get_training_dataset

get_training_dataset

CleanRoomsML.Client.get_training_dataset(**kwargs)

Returns information about a training dataset.

See also: AWS API Documentation

Request Syntax

response = client.get_training_dataset(
    trainingDatasetArn='string'
)

Parameters:

trainingDatasetArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the training dataset that you are interested in.

Return type:

dict

Returns:

Response Syntax

{
    'createTime': datetime(2015, 1, 1),
    'description': 'string',
    'name': 'string',
    'roleArn': 'string',
    'status': 'ACTIVE',
    'tags': {
        'string': 'string'
    },
    'trainingData': [
        {
            'inputConfig': {
                'dataSource': {
                    'glueDataSource': {
                        'catalogId': 'string',
                        'databaseName': 'string',
                        'tableName': 'string'
                    }
                },
                'schema': [
                    {
                        'columnName': 'string',
                        'columnTypes': [
                            'USER_ID'|'ITEM_ID'|'TIMESTAMP'|'CATEGORICAL_FEATURE'|'NUMERICAL_FEATURE',
                        ]
                    },
                ]
            },
            'type': 'INTERACTIONS'
        },
    ],
    'trainingDatasetArn': 'string',
    'updateTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • createTime (datetime) –

    The time at which the training dataset was created.

  • description (string) –

    The description of the training dataset.

  • name (string) –

    The name of the training dataset.

  • roleArn (string) –

    The IAM role used to read the training data.

  • status (string) –

    The status of the training dataset.

  • tags (dict) –

    The tags that are assigned to this training dataset.

    • (string) –

      • (string) –

  • trainingData (list) –

    Metadata about the requested training data.

    • (dict) –

      Defines where the training dataset is located, what type of data it contains, and how to access the data.

      • inputConfig (dict) –

        A DatasetInputConfig object that defines the data source and schema mapping.

        • dataSource (dict) –

          A DataSource object that specifies the Glue data source for the training data.

          • glueDataSource (dict) –

            A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.

            • catalogId (string) –

              The Glue catalog that contains the training data.

            • databaseName (string) –

              The Glue database that contains the training data.

            • tableName (string) –

              The Glue table that contains the training data.

        • schema (list) –

          The schema information for the training data.

          • (dict) –

            Metadata for a column.

            • columnName (string) –

              The name of a column.

            • columnTypes (list) –

              The data type of column.

              • (string) –

      • type (string) –

        What type of information is found in the dataset.

  • trainingDatasetArn (string) –

    The Amazon Resource Name (ARN) of the training dataset.

  • updateTime (datetime) –

    The most recent time at which the training dataset was updated.

Exceptions

• CleanRoomsML.Client.exceptions.ValidationException

• CleanRoomsML.Client.exceptions.AccessDeniedException

• CleanRoomsML.Client.exceptions.ResourceNotFoundException