Use these APIs to build and deploy your aiWARE engines.
Get an engine's name, state, build, and deployment model
Retrieves an engine's name, state, build, and deployment model based on ID.
Example
query {
engine(id:"3929002a-6902-4c59-b81c-7a79fcd8b9c0"){
id
name
state
deploymentModel
builds(buildStatus:deployed) {
records{
id
}
}
}
}
Response
{
"data": {
"engine": {
"id": "3929002a-6902-4c59-b81c-7a79fcd8b9c0",
"name": "Amazon Transcribe - V2F (EU West)",
"state": "active",
"deploymentModel": "NonNetworkIsolated",
"builds": {
"records" : [ ]
}
}
}
}
Pause the build
Pauses a current build.
[Warn] Don't pause an engine that's currently in use.
Example
mutation pauseBuild{
updateEngineBuild(input:{
id: "6ff2cd01-a648-4ce1-afe4-9392b8821057"
engineId: "0fe8e64c-6c70-4727-9d89-de06f5231a6f"
action: pause
}){
id
engineId
status
}
}
Possible values for action:
enum BuildUpdateAction {
deploy
pause
unpause
approve
disapprove
invalidate
submit
upload
delete
}
Update an engine's deployment model
Updates an engine's deployment model.
[Warn] Before running this command, use the pauseBuild command to pause the engine.
Example
mutation updateModel{
updateEngine(input:{
id:"0fe8e64c-6c70-4727-9d89-de06f5231a6f"
deploymentModel: FullyNetworkIsolated
}){
id
name
deploymentModel
}
}
Unpause the build
Resumes an engine's build.
Example
mutation unpauseBuild{
updateEngineBuild(input:{
id:"6ff2cd01-a648-4ce1-afe4-9392b8821057"
engineId:"0fe8e64c-6c70-4727-9d89-de06f5231a6f"
action:unpause
}){
id
engineId
status
}
}
Deploy a build
Deploys an engine's build.
[Note] If you changed an engine's deploymentModel using the updateModel command, deploy it again.
Example
mutation deployBuild{
updateEngineBuild(input:{
id:"6ff2cd01-a648-4ce1-afe4-9392b8821057"
engineId:"0fe8e64c-6c70-4727-9d89-de06f5231a6f"
action:deploy
}){
id
engineId
status
}
}
More API examples