CleanRoomsML / Paginator / ListMLInputChannels

ListMLInputChannels#

class CleanRoomsML.Paginator.ListMLInputChannels#

paginator = client.get_paginator('list_ml_input_channels')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from CleanRoomsML.Client.list_ml_input_channels().

Request Syntax

response_iterator = paginator.paginate(
    membershipIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

membershipIdentifier (string) –
[REQUIRED]

The membership ID of the membership that contains the ML input channels that you want to list.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- 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.
- NextToken (string) –
  
  A token to resume pagination.