Provides the information to create an ML input channel¶

Description¶

Provides the information to create an ML input channel. An ML input channel is the result of a query that can be used for ML modeling.

Usage¶

cleanroomsml_create_ml_input_channel(membershipIdentifier,
  configuredModelAlgorithmAssociations, inputChannel, name,
  retentionInDays, description, kmsKeyArn, tags, payerConfiguration)

Arguments¶

• membershipIdentifier

  [required] The membership ID of the member that is creating the ML input channel.

• configuredModelAlgorithmAssociations

  [required] The associated configured model algorithms that are necessary to create this ML input channel.

• inputChannel

  [required] The input data that is used to create this ML input channel.

• name

  [required] The name of the ML input channel.

• retentionInDays

  [required] The number of days that the data in the ML input channel is retained.

• description

  The description of the ML input channel.

• kmsKeyArn

  The Amazon Resource Name (ARN) of the KMS key that is used to access the input channel.

• tags

  The optional metadata that you apply 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.

• payerConfiguration

  The payer configuration for the ML input channel. Determines which member account pays for compute and synthetic data costs.

Value¶

A list with the following syntax:

list(
  mlInputChannelArn = "string"
)

Request syntax¶

svc$create_ml_input_channel(
  membershipIdentifier = "string",
  configuredModelAlgorithmAssociations = list(
    "string"
  ),
  inputChannel = list(
    dataSource = list(
      protectedQueryInputParameters = list(
        sqlParameters = list(
          queryString = "string",
          analysisTemplateArn = "string",
          parameters = list(
            "string"
          )
        ),
        computeConfiguration = list(
          worker = list(
            type = "CR.1X"|"CR.4X"|"CR.8X",
            number = 123,
            properties = list(
              spark = list(
                "string"
              )
            )
          )
        ),
        resultFormat = "CSV"|"PARQUET"
      )
    ),
    roleArn = "string"
  ),
  name = "string",
  retentionInDays = 123,
  description = "string",
  kmsKeyArn = "string",
  tags = list(
    "string"
  ),
  payerConfiguration = list(
    computePayerAccountId = "string",
    syntheticDataPayerAccountId = "string"
  )
)