openapi: 3.2.0
info:
version: '2017-03-31'
x-release: v4
title: 'AWS Glue #X Amz Target=AWSGlue.CreateDevEndpoint 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.CreateDevEndpoint API'
paths:
/#X-Amz-Target=AWSGlue.CreateDevEndpoint:
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: CreateDevEndpoint
description: Creates a new development endpoint.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDevEndpointResponse'
examples:
CreateDevEndpoint200Example:
summary: Default CreateDevEndpoint 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
CreateDevEndpoint480Example:
summary: Default CreateDevEndpoint 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/AlreadyExistsException'
examples:
CreateDevEndpoint481Example:
summary: Default CreateDevEndpoint 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: IdempotentParameterMismatchException
content:
application/json:
schema:
$ref: '#/components/schemas/IdempotentParameterMismatchException'
examples:
CreateDevEndpoint482Example:
summary: Default CreateDevEndpoint 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
CreateDevEndpoint483Example:
summary: Default CreateDevEndpoint 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
CreateDevEndpoint484Example:
summary: Default CreateDevEndpoint 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CreateDevEndpoint485Example:
summary: Default CreateDevEndpoint 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'486':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
CreateDevEndpoint486Example:
summary: Default CreateDevEndpoint 486 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'487':
description: ResourceNumberLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNumberLimitExceededException'
examples:
CreateDevEndpoint487Example:
summary: Default CreateDevEndpoint 487 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDevEndpointRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CreateDevEndpoint
summary: Amazon Glue Create Dev Endpoint
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- 'AWS Glue #X Amz Target=AWSGlue.CreateDevEndpoint API'
components:
schemas:
InvalidInputException: {}
CreateDevEndpointResponse:
type: object
properties:
EndpointName:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The name assigned to the new DevEndpoint.
Status:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The current status of the new DevEndpoint.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/StringList'
- description: The security groups assigned to the new DevEndpoint.
SubnetId:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The subnet ID assigned to the new DevEndpoint.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint.
YarnEndpointAddress:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The address of the YARN endpoint used by this DevEndpoint.
ZeppelinRemoteSparkInterpreterPort:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The Apache Zeppelin port for the remote Apache Spark interpreter.
NumberOfNodes:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
WorkerType:
allOf:
- $ref: '#/components/schemas/WorkerType'
- description: The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.
GlueVersion:
allOf:
- $ref: '#/components/schemas/GlueVersionString'
- description:
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
NumberOfWorkers: allOf: - $ref: '#/components/schemas/NullableInteger' - description: The number of workers of a definedworkerType that are allocated to the development endpoint.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Web Services Availability Zone where this DevEndpoint is located.
VpcId:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The ID of the virtual private cloud (VPC) used by this DevEndpoint.
ExtraPythonLibsS3Path:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint.
ExtraJarsS3Path:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: Path to one or more Java .jar files in an S3 bucket that will be loaded in your DevEndpoint.
FailureReason:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The reason for a current failure in this DevEndpoint.
SecurityConfiguration:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the SecurityConfiguration structure being used with this DevEndpoint.
CreatedTimestamp:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The point in time at which this DevEndpoint was created.
Arguments:
allOf:
- $ref: '#/components/schemas/MapValue'
- description: 'The map of arguments used to configure this DevEndpoint.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
DevEndpoint.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The IAM role for the DevEndpoint.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/StringList'
- description: Security group IDs for the security groups to be used by the new DevEndpoint.
SubnetId:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The subnet ID for the new DevEndpoint to use.
PublicKey:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
PublicKeys:
allOf:
- $ref: '#/components/schemas/PublicKeysList'
- description: A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
DevEndpoint.
WorkerType:
allOf:
- $ref: '#/components/schemas/WorkerType'
- description: 'The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.
.jar files in an S3 bucket that should be loaded in your DevEndpoint.
SecurityConfiguration:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the SecurityConfiguration structure to be used with this DevEndpoint.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
Arguments:
allOf:
- $ref: '#/components/schemas/MapValue'
- description: A map of arguments used to configure the DevEndpoint.
AccessDeniedException: {}
GlueVersionString:
type: string
pattern: ^\w+\.\w+$
minLength: 1
maxLength: 255
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