GetCollaborationMLInputChannel
Returns information about a specific ML input channel in a collaboration.
Request Syntax
GET /collaborations/collaborationIdentifier/ml-input-channels/mlInputChannelArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- collaborationIdentifier
-
The collaboration ID of the collaboration 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
-
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
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"collaborationIdentifier": "string",
"configuredModelAlgorithmAssociations": [ "string" ],
"createTime": "string",
"creatorAccountId": "string",
"description": "string",
"membershipIdentifier": "string",
"mlInputChannelArn": "string",
"name": "string",
"numberOfRecords": number,
"retentionInDays": number,
"status": "string",
"statusDetails": {
"message": "string",
"statusCode": "string"
},
"updateTime": "string"
}Response Elements
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
-
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
-
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
-
The time at which the ML input channel was created.
Type: Timestamp
- creatorAccountId
-
The account ID of the member who created the ML input channel.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
[0-9]{12} - description
-
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]* - membershipIdentifier
-
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
-
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
-
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]* - numberOfRecords
-
The number of records in the ML input channel.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 100000000000.
- retentionInDays
-
The number of days to retain the data for the ML input channel.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 30.
- status
-
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
-
Details about the status of a resource.
Type: StatusDetails object
- updateTime
-
The most recent time at which the ML input channel was updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
- ValidationException
-
The request parameters for this request are incorrect.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
