GetMLInputChannel - AWS Clean Rooms ML
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetMLInputChannel

Returns information about an ML input channel.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

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

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",
   "description": "string",
   "inputChannel": { 
      "dataSource": { ... },
      "roleArn": "string"
   },
   "kmsKeyArn": "string",
   "membershipIdentifier": "string",
   "mlInputChannelArn": "string",
   "name": "string",
   "numberOfFiles": number,
   "numberOfRecords": number,
   "protectedQueryIdentifier": "string",
   "retentionInDays": number,
   "sizeInGb": number,
   "status": "string",
   "statusDetails": { 
      "message": "string",
      "statusCode": "string"
   },
   "tags": { 
      "string" : "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

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]*

inputChannel

The input channel that was used to create the ML input channel.

Type: InputChannel object

kmsKeyArn

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

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]*

numberOfFiles

The number of files in the ML input channel.

Type: Double

Valid Range: Minimum value of 0. Maximum value of 1000000.

numberOfRecords

The number of records in the ML input channel.

Type: Long

Valid Range: Minimum value of 0. Maximum value of 100000000000.

protectedQueryIdentifier

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

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

The size, in GB, of the ML input channel.

Type: Double

Valid Range: Minimum value of 0. Maximum value of 1000000.

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

tags

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.

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

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: