prowler-sdk-poc
Version:
1,398 lines • 32.9 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2016-08-10",
"endpointPrefix": "batch",
"jsonVersion": "1.1",
"protocol": "rest-json",
"serviceAbbreviation": "AWS Batch",
"serviceFullName": "AWS Batch",
"serviceId": "Batch",
"signatureVersion": "v4",
"uid": "batch-2016-08-10"
},
"operations": {
"CancelJob": {
"http": {
"requestUri": "/v1/canceljob"
},
"input": {
"type": "structure",
"required": [
"jobId",
"reason"
],
"members": {
"jobId": {},
"reason": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CreateComputeEnvironment": {
"http": {
"requestUri": "/v1/createcomputeenvironment"
},
"input": {
"type": "structure",
"required": [
"computeEnvironmentName",
"type"
],
"members": {
"computeEnvironmentName": {},
"type": {},
"state": {},
"computeResources": {
"shape": "S7"
},
"serviceRole": {},
"tags": {
"shape": "Si"
}
}
},
"output": {
"type": "structure",
"members": {
"computeEnvironmentName": {},
"computeEnvironmentArn": {}
}
}
},
"CreateJobQueue": {
"http": {
"requestUri": "/v1/createjobqueue"
},
"input": {
"type": "structure",
"required": [
"jobQueueName",
"priority",
"computeEnvironmentOrder"
],
"members": {
"jobQueueName": {},
"state": {},
"priority": {
"type": "integer"
},
"computeEnvironmentOrder": {
"shape": "So"
},
"tags": {
"shape": "Si"
}
}
},
"output": {
"type": "structure",
"required": [
"jobQueueName",
"jobQueueArn"
],
"members": {
"jobQueueName": {},
"jobQueueArn": {}
}
}
},
"DeleteComputeEnvironment": {
"http": {
"requestUri": "/v1/deletecomputeenvironment"
},
"input": {
"type": "structure",
"required": [
"computeEnvironment"
],
"members": {
"computeEnvironment": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteJobQueue": {
"http": {
"requestUri": "/v1/deletejobqueue"
},
"input": {
"type": "structure",
"required": [
"jobQueue"
],
"members": {
"jobQueue": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeregisterJobDefinition": {
"http": {
"requestUri": "/v1/deregisterjobdefinition"
},
"input": {
"type": "structure",
"required": [
"jobDefinition"
],
"members": {
"jobDefinition": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DescribeComputeEnvironments": {
"http": {
"requestUri": "/v1/describecomputeenvironments"
},
"input": {
"type": "structure",
"members": {
"computeEnvironments": {
"shape": "Sb"
},
"maxResults": {
"type": "integer"
},
"nextToken": {}
}
},
"output": {
"type": "structure",
"members": {
"computeEnvironments": {
"type": "list",
"member": {
"type": "structure",
"required": [
"computeEnvironmentName",
"computeEnvironmentArn",
"ecsClusterArn"
],
"members": {
"computeEnvironmentName": {},
"computeEnvironmentArn": {},
"ecsClusterArn": {},
"tags": {
"shape": "Si"
},
"type": {},
"state": {},
"status": {},
"statusReason": {},
"computeResources": {
"shape": "S7"
},
"serviceRole": {}
}
}
},
"nextToken": {}
}
}
},
"DescribeJobDefinitions": {
"http": {
"requestUri": "/v1/describejobdefinitions"
},
"input": {
"type": "structure",
"members": {
"jobDefinitions": {
"shape": "Sb"
},
"maxResults": {
"type": "integer"
},
"jobDefinitionName": {},
"status": {},
"nextToken": {}
}
},
"output": {
"type": "structure",
"members": {
"jobDefinitions": {
"type": "list",
"member": {
"type": "structure",
"required": [
"jobDefinitionName",
"jobDefinitionArn",
"revision",
"type"
],
"members": {
"jobDefinitionName": {},
"jobDefinitionArn": {},
"revision": {
"type": "integer"
},
"status": {},
"type": {},
"parameters": {
"shape": "S16"
},
"retryStrategy": {
"shape": "S17"
},
"containerProperties": {
"shape": "S1b"
},
"timeout": {
"shape": "S28"
},
"nodeProperties": {
"shape": "S29"
},
"tags": {
"shape": "Si"
},
"propagateTags": {
"type": "boolean"
},
"platformCapabilities": {
"shape": "S2c"
}
}
}
},
"nextToken": {}
}
}
},
"DescribeJobQueues": {
"http": {
"requestUri": "/v1/describejobqueues"
},
"input": {
"type": "structure",
"members": {
"jobQueues": {
"shape": "Sb"
},
"maxResults": {
"type": "integer"
},
"nextToken": {}
}
},
"output": {
"type": "structure",
"members": {
"jobQueues": {
"type": "list",
"member": {
"type": "structure",
"required": [
"jobQueueName",
"jobQueueArn",
"state",
"priority",
"computeEnvironmentOrder"
],
"members": {
"jobQueueName": {},
"jobQueueArn": {},
"state": {},
"status": {},
"statusReason": {},
"priority": {
"type": "integer"
},
"computeEnvironmentOrder": {
"shape": "So"
},
"tags": {
"shape": "Si"
}
}
}
},
"nextToken": {}
}
}
},
"DescribeJobs": {
"http": {
"requestUri": "/v1/describejobs"
},
"input": {
"type": "structure",
"required": [
"jobs"
],
"members": {
"jobs": {
"shape": "Sb"
}
}
},
"output": {
"type": "structure",
"members": {
"jobs": {
"type": "list",
"member": {
"type": "structure",
"required": [
"jobName",
"jobId",
"jobQueue",
"status",
"startedAt",
"jobDefinition"
],
"members": {
"jobArn": {},
"jobName": {},
"jobId": {},
"jobQueue": {},
"status": {},
"attempts": {
"type": "list",
"member": {
"type": "structure",
"members": {
"container": {
"type": "structure",
"members": {
"containerInstanceArn": {},
"taskArn": {},
"exitCode": {
"type": "integer"
},
"reason": {},
"logStreamName": {},
"networkInterfaces": {
"shape": "S2r"
}
}
},
"startedAt": {
"type": "long"
},
"stoppedAt": {
"type": "long"
},
"statusReason": {}
}
}
},
"statusReason": {},
"createdAt": {
"type": "long"
},
"retryStrategy": {
"shape": "S17"
},
"startedAt": {
"type": "long"
},
"stoppedAt": {
"type": "long"
},
"dependsOn": {
"shape": "S2u"
},
"jobDefinition": {},
"parameters": {
"shape": "S16"
},
"container": {
"type": "structure",
"members": {
"image": {},
"vcpus": {
"type": "integer"
},
"memory": {
"type": "integer"
},
"command": {
"shape": "Sb"
},
"jobRoleArn": {},
"executionRoleArn": {},
"volumes": {
"shape": "S1c"
},
"environment": {
"shape": "S1j"
},
"mountPoints": {
"shape": "S1l"
},
"readonlyRootFilesystem": {
"type": "boolean"
},
"ulimits": {
"shape": "S1o"
},
"privileged": {
"type": "boolean"
},
"user": {},
"exitCode": {
"type": "integer"
},
"reason": {},
"containerInstanceArn": {},
"taskArn": {},
"logStreamName": {},
"instanceType": {},
"networkInterfaces": {
"shape": "S2r"
},
"resourceRequirements": {
"shape": "S1q"
},
"linuxParameters": {
"shape": "S1t"
},
"logConfiguration": {
"shape": "S20"
},
"secrets": {
"shape": "S23"
},
"networkConfiguration": {
"shape": "S25"
},
"fargatePlatformConfiguration": {
"shape": "S27"
}
}
},
"nodeDetails": {
"type": "structure",
"members": {
"nodeIndex": {
"type": "integer"
},
"isMainNode": {
"type": "boolean"
}
}
},
"nodeProperties": {
"shape": "S29"
},
"arrayProperties": {
"type": "structure",
"members": {
"statusSummary": {
"type": "map",
"key": {},
"value": {
"type": "integer"
}
},
"size": {
"type": "integer"
},
"index": {
"type": "integer"
}
}
},
"timeout": {
"shape": "S28"
},
"tags": {
"shape": "Si"
},
"propagateTags": {
"type": "boolean"
},
"platformCapabilities": {
"shape": "S2c"
}
}
}
}
}
}
},
"ListJobs": {
"http": {
"requestUri": "/v1/listjobs"
},
"input": {
"type": "structure",
"members": {
"jobQueue": {},
"arrayJobId": {},
"multiNodeJobId": {},
"jobStatus": {},
"maxResults": {
"type": "integer"
},
"nextToken": {},
"filters": {
"type": "list",
"member": {
"type": "structure",
"members": {
"name": {},
"values": {
"shape": "Sb"
}
}
}
}
}
},
"output": {
"type": "structure",
"required": [
"jobSummaryList"
],
"members": {
"jobSummaryList": {
"type": "list",
"member": {
"type": "structure",
"required": [
"jobId",
"jobName"
],
"members": {
"jobArn": {},
"jobId": {},
"jobName": {},
"createdAt": {
"type": "long"
},
"status": {},
"statusReason": {},
"startedAt": {
"type": "long"
},
"stoppedAt": {
"type": "long"
},
"container": {
"type": "structure",
"members": {
"exitCode": {
"type": "integer"
},
"reason": {}
}
},
"arrayProperties": {
"type": "structure",
"members": {
"size": {
"type": "integer"
},
"index": {
"type": "integer"
}
}
},
"nodeProperties": {
"type": "structure",
"members": {
"isMainNode": {
"type": "boolean"
},
"numNodes": {
"type": "integer"
},
"nodeIndex": {
"type": "integer"
}
}
},
"jobDefinition": {}
}
}
},
"nextToken": {}
}
}
},
"ListTagsForResource": {
"http": {
"method": "GET",
"requestUri": "/v1/tags/{resourceArn}"
},
"input": {
"type": "structure",
"required": [
"resourceArn"
],
"members": {
"resourceArn": {
"location": "uri",
"locationName": "resourceArn"
}
}
},
"output": {
"type": "structure",
"members": {
"tags": {
"shape": "Si"
}
}
}
},
"RegisterJobDefinition": {
"http": {
"requestUri": "/v1/registerjobdefinition"
},
"input": {
"type": "structure",
"required": [
"jobDefinitionName",
"type"
],
"members": {
"jobDefinitionName": {},
"type": {},
"parameters": {
"shape": "S16"
},
"containerProperties": {
"shape": "S1b"
},
"nodeProperties": {
"shape": "S29"
},
"retryStrategy": {
"shape": "S17"
},
"propagateTags": {
"type": "boolean"
},
"timeout": {
"shape": "S28"
},
"tags": {
"shape": "Si"
},
"platformCapabilities": {
"shape": "S2c"
}
}
},
"output": {
"type": "structure",
"required": [
"jobDefinitionName",
"jobDefinitionArn",
"revision"
],
"members": {
"jobDefinitionName": {},
"jobDefinitionArn": {},
"revision": {
"type": "integer"
}
}
}
},
"SubmitJob": {
"http": {
"requestUri": "/v1/submitjob"
},
"input": {
"type": "structure",
"required": [
"jobName",
"jobQueue",
"jobDefinition"
],
"members": {
"jobName": {},
"jobQueue": {},
"arrayProperties": {
"type": "structure",
"members": {
"size": {
"type": "integer"
}
}
},
"dependsOn": {
"shape": "S2u"
},
"jobDefinition": {},
"parameters": {
"shape": "S16"
},
"containerOverrides": {
"shape": "S3h"
},
"nodeOverrides": {
"type": "structure",
"members": {
"numNodes": {
"type": "integer"
},
"nodePropertyOverrides": {
"type": "list",
"member": {
"type": "structure",
"required": [
"targetNodes"
],
"members": {
"targetNodes": {},
"containerOverrides": {
"shape": "S3h"
}
}
}
}
}
},
"retryStrategy": {
"shape": "S17"
},
"propagateTags": {
"type": "boolean"
},
"timeout": {
"shape": "S28"
},
"tags": {
"shape": "Si"
}
}
},
"output": {
"type": "structure",
"required": [
"jobName",
"jobId"
],
"members": {
"jobArn": {},
"jobName": {},
"jobId": {}
}
}
},
"TagResource": {
"http": {
"requestUri": "/v1/tags/{resourceArn}"
},
"input": {
"type": "structure",
"required": [
"resourceArn",
"tags"
],
"members": {
"resourceArn": {
"location": "uri",
"locationName": "resourceArn"
},
"tags": {
"shape": "Si"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"TerminateJob": {
"http": {
"requestUri": "/v1/terminatejob"
},
"input": {
"type": "structure",
"required": [
"jobId",
"reason"
],
"members": {
"jobId": {},
"reason": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"UntagResource": {
"http": {
"method": "DELETE",
"requestUri": "/v1/tags/{resourceArn}"
},
"input": {
"type": "structure",
"required": [
"resourceArn",
"tagKeys"
],
"members": {
"resourceArn": {
"location": "uri",
"locationName": "resourceArn"
},
"tagKeys": {
"location": "querystring",
"locationName": "tagKeys",
"type": "list",
"member": {}
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"UpdateComputeEnvironment": {
"http": {
"requestUri": "/v1/updatecomputeenvironment"
},
"input": {
"type": "structure",
"required": [
"computeEnvironment"
],
"members": {
"computeEnvironment": {},
"state": {},
"computeResources": {
"type": "structure",
"members": {
"minvCpus": {
"type": "integer"
},
"maxvCpus": {
"type": "integer"
},
"desiredvCpus": {
"type": "integer"
},
"subnets": {
"shape": "Sb"
},
"securityGroupIds": {
"shape": "Sb"
}
}
},
"serviceRole": {}
}
},
"output": {
"type": "structure",
"members": {
"computeEnvironmentName": {},
"computeEnvironmentArn": {}
}
}
},
"UpdateJobQueue": {
"http": {
"requestUri": "/v1/updatejobqueue"
},
"input": {
"type": "structure",
"required": [
"jobQueue"
],
"members": {
"jobQueue": {},
"state": {},
"priority": {
"type": "integer"
},
"computeEnvironmentOrder": {
"shape": "So"
}
}
},
"output": {
"type": "structure",
"members": {
"jobQueueName": {},
"jobQueueArn": {}
}
}
}
},
"shapes": {
"S7": {
"type": "structure",
"required": [
"type",
"maxvCpus",
"subnets"
],
"members": {
"type": {},
"allocationStrategy": {},
"minvCpus": {
"type": "integer"
},
"maxvCpus": {
"type": "integer"
},
"desiredvCpus": {
"type": "integer"
},
"instanceTypes": {
"shape": "Sb"
},
"imageId": {
"deprecated": true,
"deprecatedMessage": "This field is deprecated, use ec2Configuration[].imageIdOverride instead."
},
"subnets": {
"shape": "Sb"
},
"securityGroupIds": {
"shape": "Sb"
},
"ec2KeyPair": {},
"instanceRole": {},
"tags": {
"type": "map",
"key": {},
"value": {}
},
"placementGroup": {},
"bidPercentage": {
"type": "integer"
},
"spotIamFleetRole": {},
"launchTemplate": {
"type": "structure",
"members": {
"launchTemplateId": {},
"launchTemplateName": {},
"version": {}
}
},
"ec2Configuration": {
"type": "list",
"member": {
"type": "structure",
"required": [
"imageType"
],
"members": {
"imageType": {},
"imageIdOverride": {}
}
}
}
}
},
"Sb": {
"type": "list",
"member": {}
},
"Si": {
"type": "map",
"key": {},
"value": {}
},
"So": {
"type": "list",
"member": {
"type": "structure",
"required": [
"order",
"computeEnvironment"
],
"members": {
"order": {
"type": "integer"
},
"computeEnvironment": {}
}
}
},
"S16": {
"type": "map",
"key": {},
"value": {}
},
"S17": {
"type": "structure",
"members": {
"attempts": {
"type": "integer"
},
"evaluateOnExit": {
"type": "list",
"member": {
"type": "structure",
"required": [
"action"
],
"members": {
"onStatusReason": {},
"onReason": {},
"onExitCode": {},
"action": {}
}
}
}
}
},
"S1b": {
"type": "structure",
"members": {
"image": {},
"vcpus": {
"deprecated": true,
"deprecatedMessage": "This field is deprecated, use resourceRequirements instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"deprecatedMessage": "This field is deprecated, use resourceRequirements instead.",
"type": "integer"
},
"command": {
"shape": "Sb"
},
"jobRoleArn": {},
"executionRoleArn": {},
"volumes": {
"shape": "S1c"
},
"environment": {
"shape": "S1j"
},
"mountPoints": {
"shape": "S1l"
},
"readonlyRootFilesystem": {
"type": "boolean"
},
"privileged": {
"type": "boolean"
},
"ulimits": {
"shape": "S1o"
},
"user": {},
"instanceType": {},
"resourceRequirements": {
"shape": "S1q"
},
"linuxParameters": {
"shape": "S1t"
},
"logConfiguration": {
"shape": "S20"
},
"secrets": {
"shape": "S23"
},
"networkConfiguration": {
"shape": "S25"
},
"fargatePlatformConfiguration": {
"shape": "S27"
}
}
},
"S1c": {
"type": "list",
"member": {
"type": "structure",
"members": {
"host": {
"type": "structure",
"members": {
"sourcePath": {}
}
},
"name": {},
"efsVolumeConfiguration": {
"type": "structure",
"required": [
"fileSystemId"
],
"members": {
"fileSystemId": {},
"rootDirectory": {},
"transitEncryption": {},
"transitEncryptionPort": {
"type": "integer"
},
"authorizationConfig": {
"type": "structure",
"members": {
"accessPointId": {},
"iam": {}
}
}
}
}
}
}
},
"S1j": {
"type": "list",
"member": {
"type": "structure",
"members": {
"name": {},
"value": {}
}
}
},
"S1l": {
"type": "list",
"member": {
"type": "structure",
"members": {
"containerPath": {},
"readOnly": {
"type": "boolean"
},
"sourceVolume": {}
}
}
},
"S1o": {
"type": "list",
"member": {
"type": "structure",
"required": [
"hardLimit",
"name",
"softLimit"
],
"members": {
"hardLimit": {
"type": "integer"
},
"name": {},
"softLimit": {
"type": "integer"
}
}
}
},
"S1q": {
"type": "list",
"member": {
"type": "structure",
"required": [
"value",
"type"
],
"members": {
"value": {},
"type": {}
}
}
},
"S1t": {
"type": "structure",
"members": {
"devices": {
"type": "list",
"member": {
"type": "structure",
"required": [
"hostPath"
],
"members": {
"hostPath": {},
"containerPath": {},
"permissions": {
"type": "list",
"member": {}
}
}
}
},
"initProcessEnabled": {
"type": "boolean"
},
"sharedMemorySize": {
"type": "integer"
},
"tmpfs": {
"type": "list",
"member": {
"type": "structure",
"required": [
"containerPath",
"size"
],
"members": {
"containerPath": {},
"size": {
"type": "integer"
},
"mountOptions": {
"shape": "Sb"
}
}
}
},
"maxSwap": {
"type": "integer"
},
"swappiness": {
"type": "integer"
}
}
},
"S20": {
"type": "structure",
"required": [
"logDriver"
],
"members": {
"logDriver": {},
"options": {
"type": "map",
"key": {},
"value": {}
},
"secretOptions": {
"shape": "S23"
}
}
},
"S23": {
"type": "list",
"member": {
"type": "structure",
"required": [
"name",
"valueFrom"
],
"members": {
"name": {},
"valueFrom": {}
}
}
},
"S25": {
"type": "structure",
"members": {
"assignPublicIp": {}
}
},
"S27": {
"type": "structure",
"members": {
"platformVersion": {}
}
},
"S28": {
"type": "structure",
"members": {
"attemptDurationSeconds": {
"type": "integer"
}
}
},
"S29": {
"type": "structure",
"required": [
"numNodes",
"mainNode",
"nodeRangeProperties"
],
"members": {
"numNodes": {
"type": "integer"
},
"mainNode": {
"type": "integer"
},
"nodeRangeProperties": {
"type": "list",
"member": {
"type": "structure",
"required": [
"targetNodes"
],
"members": {
"targetNodes": {},
"container": {
"shape": "S1b"
}
}
}
}
}
},
"S2c": {
"type": "list",
"member": {}
},
"S2r": {
"type": "list",
"member": {
"type": "structure",
"members": {
"attachmentId": {},
"ipv6Address": {},
"privateIpv4Address": {}
}
}
},
"S2u": {
"type": "list",
"member": {
"type": "structure",
"members": {
"jobId": {},
"type": {}
}
}
},
"S3h": {
"type": "structure",
"members": {
"vcpus": {
"deprecated": true,
"deprecatedMessage": "This field is deprecated, use resourceRequirements instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"deprecatedMessage": "This field is deprecated, use resourceRequirements instead.",
"type": "integer"
},
"command": {
"shape": "Sb"
},
"instanceType": {},
"environment": {
"shape": "S1j"
},
"resourceRequirements": {
"shape": "S1q"
}
}
}
}
}