openapi: 3.2.0
info:
version: '2017-03-31'
x-release: v4
title: 'AWS Glue #X Amz Target=AWSGlue.BatchStopJobRun API'
description: 'Glue
Defines the public endpoint for the Glue service.'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: glue
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/glue-2017-03-31.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://glue.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Glue multi-region endpoint
- url: https://glue.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Glue multi-region endpoint
- url: http://glue.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
- url: https://glue.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: 'AWS Glue #X Amz Target=AWSGlue.BatchStopJobRun API'
paths:
/#X-Amz-Target=AWSGlue.BatchStopJobRun:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: BatchStopJobRun
description: Stops one or more job runs for a specified job definition.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchStopJobRunResponse'
examples:
BatchStopJobRun200Example:
summary: Default BatchStopJobRun 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchStopJobRun480Example:
summary: Default BatchStopJobRun 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
BatchStopJobRun481Example:
summary: Default BatchStopJobRun 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchStopJobRun482Example:
summary: Default BatchStopJobRun 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchStopJobRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchStopJobRun
summary: Amazon Glue Batch Stop Job Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- 'AWS Glue #X Amz Target=AWSGlue.BatchStopJobRun API'
components:
schemas:
InvalidInputException: {}
BatchStopJobRunError:
type: object
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job definition that is used in the job run in question.
JobRunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The JobRunId of the job run in question.
ErrorDetail:
allOf:
- $ref: '#/components/schemas/ErrorDetail'
- description: Specifies details about the error that was encountered.
description: Records an error that occurred when attempting to stop a specified job run.
ErrorDetail:
type: object
properties:
ErrorCode:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The code associated with this error.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A message describing the error.
description: Contains details about an error.
BatchStopJobRunSuccessfulSubmissionList:
type: array
items:
$ref: '#/components/schemas/BatchStopJobRunSuccessfulSubmission'
DescriptionString:
type: string
minLength: 0
maxLength: 2048
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
InternalServiceException: {}
BatchStopJobRunResponse:
type: object
properties:
SuccessfulSubmissions:
allOf:
- $ref: '#/components/schemas/BatchStopJobRunSuccessfulSubmissionList'
- description: A list of the JobRuns that were successfully submitted for stopping.
Errors:
allOf:
- $ref: '#/components/schemas/BatchStopJobRunErrorList'
- description: A list of the errors that were encountered in trying to stop JobRuns, including the JobRunId for which each error was encountered and details about the error.
BatchStopJobRunSuccessfulSubmission:
type: object
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job definition used in the job run that was stopped.
JobRunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The JobRunId of the job run that was stopped.
description: Records a successful request to stop a specified JobRun.
BatchStopJobRunRequest:
type: object
required:
- JobName
- JobRunIds
title: BatchStopJobRunRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job definition for which to stop job runs.
JobRunIds:
allOf:
- $ref: '#/components/schemas/BatchStopJobRunJobRunIdList'
- description: A list of the JobRunIds that should be stopped for that job definition.
BatchStopJobRunErrorList:
type: array
items:
$ref: '#/components/schemas/BatchStopJobRunError'
NameString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
IdString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
OperationTimeoutException: {}
BatchStopJobRunJobRunIdList:
type: array
items:
$ref: '#/components/schemas/IdString'
minItems: 1
maxItems: 25
parameters:
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/glue/
x-hasEquivalentPaths: true