CleanRoomsML / Client / get_collaboration_ml_input_channel

get_collaboration_ml_input_channel#

CleanRoomsML.Client.get_collaboration_ml_input_channel(**kwargs)#

Returns information about a specific ML input channel in a collaboration.

See also: AWS API Documentation

Request Syntax

response = client.get_collaboration_ml_input_channel(
    mlInputChannelArn='string',
    collaborationIdentifier='string'
)
Parameters:

  • mlInputChannelArn (string) –

    [REQUIRED]

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

  • collaborationIdentifier (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'createTime': datetime(2015, 1, 1),
    'updateTime': datetime(2015, 1, 1),
    'creatorAccountId': 'string',
    'membershipIdentifier': 'string',
    'collaborationIdentifier': 'string',
    'mlInputChannelArn': 'string',
    'name': 'string',
    'configuredModelAlgorithmAssociations': [
        'string',
    ],
    'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'INACTIVE',
    'statusDetails': {
        'statusCode': 'string',
        'message': 'string'
    },
    'retentionInDays': 123,
    'numberOfRecords': 123,
    'description': 'string'
}

Response Structure

  • (dict) –

    • createTime (datetime) –

      The time at which the ML input channel was created.

    • updateTime (datetime) –

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

    • creatorAccountId (string) –

      The account ID of the member who created the ML input channel.

    • 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 (dict) –

      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 retain the data for the ML input channel.

    • numberOfRecords (integer) –

      The number of records in the ML input channel.

    • description (string) –

      The description of the ML input channel.

Exceptions