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-ml-input-channel

Description

Returns information about an ML input channel.

See also: AWS API Documentation

Synopsis

  get-ml-input-channel
--ml-input-channel-arn <value>
--membership-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

--ml-input-channel-arn (string)

The Amazon Resource Name (ARN) of the ML input channel that you want to get.

--membership-identifier (string)

The membership ID of the membership that contains the ML input channel that you want to get.

--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 membership that contains the ML input channel.

collaborationIdentifier -> (string)

The collaboration ID of the collaboration that contains the ML input channel.

mlInputChannelArn -> (string)

The Amazon Resource Name (ARN) of the ML input channel.

name -> (string)

The name of the ML input channel.

configuredModelAlgorithmAssociations -> (list)

The configured model algorithm associations that were used to create the ML input channel.

(string)

status -> (string)

The status of the ML input channel.

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.

retentionInDays -> (integer)

The number of days to keep the data in the ML input channel.

numberOfRecords -> (long)

The number of records in the ML input channel.

privacyBudgets -> (tagged union structure)

Returns the privacy budgets that control access to this Clean Rooms ML input channel. Use these budgets to monitor and limit resource consumption over specified time periods.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: accessBudgets.

accessBudgets -> (list)

A list of access budgets that apply to resources associated with this Clean Rooms ML input channel.

(structure)

An access budget that defines consumption limits for a specific resource within defined time periods.

resourceArn -> (string)

The Amazon Resource Name (ARN) of the resource that this access budget applies to.

details -> (list)

A list of budget details for this resource. Contains active budget periods that apply to the resource.

(structure)

The detailed information for a specific budget period, including time boundaries and budget amounts.

startTime -> (timestamp)

The start time of this budget period.

endTime -> (timestamp)

The end time of this budget period. If not specified, the budget period continues indefinitely.

remainingBudget -> (integer)

The amount of budget remaining in this period.

budget -> (integer)

The total budget amount allocated for this period.

budgetType -> (string)

The type of budget period. Calendar-based types reset automatically at regular intervals, while LIFETIME budgets never reset.

autoRefresh -> (string)

Specifies whether this budget automatically refreshes when the current period ends.

aggregateRemainingBudget -> (integer)

The total remaining budget across all active budget periods for this resource.

description -> (string)

The description of the ML input channel.

syntheticDataConfiguration -> (structure)

The synthetic data configuration for this ML input channel, including parameters for generating privacy-preserving synthetic data and evaluation scores for measuring the privacy of the generated data.

syntheticDataParameters -> (structure)

The parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process.

epsilon -> (double)

The epsilon value for differential privacy, which controls the privacy-utility tradeoff in synthetic data generation. Lower values provide stronger privacy guarantees but may reduce data utility.

maxMembershipInferenceAttackScore -> (double)

The maximum acceptable score for membership inference attack vulnerability. Synthetic data generation fails if the score for the resulting data exceeds this threshold.

columnClassification -> (structure)

Classification details for data columns that specify how each column should be treated during synthetic data generation.

columnMapping -> (list)

A mapping that defines the classification of data columns for synthetic data generation and specifies how each column should be handled during the privacy-preserving data synthesis process.

(structure)

Properties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling.

columnName -> (string)

The name of the data column as it appears in the dataset.

columnType -> (string)

The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.

isPredictiveValue -> (boolean)

Indicates if this column contains predictive values that should be treated as target variables in machine learning models. This affects how the synthetic data generation preserves statistical relationships.

syntheticDataEvaluationScores -> (structure)

Evaluation scores that assess the quality and privacy characteristics of the generated synthetic data, providing metrics on data utility and privacy preservation.

dataPrivacyScores -> (structure)

Privacy-specific evaluation scores that measure how well the synthetic data protects individual privacy, including assessments of potential privacy risks such as membership inference attacks.

membershipInferenceAttackScores -> (list)

Scores that evaluate the vulnerability of the synthetic data to membership inference attacks, which attempt to determine whether a specific individual was a member of the original dataset.

(structure)

A score that measures the vulnerability of synthetic data to membership inference attacks and provides both the numerical score and the version of the attack methodology used for evaluation.

attackVersion -> (string)

The version of the membership inference attack, which consists of the attack type and its version number, used to generate this privacy score.

score -> (double)

The numerical score representing the vulnerability to membership inference attacks.

createTime -> (timestamp)

The time at which the ML input channel was created.

updateTime -> (timestamp)

The most recent time at which the ML input channel was updated.

inputChannel -> (structure)

The input channel that was used to create the ML input channel.

dataSource -> (tagged union structure)

The data source that is used to create the ML input channel.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: protectedQueryInputParameters.

protectedQueryInputParameters -> (structure)

Provides information necessary to perform the protected query.

sqlParameters -> (structure)

The parameters for the SQL type Protected Query.

queryString -> (string)

The query string to be submitted.

analysisTemplateArn -> (string)

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

parameters -> (map)

The protected query SQL parameters.

key -> (string)

value -> (string)

computeConfiguration -> (tagged union structure)

Provides configuration information for the workers that will perform the protected query.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: worker.

worker -> (structure)

The worker instances that will perform the compute work.

type -> (string)

The instance type of the compute workers that are used.

number -> (integer)

The number of compute workers that are used.

resultFormat -> (string)

The format in which the query results should be returned. If not specified, defaults to CSV .

roleArn -> (string)

The Amazon Resource Name (ARN) of the role used to run the query specified in the dataSource field of the input channel.

Passing a role across AWS accounts is not allowed. If you pass a role that isn’t in your account, you get an AccessDeniedException error.

protectedQueryIdentifier -> (string)

The ID of the protected query that was used to create the ML input channel.

numberOfFiles -> (double)

The number of files in the ML input channel.

sizeInGb -> (double)

The size, in GB, of the ML input channel.

kmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.

tags -> (map)

The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8.
  • Maximum value length - 256 Unicode characters in UTF-8.
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

key -> (string)

value -> (string)