api.md

AWS Batch with FFMPEG : HTTP REST API Documentation

• AWS Batch with FFMPEG : HTTP REST API Documentation
• API Resources
  • post__batch_execute_amd
  • post__batch_describe
  • post__batch_execute_arm
  • post__batch_execute_intel
  • post__state_execute
  • post__batch_execute_xilinx
  • post__batch_execute_fargate
  • post__state_describe
  • post__batch_execute_nvidia
  • post__batch_execute_fargate-arm
• Schemas

API Resources

post__batch_execute_amd

Code samples

POST /batch/execute/amd

Body parameter

{
  "input_file_options": "string",
  "output_url": "string",
  "name": "string",
  "output_file_options": "string",
  "global_options": "string",
  "instance_type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	batchapiba0qXhDPEBUr0E	true	none
» input_file_options	body	string	false	none
» output_url	body	string	false	none
» name	body	string	false	none
» output_file_options	body	string	false	none
» global_options	body	string	false	none
» instance_type	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

post__batch_describe

Code samples

POST /batch/describe

Body parameter

{
  "jobId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	batchapibaJsrkUdOCalLU	true	none
» jobId	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

post__batch_execute_arm

Code samples

POST /batch/execute/arm

Body parameter

{
  "input_file_options": "string",
  "output_url": "string",
  "name": "string",
  "output_file_options": "string",
  "global_options": "string",
  "instance_type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	batchapiba0qXhDPEBUr0E	true	none
» input_file_options	body	string	false	none
» output_url	body	string	false	none
» name	body	string	false	none
» output_file_options	body	string	false	none
» global_options	body	string	false	none
» instance_type	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

post__batch_execute_intel

Code samples

POST /batch/execute/intel

Body parameter

{
  "input_file_options": "string",
  "output_url": "string",
  "name": "string",
  "output_file_options": "string",
  "global_options": "string",
  "instance_type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	batchapiba0qXhDPEBUr0E	true	none
» input_file_options	body	string	false	none
» output_url	body	string	false	none
» name	body	string	false	none
» output_file_options	body	string	false	none
» global_options	body	string	false	none
» instance_type	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

post__state_execute

Code samples

POST /state/execute

Body parameter

{
  "compute": "string",
  "output": {
    "s3_bucket": "string",
    "file_options": "string",
    "s3_prefix": "string"
  },
  "input": {
    "s3_bucket": "string",
    "file_options": "string",
    "s3_prefix": "string"
  },
  "name": "string",
  "global": {
    "options": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	batchapibaX7LgouXSmK6F	true	none
» compute	body	string	false	none
» output	body	object	false	none
»» s3_bucket	body	string	false	none
»» file_options	body	string	false	none
»» s3_prefix	body	string	false	none
» input	body	object	false	none
»» s3_bucket	body	string	false	none
»» file_options	body	string	false	none
»» s3_prefix	body	string	false	none
» name	body	string	false	none
» global	body	object	false	none
»» options	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

post__batch_execute_xilinx

Code samples

POST /batch/execute/xilinx

Body parameter

{
  "input_file_options": "string",
  "output_url": "string",
  "name": "string",
  "output_file_options": "string",
  "global_options": "string",
  "instance_type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	batchapiba0qXhDPEBUr0E	true	none
» input_file_options	body	string	false	none
» output_url	body	string	false	none
» name	body	string	false	none
» output_file_options	body	string	false	none
» global_options	body	string	false	none
» instance_type	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

post__batch_execute_fargate

Code samples

POST /batch/execute/fargate

Body parameter

{
  "input_file_options": "string",
  "output_url": "string",
  "name": "string",
  "output_file_options": "string",
  "global_options": "string",
  "instance_type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	batchapiba0qXhDPEBUr0E	true	none
» input_file_options	body	string	false	none
» output_url	body	string	false	none
» name	body	string	false	none
» output_file_options	body	string	false	none
» global_options	body	string	false	none
» instance_type	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

post__state_describe

Code samples

POST /state/describe

Body parameter

{
  "executionArn": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	batchapibaQtUw4LHPXGX2	true	none
» executionArn	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

post__batch_execute_nvidia

Code samples

POST /batch/execute/nvidia

Body parameter

{
  "input_file_options": "string",
  "output_url": "string",
  "name": "string",
  "output_file_options": "string",
  "global_options": "string",
  "instance_type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	batchapiba0qXhDPEBUr0E	true	none
» input_file_options	body	string	false	none
» output_url	body	string	false	none
» name	body	string	false	none
» output_file_options	body	string	false	none
» global_options	body	string	false	none
» instance_type	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

post__batch_execute_fargate-arm

Code samples

POST /batch/execute/fargate-arm

Body parameter

{
  "input_file_options": "string",
  "output_url": "string",
  "name": "string",
  "output_file_options": "string",
  "global_options": "string",
  "instance_type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	batchapiba0qXhDPEBUr0E	true	none
» input_file_options	body	string	false	none
» output_url	body	string	false	none
» name	body	string	false	none
» output_file_options	body	string	false	none
» global_options	body	string	false	none
» instance_type	body	string	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	200 response	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: sigv4

Schemas

batchapibaQtUw4LHPXGX2

{
  "executionArn": "string"
}

sfn-describe-request-schema

Properties

Name	Type	Required	Restrictions	Description
executionArn	string	false	none	none

batchapibaX7LgouXSmK6F

{
  "compute": "string",
  "output": {
    "s3_bucket": "string",
    "file_options": "string",
    "s3_prefix": "string"
  },
  "input": {
    "s3_bucket": "string",
    "file_options": "string",
    "s3_prefix": "string"
  },
  "name": "string",
  "global": {
    "options": "string"
  }
}

sfn-request-schema

Properties

Name	Type	Required	Restrictions	Description
compute	string	false	none	none
output	object	false	none	none
» s3_bucket	string	false	none	none
» file_options	string	false	none	none
» s3_prefix	string	false	none	none
input	object	false	none	none
» s3_bucket	string	false	none	none
» file_options	string	false	none	none
» s3_prefix	string	false	none	none
name	string	false	none	none
global	object	false	none	none
» options	string	false	none	none

batchapibaJsrkUdOCalLU

{
  "jobId": "string"
}

batch-describe-request-schema

Properties

Name	Type	Required	Restrictions	Description
jobId	string	false	none	none

batchapiba0qXhDPEBUr0E

{
  "input_file_options": "string",
  "output_url": "string",
  "name": "string",
  "output_file_options": "string",
  "global_options": "string",
  "instance_type": "string"
}

ffmpeg-request-schema

Properties

Name	Type	Required	Restrictions	Description
input_file_options	string	false	none	none
output_url	string	false	none	none
name	string	false	none	none
output_file_options	string	false	none	none
global_options	string	false	none	none
instance_type	string	false	none	none