openapi: 3.0.0
info:
version: '2017-03-31'
x-release: v4
title: 'AWS Glue #X Amz Target=AWSGlue.BatchCreatePartition #X Amz Target=AWSGlue.BatchCreatePartition #X Amz Target=AWSGlue.GetBlueprintRuns API'
description:
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: '#X Amz Target=AWSGlue.GetBlueprintRuns' paths: /#X-Amz-Target=AWSGlue.GetBlueprintRuns: 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: GetBlueprintRuns description: Retrieves the details of blueprint runs for a specified blueprint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetBlueprintRunsResponse' examples: GetBlueprintRuns200Example: summary: Default GetBlueprintRuns 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetBlueprintRuns480Example: summary: Default GetBlueprintRuns 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetBlueprintRuns481Example: summary: Default GetBlueprintRuns 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetBlueprintRuns482Example: summary: Default GetBlueprintRuns 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetBlueprintRuns483Example: summary: Default GetBlueprintRuns 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetBlueprintRunsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetBlueprintRuns summary: Amazon Glue Get Blueprint Runs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=AWSGlue.GetBlueprintRuns' components: schemas: InternalServiceException: {} BlueprintRuns: type: array items: $ref: '#/components/schemas/BlueprintRun' MessageString: type: string OrchestrationIAMRoleArn: type: string pattern: arn:aws[^:]*:iam::[0-9]*:role/.+ minLength: 1 maxLength: 1024 EntityNotFoundException: {} PageSize: type: integer minimum: 1 maximum: 1000 BlueprintParameters: type: string minLength: 1 maxLength: 131072 OperationTimeoutException: {} BlueprintRunState: type: string enum: - RUNNING - SUCCEEDED - FAILED - ROLLING_BACK BlueprintRun: type: object properties: BlueprintName: allOf: - $ref: '#/components/schemas/OrchestrationNameString' - description: The name of the blueprint. RunId: allOf: - $ref: '#/components/schemas/IdString' - description: The run ID for this blueprint run. WorkflowName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created. State: allOf: - $ref: '#/components/schemas/BlueprintRunState' - description:The state of the blueprint run. Possible values are:
Running — The blueprint run is in progress.
Succeeded — The blueprint run completed successfully.
Failed — The blueprint run failed and rollback is complete.
Rolling Back — The blueprint run failed and rollback is in progress.
Blueprint$ParameterSpec.
RoleArn:
allOf:
- $ref: '#/components/schemas/OrchestrationIAMRoleArn'
- description: The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
description: The details of a blueprint run.
IdString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
GetBlueprintRunsResponse:
type: object
properties:
BlueprintRuns:
allOf:
- $ref: '#/components/schemas/BlueprintRuns'
- description: Returns a list of BlueprintRun objects.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if not all blueprint runs have been returned.
OrchestrationNameString:
type: string
pattern: '[\.\-_A-Za-z0-9]+'
minLength: 1
maxLength: 128
GenericString:
type: string
NameString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
TimestampValue:
type: string
format: date-time
InvalidInputException: {}
GetBlueprintRunsRequest:
type: object
required:
- BlueprintName
title: GetBlueprintRunsRequest
properties:
BlueprintName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the blueprint.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if this is a continuation request.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum size of a list to return.
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
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-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-Algorithm:
name: X-Amz-Algorithm
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