Provides the information necessary to start a trained model export job.
Request Syntax
POST /memberships/membershipIdentifier/trained-models/trainedModelArn/export-jobs HTTP/1.1
Content-type: application/json
{
"description": "string",
"name": "string",
"outputConfiguration": {
"members": [
{
"accountId": "string"
}
]
}
}URI Request Parameters
The request uses the following URI parameters.
- membershipIdentifier
-
The membership ID of the member that is receiving the exported trained model artifacts.
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
- trainedModelArn
-
The Amazon Resource Name (ARN) of the trained model that you want to export.
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}/trained-model/[-a-zA-Z0-9_/.]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
The description of the trained model export job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*Required: No
- name
-
The name of the trained model export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*Required: Yes
- outputConfiguration
-
The output configuration information for the trained model export job.
Type: TrainedModelExportOutputConfiguration object
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ConflictException
-
You can't complete this action because another resource depends on this resource.
HTTP Status Code: 409
- 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:
