CleanRoomsML / Client / get_ml_input_channel

get_ml_input_channel#

CleanRoomsML.Client.get_ml_input_channel(**kwargs)#

Returns information about an ML input channel.

Request Syntax

response = client.get_ml_input_channel(
    mlInputChannelArn='string',
    membershipIdentifier='string'
)

Parameters:

mlInputChannelArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the ML input channel that you want to get.
membershipIdentifier (string) –
[REQUIRED]

The membership ID of the membership 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),
    'membershipIdentifier': 'string',
    'collaborationIdentifier': 'string',
    'inputChannel': {
        'dataSource': {
            'protectedQueryInputParameters': {
                'sqlParameters': {
                    'queryString': 'string',
                    'analysisTemplateArn': 'string',
                    'parameters': {
                        'string': 'string'
                    }
                },
                'computeConfiguration': {
                    'worker': {
                        'type': 'CR.1X'|'CR.4X',
                        'number': 123
                    }
                }
            }
        },
        'roleArn': 'string'
    },
    'protectedQueryIdentifier': '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,
    'numberOfFiles': 123.0,
    'sizeInGb': 123.0,
    'description': 'string',
    'kmsKeyArn': 'string',
    'tags': {
        'string': '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.
- 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.
- inputChannel (dict) –
  
  The input channel that was used to create the ML input channel.
  - dataSource (dict) –
    
    The data source that is used to create the ML input channel.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: protectedQueryInputParameters. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - protectedQueryInputParameters (dict) –
      
      Provides information necessary to perform the protected query.
      - sqlParameters (dict) –
        
        The parameters for the SQL type Protected Query.
        
        queryString (string) –
        
        The query string to be submitted.
        
        analysisTemplateArn (string) –
        
        The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
        
        parameters (dict) –
        
        The protected query SQL parameters.
        
        (string) –
        
        (string) –
      - computeConfiguration (dict) –
        
        Provides configuration information for the workers that will perform the protected query.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: worker. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        worker (dict) –
        
        The worker instances that will perform the compute work.
        
        type (string) –
        
        The instance type of the compute workers that are used.
        
        number (integer) –
        
        The number of compute workers that are used.
  - roleArn (string) –
    
    The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field the input channel.
    
    Passing a role across AWS accounts is not allowed. If you pass a role that isn’t in your account, you get an AccessDeniedException error.
- 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.
- 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 keep the data in the ML input channel.
- numberOfRecords (integer) –
  
  The number of records in the ML input channel.
- numberOfFiles (float) –
  
  The number of files in the ML input channel.
- sizeInGb (float) –
  
  The size, in GB, of the ML input channel.
- description (string) –
  
  The description of the ML input channel.
- kmsKeyArn (string) –
  
  The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.
- tags (dict) –
  
  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.
  - (string) –
    - (string) –

Exceptions

CleanRoomsML.Client.exceptions.ValidationException
CleanRoomsML.Client.exceptions.AccessDeniedException
CleanRoomsML.Client.exceptions.ResourceNotFoundException