GetTrainingDataset - AWS Clean Rooms ML
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetTrainingDataset

Returns information about a training dataset.

Request Syntax

GET /training-dataset/trainingDatasetArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

trainingDatasetArn

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:training-dataset/[-a-zA-Z0-9_/.]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "createTime": "string",
   "description": "string",
   "name": "string",
   "roleArn": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "trainingData": [ 
      { 
         "inputConfig": { 
            "dataSource": { 
               "glueDataSource": { 
                  "catalogId": "string",
                  "databaseName": "string",
                  "tableName": "string"
               }
            },
            "schema": [ 
               { 
                  "columnName": "string",
                  "columnTypes": [ "string" ]
               }
            ]
         },
         "type": "string"
      }
   ],
   "trainingDatasetArn": "string",
   "updateTime": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createTime

The time at which the training dataset was created.

Type: Timestamp

description

The description of the training dataset.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

name

The name of the training dataset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

roleArn

The IAM role used to read the training data.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:iam::[0-9]{12}:role/.+

status

The status of the training dataset.

Type: String

Valid Values: ACTIVE

tags

The tags that are assigned to this training dataset.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

trainingData

Metadata about the requested training data.

Type: Array of Dataset objects

trainingDatasetArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:training-dataset/[-a-zA-Z0-9_/.]+

updateTime

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The resource you are requesting does not exist.

HTTP Status Code: 404

ValidationException

The request parameters for this request are incorrect.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: