openapi: 3.2.0
info:
version: '2017-03-31'
x-release: v4
title: 'AWS Glue #X Amz Target=AWSGlue.GetRegistry 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.GetRegistry API'
paths:
/#X-Amz-Target=AWSGlue.GetRegistry:
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: GetRegistry
description: Describes the specified registry in detail.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRegistryResponse'
examples:
GetRegistry200Example:
summary: Default GetRegistry 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetRegistry480Example:
summary: Default GetRegistry 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
GetRegistry481Example:
summary: Default GetRegistry 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetRegistry482Example:
summary: Default GetRegistry 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetRegistry483Example:
summary: Default GetRegistry 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetRegistryInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetRegistry
summary: Amazon Glue Get Registry
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- 'AWS Glue #X Amz Target=AWSGlue.GetRegistry API'
components:
schemas:
InvalidInputException: {}
GlueResourceArn:
type: string
pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
minLength: 1
maxLength: 10240
EntityNotFoundException: {}
DescriptionString:
type: string
minLength: 0
maxLength: 2048
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
RegistryId:
type: object
properties:
RegistryName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: 'Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided. '
RegistryArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.
description: A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
InternalServiceException: {}
SchemaRegistryNameString:
type: string
pattern: '[a-zA-Z0-9-_$#.]+'
minLength: 1
maxLength: 255
GetRegistryResponse:
type: object
properties:
RegistryName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the registry.
RegistryArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the registry.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the registry.
Status:
allOf:
- $ref: '#/components/schemas/RegistryStatus'
- description: The status of the registry.
CreatedTime:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: The date and time the registry was created.
UpdatedTime:
allOf:
- $ref: '#/components/schemas/UpdatedTimestamp'
- description: The date and time the registry was updated.
GetRegistryInput:
type: object
required:
- RegistryId
title: GetRegistryInput
properties:
RegistryId:
allOf:
- $ref: '#/components/schemas/RegistryId'
- description: This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
RegistryStatus:
type: string
enum:
- AVAILABLE
- DELETING
CreatedTimestamp:
type: string
UpdatedTimestamp:
type: string
AccessDeniedException: {}
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