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.GetBlueprint 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.GetBlueprint' paths: /#X-Amz-Target=AWSGlue.GetBlueprint: 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: GetBlueprint description: Retrieves the details of a blueprint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetBlueprintResponse' examples: GetBlueprint200Example: summary: Default GetBlueprint 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetBlueprint480Example: summary: Default GetBlueprint 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetBlueprint481Example: summary: Default GetBlueprint 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetBlueprint482Example: summary: Default GetBlueprint 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetBlueprint483Example: summary: Default GetBlueprint 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetBlueprintRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetBlueprint summary: Amazon Glue Get Blueprint x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=AWSGlue.GetBlueprint' components: schemas: InternalServiceException: {} EntityNotFoundException: {} NullableBoolean: type: boolean OperationTimeoutException: {} Generic512CharString: type: string minLength: 1 maxLength: 512 ErrorString: type: string GetBlueprintResponse: type: object properties: Blueprint: allOf: - $ref: '#/components/schemas/Blueprint' - description: Returns aBlueprint object.
BlueprintParameterSpec:
type: string
minLength: 1
maxLength: 131072
OrchestrationNameString:
type: string
pattern: '[\.\-_A-Za-z0-9]+'
minLength: 1
maxLength: 128
LastActiveDefinition:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/Generic512CharString'
- description: The description of the blueprint.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The date and time the blueprint was last modified.
ParameterSpec:
allOf:
- $ref: '#/components/schemas/BlueprintParameterSpec'
- description: A JSON string specifying the parameters for the blueprint.
BlueprintLocation:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.
BlueprintServiceLocation:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.
description: When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
GenericString:
type: string
BlueprintStatus:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- FAILED
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: {}
GetBlueprintRequest:
type: object
required:
- Name
title: GetBlueprintRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the blueprint.
IncludeBlueprint:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies whether or not to include the blueprint in the response.
IncludeParameterSpec:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies whether or not to include the parameter specification.
Blueprint:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/OrchestrationNameString'
- description: The name of the blueprint.
Description:
allOf:
- $ref: '#/components/schemas/Generic512CharString'
- description: The description of the blueprint.
CreatedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The date and time the blueprint was registered.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The date and time the blueprint was last modified.
ParameterSpec:
allOf:
- $ref: '#/components/schemas/BlueprintParameterSpec'
- description: A JSON string that indicates the list of parameter specifications for the blueprint.
BlueprintLocation:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: Specifies the path in Amazon S3 where the blueprint is published.
BlueprintServiceLocation:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.
Status:
allOf:
- $ref: '#/components/schemas/BlueprintStatus'
- description: The status of the blueprint registration.
Creating — The blueprint registration is in progress.
Active — The blueprint has been successfully registered.
Updating — An update to the blueprint registration is in progress.
Failed — The blueprint registration failed.