CleanRoomsML / Client / get_configured_model_algorithm_association

get_configured_model_algorithm_association#

CleanRoomsML.Client.get_configured_model_algorithm_association(**kwargs)#

Returns information about a configured model algorithm association.

Request Syntax

response = client.get_configured_model_algorithm_association(
    configuredModelAlgorithmAssociationArn='string',
    membershipIdentifier='string'
)

Parameters:

configuredModelAlgorithmAssociationArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the configured model algorithm association that you want to return information about.
membershipIdentifier (string) –
[REQUIRED]

The membership ID of the member that created the configured model algorithm association.

Return type:

dict

Returns:

Response Syntax

{
    'createTime': datetime(2015, 1, 1),
    'updateTime': datetime(2015, 1, 1),
    'configuredModelAlgorithmAssociationArn': 'string',
    'membershipIdentifier': 'string',
    'collaborationIdentifier': 'string',
    'configuredModelAlgorithmArn': 'string',
    'name': 'string',
    'privacyConfiguration': {
        'policies': {
            'trainedModels': {
                'containerLogs': [
                    {
                        'allowedAccountIds': [
                            'string',
                        ],
                        'filterPattern': 'string'
                    },
                ],
                'containerMetrics': {
                    'noiseLevel': 'HIGH'|'MEDIUM'|'LOW'|'NONE'
                }
            },
            'trainedModelExports': {
                'maxSize': {
                    'unit': 'GB',
                    'value': 123.0
                },
                'filesToExport': [
                    'MODEL'|'OUTPUT',
                ]
            },
            'trainedModelInferenceJobs': {
                'containerLogs': [
                    {
                        'allowedAccountIds': [
                            'string',
                        ],
                        'filterPattern': 'string'
                    },
                ],
                'maxOutputSize': {
                    'unit': 'GB',
                    'value': 123.0
                }
            }
        }
    },
    'description': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- createTime (datetime) –
  
  The time at which the configured model algorithm association was created.
- updateTime (datetime) –
  
  The most recent time at which the configured model algorithm association was updated.
- configuredModelAlgorithmAssociationArn (string) –
  
  The Amazon Resource Name (ARN) of the configured model algorithm association.
- membershipIdentifier (string) –
  
  The membership ID of the member that created the configured model algorithm association.
- collaborationIdentifier (string) –
  
  The collaboration ID of the collaboration that contains the configured model algorithm association.
- configuredModelAlgorithmArn (string) –
  
  The Amazon Resource Name (ARN) of the configured model algorithm that was associated to the collaboration.
- name (string) –
  
  The name of the configured model algorithm association.
- privacyConfiguration (dict) –
  
  The privacy configuration information for the configured model algorithm association.
  - policies (dict) –
    
    The privacy configuration policies for a configured model algorithm association.
    - trainedModels (dict) –
      
      Specifies who will receive the trained models.
      - containerLogs (list) –
        
        The container for the logs of the trained model.
        
        (dict) –
        
        Provides the information necessary for a user to access the logs.
        
        allowedAccountIds (list) –
        
        A list of account IDs that are allowed to access the logs.
        
        (string) –
        
        filterPattern (string) –
        
        A regular expression pattern that is used to parse the logs and return information that matches the pattern.
      - containerMetrics (dict) –
        
        The container for the metrics of the trained model.
        
        noiseLevel (string) –
        
        The noise level for the generated metrics.
    - trainedModelExports (dict) –
      
      Specifies who will receive the trained model export.
      - maxSize (dict) –
        
        The maximum size of the data that can be exported.
        
        unit (string) –
        
        The unit of measurement for the data size.
        
        value (float) –
        
        The maximum size of the dataset to export.
      - filesToExport (list) –
        
        The files that are exported during the trained model export job.
        
        (string) –
    - trainedModelInferenceJobs (dict) –
      
      Specifies who will receive the trained model inference jobs.
      - containerLogs (list) –
        
        The logs container for the trained model inference job.
        
        (dict) –
        
        Provides the information necessary for a user to access the logs.
        
        allowedAccountIds (list) –
        
        A list of account IDs that are allowed to access the logs.
        
        (string) –
        
        filterPattern (string) –
        
        A regular expression pattern that is used to parse the logs and return information that matches the pattern.
      - maxOutputSize (dict) –
        
        The maximum allowed size of the output of the trained model inference job.
        
        unit (string) –
        
        The measurement unit to use.
        
        value (float) –
        
        The maximum output size value.
- description (string) –
  
  The description of the configured model algorithm association.
- 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