Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . cleanroomsml ]
get-training-dataset¶
Synopsis¶
get-training-dataset
--training-dataset-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--training-dataset-arn (string)
The Amazon Resource Name (ARN) of the training dataset that you are interested in.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output¶
createTime -> (timestamp)
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 -> (map)
The tags that are assigned to this training dataset.
key -> (string)
value -> (string)
trainingData -> (list)
Metadata about the requested training data.
(structure)
Defines where the training dataset is located, what type of data it contains, and how to access the data.
inputConfig -> (structure)
A DatasetInputConfig object that defines the data source and schema mapping.
dataSource -> (structure)
A DataSource object that specifies the Glue data source for the training data.
glueDataSource -> (structure)
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.
(structure)
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 -> (timestamp)
The most recent time at which the training dataset was updated.