Skip to content

GetMLInputChannelResponse

Source code in docs_src/capo_cleanroomsml/types/get_ml_input_channel_response.py
class GetMLInputChannelResponse(TypedDict, closed=True):
    membership_identifier: "capo_cleanroomsml.types.uuid.UUID"
    """<p>The membership ID of the membership that contains the ML input channel.</p>"""
    collaboration_identifier: "capo_cleanroomsml.types.uuid.UUID"
    """<p>The collaboration ID of the collaboration that contains the ML input channel.</p>"""
    ml_input_channel_arn: (
        "capo_cleanroomsml.types.ml_input_channel_arn.MLInputChannelArn"
    )
    """<p>The Amazon Resource Name (ARN) of the ML input channel.</p>"""
    name: "capo_cleanroomsml.types.name_string.NameString"
    """<p>The name of the ML input channel.</p>"""
    configured_model_algorithm_associations: "capo_cleanroomsml.types.configured_model_algorithm_association_arn_list.ConfiguredModelAlgorithmAssociationArnList"
    """<p>The configured model algorithm associations that were used to create the ML input channel.</p>"""
    status: "capo_cleanroomsml.types.ml_input_channel_status.MLInputChannelStatus"
    """<p>The status of the ML input channel.</p>"""
    status_details: NotRequired["capo_cleanroomsml.types.status_details.StatusDetails"]
    retention_in_days: "int"
    """<p>The number of days to keep the data in the ML input channel.</p>"""
    number_of_records: NotRequired["int"]
    """<p>The number of records in the ML input channel.</p>"""
    privacy_budgets: NotRequired[
        "capo_cleanroomsml.types.privacy_budgets.PrivacyBudgets"
    ]
    """<p>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.</p>"""
    description: NotRequired[
        "capo_cleanroomsml.types.resource_description.ResourceDescription"
    ]
    """<p>The description of the ML input channel.</p>"""
    synthetic_data_configuration: NotRequired[
        "capo_cleanroomsml.types.synthetic_data_configuration.SyntheticDataConfiguration"
    ]
    """<p>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.</p>"""
    payer_configuration: NotRequired[
        "capo_cleanroomsml.types.payer_configuration.PayerConfiguration"
    ]
    """<p>The payer configuration for the ML input channel.</p>"""
    create_time: "datetime.datetime"
    """<p>The time at which the ML input channel was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The most recent time at which the ML input channel was updated.</p>"""
    input_channel: "capo_cleanroomsml.types.input_channel.InputChannel"
    """<p>The input channel that was used to create the ML input channel.</p>"""
    protected_query_identifier: NotRequired["capo_cleanroomsml.types.uuid.UUID"]
    """<p>The ID of the protected query that was used to create the ML input channel.</p>"""
    number_of_files: NotRequired["float"]
    """<p>The number of files in the ML input channel.</p>"""
    size_in_gb: NotRequired["float"]
    """<p>The size, in GB, of the ML input channel.</p>"""
    kms_key_arn: NotRequired["capo_cleanroomsml.types.kms_key_arn.KmsKeyArn"]
    """<p>The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.</p>"""
    tags: NotRequired["capo_cleanroomsml.types.tag_map.TagMap"]
    """<p>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.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>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: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>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.</p> </li> </ul>"""

collaboration_identifier instance-attribute

collaboration_identifier: UUID

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

configured_model_algorithm_associations instance-attribute

configured_model_algorithm_associations: ConfiguredModelAlgorithmAssociationArnList

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

create_time instance-attribute

create_time: datetime

The time at which the ML input channel was created.

description instance-attribute

description: NotRequired[ResourceDescription]

The description of the ML input channel.

input_channel instance-attribute

input_channel: InputChannel

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

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

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

membership_identifier instance-attribute

membership_identifier: UUID

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

ml_input_channel_arn instance-attribute

ml_input_channel_arn: MLInputChannelArn

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

name instance-attribute

name: NameString

The name of the ML input channel.

number_of_files instance-attribute

number_of_files: NotRequired[float]

The number of files in the ML input channel.

number_of_records instance-attribute

number_of_records: NotRequired[int]

The number of records in the ML input channel.

payer_configuration instance-attribute

payer_configuration: NotRequired[PayerConfiguration]

The payer configuration for the ML input channel.

privacy_budgets instance-attribute

privacy_budgets: NotRequired[PrivacyBudgets]

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.

protected_query_identifier instance-attribute

protected_query_identifier: NotRequired[UUID]

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

retention_in_days instance-attribute

retention_in_days: int

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

size_in_gb instance-attribute

size_in_gb: NotRequired[float]

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

status instance-attribute

The status of the ML input channel.

status_details instance-attribute

status_details: NotRequired[StatusDetails]

synthetic_data_configuration instance-attribute

synthetic_data_configuration: NotRequired[SyntheticDataConfiguration]

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.

tags instance-attribute

tags: NotRequired[TagMap]

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.

update_time instance-attribute

update_time: datetime

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