AWS CLI Command Reference

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-collaboration-trained-model

Description

Returns information about a trained model in a collaboration.

See also: AWS API Documentation

Synopsis

  get-collaboration-trained-model
--trained-model-arn <value>
--collaboration-identifier <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

--trained-model-arn (string)

The Amazon Resource Name (ARN) of the trained model that you want to return information about.

--collaboration-identifier (string)

The collaboration ID that contains the trained model that you want to return information about.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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

membershipIdentifier -> (string)

The membership ID of the member that created the trained model.

collaborationIdentifier -> (string)

The collaboration ID of the collaboration that contains the trained model.

trainedModelArn -> (string)

The Amazon Resource Name (ARN) of the trained model.

name -> (string)

The name of the trained model.

description -> (string)

The description of the trained model.

status -> (string)

The status of the trained model.

statusDetails -> (structure)

Details about the status of a resource.

statusCode -> (string)

The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.

message -> (string)

The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling.

configuredModelAlgorithmAssociationArn -> (string)

The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.

resourceConfig -> (structure)

The EC2 resource configuration that was used to train this model.

instanceCount -> (integer)

The number of resources that are used to train the model.

instanceType -> (string)

The instance type that is used to train the model.

volumeSizeInGB -> (integer)

The maximum size of the instance that is used to train the model.

stoppingCondition -> (structure)

The stopping condition that determined when model training ended.

maxRuntimeInSeconds -> (integer)

The maximum amount of time, in seconds, that model training can run before it is terminated.

metricsStatus -> (string)

The status of the model metrics.

metricsStatusDetails -> (string)

Details about the status information for the model metrics.

logsStatus -> (string)

Status information for the logs.

logsStatusDetails -> (string)

Details about the status information for the logs.

trainingContainerImageDigest -> (string)

Information about the training container image.

createTime -> (timestamp)

The time at which the trained model was created.

updateTime -> (timestamp)

The most recent time at which the trained model was updated.

creatorAccountId -> (string)

The account ID of the member that created the trained model.