# GetMLInputChannel
<a name="API_GetMLInputChannel"></a>

Returns information about an ML input channel.

## Request Syntax
<a name="API_GetMLInputChannel_RequestSyntax"></a>

```
GET /memberships/membershipIdentifier/ml-input-channels/mlInputChannelArn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetMLInputChannel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [membershipIdentifier](#API_GetMLInputChannel_RequestSyntax) **   <a name="API-GetMLInputChannel-request-uri-membershipIdentifier"></a>
The membership ID of the membership that contains the ML input channel that you want to get.  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** [mlInputChannelArn](#API_GetMLInputChannel_RequestSyntax) **   <a name="API-GetMLInputChannel-request-uri-mlInputChannelArn"></a>
The Amazon Resource Name (ARN) of the ML input channel that you want to get.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ml-input-channel/[-a-zA-Z0-9_/.]+`   
Required: Yes

## Request Body
<a name="API_GetMLInputChannel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetMLInputChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "collaborationIdentifier": "string",
   "configuredModelAlgorithmAssociations": [ "string" ],
   "createTime": "string",
   "description": "string",
   "inputChannel": { 
      "dataSource": { ... },
      "roleArn": "string"
   },
   "kmsKeyArn": "string",
   "membershipIdentifier": "string",
   "mlInputChannelArn": "string",
   "name": "string",
   "numberOfFiles": number,
   "numberOfRecords": number,
   "privacyBudgets": { ... },
   "protectedQueryIdentifier": "string",
   "retentionInDays": number,
   "sizeInGb": number,
   "status": "string",
   "statusDetails": { 
      "message": "string",
      "statusCode": "string"
   },
   "syntheticDataConfiguration": { 
      "syntheticDataEvaluationScores": { 
         "dataPrivacyScores": { 
            "membershipInferenceAttackScores": [ 
               { 
                  "attackVersion": "string",
                  "score": number
               }
            ]
         }
      },
      "syntheticDataParameters": { 
         "columnClassification": { 
            "columnMapping": [ 
               { 
                  "columnName": "string",
                  "columnType": "string",
                  "isPredictiveValue": boolean
               }
            ]
         },
         "epsilon": number,
         "maxMembershipInferenceAttackScore": number
      }
   },
   "tags": { 
      "string" : "string" 
   },
   "updateTime": "string"
}
```

## Response Elements
<a name="API_GetMLInputChannel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [collaborationIdentifier](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-collaborationIdentifier"></a>
The collaboration ID of the collaboration that contains the ML input channel.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

 ** [configuredModelAlgorithmAssociations](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-configuredModelAlgorithmAssociations"></a>
The configured model algorithm associations that were used to create the ML input channel.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/configured-model-algorithm-association/[-a-zA-Z0-9_/.]+` 

 ** [createTime](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-createTime"></a>
The time at which the ML input channel was created.  
Type: Timestamp

 ** [description](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-description"></a>
The description of the ML input channel.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` 

 ** [inputChannel](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-inputChannel"></a>
The input channel that was used to create the ML input channel.  
Type: [InputChannel](API_InputChannel.md) object

 ** [kmsKeyArn](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-kmsKeyArn"></a>
The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+` 

 ** [membershipIdentifier](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-membershipIdentifier"></a>
The membership ID of the membership that contains the ML input channel.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

 ** [mlInputChannelArn](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-mlInputChannelArn"></a>
The Amazon Resource Name (ARN) of the ML input channel.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ml-input-channel/[-a-zA-Z0-9_/.]+` 

 ** [name](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-name"></a>
The name of the ML input channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` 

 ** [numberOfFiles](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-numberOfFiles"></a>
The number of files in the ML input channel.  
Type: Double  
Valid Range: Minimum value of 0. Maximum value of 1000000.

 ** [numberOfRecords](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-numberOfRecords"></a>
The number of records in the ML input channel.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 100000000000.

 ** [privacyBudgets](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-privacyBudgets"></a>
Returns the privacy budgets that control access to this Clean Rooms ML input channel. Use these budgets to monitor and limit resource consumption over specified time periods.  
Type: [PrivacyBudgets](API_PrivacyBudgets.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [protectedQueryIdentifier](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-protectedQueryIdentifier"></a>
The ID of the protected query that was used to create the ML input channel.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

 ** [retentionInDays](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-retentionInDays"></a>
The number of days to keep the data in the ML input channel.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 30.

 ** [sizeInGb](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-sizeInGb"></a>
The size, in GB, of the ML input channel.  
Type: Double  
Valid Range: Minimum value of 0. Maximum value of 1000000.

 ** [status](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-status"></a>
The status of the ML input channel.  
Type: String  
Valid Values: `CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_PENDING | DELETE_IN_PROGRESS | DELETE_FAILED | INACTIVE` 

 ** [statusDetails](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-statusDetails"></a>
Details about the status of a resource.  
Type: [StatusDetails](API_StatusDetails.md) object

 ** [syntheticDataConfiguration](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-syntheticDataConfiguration"></a>
The synthetic data configuration for this ML input channel, including parameters for generating privacy-preserving synthetic data and evaluation scores for measuring the privacy of the generated data.  
Type: [SyntheticDataConfiguration](API_SyntheticDataConfiguration.md) object

 ** [tags](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-tags"></a>
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: \$1 - = . \$1 : / @.
+ 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.
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [updateTime](#API_GetMLInputChannel_ResponseSyntax) **   <a name="API-GetMLInputChannel-response-updateTime"></a>
The most recent time at which the ML input channel was updated.  
Type: Timestamp

## Errors
<a name="API_GetMLInputChannel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The resource you are requesting does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The request parameters for this request are incorrect.  
HTTP Status Code: 400

## See Also
<a name="API_GetMLInputChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanroomsml-2023-09-06/GetMLInputChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanroomsml-2023-09-06/GetMLInputChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanroomsml-2023-09-06/GetMLInputChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanroomsml-2023-09-06/GetMLInputChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanroomsml-2023-09-06/GetMLInputChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanroomsml-2023-09-06/GetMLInputChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanroomsml-2023-09-06/GetMLInputChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanroomsml-2023-09-06/GetMLInputChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanroomsml-2023-09-06/GetMLInputChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanroomsml-2023-09-06/GetMLInputChannel)