CleanRoomsML / Client / list_ml_input_channels

list_ml_input_channels#

CleanRoomsML.Client.list_ml_input_channels(**kwargs)#

Returns a list of ML input channels.

See also: AWS API Documentation

Request Syntax

response = client.list_ml_input_channels(
    nextToken='string',
    maxResults=123,
    membershipIdentifier='string'
)
Parameters:

  • nextToken (string) – The token value retrieved from a previous call to access the next page of results.

  • maxResults (integer) – The maximum number of ML input channels to return.

  • membershipIdentifier (string) –

    [REQUIRED]

    The membership ID of the membership that contains the ML input channels that you want to list.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'mlInputChannelsList': [
        {
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'membershipIdentifier': 'string',
            'collaborationIdentifier': 'string',
            'name': 'string',
            'configuredModelAlgorithmAssociations': [
                'string',
            ],
            'protectedQueryIdentifier': 'string',
            'mlInputChannelArn': 'string',
            'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'INACTIVE',
            'description': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The token value used to access the next page of results.

    • mlInputChannelsList (list) –

      The list of ML input channels that you wanted.

      • (dict) –

        Provides summary information about the ML input channel.

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

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

        • name (string) –

          The name of the ML input channel.

        • configuredModelAlgorithmAssociations (list) –

          The associated configured model algorithms used to create the ML input channel.

          • (string) –

        • protectedQueryIdentifier (string) –

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

        • mlInputChannelArn (string) –

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

        • status (string) –

          The status of the ML input channel.

        • description (string) –

          The description of the ML input channel.

Exceptions