openapi: 3.0.0
info:
version: '2017-03-31'
x-release: v4
title: AWS Glue
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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/glue/ 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) x-hasEquivalentPaths: true paths: /#X-Amz-Target=AWSGlue.BatchCreatePartition: post: operationId: BatchCreatePartition description: Creates one or more partitions in a batch operation. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchCreatePartitionResponse' examples: BatchCreatePartition200Example: summary: Default BatchCreatePartition 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: BatchCreatePartition480Example: summary: Default BatchCreatePartition 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' examples: BatchCreatePartition481Example: summary: Default BatchCreatePartition 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: BatchCreatePartition482Example: summary: Default BatchCreatePartition 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: BatchCreatePartition483Example: summary: Default BatchCreatePartition 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: BatchCreatePartition484Example: summary: Default BatchCreatePartition 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: BatchCreatePartition485Example: summary: Default BatchCreatePartition 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '486': description: GlueEncryptionException content: application/json: schema: $ref: '#/components/schemas/GlueEncryptionException' examples: BatchCreatePartition486Example: summary: Default BatchCreatePartition 486 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchCreatePartitionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.BatchCreatePartition summary: Amazon Glue Batch Create Partition x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.BatchDeleteConnection: post: operationId: BatchDeleteConnection description: Deletes a list of connection definitions from the Data Catalog. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDeleteConnectionResponse' examples: BatchDeleteConnection200Example: summary: Default BatchDeleteConnection 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: BatchDeleteConnection480Example: summary: Default BatchDeleteConnection 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: BatchDeleteConnection481Example: summary: Default BatchDeleteConnection 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDeleteConnectionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.BatchDeleteConnection summary: Amazon Glue Batch Delete Connection x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.BatchDeletePartition: post: operationId: BatchDeletePartition description: Deletes one or more partitions in a batch operation. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDeletePartitionResponse' examples: BatchDeletePartition200Example: summary: Default BatchDeletePartition 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: BatchDeletePartition480Example: summary: Default BatchDeletePartition 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: BatchDeletePartition481Example: summary: Default BatchDeletePartition 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: BatchDeletePartition482Example: summary: Default BatchDeletePartition 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: BatchDeletePartition483Example: summary: Default BatchDeletePartition 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDeletePartitionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.BatchDeletePartition summary: Amazon Glue Batch Delete Partition x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.BatchDeleteTable: post: operationId: BatchDeleteTable description:Deletes multiple tables at once.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling
BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any
resources that belong to the table.
ListCrawlers operation, you can call this operation to access the data to which
you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetCrawlersResponse'
examples:
BatchGetCrawlers200Example:
summary: Default BatchGetCrawlers 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchGetCrawlers480Example:
summary: Default BatchGetCrawlers 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchGetCrawlers481Example:
summary: Default BatchGetCrawlers 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetCrawlersRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchGetCrawlers
summary: Amazon Glue Batch Get Crawlers
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.BatchGetCustomEntityTypes:
post:
operationId: BatchGetCustomEntityTypes
description: Retrieves the details for the custom patterns specified by a list of names.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetCustomEntityTypesResponse'
examples:
BatchGetCustomEntityTypes200Example:
summary: Default BatchGetCustomEntityTypes 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchGetCustomEntityTypes480Example:
summary: Default BatchGetCustomEntityTypes 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
BatchGetCustomEntityTypes481Example:
summary: Default BatchGetCustomEntityTypes 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchGetCustomEntityTypes482Example:
summary: Default BatchGetCustomEntityTypes 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetCustomEntityTypesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchGetCustomEntityTypes
summary: Amazon Glue Batch Get Custom Entity Types
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.BatchGetDataQualityResult:
post:
operationId: BatchGetDataQualityResult
description: Retrieves a list of data quality results for the specified result IDs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetDataQualityResultResponse'
examples:
BatchGetDataQualityResult200Example:
summary: Default BatchGetDataQualityResult 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchGetDataQualityResult480Example:
summary: Default BatchGetDataQualityResult 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchGetDataQualityResult481Example:
summary: Default BatchGetDataQualityResult 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
BatchGetDataQualityResult482Example:
summary: Default BatchGetDataQualityResult 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetDataQualityResultRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchGetDataQualityResult
summary: Amazon Glue Batch Get Data Quality Result
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.BatchGetDevEndpoints:
post:
operationId: BatchGetDevEndpoints
description: Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints operation, you can call this operation to access
the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetDevEndpointsResponse'
examples:
BatchGetDevEndpoints200Example:
summary: Default BatchGetDevEndpoints 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
BatchGetDevEndpoints480Example:
summary: Default BatchGetDevEndpoints 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
BatchGetDevEndpoints481Example:
summary: Default BatchGetDevEndpoints 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchGetDevEndpoints482Example:
summary: Default BatchGetDevEndpoints 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchGetDevEndpoints483Example:
summary: Default BatchGetDevEndpoints 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetDevEndpointsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchGetDevEndpoints
summary: Amazon Glue Batch Get Dev Endpoints
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.BatchGetJobs:
post:
operationId: BatchGetJobs
description: 'Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have
been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetJobsResponse'
examples:
BatchGetJobs200Example:
summary: Default BatchGetJobs 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
BatchGetJobs480Example:
summary: Default BatchGetJobs 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchGetJobs481Example:
summary: Default BatchGetJobs 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchGetJobs482Example:
summary: Default BatchGetJobs 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetJobsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchGetJobs
summary: Amazon Glue Batch Get Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.BatchGetPartition:
post:
operationId: BatchGetPartition
description: Retrieves partitions in a batch request.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetPartitionResponse'
examples:
BatchGetPartition200Example:
summary: Default BatchGetPartition 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchGetPartition480Example:
summary: Default BatchGetPartition 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
BatchGetPartition481Example:
summary: Default BatchGetPartition 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchGetPartition482Example:
summary: Default BatchGetPartition 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
BatchGetPartition483Example:
summary: Default BatchGetPartition 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
BatchGetPartition484Example:
summary: Default BatchGetPartition 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: InvalidStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidStateException'
examples:
BatchGetPartition485Example:
summary: Default BatchGetPartition 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'486':
description: FederationSourceException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceException'
examples:
BatchGetPartition486Example:
summary: Default BatchGetPartition 486 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'487':
description: FederationSourceRetryableException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceRetryableException'
examples:
BatchGetPartition487Example:
summary: Default BatchGetPartition 487 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetPartitionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchGetPartition
summary: Amazon Glue Batch Get Partition
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.BatchGetTriggers:
post:
operationId: BatchGetTriggers
description: Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which
you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetTriggersResponse'
examples:
BatchGetTriggers200Example:
summary: Default BatchGetTriggers 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
BatchGetTriggers480Example:
summary: Default BatchGetTriggers 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchGetTriggers481Example:
summary: Default BatchGetTriggers 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchGetTriggers482Example:
summary: Default BatchGetTriggers 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetTriggersRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchGetTriggers
summary: Amazon Glue Batch Get Triggers
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.BatchGetWorkflows:
post:
operationId: BatchGetWorkflows
description: Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows operation, you can call this operation to access the data to
which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetWorkflowsResponse'
examples:
BatchGetWorkflows200Example:
summary: Default BatchGetWorkflows 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
BatchGetWorkflows480Example:
summary: Default BatchGetWorkflows 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchGetWorkflows481Example:
summary: Default BatchGetWorkflows 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchGetWorkflows482Example:
summary: Default BatchGetWorkflows 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetWorkflowsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchGetWorkflows
summary: Amazon Glue Batch Get Workflows
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.BatchStopJobRun:
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
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'
/#X-Amz-Target=AWSGlue.BatchUpdatePartition:
post:
operationId: BatchUpdatePartition
description: Updates one or more partitions in a batch operation.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchUpdatePartitionResponse'
examples:
BatchUpdatePartition200Example:
summary: Default BatchUpdatePartition 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
BatchUpdatePartition480Example:
summary: Default BatchUpdatePartition 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
BatchUpdatePartition481Example:
summary: Default BatchUpdatePartition 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
BatchUpdatePartition482Example:
summary: Default BatchUpdatePartition 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
BatchUpdatePartition483Example:
summary: Default BatchUpdatePartition 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
BatchUpdatePartition484Example:
summary: Default BatchUpdatePartition 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchUpdatePartitionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.BatchUpdatePartition
summary: Amazon Glue Batch Update Partition
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CancelDataQualityRuleRecommendationRun:
post:
operationId: CancelDataQualityRuleRecommendationRun
description: Cancels the specified recommendation run that was being used to generate rules.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelDataQualityRuleRecommendationRunResponse'
examples:
CancelDataQualityRuleRecommendationRun200Example:
summary: Default CancelDataQualityRuleRecommendationRun 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
CancelDataQualityRuleRecommendationRun480Example:
summary: Default CancelDataQualityRuleRecommendationRun 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CancelDataQualityRuleRecommendationRun481Example:
summary: Default CancelDataQualityRuleRecommendationRun 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
CancelDataQualityRuleRecommendationRun482Example:
summary: Default CancelDataQualityRuleRecommendationRun 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
CancelDataQualityRuleRecommendationRun483Example:
summary: Default CancelDataQualityRuleRecommendationRun 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelDataQualityRuleRecommendationRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CancelDataQualityRuleRecommendationRun
summary: Amazon Glue Cancel Data Quality Rule Recommendation Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CancelDataQualityRulesetEvaluationRun:
post:
operationId: CancelDataQualityRulesetEvaluationRun
description: Cancels a run where a ruleset is being evaluated against a data source.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelDataQualityRulesetEvaluationRunResponse'
examples:
CancelDataQualityRulesetEvaluationRun200Example:
summary: Default CancelDataQualityRulesetEvaluationRun 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
CancelDataQualityRulesetEvaluationRun480Example:
summary: Default CancelDataQualityRulesetEvaluationRun 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CancelDataQualityRulesetEvaluationRun481Example:
summary: Default CancelDataQualityRulesetEvaluationRun 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
CancelDataQualityRulesetEvaluationRun482Example:
summary: Default CancelDataQualityRulesetEvaluationRun 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
CancelDataQualityRulesetEvaluationRun483Example:
summary: Default CancelDataQualityRulesetEvaluationRun 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelDataQualityRulesetEvaluationRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CancelDataQualityRulesetEvaluationRun
summary: Amazon Glue Cancel Data Quality Ruleset Evaluation Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CancelMLTaskRun:
post:
operationId: CancelMLTaskRun
description: "Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning
task run at any time by calling CancelMLTaskRun with a task run's parent transform's TransformID and the task run's TaskRunId. "
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelMLTaskRunResponse'
examples:
CancelMLTaskRun200Example:
summary: Default CancelMLTaskRun 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
CancelMLTaskRun480Example:
summary: Default CancelMLTaskRun 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CancelMLTaskRun481Example:
summary: Default CancelMLTaskRun 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
CancelMLTaskRun482Example:
summary: Default CancelMLTaskRun 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
CancelMLTaskRun483Example:
summary: Default CancelMLTaskRun 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelMLTaskRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CancelMLTaskRun
summary: Amazon Glue Cancel M L Task Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CancelStatement:
post:
operationId: CancelStatement
description: Cancels the statement.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelStatementResponse'
examples:
CancelStatement200Example:
summary: Default CancelStatement 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
CancelStatement480Example:
summary: Default CancelStatement 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
CancelStatement481Example:
summary: Default CancelStatement 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
CancelStatement482Example:
summary: Default CancelStatement 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
CancelStatement483Example:
summary: Default CancelStatement 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CancelStatement484Example:
summary: Default CancelStatement 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: IllegalSessionStateException
content:
application/json:
schema:
$ref: '#/components/schemas/IllegalSessionStateException'
examples:
CancelStatement485Example:
summary: Default CancelStatement 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelStatementRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CancelStatement
summary: Amazon Glue Cancel Statement
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CheckSchemaVersionValidity:
post:
operationId: CheckSchemaVersionValidity
description: Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat as the format. Since it does not take a
schema set name, no compatibility checks are performed.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CheckSchemaVersionValidityResponse'
examples:
CheckSchemaVersionValidity200Example:
summary: Default CheckSchemaVersionValidity 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CheckSchemaVersionValidity480Example:
summary: Default CheckSchemaVersionValidity 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
CheckSchemaVersionValidity481Example:
summary: Default CheckSchemaVersionValidity 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
CheckSchemaVersionValidity482Example:
summary: Default CheckSchemaVersionValidity 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CheckSchemaVersionValidityInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CheckSchemaVersionValidity
summary: Amazon Glue Check Schema Version Validity
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CreateBlueprint:
post:
operationId: CreateBlueprint
description: Registers a blueprint with Glue.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBlueprintResponse'
examples:
CreateBlueprint200Example:
summary: Default CreateBlueprint 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: AlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/AlreadyExistsException'
examples:
CreateBlueprint480Example:
summary: Default CreateBlueprint 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CreateBlueprint481Example:
summary: Default CreateBlueprint 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
CreateBlueprint482Example:
summary: Default CreateBlueprint 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
CreateBlueprint483Example:
summary: Default CreateBlueprint 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: ResourceNumberLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNumberLimitExceededException'
examples:
CreateBlueprint484Example:
summary: Default CreateBlueprint 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBlueprintRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CreateBlueprint
summary: Amazon Glue Create Blueprint
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CreateClassifier:
post:
operationId: CreateClassifier
description: Creates a classifier in the user's account. This can be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier,
depending on which field of the request is present.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClassifierResponse'
examples:
CreateClassifier200Example:
summary: Default CreateClassifier 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: AlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/AlreadyExistsException'
examples:
CreateClassifier480Example:
summary: Default CreateClassifier 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CreateClassifier481Example:
summary: Default CreateClassifier 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
CreateClassifier482Example:
summary: Default CreateClassifier 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClassifierRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CreateClassifier
summary: Amazon Glue Create Classifier
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CreateConnection:
post:
operationId: CreateConnection
description: Creates a connection definition in the Data Catalog.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConnectionResponse'
examples:
CreateConnection200Example:
summary: Default CreateConnection 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: AlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/AlreadyExistsException'
examples:
CreateConnection480Example:
summary: Default CreateConnection 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CreateConnection481Example:
summary: Default CreateConnection 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
CreateConnection482Example:
summary: Default CreateConnection 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: ResourceNumberLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNumberLimitExceededException'
examples:
CreateConnection483Example:
summary: Default CreateConnection 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
CreateConnection484Example:
summary: Default CreateConnection 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConnectionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CreateConnection
summary: Amazon Glue Create Connection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CreateCrawler:
post:
operationId: CreateCrawler
description: Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the
jdbcTargets field, or the DynamoDBTargets field.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCrawlerResponse'
examples:
CreateCrawler200Example:
summary: Default CreateCrawler 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CreateCrawler480Example:
summary: Default CreateCrawler 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/AlreadyExistsException'
examples:
CreateCrawler481Example:
summary: Default CreateCrawler 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
CreateCrawler482Example:
summary: Default CreateCrawler 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: ResourceNumberLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNumberLimitExceededException'
examples:
CreateCrawler483Example:
summary: Default CreateCrawler 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCrawlerRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CreateCrawler
summary: Amazon Glue Create Crawler
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.CreateCustomEntityType:
post:
operationId: CreateCustomEntityType
description: Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateCustomEntityTypeResponse' examples: CreateCustomEntityType200Example: summary: Default CreateCustomEntityType 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: CreateCustomEntityType480Example: summary: Default CreateCustomEntityType 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' examples: CreateCustomEntityType481Example: summary: Default CreateCustomEntityType 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' examples: CreateCustomEntityType482Example: summary: Default CreateCustomEntityType 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: CreateCustomEntityType483Example: summary: Default CreateCustomEntityType 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: CreateCustomEntityType484Example: summary: Default CreateCustomEntityType 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: CreateCustomEntityType485Example: summary: Default CreateCustomEntityType 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '486': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: CreateCustomEntityType486Example: summary: Default CreateCustomEntityType 486 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCustomEntityTypeRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.CreateCustomEntityType summary: Amazon Glue Create Custom Entity Type x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.CreateDataQualityRuleset: post: operationId: CreateDataQualityRuleset description:Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDataQualityRulesetResponse' examples: CreateDataQualityRuleset200Example: summary: Default CreateDataQualityRuleset 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: CreateDataQualityRuleset480Example: summary: Default CreateDataQualityRuleset 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' examples: CreateDataQualityRuleset481Example: summary: Default CreateDataQualityRuleset 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: CreateDataQualityRuleset482Example: summary: Default CreateDataQualityRuleset 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: CreateDataQualityRuleset483Example: summary: Default CreateDataQualityRuleset 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: CreateDataQualityRuleset484Example: summary: Default CreateDataQualityRuleset 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDataQualityRulesetRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.CreateDataQualityRuleset summary: Amazon Glue Create Data Quality Ruleset x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.CreateDatabase: post: operationId: CreateDatabase description: Creates a new database in a Data Catalog. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDatabaseResponse' examples: CreateDatabase200Example: summary: Default CreateDatabase 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: CreateDatabase480Example: summary: Default CreateDatabase 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' examples: CreateDatabase481Example: summary: Default CreateDatabase 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: CreateDatabase482Example: summary: Default CreateDatabase 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: CreateDatabase483Example: summary: Default CreateDatabase 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: CreateDatabase484Example: summary: Default CreateDatabase 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: GlueEncryptionException content: application/json: schema: $ref: '#/components/schemas/GlueEncryptionException' examples: CreateDatabase485Example: summary: Default CreateDatabase 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '486': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: CreateDatabase486Example: summary: Default CreateDatabase 486 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '487': description: FederatedResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/FederatedResourceAlreadyExistsException' examples: CreateDatabase487Example: summary: Default CreateDatabase 487 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDatabaseRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.CreateDatabase summary: Amazon Glue Create Database x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.CreateDevEndpoint: 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 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' /#X-Amz-Target=AWSGlue.CreateJob: post: operationId: CreateJob description: Creates a new job definition. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateJobResponse' examples: CreateJob200Example: summary: Default CreateJob 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: CreateJob480Example: summary: Default CreateJob 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' examples: CreateJob481Example: summary: Default CreateJob 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' examples: CreateJob482Example: summary: Default CreateJob 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: CreateJob483Example: summary: Default CreateJob 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: CreateJob484Example: summary: Default CreateJob 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: CreateJob485Example: summary: Default CreateJob 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '486': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: CreateJob486Example: summary: Default CreateJob 486 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.CreateJob summary: Amazon Glue Create Job x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.CreateMLTransform: post: operationId: CreateMLTransform description:Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.
Call this operation as the first step in the
process of using a machine learning transform (such as the FindMatches transform) for deduplicating data. You can provide an optional Description, in addition to the
parameters that you want to use for your algorithm.
You must also specify certain parameters for the tasks that Glue runs on your behalf as part of learning from your data and creating
a high-quality machine learning transform. These parameters include Role, and optionally, AllocatedCapacity, Timeout, and MaxRetries. For
more information, see Jobs.
Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.
When the schema
set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version.
For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion API is used.
When this API is called without a RegistryId, this will create an entry for a "default-registry" in the registry database tables, if it is not already present.
Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is DeletePartition.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is DeleteTable.
RUNNING.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCrawlerResponse'
examples:
DeleteCrawler200Example:
summary: Default DeleteCrawler 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
DeleteCrawler480Example:
summary: Default DeleteCrawler 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: CrawlerRunningException
content:
application/json:
schema:
$ref: '#/components/schemas/CrawlerRunningException'
examples:
DeleteCrawler481Example:
summary: Default DeleteCrawler 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: SchedulerTransitioningException
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulerTransitioningException'
examples:
DeleteCrawler482Example:
summary: Default DeleteCrawler 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
DeleteCrawler483Example:
summary: Default DeleteCrawler 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCrawlerRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeleteCrawler
summary: Amazon Glue Delete Crawler
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.DeleteCustomEntityType:
post:
operationId: DeleteCustomEntityType
description: Deletes a custom pattern by specifying its name.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCustomEntityTypeResponse'
examples:
DeleteCustomEntityType200Example:
summary: Default DeleteCustomEntityType 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
DeleteCustomEntityType480Example:
summary: Default DeleteCustomEntityType 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DeleteCustomEntityType481Example:
summary: Default DeleteCustomEntityType 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
DeleteCustomEntityType482Example:
summary: Default DeleteCustomEntityType 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
DeleteCustomEntityType483Example:
summary: Default DeleteCustomEntityType 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
DeleteCustomEntityType484Example:
summary: Default DeleteCustomEntityType 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCustomEntityTypeRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeleteCustomEntityType
summary: Amazon Glue Delete Custom Entity Type
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.DeleteDataQualityRuleset:
post:
operationId: DeleteDataQualityRuleset
description: Deletes a data quality ruleset.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDataQualityRulesetResponse'
examples:
DeleteDataQualityRuleset200Example:
summary: Default DeleteDataQualityRuleset 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
DeleteDataQualityRuleset480Example:
summary: Default DeleteDataQualityRuleset 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
DeleteDataQualityRuleset481Example:
summary: Default DeleteDataQualityRuleset 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
DeleteDataQualityRuleset482Example:
summary: Default DeleteDataQualityRuleset 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
DeleteDataQualityRuleset483Example:
summary: Default DeleteDataQualityRuleset 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDataQualityRulesetRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeleteDataQualityRuleset
summary: Amazon Glue Delete Data Quality Ruleset
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.DeleteDatabase:
post:
operationId: DeleteDatabase
description: Removes a specified database from a Data Catalog.
After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteDatabase, use DeleteTableVersion or
BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or
BatchDeleteTable, to delete any resources that belong to the database.
DeleteMLTransforms. However, any Glue jobs that still reference the deleted transform will no longer succeed.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMLTransformResponse'
examples:
DeleteMLTransform200Example:
summary: Default DeleteMLTransform 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
DeleteMLTransform480Example:
summary: Default DeleteMLTransform 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
DeleteMLTransform481Example:
summary: Default DeleteMLTransform 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
DeleteMLTransform482Example:
summary: Default DeleteMLTransform 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
DeleteMLTransform483Example:
summary: Default DeleteMLTransform 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMLTransformRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeleteMLTransform
summary: Amazon Glue Delete M L Transform
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.DeletePartition:
post:
operationId: DeletePartition
description: Deletes a specified partition.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePartitionResponse'
examples:
DeletePartition200Example:
summary: Default DeletePartition 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
DeletePartition480Example:
summary: Default DeletePartition 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
DeletePartition481Example:
summary: Default DeletePartition 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
DeletePartition482Example:
summary: Default DeletePartition 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
DeletePartition483Example:
summary: Default DeletePartition 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePartitionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeletePartition
summary: Amazon Glue Delete Partition
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.DeletePartitionIndex:
post:
operationId: DeletePartitionIndex
description: Deletes a specified partition index from an existing table.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePartitionIndexResponse'
examples:
DeletePartitionIndex200Example:
summary: Default DeletePartitionIndex 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
DeletePartitionIndex480Example:
summary: Default DeletePartitionIndex 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
DeletePartitionIndex481Example:
summary: Default DeletePartitionIndex 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
DeletePartitionIndex482Example:
summary: Default DeletePartitionIndex 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
DeletePartitionIndex483Example:
summary: Default DeletePartitionIndex 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
DeletePartitionIndex484Example:
summary: Default DeletePartitionIndex 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
DeletePartitionIndex485Example:
summary: Default DeletePartitionIndex 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePartitionIndexRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeletePartitionIndex
summary: Amazon Glue Delete Partition Index
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.DeleteRegistry:
post:
operationId: DeleteRegistry
description: 'Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call.
Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion
APIs. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRegistryResponse'
examples:
DeleteRegistry200Example:
summary: Default DeleteRegistry 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
DeleteRegistry480Example:
summary: Default DeleteRegistry 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
DeleteRegistry481Example:
summary: Default DeleteRegistry 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DeleteRegistry482Example:
summary: Default DeleteRegistry 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
DeleteRegistry483Example:
summary: Default DeleteRegistry 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRegistryInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeleteRegistry
summary: Amazon Glue Delete Registry
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.DeleteResourcePolicy:
post:
operationId: DeleteResourcePolicy
description: Deletes a specified policy.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResourcePolicyResponse'
examples:
DeleteResourcePolicy200Example:
summary: Default DeleteResourcePolicy 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
DeleteResourcePolicy480Example:
summary: Default DeleteResourcePolicy 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
DeleteResourcePolicy481Example:
summary: Default DeleteResourcePolicy 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
DeleteResourcePolicy482Example:
summary: Default DeleteResourcePolicy 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
DeleteResourcePolicy483Example:
summary: Default DeleteResourcePolicy 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: ConditionCheckFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ConditionCheckFailureException'
examples:
DeleteResourcePolicy484Example:
summary: Default DeleteResourcePolicy 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResourcePolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeleteResourcePolicy
summary: Amazon Glue Delete Resource Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.DeleteSchema:
post:
operationId: DeleteSchema
description: Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the
asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSchemaResponse'
examples:
DeleteSchema200Example:
summary: Default DeleteSchema 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
DeleteSchema480Example:
summary: Default DeleteSchema 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
DeleteSchema481Example:
summary: Default DeleteSchema 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DeleteSchema482Example:
summary: Default DeleteSchema 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
DeleteSchema483Example:
summary: Default DeleteSchema 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSchemaInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeleteSchema
summary: Amazon Glue Delete Schema
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.DeleteSchemaVersions:
post:
operationId: DeleteSchemaVersions
description: Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as
BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions.
When the range of version numbers
contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint
API before using this API.
You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by
the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database.
If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSchemaVersionsResponse' examples: DeleteSchemaVersions200Example: summary: Default DeleteSchemaVersions 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: DeleteSchemaVersions480Example: summary: Default DeleteSchemaVersions 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: DeleteSchemaVersions481Example: summary: Default DeleteSchemaVersions 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DeleteSchemaVersions482Example: summary: Default DeleteSchemaVersions 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: DeleteSchemaVersions483Example: summary: Default DeleteSchemaVersions 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteSchemaVersionsInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.DeleteSchemaVersions summary: Amazon Glue Delete Schema Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.DeleteSecurityConfiguration: post: operationId: DeleteSecurityConfiguration description: Deletes a specified security configuration. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSecurityConfigurationResponse' examples: DeleteSecurityConfiguration200Example: summary: Default DeleteSecurityConfiguration 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: DeleteSecurityConfiguration480Example: summary: Default DeleteSecurityConfiguration 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: DeleteSecurityConfiguration481Example: summary: Default DeleteSecurityConfiguration 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: DeleteSecurityConfiguration482Example: summary: Default DeleteSecurityConfiguration 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: DeleteSecurityConfiguration483Example: summary: Default DeleteSecurityConfiguration 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteSecurityConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.DeleteSecurityConfiguration summary: Amazon Glue Delete Security Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.DeleteSession: post: operationId: DeleteSession description: Deletes the session. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSessionResponse' examples: DeleteSession200Example: summary: Default DeleteSession 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DeleteSession480Example: summary: Default DeleteSession 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: DeleteSession481Example: summary: Default DeleteSession 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: DeleteSession482Example: summary: Default DeleteSession 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: DeleteSession483Example: summary: Default DeleteSession 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: IllegalSessionStateException content: application/json: schema: $ref: '#/components/schemas/IllegalSessionStateException' examples: DeleteSession484Example: summary: Default DeleteSession 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: DeleteSession485Example: summary: Default DeleteSession 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteSessionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.DeleteSession summary: Amazon Glue Delete Session x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.DeleteTable: post: operationId: DeleteTable description:Removes a table definition from the Data Catalog.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources,
before calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to
delete any resources that belong to the table.
Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetPartition.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetTable.
Retrieves information about a specified development endpoint.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Retrieves all the development endpoints in this Amazon Web Services account.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Returns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJobBookmarkResponse' examples: GetJobBookmark200Example: summary: Default GetJobBookmark 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetJobBookmark480Example: summary: Default GetJobBookmark 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetJobBookmark481Example: summary: Default GetJobBookmark 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetJobBookmark482Example: summary: Default GetJobBookmark 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetJobBookmark483Example: summary: Default GetJobBookmark 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetJobBookmark484Example: summary: Default GetJobBookmark 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetJobBookmarkRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetJobBookmark summary: Amazon Glue Get Job Bookmark x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetJobRun: post: operationId: GetJobRun description: Retrieves the metadata for a given job run. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJobRunResponse' examples: GetJobRun200Example: summary: Default GetJobRun 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetJobRun480Example: summary: Default GetJobRun 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetJobRun481Example: summary: Default GetJobRun 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetJobRun482Example: summary: Default GetJobRun 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetJobRun483Example: summary: Default GetJobRun 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetJobRunRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetJobRun summary: Amazon Glue Get Job Run x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetJobRuns: post: operationId: GetJobRuns description: Retrieves metadata for all runs of a given job definition. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJobRunsResponse' examples: GetJobRuns200Example: summary: Default GetJobRuns 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetJobRuns480Example: summary: Default GetJobRuns 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetJobRuns481Example: summary: Default GetJobRuns 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetJobRuns482Example: summary: Default GetJobRuns 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetJobRuns483Example: summary: Default GetJobRuns 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetJobRunsRequest' 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.GetJobRuns summary: Amazon Glue Get Job Runs x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetJobs: post: operationId: GetJobs description: Retrieves all current job definitions. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJobsResponse' examples: GetJobs200Example: summary: Default GetJobs 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetJobs480Example: summary: Default GetJobs 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetJobs481Example: summary: Default GetJobs 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetJobs482Example: summary: Default GetJobs 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetJobs483Example: summary: Default GetJobs 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetJobsRequest' 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.GetJobs summary: Amazon Glue Get Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetMLTaskRun: post: operationId: GetMLTaskRun description: Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by callingGetMLTaskRun with the TaskRunID and its parent transform's TransformID.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetMLTaskRunResponse'
examples:
GetMLTaskRun200Example:
summary: Default GetMLTaskRun 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetMLTaskRun480Example:
summary: Default GetMLTaskRun 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetMLTaskRun481Example:
summary: Default GetMLTaskRun 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetMLTaskRun482Example:
summary: Default GetMLTaskRun 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetMLTaskRun483Example:
summary: Default GetMLTaskRun 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetMLTaskRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetMLTaskRun
summary: Amazon Glue Get M L Task Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetMLTaskRuns:
post:
operationId: GetMLTaskRuns
description: Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning
workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform's TransformID and other optional
parameters as documented in this section.
This operation returns a list of historic runs and must be paginated.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMLTaskRunsResponse' examples: GetMLTaskRuns200Example: summary: Default GetMLTaskRuns 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetMLTaskRuns480Example: summary: Default GetMLTaskRuns 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetMLTaskRuns481Example: summary: Default GetMLTaskRuns 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetMLTaskRuns482Example: summary: Default GetMLTaskRuns 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetMLTaskRuns483Example: summary: Default GetMLTaskRuns 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetMLTaskRunsRequest' 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.GetMLTaskRuns summary: Amazon Glue Get M L Task Runs x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetMLTransform: post: operationId: GetMLTransform description: Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by callingGetMLTransform.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetMLTransformResponse'
examples:
GetMLTransform200Example:
summary: Default GetMLTransform 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetMLTransform480Example:
summary: Default GetMLTransform 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetMLTransform481Example:
summary: Default GetMLTransform 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetMLTransform482Example:
summary: Default GetMLTransform 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetMLTransform483Example:
summary: Default GetMLTransform 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetMLTransformRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetMLTransform
summary: Amazon Glue Get M L Transform
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetMLTransforms:
post:
operationId: GetMLTransforms
description: Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the
details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling
GetMLTransforms.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetMLTransformsResponse'
examples:
GetMLTransforms200Example:
summary: Default GetMLTransforms 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetMLTransforms480Example:
summary: Default GetMLTransforms 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetMLTransforms481Example:
summary: Default GetMLTransforms 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetMLTransforms482Example:
summary: Default GetMLTransforms 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetMLTransforms483Example:
summary: Default GetMLTransforms 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetMLTransformsRequest'
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.GetMLTransforms
summary: Amazon Glue Get M L Transforms
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetMapping:
post:
operationId: GetMapping
description: Creates mappings.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetMappingResponse'
examples:
GetMapping200Example:
summary: Default GetMapping 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetMapping480Example:
summary: Default GetMapping 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetMapping481Example:
summary: Default GetMapping 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetMapping482Example:
summary: Default GetMapping 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetMapping483Example:
summary: Default GetMapping 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetMappingRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetMapping
summary: Amazon Glue Get Mapping
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetPartition:
post:
operationId: GetPartition
description: Retrieves information about a specified partition.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPartitionResponse'
examples:
GetPartition200Example:
summary: Default GetPartition 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetPartition480Example:
summary: Default GetPartition 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetPartition481Example:
summary: Default GetPartition 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetPartition482Example:
summary: Default GetPartition 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetPartition483Example:
summary: Default GetPartition 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
GetPartition484Example:
summary: Default GetPartition 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: FederationSourceException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceException'
examples:
GetPartition485Example:
summary: Default GetPartition 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'486':
description: FederationSourceRetryableException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceRetryableException'
examples:
GetPartition486Example:
summary: Default GetPartition 486 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetPartitionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetPartition
summary: Amazon Glue Get Partition
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetPartitionIndexes:
post:
operationId: GetPartitionIndexes
description: Retrieves the partition indexes associated with a table.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPartitionIndexesResponse'
examples:
GetPartitionIndexes200Example:
summary: Default GetPartitionIndexes 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetPartitionIndexes480Example:
summary: Default GetPartitionIndexes 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetPartitionIndexes481Example:
summary: Default GetPartitionIndexes 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetPartitionIndexes482Example:
summary: Default GetPartitionIndexes 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetPartitionIndexes483Example:
summary: Default GetPartitionIndexes 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
GetPartitionIndexes484Example:
summary: Default GetPartitionIndexes 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetPartitionIndexesRequest'
parameters:
- 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.GetPartitionIndexes
summary: Amazon Glue Get Partition Indexes
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetPartitions:
post:
operationId: GetPartitions
description: Retrieves information about the partitions in a table.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPartitionsResponse'
examples:
GetPartitions200Example:
summary: Default GetPartitions 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetPartitions480Example:
summary: Default GetPartitions 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetPartitions481Example:
summary: Default GetPartitions 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetPartitions482Example:
summary: Default GetPartitions 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetPartitions483Example:
summary: Default GetPartitions 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
GetPartitions484Example:
summary: Default GetPartitions 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: InvalidStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidStateException'
examples:
GetPartitions485Example:
summary: Default GetPartitions 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'486':
description: ResourceNotReadyException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotReadyException'
examples:
GetPartitions486Example:
summary: Default GetPartitions 486 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'487':
description: FederationSourceException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceException'
examples:
GetPartitions487Example:
summary: Default GetPartitions 487 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'488':
description: FederationSourceRetryableException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceRetryableException'
examples:
GetPartitions488Example:
summary: Default GetPartitions 488 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetPartitionsRequest'
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.GetPartitions
summary: Amazon Glue Get Partitions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetPlan:
post:
operationId: GetPlan
description: Gets code to perform a specified mapping.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPlanResponse'
examples:
GetPlan200Example:
summary: Default GetPlan 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetPlan480Example:
summary: Default GetPlan 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetPlan481Example:
summary: Default GetPlan 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetPlan482Example:
summary: Default GetPlan 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetPlanRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetPlan
summary: Amazon Glue Get Plan
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetRegistry:
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
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'
/#X-Amz-Target=AWSGlue.GetResourcePolicies:
post:
operationId: GetResourcePolicies
description: Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy.
If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can't return the Data Catalog resource policy.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetResourcePoliciesResponse' examples: GetResourcePolicies200Example: summary: Default GetResourcePolicies 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetResourcePolicies480Example: summary: Default GetResourcePolicies 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetResourcePolicies481Example: summary: Default GetResourcePolicies 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetResourcePolicies482Example: summary: Default GetResourcePolicies 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: GlueEncryptionException content: application/json: schema: $ref: '#/components/schemas/GlueEncryptionException' examples: GetResourcePolicies483Example: summary: Default GetResourcePolicies 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetResourcePoliciesRequest' 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.GetResourcePolicies summary: Amazon Glue Get Resource Policies x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetResourcePolicy: post: operationId: GetResourcePolicy description: Retrieves a specified resource policy. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetResourcePolicyResponse' examples: GetResourcePolicy200Example: summary: Default GetResourcePolicy 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetResourcePolicy480Example: summary: Default GetResourcePolicy 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetResourcePolicy481Example: summary: Default GetResourcePolicy 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetResourcePolicy482Example: summary: Default GetResourcePolicy 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetResourcePolicy483Example: summary: Default GetResourcePolicy 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetResourcePolicyRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetResourcePolicy summary: Amazon Glue Get Resource Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetSchema: post: operationId: GetSchema description: Describes the specified schema in detail. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSchemaResponse' examples: GetSchema200Example: summary: Default GetSchema 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetSchema480Example: summary: Default GetSchema 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetSchema481Example: summary: Default GetSchema 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetSchema482Example: summary: Default GetSchema 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetSchema483Example: summary: Default GetSchema 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetSchemaInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetSchema summary: Amazon Glue Get Schema x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetSchemaByDefinition: post: operationId: GetSchemaByDefinition description: Retrieves a schema by theSchemaDefinition. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of
the SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in
Deleted statuses will not be included in the results.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSchemaByDefinitionResponse'
examples:
GetSchemaByDefinition200Example:
summary: Default GetSchemaByDefinition 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetSchemaByDefinition480Example:
summary: Default GetSchemaByDefinition 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
GetSchemaByDefinition481Example:
summary: Default GetSchemaByDefinition 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetSchemaByDefinition482Example:
summary: Default GetSchemaByDefinition 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetSchemaByDefinition483Example:
summary: Default GetSchemaByDefinition 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetSchemaByDefinitionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetSchemaByDefinition
summary: Amazon Glue Get Schema by Definition
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetSchemaVersion:
post:
operationId: GetSchemaVersion
description: Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSchemaVersionResponse'
examples:
GetSchemaVersion200Example:
summary: Default GetSchemaVersion 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetSchemaVersion480Example:
summary: Default GetSchemaVersion 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
GetSchemaVersion481Example:
summary: Default GetSchemaVersion 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetSchemaVersion482Example:
summary: Default GetSchemaVersion 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetSchemaVersion483Example:
summary: Default GetSchemaVersion 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetSchemaVersionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetSchemaVersion
summary: Amazon Glue Get Schema Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetSchemaVersionsDiff:
post:
operationId: GetSchemaVersionsDiff
description: Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSchemaVersionsDiffResponse' examples: GetSchemaVersionsDiff200Example: summary: Default GetSchemaVersionsDiff 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetSchemaVersionsDiff480Example: summary: Default GetSchemaVersionsDiff 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetSchemaVersionsDiff481Example: summary: Default GetSchemaVersionsDiff 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetSchemaVersionsDiff482Example: summary: Default GetSchemaVersionsDiff 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetSchemaVersionsDiff483Example: summary: Default GetSchemaVersionsDiff 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetSchemaVersionsDiffInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetSchemaVersionsDiff summary: Amazon Glue Get Schema Versions Diff x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetSecurityConfiguration: post: operationId: GetSecurityConfiguration description: Retrieves a specified security configuration. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSecurityConfigurationResponse' examples: GetSecurityConfiguration200Example: summary: Default GetSecurityConfiguration 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetSecurityConfiguration480Example: summary: Default GetSecurityConfiguration 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetSecurityConfiguration481Example: summary: Default GetSecurityConfiguration 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetSecurityConfiguration482Example: summary: Default GetSecurityConfiguration 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetSecurityConfiguration483Example: summary: Default GetSecurityConfiguration 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetSecurityConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetSecurityConfiguration summary: Amazon Glue Get Security Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetSecurityConfigurations: post: operationId: GetSecurityConfigurations description: Retrieves a list of all security configurations. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSecurityConfigurationsResponse' examples: GetSecurityConfigurations200Example: summary: Default GetSecurityConfigurations 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetSecurityConfigurations480Example: summary: Default GetSecurityConfigurations 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetSecurityConfigurations481Example: summary: Default GetSecurityConfigurations 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetSecurityConfigurations482Example: summary: Default GetSecurityConfigurations 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetSecurityConfigurations483Example: summary: Default GetSecurityConfigurations 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetSecurityConfigurationsRequest' 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.GetSecurityConfigurations summary: Amazon Glue Get Security Configurations x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetSession: post: operationId: GetSession description: Retrieves the session. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSessionResponse' examples: GetSession200Example: summary: Default GetSession 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetSession480Example: summary: Default GetSession 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetSession481Example: summary: Default GetSession 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetSession482Example: summary: Default GetSession 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetSession483Example: summary: Default GetSession 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetSession484Example: summary: Default GetSession 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetSessionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetSession summary: Amazon Glue Get Session x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetStatement: post: operationId: GetStatement description: Retrieves the statement. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetStatementResponse' examples: GetStatement200Example: summary: Default GetStatement 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetStatement480Example: summary: Default GetStatement 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetStatement481Example: summary: Default GetStatement 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetStatement482Example: summary: Default GetStatement 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetStatement483Example: summary: Default GetStatement 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetStatement484Example: summary: Default GetStatement 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: IllegalSessionStateException content: application/json: schema: $ref: '#/components/schemas/IllegalSessionStateException' examples: GetStatement485Example: summary: Default GetStatement 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetStatementRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetStatement summary: Amazon Glue Get Statement x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.GetTable: post: operationId: GetTable description: Retrieves theTable definition in a Data Catalog for a specified table.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTableResponse'
examples:
GetTable200Example:
summary: Default GetTable 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetTable480Example:
summary: Default GetTable 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetTable481Example:
summary: Default GetTable 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetTable482Example:
summary: Default GetTable 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetTable483Example:
summary: Default GetTable 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
GetTable484Example:
summary: Default GetTable 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: ResourceNotReadyException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotReadyException'
examples:
GetTable485Example:
summary: Default GetTable 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'486':
description: FederationSourceException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceException'
examples:
GetTable486Example:
summary: Default GetTable 486 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'487':
description: FederationSourceRetryableException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceRetryableException'
examples:
GetTable487Example:
summary: Default GetTable 487 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTableRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetTable
summary: Amazon Glue Get Table
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetTableVersion:
post:
operationId: GetTableVersion
description: Retrieves a specified version of a table.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTableVersionResponse'
examples:
GetTableVersion200Example:
summary: Default GetTableVersion 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetTableVersion480Example:
summary: Default GetTableVersion 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetTableVersion481Example:
summary: Default GetTableVersion 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetTableVersion482Example:
summary: Default GetTableVersion 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetTableVersion483Example:
summary: Default GetTableVersion 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
GetTableVersion484Example:
summary: Default GetTableVersion 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTableVersionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetTableVersion
summary: Amazon Glue Get Table Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetTableVersions:
post:
operationId: GetTableVersions
description: Retrieves a list of strings that identify available versions of a specified table.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTableVersionsResponse'
examples:
GetTableVersions200Example:
summary: Default GetTableVersions 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetTableVersions480Example:
summary: Default GetTableVersions 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetTableVersions481Example:
summary: Default GetTableVersions 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetTableVersions482Example:
summary: Default GetTableVersions 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetTableVersions483Example:
summary: Default GetTableVersions 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
GetTableVersions484Example:
summary: Default GetTableVersions 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTableVersionsRequest'
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.GetTableVersions
summary: Amazon Glue Get Table Versions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetTables:
post:
operationId: GetTables
description: Retrieves the definitions of some or all of the tables in a given Database.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTablesResponse'
examples:
GetTables200Example:
summary: Default GetTables 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetTables480Example:
summary: Default GetTables 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetTables481Example:
summary: Default GetTables 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetTables482Example:
summary: Default GetTables 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetTables483Example:
summary: Default GetTables 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
GetTables484Example:
summary: Default GetTables 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: FederationSourceException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceException'
examples:
GetTables485Example:
summary: Default GetTables 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'486':
description: FederationSourceRetryableException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceRetryableException'
examples:
GetTables486Example:
summary: Default GetTables 486 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTablesRequest'
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.GetTables
summary: Amazon Glue Get Tables
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetTags:
post:
operationId: GetTags
description: Retrieves a list of tags associated with a resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTagsResponse'
examples:
GetTags200Example:
summary: Default GetTags 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetTags480Example:
summary: Default GetTags 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetTags481Example:
summary: Default GetTags 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetTags482Example:
summary: Default GetTags 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetTags483Example:
summary: Default GetTags 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTagsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetTags
summary: Amazon Glue Get Tags
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetTrigger:
post:
operationId: GetTrigger
description: Retrieves the definition of a trigger.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTriggerResponse'
examples:
GetTrigger200Example:
summary: Default GetTrigger 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetTrigger480Example:
summary: Default GetTrigger 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetTrigger481Example:
summary: Default GetTrigger 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetTrigger482Example:
summary: Default GetTrigger 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetTrigger483Example:
summary: Default GetTrigger 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTriggerRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetTrigger
summary: Amazon Glue Get Trigger
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetTriggers:
post:
operationId: GetTriggers
description: Gets all the triggers associated with a job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTriggersResponse'
examples:
GetTriggers200Example:
summary: Default GetTriggers 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetTriggers480Example:
summary: Default GetTriggers 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetTriggers481Example:
summary: Default GetTriggers 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetTriggers482Example:
summary: Default GetTriggers 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetTriggers483Example:
summary: Default GetTriggers 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTriggersRequest'
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.GetTriggers
summary: Amazon Glue Get Triggers
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.GetUnfilteredPartitionMetadata:
post:
operationId: GetUnfilteredPartitionMetadata
description: Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
glue:GetPartition.
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
glue:GetPartitions.
Retrieves table metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
glue:GetTable.
Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be
retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.
You may use this API to:
Retrive all the crawls of a specified crawler.
Retrieve all the crawls of a specified crawler within a limited count.
Retrieve all the crawls of a specified crawler in a specific time range.
Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.
Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which
resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged
resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be
retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with
the tags are retrieved. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListMLTransformsResponse'
examples:
ListMLTransforms200Example:
summary: Default ListMLTransforms 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
ListMLTransforms480Example:
summary: Default ListMLTransforms 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
ListMLTransforms481Example:
summary: Default ListMLTransforms 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
ListMLTransforms482Example:
summary: Default ListMLTransforms 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
ListMLTransforms483Example:
summary: Default ListMLTransforms 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListMLTransformsRequest'
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.ListMLTransforms
summary: Amazon Glue List M L Transforms
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.ListRegistries:
post:
operationId: ListRegistries
description: Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty
results will be returned if there are no registries available.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRegistriesResponse'
examples:
ListRegistries200Example:
summary: Default ListRegistries 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
ListRegistries480Example:
summary: Default ListRegistries 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListRegistries481Example:
summary: Default ListRegistries 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
ListRegistries482Example:
summary: Default ListRegistries 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListRegistriesInput'
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.ListRegistries
summary: Amazon Glue List Registries
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.ListSchemaVersions:
post:
operationId: ListSchemaVersions
description: Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be
returned if there are no schema versions available.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSchemaVersionsResponse'
examples:
ListSchemaVersions200Example:
summary: Default ListSchemaVersions 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
ListSchemaVersions480Example:
summary: Default ListSchemaVersions 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListSchemaVersions481Example:
summary: Default ListSchemaVersions 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
ListSchemaVersions482Example:
summary: Default ListSchemaVersions 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
ListSchemaVersions483Example:
summary: Default ListSchemaVersions 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListSchemaVersionsInput'
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.ListSchemaVersions
summary: Amazon Glue List Schema Versions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.ListSchemas:
post:
operationId: ListSchemas
description: Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.
When the RegistryId is not provided, all the schemas across registries will be part of the API response.
Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be
retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.
If this is the first schema definition to be registered in the Schema
Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the
GetSchemaVersion API with the SchemaVersionId to check compatibility modes.
If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RegisterSchemaVersionResponse' examples: RegisterSchemaVersion200Example: summary: Default RegisterSchemaVersion 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: RegisterSchemaVersion480Example: summary: Default RegisterSchemaVersion 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: RegisterSchemaVersion481Example: summary: Default RegisterSchemaVersion 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: RegisterSchemaVersion482Example: summary: Default RegisterSchemaVersion 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: RegisterSchemaVersion483Example: summary: Default RegisterSchemaVersion 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: RegisterSchemaVersion484Example: summary: Default RegisterSchemaVersion 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: RegisterSchemaVersion485Example: summary: Default RegisterSchemaVersion 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegisterSchemaVersionInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.RegisterSchemaVersion summary: Amazon Glue Register Schema Version x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.RemoveSchemaVersionMetadata: post: operationId: RemoveSchemaVersionMetadata description: Removes a key value pair from the schema version metadata for the specified schema version ID. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveSchemaVersionMetadataResponse' examples: RemoveSchemaVersionMetadata200Example: summary: Default RemoveSchemaVersionMetadata 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: RemoveSchemaVersionMetadata480Example: summary: Default RemoveSchemaVersionMetadata 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: RemoveSchemaVersionMetadata481Example: summary: Default RemoveSchemaVersionMetadata 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: RemoveSchemaVersionMetadata482Example: summary: Default RemoveSchemaVersionMetadata 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RemoveSchemaVersionMetadataInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.RemoveSchemaVersionMetadata summary: Amazon Glue Remove Schema Version Metadata x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.ResetJobBookmark: post: operationId: ResetJobBookmark description:Resets a bookmark entry.
For more information about enabling and using job bookmarks, see:
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResetJobBookmarkResponse' examples: ResetJobBookmark200Example: summary: Default ResetJobBookmark 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: ResetJobBookmark480Example: summary: Default ResetJobBookmark 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: ResetJobBookmark481Example: summary: Default ResetJobBookmark 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: ResetJobBookmark482Example: summary: Default ResetJobBookmark 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: ResetJobBookmark483Example: summary: Default ResetJobBookmark 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResetJobBookmarkRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.ResetJobBookmark summary: Amazon Glue Reset Job Bookmark x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.ResumeWorkflowRun: post: operationId: ResumeWorkflowRun description: Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResumeWorkflowRunResponse' examples: ResumeWorkflowRun200Example: summary: Default ResumeWorkflowRun 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: ResumeWorkflowRun480Example: summary: Default ResumeWorkflowRun 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: ResumeWorkflowRun481Example: summary: Default ResumeWorkflowRun 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: ResumeWorkflowRun482Example: summary: Default ResumeWorkflowRun 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: ResumeWorkflowRun483Example: summary: Default ResumeWorkflowRun 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: ConcurrentRunsExceededException content: application/json: schema: $ref: '#/components/schemas/ConcurrentRunsExceededException' examples: ResumeWorkflowRun484Example: summary: Default ResumeWorkflowRun 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: IllegalWorkflowStateException content: application/json: schema: $ref: '#/components/schemas/IllegalWorkflowStateException' examples: ResumeWorkflowRun485Example: summary: Default ResumeWorkflowRun 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResumeWorkflowRunRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.ResumeWorkflowRun summary: Amazon Glue Resume Workflow Run x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.RunStatement: post: operationId: RunStatement description: Executes the statement. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RunStatementResponse' examples: RunStatement200Example: summary: Default RunStatement 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: RunStatement480Example: summary: Default RunStatement 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: RunStatement481Example: summary: Default RunStatement 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: RunStatement482Example: summary: Default RunStatement 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: RunStatement483Example: summary: Default RunStatement 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: RunStatement484Example: summary: Default RunStatement 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: RunStatement485Example: summary: Default RunStatement 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '486': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: RunStatement486Example: summary: Default RunStatement 486 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '487': description: IllegalSessionStateException content: application/json: schema: $ref: '#/components/schemas/IllegalSessionStateException' examples: RunStatement487Example: summary: Default RunStatement 487 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RunStatementRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.RunStatement summary: Amazon Glue Run Statement x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.SearchTables: post: operationId: SearchTables description:Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SearchTablesResponse' examples: SearchTables200Example: summary: Default SearchTables 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: SearchTables480Example: summary: Default SearchTables 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: SearchTables481Example: summary: Default SearchTables 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: SearchTables482Example: summary: Default SearchTables 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchTablesRequest' 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.SearchTables summary: Amazon Glue Search Tables x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.StartBlueprintRun: post: operationId: StartBlueprintRun description: Starts a new run of the specified blueprint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartBlueprintRunResponse' examples: StartBlueprintRun200Example: summary: Default StartBlueprintRun 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: StartBlueprintRun480Example: summary: Default StartBlueprintRun 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: StartBlueprintRun481Example: summary: Default StartBlueprintRun 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: StartBlueprintRun482Example: summary: Default StartBlueprintRun 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: StartBlueprintRun483Example: summary: Default StartBlueprintRun 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: StartBlueprintRun484Example: summary: Default StartBlueprintRun 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: IllegalBlueprintStateException content: application/json: schema: $ref: '#/components/schemas/IllegalBlueprintStateException' examples: StartBlueprintRun485Example: summary: Default StartBlueprintRun 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartBlueprintRunRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.StartBlueprintRun summary: Amazon Glue Start Blueprint Run x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.StartCrawler: post: operationId: StartCrawler description: Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartCrawlerResponse' examples: StartCrawler200Example: summary: Default StartCrawler 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: StartCrawler480Example: summary: Default StartCrawler 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: CrawlerRunningException content: application/json: schema: $ref: '#/components/schemas/CrawlerRunningException' examples: StartCrawler481Example: summary: Default StartCrawler 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: StartCrawler482Example: summary: Default StartCrawler 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartCrawlerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.StartCrawler summary: Amazon Glue Start Crawler x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.StartCrawlerSchedule: post: operationId: StartCrawlerSchedule description: Changes the schedule state of the specified crawler toSCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartCrawlerScheduleResponse'
examples:
StartCrawlerSchedule200Example:
summary: Default StartCrawlerSchedule 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
StartCrawlerSchedule480Example:
summary: Default StartCrawlerSchedule 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: SchedulerRunningException
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulerRunningException'
examples:
StartCrawlerSchedule481Example:
summary: Default StartCrawlerSchedule 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: SchedulerTransitioningException
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulerTransitioningException'
examples:
StartCrawlerSchedule482Example:
summary: Default StartCrawlerSchedule 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: NoScheduleException
content:
application/json:
schema:
$ref: '#/components/schemas/NoScheduleException'
examples:
StartCrawlerSchedule483Example:
summary: Default StartCrawlerSchedule 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
StartCrawlerSchedule484Example:
summary: Default StartCrawlerSchedule 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartCrawlerScheduleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.StartCrawlerSchedule
summary: Amazon Glue Start Crawler Schedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.StartDataQualityRuleRecommendationRun:
post:
operationId: StartDataQualityRuleRecommendationRun
description: Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a
potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartDataQualityRuleRecommendationRunResponse'
examples:
StartDataQualityRuleRecommendationRun200Example:
summary: Default StartDataQualityRuleRecommendationRun 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StartDataQualityRuleRecommendationRun480Example:
summary: Default StartDataQualityRuleRecommendationRun 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
StartDataQualityRuleRecommendationRun481Example:
summary: Default StartDataQualityRuleRecommendationRun 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
StartDataQualityRuleRecommendationRun482Example:
summary: Default StartDataQualityRuleRecommendationRun 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StartDataQualityRuleRecommendationRun483Example:
summary: Default StartDataQualityRuleRecommendationRun 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartDataQualityRuleRecommendationRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.StartDataQualityRuleRecommendationRun
summary: Amazon Glue Start Data Quality Rule Recommendation Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.StartDataQualityRulesetEvaluationRun:
post:
operationId: StartDataQualityRulesetEvaluationRun
description: Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table). The evaluation computes
results which you can retrieve with the GetDataQualityResult API.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartDataQualityRulesetEvaluationRunResponse'
examples:
StartDataQualityRulesetEvaluationRun200Example:
summary: Default StartDataQualityRulesetEvaluationRun 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StartDataQualityRulesetEvaluationRun480Example:
summary: Default StartDataQualityRulesetEvaluationRun 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
StartDataQualityRulesetEvaluationRun481Example:
summary: Default StartDataQualityRulesetEvaluationRun 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
StartDataQualityRulesetEvaluationRun482Example:
summary: Default StartDataQualityRulesetEvaluationRun 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
StartDataQualityRulesetEvaluationRun483Example:
summary: Default StartDataQualityRulesetEvaluationRun 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StartDataQualityRulesetEvaluationRun484Example:
summary: Default StartDataQualityRulesetEvaluationRun 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartDataQualityRulesetEvaluationRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.StartDataQualityRulesetEvaluationRun
summary: Amazon Glue Start Data Quality Ruleset Evaluation Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.StartExportLabelsTaskRun:
post:
operationId: StartExportLabelsTaskRun
description: Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning
workflow. You typically use StartExportLabelsTaskRun when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that
were previously submitted as truth. This API operation accepts the TransformId whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the
labels to. The operation returns a TaskRunId. You can check on the status of your task run by calling the GetMLTaskRun API.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartExportLabelsTaskRunResponse'
examples:
StartExportLabelsTaskRun200Example:
summary: Default StartExportLabelsTaskRun 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
StartExportLabelsTaskRun480Example:
summary: Default StartExportLabelsTaskRun 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StartExportLabelsTaskRun481Example:
summary: Default StartExportLabelsTaskRun 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
StartExportLabelsTaskRun482Example:
summary: Default StartExportLabelsTaskRun 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
StartExportLabelsTaskRun483Example:
summary: Default StartExportLabelsTaskRun 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartExportLabelsTaskRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.StartExportLabelsTaskRun
summary: Amazon Glue Start Export Labels Task Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.StartImportLabelsTaskRun:
post:
operationId: StartImportLabelsTaskRun
description: Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as
part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the quality of your machine learning
transform.
After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these
questions is often called 'labeling' in the machine learning workflows). In the case of the FindMatches transform, these questions are of the form, “What is the correct way to
group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to
StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform use the new and improved labels and perform a
higher-quality transformation.
By default, StartMLLabelingSetGenerationTaskRun continually learns from and combines all labels that you upload unless you set
Replace to true. If you set Replace to true, StartImportLabelsTaskRun deletes and forgets all previously uploaded labels and learns only from the exact
set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform
quality.
You can check on the status of your task run by calling the GetMLTaskRun operation.
Starts a task to estimate the quality of the transform.
When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.
Returns a unique identifier for the run. You can call GetMLTaskRun to get more information about the
stats of the EvaluationTaskRun.
Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.
When the
StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.
In the case of the
FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”
After the
labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the
machine learning transform will use the new and improved labels and perform a higher-quality transformation.
NOT_SCHEDULED, but does not stop the crawler if it is already running.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopCrawlerScheduleResponse'
examples:
StopCrawlerSchedule200Example:
summary: Default StopCrawlerSchedule 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
StopCrawlerSchedule480Example:
summary: Default StopCrawlerSchedule 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: SchedulerNotRunningException
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulerNotRunningException'
examples:
StopCrawlerSchedule481Example:
summary: Default StopCrawlerSchedule 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: SchedulerTransitioningException
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulerTransitioningException'
examples:
StopCrawlerSchedule482Example:
summary: Default StopCrawlerSchedule 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
StopCrawlerSchedule483Example:
summary: Default StopCrawlerSchedule 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopCrawlerScheduleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.StopCrawlerSchedule
summary: Amazon Glue Stop Crawler Schedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.StopSession:
post:
operationId: StopSession
description: Stops the session.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopSessionResponse'
examples:
StopSession200Example:
summary: Default StopSession 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StopSession480Example:
summary: Default StopSession 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
StopSession481Example:
summary: Default StopSession 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
StopSession482Example:
summary: Default StopSession 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StopSession483Example:
summary: Default StopSession 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: IllegalSessionStateException
content:
application/json:
schema:
$ref: '#/components/schemas/IllegalSessionStateException'
examples:
StopSession484Example:
summary: Default StopSession 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
StopSession485Example:
summary: Default StopSession 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopSessionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.StopSession
summary: Amazon Glue Stop Session
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.StopTrigger:
post:
operationId: StopTrigger
description: Stops a specified trigger.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopTriggerResponse'
examples:
StopTrigger200Example:
summary: Default StopTrigger 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StopTrigger480Example:
summary: Default StopTrigger 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
StopTrigger481Example:
summary: Default StopTrigger 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
StopTrigger482Example:
summary: Default StopTrigger 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
StopTrigger483Example:
summary: Default StopTrigger 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
StopTrigger484Example:
summary: Default StopTrigger 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopTriggerRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.StopTrigger
summary: Amazon Glue Stop Trigger
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.StopWorkflowRun:
post:
operationId: StopWorkflowRun
description: Stops the execution of the specified workflow run.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopWorkflowRunResponse'
examples:
StopWorkflowRun200Example:
summary: Default StopWorkflowRun 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StopWorkflowRun480Example:
summary: Default StopWorkflowRun 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
StopWorkflowRun481Example:
summary: Default StopWorkflowRun 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
StopWorkflowRun482Example:
summary: Default StopWorkflowRun 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
StopWorkflowRun483Example:
summary: Default StopWorkflowRun 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: IllegalWorkflowStateException
content:
application/json:
schema:
$ref: '#/components/schemas/IllegalWorkflowStateException'
examples:
StopWorkflowRun484Example:
summary: Default StopWorkflowRun 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopWorkflowRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.StopWorkflowRun
summary: Amazon Glue Stop Workflow Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.TagResource:
post:
operationId: TagResource
description: Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource. In Glue, you can tag only certain resources. For information about what resources you
can tag, see Amazon Web Services Tags in Glue.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceResponse'
examples:
TagResource200Example:
summary: Default TagResource 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
TagResource480Example:
summary: Default TagResource 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
TagResource481Example:
summary: Default TagResource 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
TagResource482Example:
summary: Default TagResource 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
TagResource483Example:
summary: Default TagResource 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.TagResource
summary: Amazon Glue Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UntagResource:
post:
operationId: UntagResource
description: Removes tags from a resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceResponse'
examples:
UntagResource200Example:
summary: Default UntagResource 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UntagResource480Example:
summary: Default UntagResource 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
UntagResource481Example:
summary: Default UntagResource 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UntagResource482Example:
summary: Default UntagResource 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UntagResource483Example:
summary: Default UntagResource 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UntagResource
summary: Amazon Glue Untag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UpdateBlueprint:
post:
operationId: UpdateBlueprint
description: Updates a registered blueprint.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateBlueprintResponse'
examples:
UpdateBlueprint200Example:
summary: Default UpdateBlueprint 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UpdateBlueprint480Example:
summary: Default UpdateBlueprint 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
UpdateBlueprint481Example:
summary: Default UpdateBlueprint 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateBlueprint482Example:
summary: Default UpdateBlueprint 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UpdateBlueprint483Example:
summary: Default UpdateBlueprint 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
UpdateBlueprint484Example:
summary: Default UpdateBlueprint 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: IllegalBlueprintStateException
content:
application/json:
schema:
$ref: '#/components/schemas/IllegalBlueprintStateException'
examples:
UpdateBlueprint485Example:
summary: Default UpdateBlueprint 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateBlueprintRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UpdateBlueprint
summary: Amazon Glue Update Blueprint
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UpdateClassifier:
post:
operationId: UpdateClassifier
description: Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which
field is present).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateClassifierResponse'
examples:
UpdateClassifier200Example:
summary: Default UpdateClassifier 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateClassifier480Example:
summary: Default UpdateClassifier 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: VersionMismatchException
content:
application/json:
schema:
$ref: '#/components/schemas/VersionMismatchException'
examples:
UpdateClassifier481Example:
summary: Default UpdateClassifier 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UpdateClassifier482Example:
summary: Default UpdateClassifier 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UpdateClassifier483Example:
summary: Default UpdateClassifier 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateClassifierRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UpdateClassifier
summary: Amazon Glue Update Classifier
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UpdateColumnStatisticsForPartition:
post:
operationId: UpdateColumnStatisticsForPartition
description: Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdateTable.
StopCrawler before updating it.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCrawlerResponse'
examples:
UpdateCrawler200Example:
summary: Default UpdateCrawler 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateCrawler480Example:
summary: Default UpdateCrawler 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: VersionMismatchException
content:
application/json:
schema:
$ref: '#/components/schemas/VersionMismatchException'
examples:
UpdateCrawler481Example:
summary: Default UpdateCrawler 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UpdateCrawler482Example:
summary: Default UpdateCrawler 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: CrawlerRunningException
content:
application/json:
schema:
$ref: '#/components/schemas/CrawlerRunningException'
examples:
UpdateCrawler483Example:
summary: Default UpdateCrawler 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UpdateCrawler484Example:
summary: Default UpdateCrawler 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCrawlerRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UpdateCrawler
summary: Amazon Glue Update Crawler
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UpdateCrawlerSchedule:
post:
operationId: UpdateCrawlerSchedule
description: 'Updates the schedule of a crawler using a cron expression. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCrawlerScheduleResponse'
examples:
UpdateCrawlerSchedule200Example:
summary: Default UpdateCrawlerSchedule 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UpdateCrawlerSchedule480Example:
summary: Default UpdateCrawlerSchedule 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateCrawlerSchedule481Example:
summary: Default UpdateCrawlerSchedule 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: VersionMismatchException
content:
application/json:
schema:
$ref: '#/components/schemas/VersionMismatchException'
examples:
UpdateCrawlerSchedule482Example:
summary: Default UpdateCrawlerSchedule 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: SchedulerTransitioningException
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulerTransitioningException'
examples:
UpdateCrawlerSchedule483Example:
summary: Default UpdateCrawlerSchedule 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UpdateCrawlerSchedule484Example:
summary: Default UpdateCrawlerSchedule 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCrawlerScheduleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UpdateCrawlerSchedule
summary: Amazon Glue Update Crawler Schedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UpdateDataQualityRuleset:
post:
operationId: UpdateDataQualityRuleset
description: Updates the specified data quality ruleset.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDataQualityRulesetResponse'
examples:
UpdateDataQualityRuleset200Example:
summary: Default UpdateDataQualityRuleset 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UpdateDataQualityRuleset480Example:
summary: Default UpdateDataQualityRuleset 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: AlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/AlreadyExistsException'
examples:
UpdateDataQualityRuleset481Example:
summary: Default UpdateDataQualityRuleset 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: IdempotentParameterMismatchException
content:
application/json:
schema:
$ref: '#/components/schemas/IdempotentParameterMismatchException'
examples:
UpdateDataQualityRuleset482Example:
summary: Default UpdateDataQualityRuleset 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateDataQualityRuleset483Example:
summary: Default UpdateDataQualityRuleset 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UpdateDataQualityRuleset484Example:
summary: Default UpdateDataQualityRuleset 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
UpdateDataQualityRuleset485Example:
summary: Default UpdateDataQualityRuleset 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'486':
description: ResourceNumberLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNumberLimitExceededException'
examples:
UpdateDataQualityRuleset486Example:
summary: Default UpdateDataQualityRuleset 486 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDataQualityRulesetRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UpdateDataQualityRuleset
summary: Amazon Glue Update Data Quality Ruleset
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UpdateDatabase:
post:
operationId: UpdateDatabase
description: Updates an existing database definition in a Data Catalog.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDatabaseResponse'
examples:
UpdateDatabase200Example:
summary: Default UpdateDatabase 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UpdateDatabase480Example:
summary: Default UpdateDatabase 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateDatabase481Example:
summary: Default UpdateDatabase 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
UpdateDatabase482Example:
summary: Default UpdateDatabase 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UpdateDatabase483Example:
summary: Default UpdateDatabase 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
UpdateDatabase484Example:
summary: Default UpdateDatabase 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
UpdateDatabase485Example:
summary: Default UpdateDatabase 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDatabaseRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UpdateDatabase
summary: Amazon Glue Update Database
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UpdateDevEndpoint:
post:
operationId: UpdateDevEndpoint
description: Updates a specified development endpoint.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDevEndpointResponse'
examples:
UpdateDevEndpoint200Example:
summary: Default UpdateDevEndpoint 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UpdateDevEndpoint480Example:
summary: Default UpdateDevEndpoint 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
UpdateDevEndpoint481Example:
summary: Default UpdateDevEndpoint 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UpdateDevEndpoint482Example:
summary: Default UpdateDevEndpoint 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateDevEndpoint483Example:
summary: Default UpdateDevEndpoint 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdateDevEndpoint484Example:
summary: Default UpdateDevEndpoint 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDevEndpointRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UpdateDevEndpoint
summary: Amazon Glue Update Dev Endpoint
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UpdateJob:
post:
operationId: UpdateJob
description: Updates an existing job definition. The previous job definition is completely overwritten by this information.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateJobResponse'
examples:
UpdateJob200Example:
summary: Default UpdateJob 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateJob480Example:
summary: Default UpdateJob 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UpdateJob481Example:
summary: Default UpdateJob 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
UpdateJob482Example:
summary: Default UpdateJob 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UpdateJob483Example:
summary: Default UpdateJob 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
UpdateJob484Example:
summary: Default UpdateJob 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateJobRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UpdateJob
summary: Amazon Glue Update Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSGlue.UpdateJobFromSourceControl:
post:
operationId: UpdateJobFromSourceControl
description: Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.
This API supports optional parameters which take in the repository information.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateJobFromSourceControlResponse' examples: UpdateJobFromSourceControl200Example: summary: Default UpdateJobFromSourceControl 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: UpdateJobFromSourceControl480Example: summary: Default UpdateJobFromSourceControl 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' examples: UpdateJobFromSourceControl481Example: summary: Default UpdateJobFromSourceControl 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: UpdateJobFromSourceControl482Example: summary: Default UpdateJobFromSourceControl 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UpdateJobFromSourceControl483Example: summary: Default UpdateJobFromSourceControl 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: UpdateJobFromSourceControl484Example: summary: Default UpdateJobFromSourceControl 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: UpdateJobFromSourceControl485Example: summary: Default UpdateJobFromSourceControl 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '486': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: UpdateJobFromSourceControl486Example: summary: Default UpdateJobFromSourceControl 486 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateJobFromSourceControlRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.UpdateJobFromSourceControl summary: Amazon Glue Update Job from Source Control x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.UpdateMLTransform: post: operationId: UpdateMLTransform description:Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.
After calling this operation, you can call
the StartMLEvaluationTaskRun operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it
more cost-effective).
Updates the description, compatibility setting, or version checkpoint for a schema set.
For updating the compatibility setting, the call will not validate compatibility
for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also
required. The API will validate the checkpoint version number for consistency.
If the value for the VersionNumber (checkpoint) is provided, Compatibility is
optional and this can be used to set/reset a checkpoint for the schema.
This update will happen only if the schema is in the AVAILABLE state.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSchemaResponse' examples: UpdateSchema200Example: summary: Default UpdateSchema 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: UpdateSchema480Example: summary: Default UpdateSchema 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: UpdateSchema481Example: summary: Default UpdateSchema 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: UpdateSchema482Example: summary: Default UpdateSchema 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: UpdateSchema483Example: summary: Default UpdateSchema 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: UpdateSchema484Example: summary: Default UpdateSchema 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSchemaInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.UpdateSchema summary: Amazon Glue Update Schema x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.UpdateSourceControlFromJob: post: operationId: UpdateSourceControlFromJob description:Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job.
This API supports optional parameters which take in the repository information.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSourceControlFromJobResponse' examples: UpdateSourceControlFromJob200Example: summary: Default UpdateSourceControlFromJob 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: UpdateSourceControlFromJob480Example: summary: Default UpdateSourceControlFromJob 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' examples: UpdateSourceControlFromJob481Example: summary: Default UpdateSourceControlFromJob 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: UpdateSourceControlFromJob482Example: summary: Default UpdateSourceControlFromJob 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UpdateSourceControlFromJob483Example: summary: Default UpdateSourceControlFromJob 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: UpdateSourceControlFromJob484Example: summary: Default UpdateSourceControlFromJob 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: UpdateSourceControlFromJob485Example: summary: Default UpdateSourceControlFromJob 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '486': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: UpdateSourceControlFromJob486Example: summary: Default UpdateSourceControlFromJob 486 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSourceControlFromJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.UpdateSourceControlFromJob summary: Amazon Glue Update Source Control from Job x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.UpdateTable: post: operationId: UpdateTable description: Updates a metadata table in the Data Catalog. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateTableResponse' examples: UpdateTable200Example: summary: Default UpdateTable 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: UpdateTable480Example: summary: Default UpdateTable 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: UpdateTable481Example: summary: Default UpdateTable 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: UpdateTable482Example: summary: Default UpdateTable 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: UpdateTable483Example: summary: Default UpdateTable 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: UpdateTable484Example: summary: Default UpdateTable 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: UpdateTable485Example: summary: Default UpdateTable 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '486': description: GlueEncryptionException content: application/json: schema: $ref: '#/components/schemas/GlueEncryptionException' examples: UpdateTable486Example: summary: Default UpdateTable 486 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '487': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' examples: UpdateTable487Example: summary: Default UpdateTable 487 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateTableRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.UpdateTable summary: Amazon Glue Update Table x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.UpdateTrigger: post: operationId: UpdateTrigger description: Updates a trigger definition. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateTriggerResponse' examples: UpdateTrigger200Example: summary: Default UpdateTrigger 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: UpdateTrigger480Example: summary: Default UpdateTrigger 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: UpdateTrigger481Example: summary: Default UpdateTrigger 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: UpdateTrigger482Example: summary: Default UpdateTrigger 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: UpdateTrigger483Example: summary: Default UpdateTrigger 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: UpdateTrigger484Example: summary: Default UpdateTrigger 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateTriggerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.UpdateTrigger summary: Amazon Glue Update Trigger x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.UpdateUserDefinedFunction: post: operationId: UpdateUserDefinedFunction description: Updates an existing function definition in the Data Catalog. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateUserDefinedFunctionResponse' examples: UpdateUserDefinedFunction200Example: summary: Default UpdateUserDefinedFunction 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: UpdateUserDefinedFunction480Example: summary: Default UpdateUserDefinedFunction 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: UpdateUserDefinedFunction481Example: summary: Default UpdateUserDefinedFunction 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: UpdateUserDefinedFunction482Example: summary: Default UpdateUserDefinedFunction 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: UpdateUserDefinedFunction483Example: summary: Default UpdateUserDefinedFunction 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: GlueEncryptionException content: application/json: schema: $ref: '#/components/schemas/GlueEncryptionException' examples: UpdateUserDefinedFunction484Example: summary: Default UpdateUserDefinedFunction 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateUserDefinedFunctionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.UpdateUserDefinedFunction summary: Amazon Glue Update User Defined Function x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSGlue.UpdateWorkflow: post: operationId: UpdateWorkflow description: Updates an existing workflow. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowResponse' examples: UpdateWorkflow200Example: summary: Default UpdateWorkflow 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: UpdateWorkflow480Example: summary: Default UpdateWorkflow 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: UpdateWorkflow481Example: summary: Default UpdateWorkflow 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: UpdateWorkflow482Example: summary: Default UpdateWorkflow 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: UpdateWorkflow483Example: summary: Default UpdateWorkflow 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: UpdateWorkflow484Example: summary: Default UpdateWorkflow 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.UpdateWorkflow summary: Amazon Glue Update Workflow x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' components: parameters: 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-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential 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-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 schemas: BatchCreatePartitionResponse: type: object properties: Errors: allOf: - $ref: '#/components/schemas/PartitionErrors' - description: The errors encountered when trying to create the requested partitions. BatchCreatePartitionRequest: type: object required: - DatabaseName - TableName - PartitionInputList title: BatchCreatePartitionRequest properties: CatalogId: allOf: - $ref: '#/components/schemas/CatalogIdString' - description: The ID of the catalog in which the partition is to be created. Currently, this should be the Amazon Web Services account ID. DatabaseName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the metadata database in which the partition is to be created. TableName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the metadata table in which the partition is to be created. PartitionInputList: allOf: - $ref: '#/components/schemas/PartitionInputList' - description: A list ofPartitionInput structures that define the partitions to be created.
InvalidInputException: {}
AlreadyExistsException: {}
ResourceNumberLimitExceededException: {}
InternalServiceException: {}
EntityNotFoundException: {}
OperationTimeoutException: {}
GlueEncryptionException: {}
BatchDeleteConnectionResponse:
type: object
properties:
Succeeded:
allOf:
- $ref: '#/components/schemas/NameStringList'
- description: A list of names of the connection definitions that were successfully deleted.
Errors:
allOf:
- $ref: '#/components/schemas/ErrorByName'
- description: A map of the names of connections that were not successfully deleted to error details.
BatchDeleteConnectionRequest:
type: object
required:
- ConnectionNameList
title: BatchDeleteConnectionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
ConnectionNameList:
allOf:
- $ref: '#/components/schemas/DeleteConnectionNameList'
- description: A list of names of the connections to delete.
BatchDeletePartitionResponse:
type: object
properties:
Errors:
allOf:
- $ref: '#/components/schemas/PartitionErrors'
- description: The errors encountered when trying to delete the requested partitions.
BatchDeletePartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionsToDelete
title: BatchDeletePartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database in which the table in question resides.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table that contains the partitions to be deleted.
PartitionsToDelete:
allOf:
- $ref: '#/components/schemas/BatchDeletePartitionValueList'
- description: A list of PartitionInput structures that define the partitions to be deleted.
BatchDeleteTableResponse:
type: object
properties:
Errors:
allOf:
- $ref: '#/components/schemas/TableErrors'
- description: A list of errors encountered in attempting to delete the specified tables.
BatchDeleteTableRequest:
type: object
required:
- DatabaseName
- TablesToDelete
title: BatchDeleteTableRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.
TablesToDelete:
allOf:
- $ref: '#/components/schemas/BatchDeleteTableNameList'
- description: A list of the table to delete.
TransactionId:
allOf:
- $ref: '#/components/schemas/TransactionIdString'
- description: The transaction ID at which to delete the table contents.
ResourceNotReadyException: {}
BatchDeleteTableVersionResponse:
type: object
properties:
Errors:
allOf:
- $ref: '#/components/schemas/TableVersionErrors'
- description: A list of errors encountered while trying to delete the specified table versions.
BatchDeleteTableVersionRequest:
type: object
required:
- DatabaseName
- TableName
- VersionIds
title: BatchDeleteTableVersionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table. For Hive compatibility, this name is entirely lowercase.
VersionIds:
allOf:
- $ref: '#/components/schemas/BatchDeleteTableVersionList'
- description: A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer. Each version is incremented by 1.
BatchGetBlueprintsResponse:
type: object
properties:
Blueprints:
allOf:
- $ref: '#/components/schemas/Blueprints'
- description: Returns a list of blueprint as a Blueprints object.
MissingBlueprints:
allOf:
- $ref: '#/components/schemas/BlueprintNames'
- description: Returns a list of BlueprintNames that were not found.
BatchGetBlueprintsRequest:
type: object
required:
- Names
title: BatchGetBlueprintsRequest
properties:
Names:
allOf:
- $ref: '#/components/schemas/BatchGetBlueprintNames'
- description: A list of blueprint names.
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 parameters, as a JSON string, for the blueprint in the response.
BatchGetCrawlersResponse:
type: object
properties:
Crawlers:
allOf:
- $ref: '#/components/schemas/CrawlerList'
- description: A list of crawler definitions.
CrawlersNotFound:
allOf:
- $ref: '#/components/schemas/CrawlerNameList'
- description: A list of names of crawlers that were not found.
BatchGetCrawlersRequest:
type: object
required:
- CrawlerNames
title: BatchGetCrawlersRequest
properties:
CrawlerNames:
allOf:
- $ref: '#/components/schemas/CrawlerNameList'
- description: A list of crawler names, which might be the names returned from the ListCrawlers operation.
BatchGetCustomEntityTypesResponse:
type: object
properties:
CustomEntityTypes:
allOf:
- $ref: '#/components/schemas/CustomEntityTypes'
- description: A list of CustomEntityType objects representing the custom patterns that have been created.
CustomEntityTypesNotFound:
allOf:
- $ref: '#/components/schemas/CustomEntityTypeNames'
- description: A list of the names of custom patterns that were not found.
BatchGetCustomEntityTypesRequest:
type: object
required:
- Names
title: BatchGetCustomEntityTypesRequest
properties:
Names:
allOf:
- $ref: '#/components/schemas/CustomEntityTypeNames'
- description: A list of names of the custom patterns that you want to retrieve.
BatchGetDataQualityResultResponse:
type: object
required:
- Results
properties:
Results:
allOf:
- $ref: '#/components/schemas/DataQualityResultsList'
- description: A list of DataQualityResult objects representing the data quality results.
ResultsNotFound:
allOf:
- $ref: '#/components/schemas/DataQualityResultIds'
- description: A list of result IDs for which results were not found.
BatchGetDataQualityResultRequest:
type: object
required:
- ResultIds
title: BatchGetDataQualityResultRequest
properties:
ResultIds:
allOf:
- $ref: '#/components/schemas/DataQualityResultIds'
- description: A list of unique result IDs for the data quality results.
BatchGetDevEndpointsResponse:
type: object
properties:
DevEndpoints:
allOf:
- $ref: '#/components/schemas/DevEndpointList'
- description: A list of DevEndpoint definitions.
DevEndpointsNotFound:
allOf:
- $ref: '#/components/schemas/DevEndpointNames'
- description: A list of DevEndpoints not found.
BatchGetDevEndpointsRequest:
type: object
required:
- DevEndpointNames
title: BatchGetDevEndpointsRequest
properties:
DevEndpointNames:
allOf:
- $ref: '#/components/schemas/DevEndpointNames'
- description: The list of DevEndpoint names, which might be the names returned from the ListDevEndpoint operation.
AccessDeniedException: {}
BatchGetJobsResponse:
type: object
properties:
Jobs:
allOf:
- $ref: '#/components/schemas/JobList'
- description: A list of job definitions.
JobsNotFound:
allOf:
- $ref: '#/components/schemas/JobNameList'
- description: A list of names of jobs not found.
BatchGetJobsRequest:
type: object
required:
- JobNames
title: BatchGetJobsRequest
properties:
JobNames:
allOf:
- $ref: '#/components/schemas/JobNameList'
- description: A list of job names, which might be the names returned from the ListJobs operation.
BatchGetPartitionResponse:
type: object
properties:
Partitions:
allOf:
- $ref: '#/components/schemas/PartitionList'
- description: A list of the requested partitions.
UnprocessedKeys:
allOf:
- $ref: '#/components/schemas/BatchGetPartitionValueList'
- description: A list of the partition values in the request for which partitions were not returned.
BatchGetPartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionsToGet
title: BatchGetPartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partitions reside.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partitions' table.
PartitionsToGet:
allOf:
- $ref: '#/components/schemas/BatchGetPartitionValueList'
- description: A list of partition values identifying the partitions to retrieve.
InvalidStateException: {}
FederationSourceException: {}
FederationSourceRetryableException: {}
BatchGetTriggersResponse:
type: object
properties:
Triggers:
allOf:
- $ref: '#/components/schemas/TriggerList'
- description: A list of trigger definitions.
TriggersNotFound:
allOf:
- $ref: '#/components/schemas/TriggerNameList'
- description: A list of names of triggers not found.
BatchGetTriggersRequest:
type: object
required:
- TriggerNames
title: BatchGetTriggersRequest
properties:
TriggerNames:
allOf:
- $ref: '#/components/schemas/TriggerNameList'
- description: A list of trigger names, which may be the names returned from the ListTriggers operation.
BatchGetWorkflowsResponse:
type: object
properties:
Workflows:
allOf:
- $ref: '#/components/schemas/Workflows'
- description: A list of workflow resource metadata.
MissingWorkflows:
allOf:
- $ref: '#/components/schemas/WorkflowNames'
- description: A list of names of workflows not found.
BatchGetWorkflowsRequest:
type: object
required:
- Names
title: BatchGetWorkflowsRequest
properties:
Names:
allOf:
- $ref: '#/components/schemas/WorkflowNames'
- description: A list of workflow names, which may be the names returned from the ListWorkflows operation.
IncludeGraph:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies whether to include a graph when returning the workflow resource metadata.
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.
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.
BatchUpdatePartitionResponse:
type: object
properties:
Errors:
allOf:
- $ref: '#/components/schemas/BatchUpdatePartitionFailureList'
- description: The errors encountered when trying to update the requested partitions. A list of BatchUpdatePartitionFailureEntry objects.
BatchUpdatePartitionRequest:
type: object
required:
- DatabaseName
- TableName
- Entries
title: BatchUpdatePartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the catalog in which the partition is to be updated. Currently, this should be the Amazon Web Services account ID.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the metadata database in which the partition is to be updated.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the metadata table in which the partition is to be updated.
Entries:
allOf:
- $ref: '#/components/schemas/BatchUpdatePartitionRequestEntryList'
- description: A list of up to 100 BatchUpdatePartitionRequestEntry objects to update.
CancelDataQualityRuleRecommendationRunResponse:
type: object
properties: {}
CancelDataQualityRuleRecommendationRunRequest:
type: object
required:
- RunId
title: CancelDataQualityRuleRecommendationRunRequest
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
CancelDataQualityRulesetEvaluationRunResponse:
type: object
properties: {}
CancelDataQualityRulesetEvaluationRunRequest:
type: object
required:
- RunId
title: CancelDataQualityRulesetEvaluationRunRequest
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
CancelMLTaskRunResponse:
type: object
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the machine learning transform.
TaskRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier for the task run.
Status:
allOf:
- $ref: '#/components/schemas/TaskStatusType'
- description: The status for this run.
CancelMLTaskRunRequest:
type: object
required:
- TransformId
- TaskRunId
title: CancelMLTaskRunRequest
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the machine learning transform.
TaskRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: A unique identifier for the task run.
CancelStatementResponse:
type: object
properties: {}
CancelStatementRequest:
type: object
required:
- SessionId
- Id
title: CancelStatementRequest
properties:
SessionId:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The Session ID of the statement to be cancelled.
Id:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The ID of the statement to be cancelled.
RequestOrigin:
allOf:
- $ref: '#/components/schemas/OrchestrationNameString'
- description: The origin of the request to cancel the statement.
IllegalSessionStateException: {}
CheckSchemaVersionValidityResponse:
type: object
properties:
Valid:
allOf:
- $ref: '#/components/schemas/IsVersionValid'
- description: Return true, if the schema is valid and false otherwise.
Error:
allOf:
- $ref: '#/components/schemas/SchemaValidationError'
- description: A validation failure error message.
CheckSchemaVersionValidityInput:
type: object
required:
- DataFormat
- SchemaDefinition
title: CheckSchemaVersionValidityInput
properties:
DataFormat:
allOf:
- $ref: '#/components/schemas/DataFormat'
- description: The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
SchemaDefinition:
allOf:
- $ref: '#/components/schemas/SchemaDefinitionString'
- description: The definition of the schema that has to be validated.
CreateBlueprintResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Returns the name of the blueprint that was registered.
CreateBlueprintRequest:
type: object
required:
- Name
- BlueprintLocation
title: CreateBlueprintRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/OrchestrationNameString'
- description: The name of the blueprint.
Description:
allOf:
- $ref: '#/components/schemas/Generic512CharString'
- description: A description of the blueprint.
BlueprintLocation:
allOf:
- $ref: '#/components/schemas/OrchestrationS3Location'
- description: Specifies a path in Amazon S3 where the blueprint is published.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The tags to be applied to this blueprint.
CreateClassifierResponse:
type: object
properties: {}
CreateClassifierRequest:
type: object
title: CreateClassifierRequest
properties:
GrokClassifier:
allOf:
- $ref: '#/components/schemas/CreateGrokClassifierRequest'
- description: A GrokClassifier object specifying the classifier to create.
XMLClassifier:
allOf:
- $ref: '#/components/schemas/CreateXMLClassifierRequest'
- description: An XMLClassifier object specifying the classifier to create.
JsonClassifier:
allOf:
- $ref: '#/components/schemas/CreateJsonClassifierRequest'
- description: A JsonClassifier object specifying the classifier to create.
CsvClassifier:
allOf:
- $ref: '#/components/schemas/CreateCsvClassifierRequest'
- description: A CsvClassifier object specifying the classifier to create.
CreateConnectionResponse:
type: object
properties: {}
CreateConnectionRequest:
type: object
required:
- ConnectionInput
title: CreateConnectionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services account ID is used by default.
ConnectionInput:
allOf:
- $ref: '#/components/schemas/ConnectionInput'
- description: A ConnectionInput object defining the connection to create.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The tags you assign to the connection.
CreateCrawlerResponse:
type: object
properties: {}
CreateCrawlerRequest:
type: object
required:
- Name
- Role
- Targets
title: CreateCrawlerRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the new crawler.
Role:
allOf:
- $ref: '#/components/schemas/Role'
- description: The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
DatabaseName:
allOf:
- $ref: '#/components/schemas/DatabaseName'
- description: 'The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.'
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the new crawler.
Targets:
allOf:
- $ref: '#/components/schemas/CrawlerTargets'
- description: A list of collection of targets to crawl.
Schedule:
allOf:
- $ref: '#/components/schemas/CronExpression'
- description: 'A cron expression used to specify the schedule (see Time-Based Schedules
for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).'
Classifiers:
allOf:
- $ref: '#/components/schemas/ClassifierNameList'
- description: A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the
default classifiers for a given classification.
TablePrefix:
allOf:
- $ref: '#/components/schemas/TablePrefix'
- description: The table prefix used for catalog tables that are created.
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/SchemaChangePolicy'
- description: The policy for the crawler's update and deletion behavior.
RecrawlPolicy:
allOf:
- $ref: '#/components/schemas/RecrawlPolicy'
- description: A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
LineageConfiguration:
allOf:
- $ref: '#/components/schemas/LineageConfiguration'
- description: Specifies data lineage configuration settings for the crawler.
LakeFormationConfiguration:
allOf:
- $ref: '#/components/schemas/LakeFormationConfiguration'
- description: Specifies Lake Formation configuration settings for the crawler.
Configuration:
allOf:
- $ref: '#/components/schemas/CrawlerConfiguration'
- description: Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
CrawlerSecurityConfiguration:
allOf:
- $ref: '#/components/schemas/CrawlerSecurityConfiguration'
- description: The name of the SecurityConfiguration structure to be used by this crawler.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
CreateCustomEntityTypeResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the custom pattern you created.
CreateCustomEntityTypeRequest:
type: object
required:
- Name
- RegexString
title: CreateCustomEntityTypeRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
RegexString:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A regular expression string that is used for detecting sensitive data in a custom pattern.
ContextWords:
allOf:
- $ref: '#/components/schemas/ContextWords'
- description: A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
IdempotentParameterMismatchException: {} CreateDataQualityRulesetResponse: type: object properties: Name: allOf: - $ref: '#/components/schemas/NameString' - description: A unique name for the data quality ruleset. CreateDataQualityRulesetRequest: type: object required: - Name - Ruleset title: CreateDataQualityRulesetRequest properties: Name: allOf: - $ref: '#/components/schemas/NameString' - description: A unique name for the data quality ruleset. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: A description of the data quality ruleset. Ruleset: allOf: - $ref: '#/components/schemas/DataQualityRulesetString' - description: A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide. Tags: allOf: - $ref: '#/components/schemas/TagsMap' - description: A list of tags applied to the data quality ruleset. TargetTable: allOf: - $ref: '#/components/schemas/DataQualityTargetTable' - description: A target table associated with the data quality ruleset. ClientToken: allOf: - $ref: '#/components/schemas/HashString' - description: Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource. CreateDatabaseResponse: type: object properties: {} CreateDatabaseRequest: type: object required: - DatabaseInput title: CreateDatabaseRequest properties: CatalogId: allOf: - $ref: '#/components/schemas/CatalogIdString' - description: The ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services account ID is used by default. DatabaseInput: allOf: - $ref: '#/components/schemas/DatabaseInput' - description: The metadata for the database. Tags: allOf: - $ref: '#/components/schemas/TagsMap' - description: The tags you assign to the database. ConcurrentModificationException: {} FederatedResourceAlreadyExistsException: {} CreateDevEndpointResponse: type: object properties: EndpointName: allOf: - $ref: '#/components/schemas/GenericString' - description: The name assigned to the newDevEndpoint.
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.
ValidationException: {}
CreateJobResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The unique name that was provided for this job definition.
CreateJobRequest:
type: object
required:
- Name
- Role
- Command
title: CreateJobRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name you assign to this job definition. It must be unique in your account.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: Description of the job being defined.
LogUri:
allOf:
- $ref: '#/components/schemas/UriString'
- description: This field is reserved for future use.
Role:
allOf:
- $ref: '#/components/schemas/RoleString'
- description: The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
ExecutionProperty:
allOf:
- $ref: '#/components/schemas/ExecutionProperty'
- description: An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
Command:
allOf:
- $ref: '#/components/schemas/JobCommand'
- description: The JobCommand that runs this job.
DefaultArguments:
allOf:
- $ref: '#/components/schemas/GenericMap'
- description: The default arguments for this job.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
NonOverridableArguments: allOf: - $ref: '#/components/schemas/GenericMap' - description: Non-overridable arguments for this job, specified as name-value pairs. Connections: allOf: - $ref: '#/components/schemas/ConnectionsList' - description: The connections used for this job. MaxRetries: allOf: - $ref: '#/components/schemas/MaxRetries' - description: The maximum number of times to retry this job if it fails. AllocatedCapacity: allOf: - $ref: '#/components/schemas/IntegerValue' - deprecated: true description:This parameter is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
This property is deprecated, use MaxCapacity instead. Timeout: allOf: - $ref: '#/components/schemas/Timeout' - description: The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and entersTIMEOUT status. The default is 2,880
minutes (48 hours).
MaxCapacity:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Do not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for
MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job
(JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job
(JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs.
This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should
specify a Worker type and the Number of workers.
SecurityConfiguration structure to be used with this job.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
NotificationProperty:
allOf:
- $ref: '#/components/schemas/NotificationProperty'
- description: Specifies configuration properties of a job notification.
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 jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
NumberOfWorkers: allOf: - $ref: '#/components/schemas/NullableInteger' - description: The number of workers of a definedworkerType that are allocated when a job runs.
WorkerType:
allOf:
- $ref: '#/components/schemas/WorkerType'
- description: The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
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.
For the
G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume
streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue
version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark
jobs.
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either
NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither
NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice
versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value
other than Standard, the MaxCapacity field is set automatically and becomes read-only.
When the WorkerType field is set to a value other
than Standard, the MaxCapacity field is set automatically and becomes read-only.
The type of predefined worker that is allocated when this task runs. 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 provides 4 vCPU, 16 GB of
memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor
per worker.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either
NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither
NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice
versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
The number of workers of a defined workerType that are allocated when this task runs.
If WorkerType is set, then
NumberOfWorkers is required (and vice versa).
TIMEOUT status. The default is 2,880 minutes (48 hours).
MaxRetries:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The maximum number of times to retry a task for this transform after a task run fails.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
TransformEncryption:
allOf:
- $ref: '#/components/schemas/TransformEncryption'
- description: The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
CreatePartitionResponse:
type: object
properties: {}
CreatePartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionInput
title: CreatePartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The Amazon Web Services account ID of the catalog in which the partition is to be created.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the metadata database in which the partition is to be created.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the metadata table in which the partition is to be created.
PartitionInput:
allOf:
- $ref: '#/components/schemas/PartitionInput'
- description: A PartitionInput structure defining the partition to be created.
CreatePartitionIndexResponse:
type: object
properties: {}
CreatePartitionIndexRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionIndex
title: CreatePartitionIndexRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The catalog ID where the table resides.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Specifies the name of a database in which you want to create a partition index.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Specifies the name of a table in which you want to create a partition index.
PartitionIndex:
allOf:
- $ref: '#/components/schemas/PartitionIndex'
- description: Specifies a PartitionIndex structure to create a partition index in an existing table.
CreateRegistryResponse:
type: object
properties:
RegistryArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the newly created registry.
RegistryName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the registry.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the registry.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The tags for the registry.
CreateRegistryInput:
type: object
required:
- RegistryName
title: CreateRegistryInput
properties:
RegistryName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the registry. If description is not provided, there will not be any default value for this.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
CreateSchemaResponse:
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.
SchemaName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the schema.
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the schema if specified when created.
DataFormat:
allOf:
- $ref: '#/components/schemas/DataFormat'
- description: The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
Compatibility:
allOf:
- $ref: '#/components/schemas/Compatibility'
- description: The schema compatibility mode.
SchemaCheckpoint:
allOf:
- $ref: '#/components/schemas/SchemaCheckpointNumber'
- description: The version number of the checkpoint (the last time the compatibility mode was changed).
LatestSchemaVersion:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The latest version of the schema associated with the returned schema definition.
NextSchemaVersion:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The next version of the schema associated with the returned schema definition.
SchemaStatus:
allOf:
- $ref: '#/components/schemas/SchemaStatus'
- description: 'The status of the schema. '
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The tags for the schema.
SchemaVersionId:
allOf:
- $ref: '#/components/schemas/SchemaVersionIdString'
- description: The unique identifier of the first schema version.
SchemaVersionStatus:
allOf:
- $ref: '#/components/schemas/SchemaVersionStatus'
- description: The status of the first schema version created.
CreateSchemaInput:
type: object
required:
- SchemaName
- DataFormat
title: CreateSchemaInput
properties:
RegistryId:
allOf:
- $ref: '#/components/schemas/RegistryId'
- description: ' This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer
id>:registry/default-registry:random-5-letter-id.'
SchemaName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
DataFormat:
allOf:
- $ref: '#/components/schemas/DataFormat'
- description: The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
Compatibility:
allOf:
- $ref: '#/components/schemas/Compatibility'
- description: "The compatibility mode of the schema. The possible values are:
NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.
BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
DataFormat setting for SchemaName.
CreateScriptResponse:
type: object
properties:
PythonScript:
allOf:
- $ref: '#/components/schemas/PythonScript'
- description: The Python script generated from the DAG.
ScalaCode:
allOf:
- $ref: '#/components/schemas/ScalaCode'
- description: The Scala code generated from the DAG.
CreateScriptRequest:
type: object
title: CreateScriptRequest
properties:
DagNodes:
allOf:
- $ref: '#/components/schemas/DagNodes'
- description: A list of the nodes in the DAG.
DagEdges:
allOf:
- $ref: '#/components/schemas/DagEdges'
- description: A list of the edges in the DAG.
Language:
allOf:
- $ref: '#/components/schemas/Language'
- description: The programming language of the resulting code from the DAG.
CreateSecurityConfigurationResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name assigned to the new security configuration.
CreatedTimestamp:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The time at which the new security configuration was created.
CreateSecurityConfigurationRequest:
type: object
required:
- Name
- EncryptionConfiguration
title: CreateSecurityConfigurationRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name for the new security configuration.
EncryptionConfiguration:
allOf:
- $ref: '#/components/schemas/EncryptionConfiguration'
- description: The encryption configuration for the new security configuration.
CreateSessionResponse:
type: object
properties:
Session:
allOf:
- $ref: '#/components/schemas/Session'
- description: Returns the session object in the response.
CreateSessionRequest:
type: object
required:
- Id
- Role
- Command
title: CreateSessionRequest
properties:
Id:
allOf:
- $ref: '#/components/schemas/NameString'
- description: 'The ID of the session request. '
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: 'The description of the session. '
Role:
allOf:
- $ref: '#/components/schemas/OrchestrationRoleArn'
- description: 'The IAM Role ARN '
Command:
allOf:
- $ref: '#/components/schemas/SessionCommand'
- description: 'The SessionCommand that runs the job. '
Timeout:
allOf:
- $ref: '#/components/schemas/Timeout'
- description: ' The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the documentation
for other job types. '
IdleTimeout:
allOf:
- $ref: '#/components/schemas/Timeout'
- description: ' The number of minutes when idle before session times out. Default for Spark ETL jobs is value of Timeout. Consult the documentation for other job types. '
DefaultArguments:
allOf:
- $ref: '#/components/schemas/OrchestrationArgumentsMap'
- description: 'A map array of key-value pairs. Max is 75 pairs. '
Connections:
allOf:
- $ref: '#/components/schemas/ConnectionsList'
- description: 'The number of connections to use for the session. '
MaxCapacity:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: 'The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity
and 16 GB memory. '
NumberOfWorkers:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: 'The number of workers of a defined WorkerType to use for the session. '
WorkerType:
allOf:
- $ref: '#/components/schemas/WorkerType'
- description: The type of predefined worker that is allocated to use for the session. Accepts a value of Standard, G.1X, G.2X, or G.025X.
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.
For
the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume
streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
Table. If none is supplied, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.
TableInput:
allOf:
- $ref: '#/components/schemas/TableInput'
- description: The TableInput object that defines the metadata table to create in the catalog.
PartitionIndexes:
allOf:
- $ref: '#/components/schemas/PartitionIndexList'
- description: A list of partition indexes, PartitionIndex structures, to create in the table.
TransactionId:
allOf:
- $ref: '#/components/schemas/TransactionIdString'
- description: The ID of the transaction.
CreateTriggerResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the trigger.
CreateTriggerRequest:
type: object
required:
- Name
- Type
- Actions
title: CreateTriggerRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the trigger.
WorkflowName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the workflow associated with the trigger.
Type:
allOf:
- $ref: '#/components/schemas/TriggerType'
- description: The type of the new trigger.
Schedule:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: 'A cron expression used to specify the schedule (see Time-Based Schedules
for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
This field is required when the trigger type is SCHEDULED.
' Predicate: allOf: - $ref: '#/components/schemas/Predicate' - description:A predicate to specify when the new trigger should fire.
This field is required when the trigger type is CONDITIONAL.
true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: 'The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon
Web Services Tags in Glue in the developer guide. '
EventBatchingCondition:
allOf:
- $ref: '#/components/schemas/EventBatchingCondition'
- description: Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
CreateUserDefinedFunctionResponse:
type: object
properties: {}
CreateUserDefinedFunctionRequest:
type: object
required:
- DatabaseName
- FunctionInput
title: CreateUserDefinedFunctionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which to create the function. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database in which to create the function.
FunctionInput:
allOf:
- $ref: '#/components/schemas/UserDefinedFunctionInput'
- description: A FunctionInput object that defines the function to create in the Data Catalog.
CreateWorkflowResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the workflow which was provided as part of the request.
CreateWorkflowRequest:
type: object
required:
- Name
title: CreateWorkflowRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name to be assigned to the workflow. It should be unique within your account.
Description:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A description of the workflow.
DefaultRunProperties:
allOf:
- $ref: '#/components/schemas/WorkflowRunProperties'
- description: A collection of properties to be used as part of each execution of the workflow.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The tags to be used with this workflow.
MaxConcurrentRuns:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any
of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
DeleteBlueprintResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Returns the name of the blueprint that was deleted.
DeleteBlueprintRequest:
type: object
required:
- Name
title: DeleteBlueprintRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the blueprint to delete.
DeleteClassifierResponse:
type: object
properties: {}
DeleteClassifierRequest:
type: object
required:
- Name
title: DeleteClassifierRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the classifier to remove.
DeleteColumnStatisticsForPartitionResponse:
type: object
properties: {}
DeleteColumnStatisticsForPartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionValues
- ColumnName
title: DeleteColumnStatisticsForPartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partitions reside.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partitions' table.
PartitionValues:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: A list of partition values identifying the partition.
ColumnName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the column.
DeleteColumnStatisticsForTableResponse:
type: object
properties: {}
DeleteColumnStatisticsForTableRequest:
type: object
required:
- DatabaseName
- TableName
- ColumnName
title: DeleteColumnStatisticsForTableRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partitions reside.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partitions' table.
ColumnName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the column.
DeleteConnectionResponse:
type: object
properties: {}
DeleteConnectionRequest:
type: object
required:
- ConnectionName
title: DeleteConnectionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
ConnectionName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the connection to delete.
DeleteCrawlerResponse:
type: object
properties: {}
DeleteCrawlerRequest:
type: object
required:
- Name
title: DeleteCrawlerRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the crawler to remove.
CrawlerRunningException: {}
SchedulerTransitioningException: {}
DeleteCustomEntityTypeResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the custom pattern you deleted.
DeleteCustomEntityTypeRequest:
type: object
required:
- Name
title: DeleteCustomEntityTypeRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the custom pattern that you want to delete.
DeleteDataQualityRulesetResponse:
type: object
properties: {}
DeleteDataQualityRulesetRequest:
type: object
required:
- Name
title: DeleteDataQualityRulesetRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A name for the data quality ruleset.
DeleteDatabaseResponse:
type: object
properties: {}
DeleteDatabaseRequest:
type: object
required:
- Name
title: DeleteDatabaseRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database to delete. For Hive compatibility, this must be all lowercase.
DeleteDevEndpointResponse:
type: object
properties: {}
DeleteDevEndpointRequest:
type: object
required:
- EndpointName
title: DeleteDevEndpointRequest
properties:
EndpointName:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The name of the DevEndpoint.
DeleteJobResponse:
type: object
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job definition that was deleted.
DeleteJobRequest:
type: object
required:
- JobName
title: DeleteJobRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job definition to delete.
DeleteMLTransformResponse:
type: object
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the transform that was deleted.
DeleteMLTransformRequest:
type: object
required:
- TransformId
title: DeleteMLTransformRequest
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the transform to delete.
DeletePartitionResponse:
type: object
properties: {}
DeletePartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionValues
title: DeletePartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database in which the table in question resides.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table that contains the partition to be deleted.
PartitionValues:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: The values that define the partition.
DeletePartitionIndexResponse:
type: object
properties: {}
DeletePartitionIndexRequest:
type: object
required:
- DatabaseName
- TableName
- IndexName
title: DeletePartitionIndexRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The catalog ID where the table resides.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Specifies the name of a database from which you want to delete a partition index.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Specifies the name of a table from which you want to delete a partition index.
IndexName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partition index to be deleted.
ConflictException: {}
DeleteRegistryResponse:
type: object
properties:
RegistryName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the registry being deleted.
RegistryArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the registry being deleted.
Status:
allOf:
- $ref: '#/components/schemas/RegistryStatus'
- description: The status of the registry. A successful operation will return the Deleting status.
DeleteRegistryInput:
type: object
required:
- RegistryId
title: DeleteRegistryInput
properties:
RegistryId:
allOf:
- $ref: '#/components/schemas/RegistryId'
- description: This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
DeleteResourcePolicyResponse:
type: object
properties: {}
DeleteResourcePolicyRequest:
type: object
title: DeleteResourcePolicyRequest
properties:
PolicyHashCondition:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The hash value returned when this policy was set.
ResourceArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The ARN of the Glue resource for the resource policy to be deleted.
ConditionCheckFailureException: {}
DeleteSchemaResponse:
type: object
properties:
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema being deleted.
SchemaName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the schema being deleted.
Status:
allOf:
- $ref: '#/components/schemas/SchemaStatus'
- description: The status of the schema.
DeleteSchemaInput:
type: object
required:
- SchemaId
title: DeleteSchemaInput
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
DeleteSchemaVersionsResponse:
type: object
properties:
SchemaVersionErrors:
allOf:
- $ref: '#/components/schemas/SchemaVersionErrorList'
- description: A list of SchemaVersionErrorItem objects, each containing an error and schema version.
DeleteSchemaVersionsInput:
type: object
required:
- SchemaId
- Versions
title: DeleteSchemaVersionsInput
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
Versions:
allOf:
- $ref: '#/components/schemas/VersionsString'
- description: 'A version range may be supplied which may be of the format:
a single version number, 5
a range, 5-8 : deletes versions 5, 6, 7, 8
VersionID is a string representation of an integer. Each version is incremented by 1.
DeleteTriggerResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the trigger that was deleted.
DeleteTriggerRequest:
type: object
required:
- Name
title: DeleteTriggerRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the trigger to delete.
DeleteUserDefinedFunctionResponse:
type: object
properties: {}
DeleteUserDefinedFunctionRequest:
type: object
required:
- DatabaseName
- FunctionName
title: DeleteUserDefinedFunctionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the function is located.
FunctionName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the function definition to be deleted.
DeleteWorkflowResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the workflow specified in input.
DeleteWorkflowRequest:
type: object
required:
- Name
title: DeleteWorkflowRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the workflow to be deleted.
GetBlueprintResponse:
type: object
properties:
Blueprint:
allOf:
- $ref: '#/components/schemas/Blueprint'
- description: Returns a Blueprint object.
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.
GetBlueprintRunResponse:
type: object
properties:
BlueprintRun:
allOf:
- $ref: '#/components/schemas/BlueprintRun'
- description: Returns a BlueprintRun object.
GetBlueprintRunRequest:
type: object
required:
- BlueprintName
- RunId
title: GetBlueprintRunRequest
properties:
BlueprintName:
allOf:
- $ref: '#/components/schemas/OrchestrationNameString'
- description: The name of the blueprint.
RunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The run ID for the blueprint run you want to retrieve.
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.
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.
GetCatalogImportStatusResponse:
type: object
properties:
ImportStatus:
allOf:
- $ref: '#/components/schemas/CatalogImportStatus'
- description: The status of the specified catalog migration.
GetCatalogImportStatusRequest:
type: object
title: GetCatalogImportStatusRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.
GetClassifierResponse:
type: object
properties:
Classifier:
allOf:
- $ref: '#/components/schemas/Classifier'
- description: The requested classifier.
GetClassifierRequest:
type: object
required:
- Name
title: GetClassifierRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the classifier to retrieve.
GetClassifiersResponse:
type: object
properties:
Classifiers:
allOf:
- $ref: '#/components/schemas/ClassifierList'
- description: The requested list of classifier objects.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token.
GetClassifiersRequest:
type: object
title: GetClassifiersRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The size of the list to return (optional).
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: An optional continuation token.
GetColumnStatisticsForPartitionResponse:
type: object
properties:
ColumnStatisticsList:
allOf:
- $ref: '#/components/schemas/ColumnStatisticsList'
- description: List of ColumnStatistics that failed to be retrieved.
Errors:
allOf:
- $ref: '#/components/schemas/ColumnErrors'
- description: Error occurred during retrieving column statistics data.
GetColumnStatisticsForPartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionValues
- ColumnNames
title: GetColumnStatisticsForPartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partitions reside.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partitions' table.
PartitionValues:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: A list of partition values identifying the partition.
ColumnNames:
allOf:
- $ref: '#/components/schemas/GetColumnNamesList'
- description: A list of the column names.
GetColumnStatisticsForTableResponse:
type: object
properties:
ColumnStatisticsList:
allOf:
- $ref: '#/components/schemas/ColumnStatisticsList'
- description: List of ColumnStatistics.
Errors:
allOf:
- $ref: '#/components/schemas/ColumnErrors'
- description: List of ColumnStatistics that failed to be retrieved.
GetColumnStatisticsForTableRequest:
type: object
required:
- DatabaseName
- TableName
- ColumnNames
title: GetColumnStatisticsForTableRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partitions reside.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partitions' table.
ColumnNames:
allOf:
- $ref: '#/components/schemas/GetColumnNamesList'
- description: A list of the column names.
GetConnectionResponse:
type: object
properties:
Connection:
allOf:
- $ref: '#/components/schemas/Connection'
- description: The requested connection definition.
GetConnectionRequest:
type: object
required:
- Name
title: GetConnectionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the connection definition to retrieve.
HidePassword:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display
the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection
properties.
GetConnectionsResponse:
type: object
properties:
ConnectionList:
allOf:
- $ref: '#/components/schemas/ConnectionList'
- description: A list of requested connection definitions.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if the list of connections returned does not include the last of the filtered connections.
GetConnectionsRequest:
type: object
title: GetConnectionsRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
Filter:
allOf:
- $ref: '#/components/schemas/GetConnectionsFilter'
- description: A filter that controls which connections are returned.
HidePassword:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display
the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection
properties.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if this is a continuation call.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of connections to return in one response.
GetCrawlerResponse:
type: object
properties:
Crawler:
allOf:
- $ref: '#/components/schemas/Crawler'
- description: The metadata for the specified crawler.
GetCrawlerRequest:
type: object
required:
- Name
title: GetCrawlerRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the crawler to retrieve metadata for.
GetCrawlerMetricsResponse:
type: object
properties:
CrawlerMetricsList:
allOf:
- $ref: '#/components/schemas/CrawlerMetricsList'
- description: A list of metrics for the specified crawler.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if the returned list does not contain the last metric available.
GetCrawlerMetricsRequest:
type: object
title: GetCrawlerMetricsRequest
properties:
CrawlerNameList:
allOf:
- $ref: '#/components/schemas/CrawlerNameList'
- description: A list of the names of crawlers about which to retrieve metrics.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum size of a list to return.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if this is a continuation call.
GetCrawlersResponse:
type: object
properties:
Crawlers:
allOf:
- $ref: '#/components/schemas/CrawlerList'
- description: A list of crawler metadata.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if the returned list has not reached the end of those defined in this customer account.
GetCrawlersRequest:
type: object
title: GetCrawlersRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The number of crawlers to return on each call.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if this is a continuation request.
GetCustomEntityTypeResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the custom pattern that you retrieved.
RegexString:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A regular expression string that is used for detecting sensitive data in a custom pattern.
ContextWords:
allOf:
- $ref: '#/components/schemas/ContextWords'
- description: A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will
not be detected as sensitive data.
GetCustomEntityTypeRequest:
type: object
required:
- Name
title: GetCustomEntityTypeRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the custom pattern that you want to retrieve.
GetDataCatalogEncryptionSettingsResponse:
type: object
properties:
DataCatalogEncryptionSettings:
allOf:
- $ref: '#/components/schemas/DataCatalogEncryptionSettings'
- description: The requested security configuration.
GetDataCatalogEncryptionSettingsRequest:
type: object
title: GetDataCatalogEncryptionSettingsRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
GetDataQualityResultResponse:
type: object
properties:
ResultId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: A unique result ID for the data quality result.
Score:
allOf:
- $ref: '#/components/schemas/GenericBoundedDouble'
- description: An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: The table associated with the data quality result, if any.
RulesetName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the ruleset associated with the data quality result.
EvaluationContext:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes,
the evaluationContext can differentiate the nodes.
StartedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when the run for this data quality result started.
CompletedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when the run for this data quality result was completed.
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The job name associated with the data quality result, if any.
JobRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The job run ID associated with the data quality result, if any.
RulesetEvaluationRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run ID associated with the ruleset evaluation.
RuleResults:
allOf:
- $ref: '#/components/schemas/DataQualityRuleResults'
- description: 'A list of DataQualityRuleResult objects representing the results for each rule. '
GetDataQualityResultRequest:
type: object
required:
- ResultId
title: GetDataQualityResultRequest
properties:
ResultId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: A unique result ID for the data quality result.
GetDataQualityRuleRecommendationRunResponse:
type: object
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: The data source (an Glue table) associated with this run.
Role:
allOf:
- $ref: '#/components/schemas/RoleString'
- description: An IAM role supplied to encrypt the results of the run.
NumberOfWorkers:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The number of G.1X workers to be used in the run. The default is 5.
Timeout:
allOf:
- $ref: '#/components/schemas/Timeout'
- description: The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is
2,880 minutes (48 hours).
Status:
allOf:
- $ref: '#/components/schemas/TaskStatusType'
- description: The status for this run.
ErrorString:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The error strings that are associated with the run.
StartedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this run started.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp. The last point in time when this data quality rule recommendation run was modified.
CompletedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this run was completed.
ExecutionTime:
allOf:
- $ref: '#/components/schemas/ExecutionTime'
- description: The amount of time (in seconds) that the run consumed resources.
RecommendedRuleset:
allOf:
- $ref: '#/components/schemas/DataQualityRulesetString'
- description: When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL)
format.
CreatedRulesetName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the ruleset that was created by the run.
GetDataQualityRuleRecommendationRunRequest:
type: object
required:
- RunId
title: GetDataQualityRuleRecommendationRunRequest
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
GetDataQualityRulesetResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the ruleset.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the ruleset.
Ruleset:
allOf:
- $ref: '#/components/schemas/DataQualityRulesetString'
- description: A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
TargetTable:
allOf:
- $ref: '#/components/schemas/DataQualityTargetTable'
- description: The name and database name of the target table.
CreatedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp. The time and date that this data quality ruleset was created.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp. The last point in time when this data quality ruleset was modified.
RecommendationRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
GetDataQualityRulesetRequest:
type: object
required:
- Name
title: GetDataQualityRulesetRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the ruleset.
GetDataQualityRulesetEvaluationRunResponse:
type: object
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: The data source (an Glue table) associated with this evaluation run.
Role:
allOf:
- $ref: '#/components/schemas/RoleString'
- description: An IAM role supplied to encrypt the results of the run.
NumberOfWorkers:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The number of G.1X workers to be used in the run. The default is 5.
Timeout:
allOf:
- $ref: '#/components/schemas/Timeout'
- description: The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is
2,880 minutes (48 hours).
AdditionalRunOptions:
allOf:
- $ref: '#/components/schemas/DataQualityEvaluationRunAdditionalRunOptions'
- description: Additional run options you can specify for an evaluation run.
Status:
allOf:
- $ref: '#/components/schemas/TaskStatusType'
- description: The status for this run.
ErrorString:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The error strings that are associated with the run.
StartedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this run started.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp. The last point in time when this data quality rule recommendation run was modified.
CompletedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this run was completed.
ExecutionTime:
allOf:
- $ref: '#/components/schemas/ExecutionTime'
- description: The amount of time (in seconds) that the run consumed resources.
RulesetNames:
allOf:
- $ref: '#/components/schemas/RulesetNames'
- description: A list of ruleset names for the run.
ResultIds:
allOf:
- $ref: '#/components/schemas/DataQualityResultIdList'
- description: A list of result IDs for the data quality results for the run.
GetDataQualityRulesetEvaluationRunRequest:
type: object
required:
- RunId
title: GetDataQualityRulesetEvaluationRunRequest
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
GetDatabaseResponse:
type: object
properties:
Database:
allOf:
- $ref: '#/components/schemas/Database'
- description: The definition of the specified database in the Data Catalog.
GetDatabaseRequest:
type: object
required:
- Name
title: GetDatabaseRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
GetDatabasesResponse:
type: object
required:
- DatabaseList
properties:
DatabaseList:
allOf:
- $ref: '#/components/schemas/DatabaseList'
- description: A list of Database objects from the specified catalog.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
GetDatabasesRequest:
type: object
title: GetDatabasesRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if this is a continuation call.
MaxResults:
allOf:
- $ref: '#/components/schemas/CatalogGetterPageSize'
- description: The maximum number of databases to return in one response.
ResourceShareType:
allOf:
- $ref: '#/components/schemas/ResourceShareType'
- description: Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or
ALL.
If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.
If
set to FOREIGN, will list the databases shared with your account.
If set to ALL, will list the databases shared with your account, as well as
the databases in yor local account.
DevEndpoint definition.
GetDevEndpointRequest:
type: object
required:
- EndpointName
title: GetDevEndpointRequest
properties:
EndpointName:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: Name of the DevEndpoint to retrieve information for.
GetDevEndpointsResponse:
type: object
properties:
DevEndpoints:
allOf:
- $ref: '#/components/schemas/DevEndpointList'
- description: A list of DevEndpoint definitions.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if not all DevEndpoint definitions have yet been returned.
GetDevEndpointsRequest:
type: object
title: GetDevEndpointsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum size of information to return.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if this is a continuation call.
GetJobResponse:
type: object
properties:
Job:
allOf:
- $ref: '#/components/schemas/Job'
- description: The requested job definition.
GetJobRequest:
type: object
required:
- JobName
title: GetJobRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job definition to retrieve.
GetJobBookmarkResponse:
type: object
properties:
JobBookmarkEntry:
allOf:
- $ref: '#/components/schemas/JobBookmarkEntry'
- description: A structure that defines a point that a job can resume processing.
GetJobBookmarkRequest:
type: object
required:
- JobName
title: GetJobBookmarkRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: The name of the job in question.
RunId:
allOf:
- $ref: '#/components/schemas/RunId'
- description: The unique run identifier associated with this job run.
GetJobRunResponse:
type: object
properties:
JobRun:
allOf:
- $ref: '#/components/schemas/JobRun'
- description: The requested job-run metadata.
GetJobRunRequest:
type: object
required:
- JobName
- RunId
title: GetJobRunRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the job definition being run.
RunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The ID of the job run.
PredecessorsIncluded:
allOf:
- $ref: '#/components/schemas/BooleanValue'
- description: True if a list of predecessor runs should be returned.
GetJobRunsResponse:
type: object
properties:
JobRuns:
allOf:
- $ref: '#/components/schemas/JobRunList'
- description: A list of job-run metadata objects.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if not all requested job runs have been returned.
GetJobRunsRequest:
type: object
required:
- JobName
title: GetJobRunsRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job definition for which to retrieve all job runs.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if this is a continuation call.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum size of the response.
GetJobsResponse:
type: object
properties:
Jobs:
allOf:
- $ref: '#/components/schemas/JobList'
- description: A list of job definitions.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if not all job definitions have yet been returned.
GetJobsRequest:
type: object
title: GetJobsRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if this is a continuation call.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum size of the response.
GetMLTaskRunResponse:
type: object
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the task run.
TaskRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
Status:
allOf:
- $ref: '#/components/schemas/TaskStatusType'
- description: The status for this task run.
LogGroupName:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The names of the log groups that are associated with the task run.
Properties:
allOf:
- $ref: '#/components/schemas/TaskRunProperties'
- description: The list of properties that are associated with the task run.
ErrorString:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The error strings that are associated with the task run.
StartedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this task run started.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this task run was last modified.
CompletedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this task run was completed.
ExecutionTime:
allOf:
- $ref: '#/components/schemas/ExecutionTime'
- description: The amount of time (in seconds) that the task run consumed resources.
GetMLTaskRunRequest:
type: object
required:
- TransformId
- TaskRunId
title: GetMLTaskRunRequest
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the machine learning transform.
TaskRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the task run.
GetMLTaskRunsResponse:
type: object
properties:
TaskRuns:
allOf:
- $ref: '#/components/schemas/TaskRunList'
- description: A list of task runs that are associated with the transform.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A pagination token, if more results are available.
GetMLTaskRunsRequest:
type: object
required:
- TransformId
title: GetMLTaskRunsRequest
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the machine learning transform.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A token for pagination of the results. The default is empty.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: 'The maximum number of results to return. '
Filter:
allOf:
- $ref: '#/components/schemas/TaskRunFilterCriteria'
- description: The filter criteria, in the TaskRunFilterCriteria structure, for the task run.
Sort:
allOf:
- $ref: '#/components/schemas/TaskRunSortCriteria'
- description: The sorting criteria, in the TaskRunSortCriteria structure, for the task run.
GetMLTransformResponse:
type: object
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the transform, generated at the time that the transform was created.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The unique name given to the transform when it was created.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the transform.
Status:
allOf:
- $ref: '#/components/schemas/TransformStatusType'
- description: The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
CreatedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when the transform was created.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when the transform was last modified.
InputRecordTables:
allOf:
- $ref: '#/components/schemas/GlueTables'
- description: A list of Glue table definitions used by the transform.
Parameters:
allOf:
- $ref: '#/components/schemas/TransformParameters'
- description: The configuration parameters that are specific to the algorithm used.
EvaluationMetrics:
allOf:
- $ref: '#/components/schemas/EvaluationMetrics'
- description: The latest evaluation metrics.
LabelCount:
allOf:
- $ref: '#/components/schemas/LabelCount'
- description: The number of labels available for this transform.
Schema:
allOf:
- $ref: '#/components/schemas/TransformSchema'
- description: The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.
Role:
allOf:
- $ref: '#/components/schemas/RoleString'
- description: The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
GlueVersion:
allOf:
- $ref: '#/components/schemas/GlueVersionString'
- description: This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue
compatibility defaults to Glue 0.9. For more information, see Glue Versions in the
developer guide.
MaxCapacity:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes
read-only.
The type of predefined worker that is allocated when this task runs. 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 provides 4 vCPU, 16 GB of
memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor
per worker.
workerType that are allocated when this task runs.
Timeout:
allOf:
- $ref: '#/components/schemas/Timeout'
- description: The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters
TIMEOUT status. The default is 2,880 minutes (48 hours).
MaxRetries:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The maximum number of times to retry a task for this transform after a task run fails.
TransformEncryption:
allOf:
- $ref: '#/components/schemas/TransformEncryption'
- description: The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
GetMLTransformRequest:
type: object
required:
- TransformId
title: GetMLTransformRequest
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the transform, generated at the time that the transform was created.
GetMLTransformsResponse:
type: object
required:
- Transforms
properties:
Transforms:
allOf:
- $ref: '#/components/schemas/TransformList'
- description: A list of machine learning transforms.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A pagination token, if more results are available.
GetMLTransformsRequest:
type: object
title: GetMLTransformsRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A paginated token to offset the results.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
Filter:
allOf:
- $ref: '#/components/schemas/TransformFilterCriteria'
- description: The filter transformation criteria.
Sort:
allOf:
- $ref: '#/components/schemas/TransformSortCriteria'
- description: The sorting criteria.
GetMappingResponse:
type: object
required:
- Mapping
properties:
Mapping:
allOf:
- $ref: '#/components/schemas/MappingList'
- description: A list of mappings to the specified targets.
GetMappingRequest:
type: object
required:
- Source
title: GetMappingRequest
properties:
Source:
allOf:
- $ref: '#/components/schemas/CatalogEntry'
- description: Specifies the source table.
Sinks:
allOf:
- $ref: '#/components/schemas/CatalogEntries'
- description: A list of target tables.
Location:
allOf:
- $ref: '#/components/schemas/Location'
- description: Parameters for the mapping.
GetPartitionResponse:
type: object
properties:
Partition:
allOf:
- $ref: '#/components/schemas/Partition'
- description: The requested information, in the form of a Partition object.
GetPartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionValues
title: GetPartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partition resides.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partition's table.
PartitionValues:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: The values that define the partition.
GetPartitionIndexesResponse:
type: object
properties:
PartitionIndexDescriptorList:
allOf:
- $ref: '#/components/schemas/PartitionIndexDescriptorList'
- description: A list of index descriptors.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, present if the current list segment is not the last.
GetPartitionIndexesRequest:
type: object
required:
- DatabaseName
- TableName
title: GetPartitionIndexesRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The catalog ID where the table resides.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Specifies the name of a database from which you want to retrieve partition indexes.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Specifies the name of a table for which you want to retrieve the partition indexes.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, included if this is a continuation call.
GetPartitionsResponse:
type: object
properties:
Partitions:
allOf:
- $ref: '#/components/schemas/PartitionList'
- description: A list of requested partitions.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if the returned list of partitions does not include the last one.
GetPartitionsRequest:
type: object
required:
- DatabaseName
- TableName
title: GetPartitionsRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partitions in question reside. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partitions reside.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partitions' table.
Expression:
allOf:
- $ref: '#/components/schemas/PredicateString'
- description: "An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser
JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression
API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
The following
list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING, to be compatible with the catalog partitions.
Sample API Call:
" NextToken: allOf: - $ref: '#/components/schemas/Token' - description: A continuation token, if this is not the first call to retrieve these partitions. Segment: allOf: - $ref: '#/components/schemas/Segment' - description: The segment of the table's partitions to scan in this request. MaxResults: allOf: - $ref: '#/components/schemas/PageSize' - description: The maximum number of partitions to return in a single response. ExcludeColumnSchema: allOf: - $ref: '#/components/schemas/BooleanNullable' - description: When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data. TransactionId: allOf: - $ref: '#/components/schemas/TransactionIdString' - description: The transaction ID at which to read the partition contents. QueryAsOfTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along withTransactionId.
GetPlanResponse:
type: object
properties:
PythonScript:
allOf:
- $ref: '#/components/schemas/PythonScript'
- description: A Python script to perform the mapping.
ScalaCode:
allOf:
- $ref: '#/components/schemas/ScalaCode'
- description: The Scala code to perform the mapping.
GetPlanRequest:
type: object
required:
- Mapping
- Source
title: GetPlanRequest
properties:
Mapping:
allOf:
- $ref: '#/components/schemas/MappingList'
- description: The list of mappings from a source table to target tables.
Source:
allOf:
- $ref: '#/components/schemas/CatalogEntry'
- description: The source table.
Sinks:
allOf:
- $ref: '#/components/schemas/CatalogEntries'
- description: The target tables.
Location:
allOf:
- $ref: '#/components/schemas/Location'
- description: The parameters for the mapping.
Language:
allOf:
- $ref: '#/components/schemas/Language'
- description: The programming language of the code to perform the mapping.
AdditionalPlanOptionsMap:
allOf:
- $ref: '#/components/schemas/AdditionalPlanOptionsMap'
- description: A map to hold additional optional key-value parameters.
Currently, these key-value pairs are supported:
inferSchema — Specifies
whether to set inferSchema to true or false for the default script generated by an Glue job. For example, to set inferSchema to true, pass the following key
value pair:
--additional-plan-options-map '{"inferSchema":"true"}'
GetResourcePolicies to view
all existing resource policies. For more information see Specifying Glue Resource ARNs. '
GetSchemaResponse:
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.
SchemaName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the schema.
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of schema if specified when created
DataFormat:
allOf:
- $ref: '#/components/schemas/DataFormat'
- description: The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
Compatibility:
allOf:
- $ref: '#/components/schemas/Compatibility'
- description: The compatibility mode of the schema.
SchemaCheckpoint:
allOf:
- $ref: '#/components/schemas/SchemaCheckpointNumber'
- description: The version number of the checkpoint (the last time the compatibility mode was changed).
LatestSchemaVersion:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The latest version of the schema associated with the returned schema definition.
NextSchemaVersion:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The next version of the schema associated with the returned schema definition.
SchemaStatus:
allOf:
- $ref: '#/components/schemas/SchemaStatus'
- description: The status of the schema.
CreatedTime:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: The date and time the schema was created.
UpdatedTime:
allOf:
- $ref: '#/components/schemas/UpdatedTimestamp'
- description: The date and time the schema was updated.
GetSchemaInput:
type: object
required:
- SchemaId
title: GetSchemaInput
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName and RegistryName has to be provided.
AVRO, JSON and PROTOBUF are supported.
Status:
allOf:
- $ref: '#/components/schemas/SchemaVersionStatus'
- description: The status of the schema version.
CreatedTime:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: The date and time the schema was created.
GetSchemaByDefinitionInput:
type: object
required:
- SchemaId
- SchemaDefinition
title: GetSchemaByDefinitionInput
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One
of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName
has to be provided.
SchemaVersionId of the schema version.
SchemaDefinition:
allOf:
- $ref: '#/components/schemas/SchemaDefinitionString'
- description: The schema definition for the schema ID.
DataFormat:
allOf:
- $ref: '#/components/schemas/DataFormat'
- description: The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema.
VersionNumber:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The version number of the schema.
Status:
allOf:
- $ref: '#/components/schemas/SchemaVersionStatus'
- description: 'The status of the schema version. '
CreatedTime:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: The date and time the schema version was created.
GetSchemaVersionInput:
type: object
title: GetSchemaVersionInput
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName and RegistryName has to be provided.
SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.
SchemaVersionNumber:
allOf:
- $ref: '#/components/schemas/SchemaVersionNumber'
- description: The version number of the schema.
GetSchemaVersionsDiffResponse:
type: object
properties:
Diff:
allOf:
- $ref: '#/components/schemas/SchemaDefinitionDiff'
- description: The difference between schemas as a string in JsonPatch format.
GetSchemaVersionsDiffInput:
type: object
required:
- SchemaId
- FirstSchemaVersionNumber
- SecondSchemaVersionNumber
- SchemaDiffType
title: GetSchemaVersionsDiffInput
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One
of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName
has to be provided.
SYNTAX_DIFF, which is the currently supported diff type.
GetSecurityConfigurationResponse:
type: object
properties:
SecurityConfiguration:
allOf:
- $ref: '#/components/schemas/SecurityConfiguration'
- description: The requested security configuration.
GetSecurityConfigurationRequest:
type: object
required:
- Name
title: GetSecurityConfigurationRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the security configuration to retrieve.
GetSecurityConfigurationsResponse:
type: object
properties:
SecurityConfigurations:
allOf:
- $ref: '#/components/schemas/SecurityConfigurationList'
- description: A list of security configurations.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if there are more security configurations to return.
GetSecurityConfigurationsRequest:
type: object
title: GetSecurityConfigurationsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if this is a continuation call.
GetSessionResponse:
type: object
properties:
Session:
allOf:
- $ref: '#/components/schemas/Session'
- description: The session object is returned in the response.
GetSessionRequest:
type: object
required:
- Id
title: GetSessionRequest
properties:
Id:
allOf:
- $ref: '#/components/schemas/NameString'
- description: 'The ID of the session. '
RequestOrigin:
allOf:
- $ref: '#/components/schemas/OrchestrationNameString'
- description: 'The origin of the request. '
GetStatementResponse:
type: object
properties:
Statement:
allOf:
- $ref: '#/components/schemas/Statement'
- description: Returns the statement.
GetStatementRequest:
type: object
required:
- SessionId
- Id
title: GetStatementRequest
properties:
SessionId:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The Session ID of the statement.
Id:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The Id of the statement.
RequestOrigin:
allOf:
- $ref: '#/components/schemas/OrchestrationNameString'
- description: The origin of the request.
GetTableResponse:
type: object
properties:
Table:
allOf:
- $ref: '#/components/schemas/Table'
- description: The Table object that defines the specified table.
GetTableRequest:
type: object
required:
- DatabaseName
- Name
title: GetTableRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.
TransactionId:
allOf:
- $ref: '#/components/schemas/TransactionIdString'
- description: 'The transaction ID at which to read the table contents. '
QueryAsOfTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
GetTableVersionResponse:
type: object
properties:
TableVersion:
allOf:
- $ref: '#/components/schemas/TableVersion'
- description: The requested table version.
GetTableVersionRequest:
type: object
required:
- DatabaseName
- TableName
title: GetTableVersionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table. For Hive compatibility, this name is entirely lowercase.
VersionId:
allOf:
- $ref: '#/components/schemas/VersionString'
- description: 'The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1. '
GetTableVersionsResponse:
type: object
properties:
TableVersions:
allOf:
- $ref: '#/components/schemas/GetTableVersionsList'
- description: A list of strings identifying available versions of the specified table.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if the list of available versions does not include the last one.
GetTableVersionsRequest:
type: object
required:
- DatabaseName
- TableName
title: GetTableVersionsRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table. For Hive compatibility, this name is entirely lowercase.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if this is not the first call.
MaxResults:
allOf:
- $ref: '#/components/schemas/CatalogGetterPageSize'
- description: The maximum number of table versions to return in one response.
GetTablesResponse:
type: object
properties:
TableList:
allOf:
- $ref: '#/components/schemas/TableList'
- description: A list of the requested Table objects.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, present if the current list segment is not the last.
GetTablesRequest:
type: object
required:
- DatabaseName
title: GetTablesRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
Expression:
allOf:
- $ref: '#/components/schemas/FilterString'
- description: A regular expression pattern. If present, only those tables whose names match the pattern are returned.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, included if this is a continuation call.
MaxResults:
allOf:
- $ref: '#/components/schemas/CatalogGetterPageSize'
- description: The maximum number of tables to return in a single response.
TransactionId:
allOf:
- $ref: '#/components/schemas/TransactionIdString'
- description: The transaction ID at which to read the table contents.
QueryAsOfTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
GetTagsResponse:
type: object
properties:
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: The requested tags.
GetTagsRequest:
type: object
required:
- ResourceArn
title: GetTagsRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
GetTriggerResponse:
type: object
properties:
Trigger:
allOf:
- $ref: '#/components/schemas/Trigger'
- description: The requested trigger definition.
GetTriggerRequest:
type: object
required:
- Name
title: GetTriggerRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the trigger to retrieve.
GetTriggersResponse:
type: object
properties:
Triggers:
allOf:
- $ref: '#/components/schemas/TriggerList'
- description: A list of triggers for the specified job.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if not all the requested triggers have yet been returned.
GetTriggersRequest:
type: object
title: GetTriggersRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if this is a continuation call.
DependentJobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are returned.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum size of the response.
GetUnfilteredPartitionMetadataResponse:
type: object
properties:
Partition:
allOf:
- $ref: '#/components/schemas/Partition'
- description: A Partition object containing the partition metadata.
AuthorizedColumns:
allOf:
- $ref: '#/components/schemas/NameStringList'
- description: A list of column names that the user has been granted access to.
IsRegisteredWithLakeFormation:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: A Boolean value that indicates whether the partition location is registered with Lake Formation.
GetUnfilteredPartitionMetadataRequest:
type: object
required:
- CatalogId
- DatabaseName
- TableName
- PartitionValues
- SupportedPermissionTypes
title: GetUnfilteredPartitionMetadataRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The catalog ID where the partition resides.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: (Required) Specifies the name of a database that contains the partition.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: (Required) Specifies the name of a table that contains the partition.
PartitionValues:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: (Required) A list of partition key values.
AuditContext:
allOf:
- $ref: '#/components/schemas/AuditContext'
- description: A structure containing Lake Formation audit context information.
SupportedPermissionTypes:
allOf:
- $ref: '#/components/schemas/PermissionTypeList'
- description: '(Required) A list of supported permission types. '
PermissionTypeMismatchException: {}
GetUnfilteredPartitionsMetadataResponse:
type: object
properties:
UnfilteredPartitions:
allOf:
- $ref: '#/components/schemas/UnfilteredPartitionList'
- description: A list of requested partitions.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if the returned list of partitions does not include the last one.
GetUnfilteredPartitionsMetadataRequest:
type: object
required:
- CatalogId
- DatabaseName
- TableName
- SupportedPermissionTypes
title: GetUnfilteredPartitionsMetadataRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: 'The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default. '
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partitions reside.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table that contains the partition.
Expression:
allOf:
- $ref: '#/components/schemas/PredicateString'
- description: "An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser
JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression
API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
" AuditContext: allOf: - $ref: '#/components/schemas/AuditContext' - description: A structure containing Lake Formation audit context information. SupportedPermissionTypes: allOf: - $ref: '#/components/schemas/PermissionTypeList' - description: 'A list of supported permission types. ' NextToken: allOf: - $ref: '#/components/schemas/Token' - description: A continuation token, if this is not the first call to retrieve these partitions. Segment: allOf: - $ref: '#/components/schemas/Segment' - description: The segment of the table's partitions to scan in this request. MaxResults: allOf: - $ref: '#/components/schemas/PageSize' - description: The maximum number of partitions to return in a single response. GetUnfilteredTableMetadataResponse: type: object properties: Table: allOf: - $ref: '#/components/schemas/Table' - description: A Table object containing the table metadata. AuthorizedColumns: allOf: - $ref: '#/components/schemas/NameStringList' - description: A list of column names that the user has been granted access to. IsRegisteredWithLakeFormation: allOf: - $ref: '#/components/schemas/Boolean' - description: A Boolean value that indicates whether the partition location is registered with Lake Formation. CellFilters: allOf: - $ref: '#/components/schemas/ColumnRowFilterList' - description: A list of column row filters. GetUnfilteredTableMetadataRequest: type: object required: - CatalogId - DatabaseName - Name - SupportedPermissionTypes title: GetUnfilteredTableMetadataRequest properties: CatalogId: allOf: - $ref: '#/components/schemas/CatalogIdString' - description: The catalog ID where the table resides. DatabaseName: allOf: - $ref: '#/components/schemas/NameString' - description: (Required) Specifies the name of a database that contains the table. Name: allOf: - $ref: '#/components/schemas/NameString' - description: (Required) Specifies the name of a table for which you are requesting metadata. AuditContext: allOf: - $ref: '#/components/schemas/AuditContext' - description: A structure containing Lake Formation audit context information. SupportedPermissionTypes: allOf: - $ref: '#/components/schemas/PermissionTypeList' - description: '(Required) A list of supported permission types. ' GetUserDefinedFunctionResponse: type: object properties: UserDefinedFunction: allOf: - $ref: '#/components/schemas/UserDefinedFunction' - description: The requested function definition. GetUserDefinedFunctionRequest: type: object required: - DatabaseName - FunctionName title: GetUserDefinedFunctionRequest properties: CatalogId: allOf: - $ref: '#/components/schemas/CatalogIdString' - description: The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the Amazon Web Services account ID is used by default. DatabaseName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the catalog database where the function is located. FunctionName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the function. GetUserDefinedFunctionsResponse: type: object properties: UserDefinedFunctions: allOf: - $ref: '#/components/schemas/UserDefinedFunctionList' - description: A list of requested function definitions. NextToken: allOf: - $ref: '#/components/schemas/Token' - description: A continuation token, if the list of functions returned does not include the last requested function. GetUserDefinedFunctionsRequest: type: object required: - Pattern title: GetUserDefinedFunctionsRequest properties: CatalogId: allOf: - $ref: '#/components/schemas/CatalogIdString' - description: The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the Amazon Web Services account ID is used by default. DatabaseName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the catalog database where the functions are located. If none is provided, functions from all the databases across the catalog will be returned. Pattern: allOf: - $ref: '#/components/schemas/NameString' - description: An optional function-name pattern string that filters the function definitions returned. NextToken: allOf: - $ref: '#/components/schemas/Token' - description: A continuation token, if this is a continuation call. MaxResults: allOf: - $ref: '#/components/schemas/CatalogGetterPageSize' - description: The maximum number of functions to return in one response. GetWorkflowResponse: type: object properties: Workflow: allOf: - $ref: '#/components/schemas/Workflow' - description: The resource metadata for the workflow. GetWorkflowRequest: type: object required: - Name title: GetWorkflowRequest properties: Name: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the workflow to retrieve. IncludeGraph: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Specifies whether to include a graph when returning the workflow resource metadata. GetWorkflowRunResponse: type: object properties: Run: allOf: - $ref: '#/components/schemas/WorkflowRun' - description: The requested workflow run metadata. GetWorkflowRunRequest: type: object required: - Name - RunId title: GetWorkflowRunRequest properties: Name: allOf: - $ref: '#/components/schemas/NameString' - description: Name of the workflow being run. RunId: allOf: - $ref: '#/components/schemas/IdString' - description: The ID of the workflow run. IncludeGraph: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Specifies whether to include the workflow graph in response or not. GetWorkflowRunPropertiesResponse: type: object properties: RunProperties: allOf: - $ref: '#/components/schemas/WorkflowRunProperties' - description: The workflow run properties which were set during the specified run. GetWorkflowRunPropertiesRequest: type: object required: - Name - RunId title: GetWorkflowRunPropertiesRequest properties: Name: allOf: - $ref: '#/components/schemas/NameString' - description: Name of the workflow which was run. RunId: allOf: - $ref: '#/components/schemas/IdString' - description: The ID of the workflow run whose run properties should be returned. GetWorkflowRunsResponse: type: object properties: Runs: allOf: - $ref: '#/components/schemas/WorkflowRuns' - description: A list of workflow run metadata objects. NextToken: allOf: - $ref: '#/components/schemas/GenericString' - description: A continuation token, if not all requested workflow runs have been returned. GetWorkflowRunsRequest: type: object required: - Name title: GetWorkflowRunsRequest properties: Name: allOf: - $ref: '#/components/schemas/NameString' - description: Name of the workflow whose metadata of runs should be returned. IncludeGraph: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Specifies whether to include the workflow graph in response or not. NextToken: allOf: - $ref: '#/components/schemas/GenericString' - description: The maximum size of the response. MaxResults: allOf: - $ref: '#/components/schemas/PageSize' - description: The maximum number of workflow runs to be included in the response. ImportCatalogToGlueResponse: type: object properties: {} ImportCatalogToGlueRequest: type: object title: ImportCatalogToGlueRequest properties: CatalogId: allOf: - $ref: '#/components/schemas/CatalogIdString' - description: The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID. ListBlueprintsResponse: type: object properties: Blueprints: allOf: - $ref: '#/components/schemas/BlueprintNames' - description: List of names of blueprints in the account. NextToken: allOf: - $ref: '#/components/schemas/GenericString' - description: A continuation token, if not all blueprint names have been returned. ListBlueprintsRequest: type: object title: ListBlueprintsRequest properties: 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. Tags: allOf: - $ref: '#/components/schemas/TagsMap' - description: Filters the list by an Amazon Web Services resource tag. ListCrawlersResponse: type: object properties: CrawlerNames: allOf: - $ref: '#/components/schemas/CrawlerNameList' - description: The names of all crawlers in the account, or the crawlers with the specified tags. NextToken: allOf: - $ref: '#/components/schemas/Token' - description: A continuation token, if the returned list does not contain the last metric available. ListCrawlersRequest: type: object title: ListCrawlersRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/PageSize' - description: The maximum size of a list to return. NextToken: allOf: - $ref: '#/components/schemas/Token' - description: A continuation token, if this is a continuation request. Tags: allOf: - $ref: '#/components/schemas/TagsMap' - description: Specifies to return only these tagged resources. ListCrawlsResponse: type: object properties: Crawls: allOf: - $ref: '#/components/schemas/CrawlerHistoryList' - description: A list ofCrawlerHistory objects representing the crawl runs that meet your criteria.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
ListCrawlsRequest:
type: object
required:
- CrawlerName
title: ListCrawlsRequest
properties:
CrawlerName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the crawler whose runs you want to retrieve.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return. The default is 20, and maximum is 100.
Filters:
allOf:
- $ref: '#/components/schemas/CrawlsFilterList'
- description: Filters the crawls by the criteria you specify in a list of CrawlsFilter objects.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, if this is a continuation call.
ListCustomEntityTypesResponse:
type: object
properties:
CustomEntityTypes:
allOf:
- $ref: '#/components/schemas/CustomEntityTypes'
- description: A list of CustomEntityType objects representing custom patterns.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A pagination token, if more results are available.
ListCustomEntityTypesRequest:
type: object
title: ListCustomEntityTypesRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A paginated token to offset the results.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
ListDataQualityResultsResponse:
type: object
required:
- Results
properties:
Results:
allOf:
- $ref: '#/components/schemas/DataQualityResultDescriptionList'
- description: A list of DataQualityResultDescription objects.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A pagination token, if more results are available.
ListDataQualityResultsRequest:
type: object
title: ListDataQualityResultsRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/DataQualityResultFilterCriteria'
- description: The filter criteria.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A paginated token to offset the results.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
ListDataQualityRuleRecommendationRunsResponse:
type: object
properties:
Runs:
allOf:
- $ref: '#/components/schemas/DataQualityRuleRecommendationRunList'
- description: A list of DataQualityRuleRecommendationRunDescription objects.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A pagination token, if more results are available.
ListDataQualityRuleRecommendationRunsRequest:
type: object
title: ListDataQualityRuleRecommendationRunsRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/DataQualityRuleRecommendationRunFilter'
- description: The filter criteria.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A paginated token to offset the results.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
ListDataQualityRulesetEvaluationRunsResponse:
type: object
properties:
Runs:
allOf:
- $ref: '#/components/schemas/DataQualityRulesetEvaluationRunList'
- description: A list of DataQualityRulesetEvaluationRunDescription objects representing data quality ruleset runs.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A pagination token, if more results are available.
ListDataQualityRulesetEvaluationRunsRequest:
type: object
title: ListDataQualityRulesetEvaluationRunsRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/DataQualityRulesetEvaluationRunFilter'
- description: The filter criteria.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A paginated token to offset the results.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
ListDataQualityRulesetsResponse:
type: object
properties:
Rulesets:
allOf:
- $ref: '#/components/schemas/DataQualityRulesetList'
- description: A paginated list of rulesets for the specified list of Glue tables.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A pagination token, if more results are available.
ListDataQualityRulesetsRequest:
type: object
title: ListDataQualityRulesetsRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A paginated token to offset the results.
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
Filter:
allOf:
- $ref: '#/components/schemas/DataQualityRulesetFilterCriteria'
- description: 'The filter criteria. '
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: A list of key-value pair tags.
ListDevEndpointsResponse:
type: object
properties:
DevEndpointNames:
allOf:
- $ref: '#/components/schemas/DevEndpointNameList'
- description: The names of all the DevEndpoints in the account, or the DevEndpoints with the specified tags.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if the returned list does not contain the last metric available.
ListDevEndpointsRequest:
type: object
title: ListDevEndpointsRequest
properties:
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.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: Specifies to return only these tagged resources.
ListJobsResponse:
type: object
properties:
JobNames:
allOf:
- $ref: '#/components/schemas/JobNameList'
- description: The names of all jobs in the account, or the jobs with the specified tags.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if the returned list does not contain the last metric available.
ListJobsRequest:
type: object
title: ListJobsRequest
properties:
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.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: Specifies to return only these tagged resources.
ListMLTransformsResponse:
type: object
required:
- TransformIds
properties:
TransformIds:
allOf:
- $ref: '#/components/schemas/TransformIdList'
- description: The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: A continuation token, if the returned list does not contain the last metric available.
ListMLTransformsRequest:
type: object
title: ListMLTransformsRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- 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.
Filter:
allOf:
- $ref: '#/components/schemas/TransformFilterCriteria'
- description: A TransformFilterCriteria used to filter the machine learning transforms.
Sort:
allOf:
- $ref: '#/components/schemas/TransformSortCriteria'
- description: A TransformSortCriteria used to sort the machine learning transforms.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: Specifies to return only these tagged resources.
ListRegistriesResponse:
type: object
properties:
Registries:
allOf:
- $ref: '#/components/schemas/RegistryListDefinition'
- description: An array of RegistryDetailedListItem objects containing minimal details of each registry.
NextToken:
allOf:
- $ref: '#/components/schemas/SchemaRegistryTokenString'
- description: A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
ListRegistriesInput:
type: object
title: ListRegistriesInput
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResultsNumber'
- description: Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
NextToken:
allOf:
- $ref: '#/components/schemas/SchemaRegistryTokenString'
- description: A continuation token, if this is a continuation call.
ListSchemaVersionsResponse:
type: object
properties:
Schemas:
allOf:
- $ref: '#/components/schemas/SchemaVersionList'
- description: An array of SchemaVersionList objects containing details of each schema version.
NextToken:
allOf:
- $ref: '#/components/schemas/SchemaRegistryTokenString'
- description: A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
ListSchemaVersionsInput:
type: object
required:
- SchemaId
title: ListSchemaVersionsInput
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName and RegistryName has to be provided.
SchemaListItem objects containing details of each schema.
NextToken:
allOf:
- $ref: '#/components/schemas/SchemaRegistryTokenString'
- description: A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
ListSchemasInput:
type: object
title: ListSchemasInput
properties:
RegistryId:
allOf:
- $ref: '#/components/schemas/RegistryId'
- description: A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResultsNumber'
- description: Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
NextToken:
allOf:
- $ref: '#/components/schemas/SchemaRegistryTokenString'
- description: A continuation token, if this is a continuation call.
ListSessionsResponse:
type: object
properties:
Ids:
allOf:
- $ref: '#/components/schemas/SessionIdList'
- description: 'Returns the ID of the session. '
Sessions:
allOf:
- $ref: '#/components/schemas/SessionList'
- description: 'Returns the session object. '
NextToken:
allOf:
- $ref: '#/components/schemas/OrchestrationToken'
- description: 'The token for the next set of results, or null if there are no more result. '
ListSessionsRequest:
type: object
title: ListSessionsRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/OrchestrationToken'
- description: 'The token for the next set of results, or null if there are no more result. '
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: 'The maximum number of results. '
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: 'Tags belonging to the session. '
RequestOrigin:
allOf:
- $ref: '#/components/schemas/OrchestrationNameString'
- description: 'The origin of the request. '
ListStatementsResponse:
type: object
properties:
Statements:
allOf:
- $ref: '#/components/schemas/StatementList'
- description: Returns the list of statements.
NextToken:
allOf:
- $ref: '#/components/schemas/OrchestrationToken'
- description: A continuation token, if not all statements have yet been returned.
ListStatementsRequest:
type: object
required:
- SessionId
title: ListStatementsRequest
properties:
SessionId:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The Session ID of the statements.
RequestOrigin:
allOf:
- $ref: '#/components/schemas/OrchestrationNameString'
- description: The origin of the request to list statements.
NextToken:
allOf:
- $ref: '#/components/schemas/OrchestrationToken'
- description: A continuation token, if this is a continuation call.
ListTriggersResponse:
type: object
properties:
TriggerNames:
allOf:
- $ref: '#/components/schemas/TriggerNameList'
- description: The names of all triggers in the account, or the triggers with the specified tags.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if the returned list does not contain the last metric available.
ListTriggersRequest:
type: object
title: ListTriggersRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if this is a continuation request.
DependentJobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: ' The name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is no such trigger, all triggers are returned.'
MaxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum size of a list to return.
Tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: Specifies to return only these tagged resources.
ListWorkflowsResponse:
type: object
properties:
Workflows:
allOf:
- $ref: '#/components/schemas/WorkflowNames'
- description: List of names of workflows in the account.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A continuation token, if not all workflow names have been returned.
ListWorkflowsRequest:
type: object
title: ListWorkflowsRequest
properties:
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.
PutDataCatalogEncryptionSettingsResponse:
type: object
properties: {}
PutDataCatalogEncryptionSettingsRequest:
type: object
required:
- DataCatalogEncryptionSettings
title: PutDataCatalogEncryptionSettingsRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog to set the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
DataCatalogEncryptionSettings:
allOf:
- $ref: '#/components/schemas/DataCatalogEncryptionSettings'
- description: The security configuration to set.
PutResourcePolicyResponse:
type: object
properties:
PolicyHash:
allOf:
- $ref: '#/components/schemas/HashString'
- description: A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.
PutResourcePolicyRequest:
type: object
required:
- PolicyInJson
title: PutResourcePolicyRequest
properties:
PolicyInJson:
allOf:
- $ref: '#/components/schemas/PolicyJsonString'
- description: Contains the policy document to set, in JSON format.
ResourceArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: Do not use. For internal use only.
PolicyHashCondition:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this
parameter if no previous policy has been set.
PolicyExistsCondition:
allOf:
- $ref: '#/components/schemas/ExistCondition'
- description: A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null
value is used, the call does not depend on the existence of a policy.
EnableHybrid:
allOf:
- $ref: '#/components/schemas/EnableHybridValues'
- description: If 'TRUE', indicates that you are using both methods to grant cross-account access to Data Catalog resources:
By directly updating the
resource policy with PutResourePolicy
By using the Grant permissions command on the Amazon Web Services Management Console.
Must
be set to 'TRUE' if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is 'FALSE'.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName and RegistryName has to be provided.
DataFormat setting for the SchemaName.
RemoveSchemaVersionMetadataResponse:
type: object
properties:
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema.
SchemaName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the schema.
RegistryName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the registry.
LatestVersion:
allOf:
- $ref: '#/components/schemas/LatestSchemaVersionBoolean'
- description: The latest version of the schema.
VersionNumber:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The version number of the schema.
SchemaVersionId:
allOf:
- $ref: '#/components/schemas/SchemaVersionIdString'
- description: The version ID for the schema version.
MetadataKey:
allOf:
- $ref: '#/components/schemas/MetadataKeyString'
- description: The metadata key.
MetadataValue:
allOf:
- $ref: '#/components/schemas/MetadataValueString'
- description: The value of the metadata key.
RemoveSchemaVersionMetadataInput:
type: object
required:
- MetadataKeyValue
title: RemoveSchemaVersionMetadataInput
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
SchemaVersionNumber:
allOf:
- $ref: '#/components/schemas/SchemaVersionNumber'
- description: The version number of the schema.
SchemaVersionId:
allOf:
- $ref: '#/components/schemas/SchemaVersionIdString'
- description: The unique version ID of the schema version.
MetadataKeyValue:
allOf:
- $ref: '#/components/schemas/MetadataKeyValuePair'
- description: The value of the metadata key.
ResetJobBookmarkResponse:
type: object
properties:
JobBookmarkEntry:
allOf:
- $ref: '#/components/schemas/JobBookmarkEntry'
- description: The reset bookmark entry.
ResetJobBookmarkRequest:
type: object
required:
- JobName
title: ResetJobBookmarkRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: The name of the job in question.
RunId:
allOf:
- $ref: '#/components/schemas/RunId'
- description: The unique run identifier associated with this job run.
ResumeWorkflowRunResponse:
type: object
properties:
RunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
NodeIds:
allOf:
- $ref: '#/components/schemas/NodeIdList'
- description: A list of the node IDs for the nodes that were actually restarted.
ResumeWorkflowRunRequest:
type: object
required:
- Name
- RunId
- NodeIds
title: ResumeWorkflowRunRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the workflow to resume.
RunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The ID of the workflow run to resume.
NodeIds:
allOf:
- $ref: '#/components/schemas/NodeIdList'
- description: A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
ConcurrentRunsExceededException: {}
IllegalWorkflowStateException: {}
RunStatementResponse:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: Returns the Id of the statement that was run.
RunStatementRequest:
type: object
required:
- SessionId
- Code
title: RunStatementRequest
properties:
SessionId:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The Session Id of the statement to be run.
Code:
allOf:
- $ref: '#/components/schemas/OrchestrationStatementCodeString'
- description: The statement code to be run.
RequestOrigin:
allOf:
- $ref: '#/components/schemas/OrchestrationNameString'
- description: The origin of the request.
SearchTablesResponse:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, present if the current list segment is not the last.
TableList:
allOf:
- $ref: '#/components/schemas/TableList'
- description: A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.
SearchTablesRequest:
type: object
title: SearchTablesRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: A unique identifier, consisting of account_id .
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, included if this is a continuation call.
Filters:
allOf:
- $ref: '#/components/schemas/SearchPropertyPredicates'
- description: 'A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator member of the
PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy
match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens.
Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named
customer-link and xx-link-yy are returned, but xxlinkyy is not returned.
A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
SortCriteria: allOf: - $ref: '#/components/schemas/SortCriteria' - description: A list of criteria for sorting the results by a field name, in an ascending or descending order. MaxResults: allOf: - $ref: '#/components/schemas/PageSize' - description: The maximum number of tables to return in a single response. ResourceShareType: allOf: - $ref: '#/components/schemas/ResourceShareType' - description:Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.
If
set to FOREIGN, will search the tables shared with your account.
If set to ALL, will search the tables shared with your account, as well as
the tables in yor local account.
BlueprintParameters object.
RoleArn:
allOf:
- $ref: '#/components/schemas/OrchestrationIAMRoleArn'
- description: Specifies the IAM role used to create the workflow.
IllegalBlueprintStateException: {}
StartCrawlerResponse:
type: object
properties: {}
StartCrawlerRequest:
type: object
required:
- Name
title: StartCrawlerRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the crawler to start.
StartCrawlerScheduleResponse:
type: object
properties: {}
StartCrawlerScheduleRequest:
type: object
required:
- CrawlerName
title: StartCrawlerScheduleRequest
properties:
CrawlerName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the crawler to schedule.
SchedulerRunningException: {}
NoScheduleException: {}
StartDataQualityRuleRecommendationRunResponse:
type: object
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
StartDataQualityRuleRecommendationRunRequest:
type: object
required:
- DataSource
- Role
title: StartDataQualityRuleRecommendationRunRequest
properties:
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: The data source (Glue table) associated with this run.
Role:
allOf:
- $ref: '#/components/schemas/RoleString'
- description: An IAM role supplied to encrypt the results of the run.
NumberOfWorkers:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The number of G.1X workers to be used in the run. The default is 5.
Timeout:
allOf:
- $ref: '#/components/schemas/Timeout'
- description: The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is
2,880 minutes (48 hours).
CreatedRulesetName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A name for the ruleset.
ClientToken:
allOf:
- $ref: '#/components/schemas/HashString'
- description: Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
StartDataQualityRulesetEvaluationRunResponse:
type: object
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
StartDataQualityRulesetEvaluationRunRequest:
type: object
required:
- DataSource
- Role
- RulesetNames
title: StartDataQualityRulesetEvaluationRunRequest
properties:
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: The data source (Glue table) associated with this run.
Role:
allOf:
- $ref: '#/components/schemas/RoleString'
- description: An IAM role supplied to encrypt the results of the run.
NumberOfWorkers:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The number of G.1X workers to be used in the run. The default is 5.
Timeout:
allOf:
- $ref: '#/components/schemas/Timeout'
- description: The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is
2,880 minutes (48 hours).
ClientToken:
allOf:
- $ref: '#/components/schemas/HashString'
- description: Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
AdditionalRunOptions:
allOf:
- $ref: '#/components/schemas/DataQualityEvaluationRunAdditionalRunOptions'
- description: Additional run options you can specify for an evaluation run.
RulesetNames:
allOf:
- $ref: '#/components/schemas/RulesetNames'
- description: A list of ruleset names.
StartExportLabelsTaskRunResponse:
type: object
properties:
TaskRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier for the task run.
StartExportLabelsTaskRunRequest:
type: object
required:
- TransformId
- OutputS3Path
title: StartExportLabelsTaskRunRequest
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the machine learning transform.
OutputS3Path:
allOf:
- $ref: '#/components/schemas/UriString'
- description: The Amazon S3 path where you export the labels.
StartImportLabelsTaskRunResponse:
type: object
properties:
TaskRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier for the task run.
StartImportLabelsTaskRunRequest:
type: object
required:
- TransformId
- InputS3Path
title: StartImportLabelsTaskRunRequest
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier of the machine learning transform.
InputS3Path:
allOf:
- $ref: '#/components/schemas/UriString'
- description: The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.
ReplaceAllLabels:
allOf:
- $ref: '#/components/schemas/ReplaceBoolean'
- description: Indicates whether to overwrite your existing labels.
StartJobRunResponse:
type: object
properties:
JobRunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The ID assigned to this job run.
StartJobRunRequest:
type: object
required:
- JobName
title: StartJobRunRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job definition to use.
JobRunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The ID of a previous JobRun to retry.
Arguments:
allOf:
- $ref: '#/components/schemas/GenericMap'
- description: The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
AllocatedCapacity: allOf: - $ref: '#/components/schemas/IntegerValue' - deprecated: true description:This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
This property is deprecated, use MaxCapacity instead. Timeout: allOf: - $ref: '#/components/schemas/Timeout' - description:The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
This value overrides the timeout value set in the parent job.
Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
MaxCapacity: allOf: - $ref: '#/components/schemas/NullableDouble' - description:The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Do not set Max Capacity if
using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job,
or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is
0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job
type cannot have a fractional DPU allocation.
SecurityConfiguration structure to be used with this job run.
NotificationProperty:
allOf:
- $ref: '#/components/schemas/NotificationProperty'
- description: Specifies configuration properties of a job run notification.
WorkerType:
allOf:
- $ref: '#/components/schemas/WorkerType'
- description: The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
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 provides 4 vCPU, 16
GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
executor per worker.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We
recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
workerType that are allocated when a job runs.
ExecutionClass:
allOf:
- $ref: '#/components/schemas/ExecutionClass'
- description: Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue
version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark
jobs.
GrokClassifier object with updated fields.
XMLClassifier:
allOf:
- $ref: '#/components/schemas/UpdateXMLClassifierRequest'
- description: An XMLClassifier object with updated fields.
JsonClassifier:
allOf:
- $ref: '#/components/schemas/UpdateJsonClassifierRequest'
- description: A JsonClassifier object with updated fields.
CsvClassifier:
allOf:
- $ref: '#/components/schemas/UpdateCsvClassifierRequest'
- description: A CsvClassifier object with updated fields.
VersionMismatchException: {}
UpdateColumnStatisticsForPartitionResponse:
type: object
properties:
Errors:
allOf:
- $ref: '#/components/schemas/ColumnStatisticsErrors'
- description: Error occurred during updating column statistics data.
UpdateColumnStatisticsForPartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionValues
- ColumnStatisticsList
title: UpdateColumnStatisticsForPartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partitions reside.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partitions' table.
PartitionValues:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: A list of partition values identifying the partition.
ColumnStatisticsList:
allOf:
- $ref: '#/components/schemas/UpdateColumnStatisticsList'
- description: A list of the column statistics.
UpdateColumnStatisticsForTableResponse:
type: object
properties:
Errors:
allOf:
- $ref: '#/components/schemas/ColumnStatisticsErrors'
- description: List of ColumnStatisticsErrors.
UpdateColumnStatisticsForTableRequest:
type: object
required:
- DatabaseName
- TableName
- ColumnStatisticsList
title: UpdateColumnStatisticsForTableRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the partitions reside.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the partitions' table.
ColumnStatisticsList:
allOf:
- $ref: '#/components/schemas/UpdateColumnStatisticsList'
- description: A list of the column statistics.
UpdateConnectionResponse:
type: object
properties: {}
UpdateConnectionRequest:
type: object
required:
- Name
- ConnectionInput
title: UpdateConnectionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the connection definition to update.
ConnectionInput:
allOf:
- $ref: '#/components/schemas/ConnectionInput'
- description: A ConnectionInput object that redefines the connection in question.
UpdateCrawlerResponse:
type: object
properties: {}
UpdateCrawlerRequest:
type: object
required:
- Name
title: UpdateCrawlerRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the new crawler.
Role:
allOf:
- $ref: '#/components/schemas/Role'
- description: The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
DatabaseName:
allOf:
- $ref: '#/components/schemas/DatabaseName'
- description: 'The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.'
Description:
allOf:
- $ref: '#/components/schemas/DescriptionStringRemovable'
- description: A description of the new crawler.
Targets:
allOf:
- $ref: '#/components/schemas/CrawlerTargets'
- description: A list of targets to crawl.
Schedule:
allOf:
- $ref: '#/components/schemas/CronExpression'
- description: 'A cron expression used to specify the schedule (see Time-Based Schedules
for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).'
Classifiers:
allOf:
- $ref: '#/components/schemas/ClassifierNameList'
- description: A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the
default classifiers for a given classification.
TablePrefix:
allOf:
- $ref: '#/components/schemas/TablePrefix'
- description: The table prefix used for catalog tables that are created.
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/SchemaChangePolicy'
- description: The policy for the crawler's update and deletion behavior.
RecrawlPolicy:
allOf:
- $ref: '#/components/schemas/RecrawlPolicy'
- description: A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
LineageConfiguration:
allOf:
- $ref: '#/components/schemas/LineageConfiguration'
- description: Specifies data lineage configuration settings for the crawler.
LakeFormationConfiguration:
allOf:
- $ref: '#/components/schemas/LakeFormationConfiguration'
- description: Specifies Lake Formation configuration settings for the crawler.
Configuration:
allOf:
- $ref: '#/components/schemas/CrawlerConfiguration'
- description: Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
CrawlerSecurityConfiguration:
allOf:
- $ref: '#/components/schemas/CrawlerSecurityConfiguration'
- description: The name of the SecurityConfiguration structure to be used by this crawler.
UpdateCrawlerScheduleResponse:
type: object
properties: {}
UpdateCrawlerScheduleRequest:
type: object
required:
- CrawlerName
title: UpdateCrawlerScheduleRequest
properties:
CrawlerName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the crawler whose schedule to update.
Schedule:
allOf:
- $ref: '#/components/schemas/CronExpression'
- description: 'The updated cron expression used to specify the schedule (see Time-Based
Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).'
UpdateDataQualityRulesetResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the data quality ruleset.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the ruleset.
Ruleset:
allOf:
- $ref: '#/components/schemas/DataQualityRulesetString'
- description: A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
UpdateDataQualityRulesetRequest:
type: object
required:
- Name
title: UpdateDataQualityRulesetRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the data quality ruleset.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the ruleset.
Ruleset:
allOf:
- $ref: '#/components/schemas/DataQualityRulesetString'
- description: A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
UpdateDatabaseResponse:
type: object
properties: {}
UpdateDatabaseRequest:
type: object
required:
- Name
- DatabaseInput
title: UpdateDatabaseRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
DatabaseInput:
allOf:
- $ref: '#/components/schemas/DatabaseInput'
- description: A DatabaseInput object specifying the new definition of the metadata database in the catalog.
UpdateDevEndpointResponse:
type: object
properties: {}
UpdateDevEndpointRequest:
type: object
required:
- EndpointName
title: UpdateDevEndpointRequest
properties:
EndpointName:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The name of the DevEndpoint to be updated.
PublicKey:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The public key for the DevEndpoint to use.
AddPublicKeys:
allOf:
- $ref: '#/components/schemas/PublicKeysList'
- description: The list of public keys for the DevEndpoint to use.
DeletePublicKeys:
allOf:
- $ref: '#/components/schemas/PublicKeysList'
- description: The list of public keys to be deleted from the DevEndpoint.
CustomLibraries:
allOf:
- $ref: '#/components/schemas/DevEndpointCustomLibraries'
- description: Custom Python or Java libraries to be loaded in the DevEndpoint.
UpdateEtlLibraries:
allOf:
- $ref: '#/components/schemas/BooleanValue'
- description: ' True if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False if otherwise.'
DeleteArguments:
allOf:
- $ref: '#/components/schemas/StringList'
- description: The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint.
AddArguments:
allOf:
- $ref: '#/components/schemas/MapValue'
- description: 'The map of arguments to add the map of arguments used to configure the 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.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes
read-only.
The type of predefined worker that is allocated when this task runs. 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 provides 4 vCPU, 16 GB of
memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor
per worker.
workerType that are allocated when this task runs.
Timeout:
allOf:
- $ref: '#/components/schemas/Timeout'
- description: The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters
TIMEOUT status. The default is 2,880 minutes (48 hours).
MaxRetries:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The maximum number of times to retry a task for this transform after a task run fails.
UpdatePartitionResponse:
type: object
properties: {}
UpdatePartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionValueList
- PartitionInput
title: UpdatePartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partition to be updated resides. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database in which the table in question resides.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table in which the partition to be updated is located.
PartitionValueList:
allOf:
- $ref: '#/components/schemas/BoundedPartitionValueList'
- description: List of partition key values that define the partition to update.
PartitionInput:
allOf:
- $ref: '#/components/schemas/PartitionInput'
- description: The new partition object to update the partition to.
The Values property can't be changed. If you want to change the partition key values for a
partition, delete and recreate the partition.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One
of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName
has to be provided.
VersionNumber or Compatibility has to be provided.
Compatibility:
allOf:
- $ref: '#/components/schemas/Compatibility'
- description: The new compatibility setting for the schema.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: The new description for the schema.
UpdateSourceControlFromJobResponse:
type: object
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the Glue job.
UpdateSourceControlFromJobRequest:
type: object
title: UpdateSourceControlFromJobRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the Glue job to be synchronized to or from the remote repository.
Provider:
allOf:
- $ref: '#/components/schemas/SourceControlProvider'
- description: The provider for the remote repository.
RepositoryName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the remote repository that contains the job artifacts.
RepositoryOwner:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The owner of the remote repository that contains the job artifacts.
BranchName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: An optional branch in the remote repository.
Folder:
allOf:
- $ref: '#/components/schemas/NameString'
- description: An optional folder in the remote repository.
CommitId:
allOf:
- $ref: '#/components/schemas/CommitIdString'
- description: A commit ID for a commit in the remote repository.
AuthStrategy:
allOf:
- $ref: '#/components/schemas/SourceControlAuthStrategy'
- description: The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
AuthToken:
allOf:
- $ref: '#/components/schemas/AuthTokenString'
- description: The value of the authorization token.
UpdateTableResponse:
type: object
properties: {}
UpdateTableRequest:
type: object
required:
- DatabaseName
- TableInput
title: UpdateTableRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
TableInput:
allOf:
- $ref: '#/components/schemas/TableInput'
- description: An updated TableInput object to define the metadata table in the catalog.
SkipArchive:
allOf:
- $ref: '#/components/schemas/BooleanNullable'
- description: By default, UpdateTable always creates an archived version of the table before updating it. However, if skipArchive is set to true,
UpdateTable does not create the archived version.
TransactionId:
allOf:
- $ref: '#/components/schemas/TransactionIdString'
- description: 'The transaction ID at which to update the table contents. '
VersionId:
allOf:
- $ref: '#/components/schemas/VersionString'
- description: 'The version ID at which to update the table contents. '
UpdateTriggerResponse:
type: object
properties:
Trigger:
allOf:
- $ref: '#/components/schemas/Trigger'
- description: The resulting trigger definition.
UpdateTriggerRequest:
type: object
required:
- Name
- TriggerUpdate
title: UpdateTriggerRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the trigger to update.
TriggerUpdate:
allOf:
- $ref: '#/components/schemas/TriggerUpdate'
- description: The new values with which to update the trigger.
UpdateUserDefinedFunctionResponse:
type: object
properties: {}
UpdateUserDefinedFunctionRequest:
type: object
required:
- DatabaseName
- FunctionName
- FunctionInput
title: UpdateUserDefinedFunctionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the function to be updated is located. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database where the function to be updated is located.
FunctionName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the function.
FunctionInput:
allOf:
- $ref: '#/components/schemas/UserDefinedFunctionInput'
- description: A FunctionInput object that redefines the function in the Data Catalog.
UpdateWorkflowResponse:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the workflow which was specified in input.
UpdateWorkflowRequest:
type: object
required:
- Name
title: UpdateWorkflowRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the workflow to be updated.
Description:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The description of the workflow.
DefaultRunProperties:
allOf:
- $ref: '#/components/schemas/WorkflowRunProperties'
- description: A collection of properties to be used as part of each execution of the workflow.
MaxConcurrentRuns:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any
of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
AccountId:
type: string
minLength: 0
maxLength: 12
NameString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
GenericMap:
type: object
additionalProperties:
$ref: '#/components/schemas/GenericString'
Timeout:
type: integer
minimum: 1
NotificationProperty:
type: object
properties:
NotifyDelayAfter:
allOf:
- $ref: '#/components/schemas/NotifyDelayAfter'
- description: After a job run starts, the number of minutes to wait before sending a job run delay notification.
description: Specifies configuration properties of a notification.
Action:
type: object
properties:
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of a job to be run.
Arguments:
allOf:
- $ref: '#/components/schemas/GenericMap'
- description: The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout: allOf: - $ref: '#/components/schemas/Timeout' - description: TheJobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The
default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty:
allOf:
- $ref: '#/components/schemas/NotificationProperty'
- description: Specifies configuration properties of a job run notification.
CrawlerName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the crawler to be used with this action.
description: Defines an action to be initiated by a trigger.
ActionList:
type: array
items:
$ref: '#/components/schemas/Action'
EnclosedInStringProperty:
type: string
x-pattern: \([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]\|[^\S\r\n"']\)*
AdditionalOptions:
type: object
additionalProperties:
$ref: '#/components/schemas/EnclosedInStringProperty'
GenericString:
type: string
AdditionalPlanOptionsMap:
type: object
additionalProperties:
$ref: '#/components/schemas/GenericString'
AggFunction:
type: string
enum:
- avg
- countDistinct
- count
- first
- last
- kurtosis
- max
- min
- skewness
- stddev_samp
- stddev_pop
- sum
- sumDistinct
- var_samp
- var_pop
NodeName:
type: string
x-pattern: \([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]\|[^\r\n]\)*
OneInput:
type: array
items:
$ref: '#/components/schemas/NodeId'
minItems: 1
maxItems: 1
GlueStudioPathList:
type: array
items:
$ref: '#/components/schemas/EnclosedInStringProperties'
AggregateOperations:
type: array
items:
$ref: '#/components/schemas/AggregateOperation'
minItems: 1
maxItems: 30
Aggregate:
type: object
required:
- Name
- Inputs
- Groups
- Aggs
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: Specifies the fields and rows to use as inputs for the aggregate transform.
Groups:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: Specifies the fields to group by.
Aggs:
allOf:
- $ref: '#/components/schemas/AggregateOperations'
- description: 'Specifies the aggregate functions to be performed on specified fields. '
description: Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
EnclosedInStringProperties:
type: array
items:
$ref: '#/components/schemas/EnclosedInStringProperty'
AggregateOperation:
type: object
required:
- Column
- AggFunc
properties:
Column:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: Specifies the column on the data set on which the aggregation function will be applied.
AggFunc:
allOf:
- $ref: '#/components/schemas/AggFunction'
- description: 'Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
' description: Specifies the set of parameters needed to perform aggregation in the aggregate transform. Mappings: type: array items: $ref: '#/components/schemas/Mapping' ApplyMapping: type: object required: - Name - Inputs - Mapping properties: Name: allOf: - $ref: '#/components/schemas/NodeName' - description: The name of the transform node. Inputs: allOf: - $ref: '#/components/schemas/OneInput' - description: The data inputs identified by their node names. Mapping: allOf: - $ref: '#/components/schemas/Mappings' - description: Specifies the mapping of data property keys in the data source to data property keys in the data target. description: Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset. EnclosedInStringPropertyWithQuote: type: string x-pattern: \([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]\|[^\S\r\n]\)* GlueSchemas: type: array items: $ref: '#/components/schemas/GlueSchema' AthenaConnectorSource: type: object required: - Name - ConnectionName - ConnectorName - ConnectionType - SchemaName properties: Name: allOf: - $ref: '#/components/schemas/NodeName' - description: The name of the data source. ConnectionName: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: The name of the connection that is associated with the connector. ConnectorName: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: The name of a connector that assists with accessing the data store in Glue Studio. ConnectionType: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store. ConnectionTable: allOf: - $ref: '#/components/schemas/EnclosedInStringPropertyWithQuote' - description: The name of the table in the data source. SchemaName: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: The name of the Cloudwatch log group to read from. For example,/aws-glue/jobs/output.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the custom Athena source.
description: Specifies a connector to an Amazon Athena data source.
AttemptCount:
type: integer
ColumnNameString:
type: string
minLength: 1
maxLength: 1024
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
AuditColumnNamesList:
type: array
items:
$ref: '#/components/schemas/ColumnNameString'
AuditContextString:
type: string
minLength: 0
maxLength: 2048
NullableBoolean:
type: boolean
AuditContext:
type: object
properties:
AdditionalAuditContext:
allOf:
- $ref: '#/components/schemas/AuditContextString'
- description: A string containing the additional audit context information.
RequestedColumns:
allOf:
- $ref: '#/components/schemas/AuditColumnNamesList'
- description: The requested columns for audit.
AllColumnsRequested:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: All columns request for audit.
description: A structure containing the Lake Formation audit context.
AuthTokenString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
BackfillErrorCode:
type: string
enum:
- ENCRYPTED_PARTITION_ERROR
- INTERNAL_ERROR
- INVALID_PARTITION_TYPE_DATA_ERROR
- MISSING_PARTITION_VALUE_ERROR
- UNSUPPORTED_PARTITION_CHARACTER_ERROR
BackfillErroredPartitionsList:
type: array
items:
$ref: '#/components/schemas/PartitionValueList'
BackfillError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/BackfillErrorCode'
- description: The error code for an error that occurred when registering partition indexes for an existing table.
Partitions:
allOf:
- $ref: '#/components/schemas/BackfillErroredPartitionsList'
- description: A list of a limited number of partitions in the response.
description: "A list of errors that can occur when registering partition indexes for an existing table.
These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:
EncryptedPartitionError: The partitions are encrypted.
InvalidPartitionTypeDataError: The partition value doesn't match the data type for that partition column.
MissingPartitionValueError: The partitions are encrypted.
UnsupportedPartitionCharacterError: Characters inside the partition value are not supported. For example: U+0000 , U+0001, U+0002.
InternalError: Any error which does not belong to other error codes.
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.
BatchStopJobRunErrorList:
type: array
items:
$ref: '#/components/schemas/BatchStopJobRunError'
BatchStopJobRunJobRunIdList:
type: array
items:
$ref: '#/components/schemas/IdString'
minItems: 1
maxItems: 25
BatchStopJobRunSuccessfulSubmissionList:
type: array
items:
$ref: '#/components/schemas/BatchStopJobRunSuccessfulSubmission'
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.
BoundedPartitionValueList:
type: array
items:
$ref: '#/components/schemas/ValueString'
minItems: 0
maxItems: 100
BatchUpdatePartitionFailureEntry:
type: object
properties:
PartitionValueList:
allOf:
- $ref: '#/components/schemas/BoundedPartitionValueList'
- description: A list of values defining the partitions.
ErrorDetail:
allOf:
- $ref: '#/components/schemas/ErrorDetail'
- description: The details about the batch update partition error.
description: Contains information about a batch update partition error.
BatchUpdatePartitionFailureList:
type: array
items:
$ref: '#/components/schemas/BatchUpdatePartitionFailureEntry'
BatchUpdatePartitionRequestEntryList:
type: array
items:
$ref: '#/components/schemas/BatchUpdatePartitionRequestEntry'
minItems: 1
maxItems: 100
PartitionInput:
type: object
properties:
Values:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
LastAccessTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time at which the partition was accessed. StorageDescriptor: allOf: - $ref: '#/components/schemas/StorageDescriptor' - description: Provides information about the physical location where the partition is stored. Parameters: allOf: - $ref: '#/components/schemas/ParametersMap' - description: These key-value pairs define partition parameters. LastAnalyzedTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time at which column statistics were computed for this partition. description: The structure used to create and update a partition. BatchUpdatePartitionRequestEntry: type: object required: - PartitionValueList - PartitionInput properties: PartitionValueList: allOf: - $ref: '#/components/schemas/BoundedPartitionValueList' - description: A list of values defining the partitions. PartitionInput: allOf: - $ref: '#/components/schemas/PartitionInput' - description: The structure used to update a partition. description: A structure that contains the values and structure used to update a partition. BatchWindow: type: integer minimum: 1 maximum: 900 NonNegativeLong: type: integer minimum: 0 NonNegativeDouble: type: number format: double minimum: 0 BinaryColumnStatisticsData: type: object required: - MaximumLength - AverageLength - NumberOfNulls properties: MaximumLength: allOf: - $ref: '#/components/schemas/NonNegativeLong' - description: The size of the longest bit sequence in the column. AverageLength: allOf: - $ref: '#/components/schemas/NonNegativeDouble' - description: The average bit sequence length in the column. NumberOfNulls: allOf: - $ref: '#/components/schemas/NonNegativeLong' - description: The number of null values in the column. description: Defines column statistics supported for bit sequence data values. Blob: type: string Generic512CharString: type: string minLength: 1 maxLength: 512 TimestampValue: type: string format: date-time BlueprintParameterSpec: type: string minLength: 1 maxLength: 131072 BlueprintStatus: type: string enum: - CREATING - ACTIVE - UPDATING - FAILED ErrorString: type: string 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. 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 callCreateBlueprint/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.
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.
BlueprintRuns:
type: array
items:
$ref: '#/components/schemas/BlueprintRun'
Boolean:
type: boolean
BooleanColumnStatisticsData:
type: object
required:
- NumberOfTrues
- NumberOfFalses
- NumberOfNulls
properties:
NumberOfTrues:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of true values in the column.
NumberOfFalses:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of false values in the column.
NumberOfNulls:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of null values in the column.
description: Defines column statistics supported for Boolean data columns.
BooleanNullable:
type: boolean
BooleanValue:
type: boolean
ValueString:
type: string
maxLength: 1024
BoxedBoolean:
type: boolean
BoxedDoubleFraction:
type: number
format: double
minimum: 0
maximum: 1
BoxedLong:
type: integer
BoxedNonNegativeInt:
type: integer
minimum: 0
BoxedNonNegativeLong:
type: integer
minimum: 0
BoxedPositiveInt:
type: integer
minimum: 0
HashString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
TaskStatusType:
type: string
enum:
- STARTING
- RUNNING
- STOPPING
- STOPPED
- SUCCEEDED
- FAILED
- TIMEOUT
IntegerValue:
type: integer
CatalogDeltaSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the Delta Lake data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
AdditionalDeltaOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the Delta Lake source.
description: Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
CatalogEncryptionMode:
type: string
enum:
- DISABLED
- SSE-KMS
CatalogEntry:
type: object
required:
- DatabaseName
- TableName
properties:
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The database in which the table metadata resides.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table in question.
description: Specifies a table definition in the Glue Data Catalog.
CatalogEntries:
type: array
items:
$ref: '#/components/schemas/CatalogEntry'
CatalogGetterPageSize:
type: integer
minimum: 1
maximum: 100
CatalogHudiSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the Hudi data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
AdditionalHudiOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the Hudi source.
description: Specifies a Hudi data source that is registered in the Glue Data Catalog.
Timestamp:
type: string
format: date-time
CatalogImportStatus:
type: object
properties:
ImportCompleted:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: ' True if the migration has completed, or False otherwise.'
ImportTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the migration was started.
ImportedBy:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the person who initiated the migration.
description: A structure containing migration status information.
KafkaStreamingSourceOptions:
type: object
properties:
BootstrapServers:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or
defined in the table metadata in the Data Catalog.
SecurityProtocol:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".
ConnectionName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the connection.
TopicName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".
Assign:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".
SubscribePattern:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or
"subscribePattern".
Classification:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: An optional classification.
Delimiter:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies the delimiter character.
StartingOffsets:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is
"latest".
EndingOffsets:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each
TopicPartition.
PollTimeoutMs:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.
NumRetries:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeInt'
- description: The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
RetryIntervalMs:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
MaxOffsetsPerTrigger:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
MinPartitions:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeInt'
- description: The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka
partitions.
IncludeHeaders:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: 'Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key:
String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.'
AddRecordTimestamp:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by
the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to
CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
description: Additional options for streaming.
StreamingDataPreviewOptions:
type: object
properties:
PollingTime:
allOf:
- $ref: '#/components/schemas/PollingTime'
- description: The polling time in milliseconds.
RecordPollingLimit:
allOf:
- $ref: '#/components/schemas/PositiveLong'
- description: The limit to the number of records polled.
description: Specifies options related to data preview for viewing a sample of your data.
CatalogKafkaSource:
type: object
required:
- Name
- Table
- Database
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data store.
WindowSize:
allOf:
- $ref: '#/components/schemas/BoxedPositiveInt'
- description: The amount of time to spend processing each micro batch.
DetectSchema:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: Whether to automatically determine the schema from the incoming data.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
StreamingOptions:
allOf:
- $ref: '#/components/schemas/KafkaStreamingSourceOptions'
- description: Specifies the streaming options.
DataPreviewOptions:
allOf:
- $ref: '#/components/schemas/StreamingDataPreviewOptions'
- description: Specifies options related to data preview for viewing a sample of your data.
description: Specifies an Apache Kafka data store in the Data Catalog.
KinesisStreamingSourceOptions:
type: object
properties:
EndpointUrl:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The URL of the Kinesis endpoint.
StreamName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the Kinesis data stream.
Classification:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: An optional classification.
Delimiter:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies the delimiter character.
StartingPosition:
allOf:
- $ref: '#/components/schemas/StartingPosition'
- description: The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", or "earliest". The
default value is "latest".
MaxFetchTimeInMs:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
MaxFetchRecordsPerShard:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
MaxRecordPerRead:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
AddIdleTimeBetweenReads:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
IdleTimeBetweenReadsInMs:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue
version 2.0 and above.
DescribeShardInterval:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
NumRetries:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeInt'
- description: The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
RetryIntervalMs:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
MaxRetryIntervalMs:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
AvoidEmptyBatches:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
StreamArn:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the
Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
RoleSessionName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN".
AddRecordTimestamp:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by
the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue
to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
description: Additional options for the Amazon Kinesis streaming data source.
CatalogKinesisSource:
type: object
required:
- Name
- Table
- Database
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data source.
WindowSize:
allOf:
- $ref: '#/components/schemas/BoxedPositiveInt'
- description: The amount of time to spend processing each micro batch.
DetectSchema:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: Whether to automatically determine the schema from the incoming data.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
StreamingOptions:
allOf:
- $ref: '#/components/schemas/KinesisStreamingSourceOptions'
- description: Additional options for the Kinesis streaming data source.
DataPreviewOptions:
allOf:
- $ref: '#/components/schemas/StreamingDataPreviewOptions'
- description: Additional options for data preview.
description: Specifies a Kinesis data source in the Glue Data Catalog.
UpdateCatalogBehavior:
type: string
enum:
- UPDATE_IN_DATABASE
- LOG
CatalogSchemaChangePolicy:
type: object
properties:
EnableUpdateCatalog:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior:
allOf:
- $ref: '#/components/schemas/UpdateCatalogBehavior'
- description: The update behavior when the crawler finds a changed schema.
description: A policy that specifies update behavior for the crawler.
CatalogSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data store.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
description: Specifies a data store in the Glue Data Catalog.
CatalogTablesList:
type: array
items:
$ref: '#/components/schemas/NameString'
minItems: 1
ConnectionName:
type: string
EventQueueArn:
type: string
CatalogTarget:
type: object
required:
- DatabaseName
- Tables
properties:
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database to be synchronized.
Tables:
allOf:
- $ref: '#/components/schemas/CatalogTablesList'
- description: A list of the tables to be synchronized.
ConnectionName:
allOf:
- $ref: '#/components/schemas/ConnectionName'
- description: The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a
NETWORK Connection type.
EventQueueArn:
allOf:
- $ref: '#/components/schemas/EventQueueArn'
- description: A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn:
allOf:
- $ref: '#/components/schemas/EventQueueArn'
- description: A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
description: Specifies an Glue Data Catalog target.
CatalogTargetList:
type: array
items:
$ref: '#/components/schemas/CatalogTarget'
DataFormat:
type: string
enum:
- AVRO
- JSON
- PROTOBUF
SchemaDefinitionString:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 170000
IsVersionValid:
type: boolean
SchemaValidationError:
type: string
minLength: 1
maxLength: 5000
Classification:
type: string
GrokClassifier:
type: object
required:
- Name
- Classification
- GrokPattern
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
Classification:
allOf:
- $ref: '#/components/schemas/Classification'
- description: An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that this classifier was registered.
LastUpdated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that this classifier was last updated.
Version:
allOf:
- $ref: '#/components/schemas/VersionId'
- description: The version of this classifier.
GrokPattern:
allOf:
- $ref: '#/components/schemas/GrokPattern'
- description: The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.
CustomPatterns:
allOf:
- $ref: '#/components/schemas/CustomPatterns'
- description: Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.
description: A classifier that uses grok patterns.
XMLClassifier:
type: object
required:
- Name
- Classification
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
Classification:
allOf:
- $ref: '#/components/schemas/Classification'
- description: An identifier of the data format that the classifier matches.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that this classifier was registered.
LastUpdated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that this classifier was last updated.
Version:
allOf:
- $ref: '#/components/schemas/VersionId'
- description: The version of this classifier.
RowTag:
allOf:
- $ref: '#/components/schemas/RowTag'
- description: The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by />). An
empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but
<row item_a="A" item_b="B" /> is not).
description: A classifier for XML content.
JsonClassifier:
type: object
required:
- Name
- JsonPath
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that this classifier was registered.
LastUpdated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that this classifier was last updated.
Version:
allOf:
- $ref: '#/components/schemas/VersionId'
- description: The version of this classifier.
JsonPath:
allOf:
- $ref: '#/components/schemas/JsonPath'
- description: A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
description: A classifier for JSON content.
CsvClassifier:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that this classifier was registered.
LastUpdated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that this classifier was last updated.
Version:
allOf:
- $ref: '#/components/schemas/VersionId'
- description: The version of this classifier.
Delimiter:
allOf:
- $ref: '#/components/schemas/CsvColumnDelimiter'
- description: A custom symbol to denote what separates each column entry in the row.
QuoteSymbol:
allOf:
- $ref: '#/components/schemas/CsvQuoteSymbol'
- description: A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
ContainsHeader:
allOf:
- $ref: '#/components/schemas/CsvHeaderOption'
- description: Indicates whether the CSV file contains a header.
Header:
allOf:
- $ref: '#/components/schemas/CsvHeader'
- description: A list of strings representing column names.
DisableValueTrimming:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies not to trim values before identifying the type of column values. The default value is true.
AllowSingleColumn:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Enables the processing of files that contain only one column.
CustomDatatypeConfigured:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Enables the custom datatype to be configured.
CustomDatatypes:
allOf:
- $ref: '#/components/schemas/CustomDatatypes'
- description: A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
description: A classifier for custom CSV content.
Classifier:
type: object
properties:
GrokClassifier:
allOf:
- $ref: '#/components/schemas/GrokClassifier'
- description: A classifier that uses grok.
XMLClassifier:
allOf:
- $ref: '#/components/schemas/XMLClassifier'
- description: A classifier for XML content.
JsonClassifier:
allOf:
- $ref: '#/components/schemas/JsonClassifier'
- description: A classifier for JSON content.
CsvClassifier:
allOf:
- $ref: '#/components/schemas/CsvClassifier'
- description: A classifier for comma-separated values (CSV).
description: Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a
StructType object that matches that data format.
You can use the standard classifiers that Glue provides, or you can write your own classifiers to best categorize your data
sources and specify the appropriate schemas to use for them. A classifier can be a grok classifier, an XML classifier, a JSON classifier, or a custom
CSV classifier, as specified in one of the fields in the Classifier object.
ConnectionTable or query, but not both.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the custom JDBC source.
description: Specifies a connector to a JDBC data source.
SparkConnectorSource:
type: object
required:
- Name
- ConnectionName
- ConnectorName
- ConnectionType
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data source.
ConnectionName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the connection that is associated with the connector.
ConnectorName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Additional connection options for the connector.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies data schema for the custom spark source.
description: Specifies a connector to an Apache Spark data source.
RedshiftSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the Amazon Redshift data store.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The database table to read from.
RedshiftTmpDir:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The IAM role with permissions.
description: Specifies an Amazon Redshift data store.
S3CatalogSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data store.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The database table to read from.
PartitionPredicate:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to "" – empty by default.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/S3SourceAdditionalOptions'
- description: Specifies additional connection options.
description: Specifies an Amazon S3 data store in the Glue Data Catalog.
S3CsvSource:
type: object
required:
- Name
- Paths
- Separator
- QuoteChar
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data store.
Paths:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: A list of the Amazon S3 paths to read from.
CompressionType:
allOf:
- $ref: '#/components/schemas/CompressionType'
- description: Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and
"bzip").
Exclusions:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files. '
GroupSize:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles" must be set to "inPartition" for this to take effect.
GroupFiles:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition".
To disable grouping when there are more than 50,000 files, set this parameter to "none".
Recurse:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeInt'
- description: This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand
milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or
15 minutes.
MaxFilesInBand:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeInt'
- description: This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job
run.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/S3DirectSourceAdditionalOptions'
- description: Specifies additional connection options.
Separator:
allOf:
- $ref: '#/components/schemas/Separator'
- description: 'Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.'
Escaper:
allOf:
- $ref: '#/components/schemas/EnclosedInStringPropertyWithQuote'
- description: Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none. If enabled, the character which immediately
follows is used as-is, except for a small set of well-known escapes (\n, \r, \t, and \0).
QuoteChar:
allOf:
- $ref: '#/components/schemas/QuoteChar'
- description: "Specifies the character to use for quoting. The default is a double quote: '\"'. Set this to -1 to turn off quoting entirely."
Multiline:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to
True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.
WithHeader:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: A Boolean value that specifies whether to treat the first line as a header. The default value is False.
WriteHeader:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: 'A Boolean value that specifies whether to write the header to output. The default value is True. '
SkipFirst:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: A Boolean value that specifies whether to skip the first data line. The default value is False.
OptimizePerformance:
allOf:
- $ref: '#/components/schemas/BooleanValue'
- description: A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the S3 CSV source.
description: Specifies a command-separated value (CSV) data store stored in Amazon S3.
S3JsonSource:
type: object
required:
- Name
- Paths
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data store.
Paths:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: A list of the Amazon S3 paths to read from.
CompressionType:
allOf:
- $ref: '#/components/schemas/CompressionType'
- description: Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and
"bzip").
Exclusions:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files. '
GroupSize:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles" must be set to "inPartition" for this to take effect.
GroupFiles:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition".
To disable grouping when there are more than 50,000 files, set this parameter to "none".
Recurse:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeInt'
- description: This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand
milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or
15 minutes.
MaxFilesInBand:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeInt'
- description: This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job
run.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/S3DirectSourceAdditionalOptions'
- description: Specifies additional connection options.
JsonPath:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: A JsonPath string defining the JSON data.
Multiline:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to
True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the S3 JSON source.
description: Specifies a JSON data store stored in Amazon S3.
S3ParquetSource:
type: object
required:
- Name
- Paths
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data store.
Paths:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: A list of the Amazon S3 paths to read from.
CompressionType:
allOf:
- $ref: '#/components/schemas/ParquetCompressionType'
- description: Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and
"bzip").
Exclusions:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files. '
GroupSize:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles" must be set to "inPartition" for this to take effect.
GroupFiles:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition".
To disable grouping when there are more than 50,000 files, set this parameter to "none".
Recurse:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeInt'
- description: This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand
milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or
15 minutes.
MaxFilesInBand:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeInt'
- description: This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job
run.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/S3DirectSourceAdditionalOptions'
- description: Specifies additional connection options.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the S3 Parquet source.
description: Specifies an Apache Parquet data store stored in Amazon S3.
RelationalCatalogSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
description: Specifies a Relational database data source in the Glue Data Catalog.
DynamoDBCatalogSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
description: Specifies a DynamoDB data source in the Glue Data Catalog.
JDBCConnectorTarget:
type: object
required:
- Name
- Inputs
- ConnectionName
- ConnectionTable
- ConnectorName
- ConnectionType
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
ConnectionName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the connection that is associated with the connector.
ConnectionTable:
allOf:
- $ref: '#/components/schemas/EnclosedInStringPropertyWithQuote'
- description: The name of the table in the data target.
ConnectorName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of a connector that will be used.
ConnectionType:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Additional connection options for the connector.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the JDBC target.
description: Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
SparkConnectorTarget:
type: object
required:
- Name
- Inputs
- ConnectionName
- ConnectorName
- ConnectionType
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
ConnectionName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of a connection for an Apache Spark connector.
ConnectorName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of an Apache Spark connector.
ConnectionType:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Additional connection options for the connector.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the custom spark target.
description: Specifies a target that uses an Apache Spark connector.
RedshiftTarget:
type: object
required:
- Name
- Inputs
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to write to.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to write to.
RedshiftTmpDir:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The IAM role with permissions.
UpsertRedshiftOptions:
allOf:
- $ref: '#/components/schemas/UpsertRedshiftTargetOptions'
- description: The set of options to configure an upsert operation when writing to a Redshift target.
description: Specifies a target that uses Amazon Redshift.
S3CatalogTarget:
type: object
required:
- Name
- Inputs
- Table
- Database
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
PartitionKeys:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: Specifies native partitioning using a sequence of keys.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to write to.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to write to.
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/CatalogSchemaChangePolicy'
- description: A policy that specifies update behavior for the crawler.
description: Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
S3GlueParquetTarget:
type: object
required:
- Name
- Inputs
- Path
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
PartitionKeys:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: Specifies native partitioning using a sequence of keys.
Path:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: A single Amazon S3 path to write to.
Compression:
allOf:
- $ref: '#/components/schemas/ParquetCompressionType'
- description: Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and
"bzip").
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/DirectSchemaChangePolicy'
- description: A policy that specifies update behavior for the crawler.
description: Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
S3DirectTarget:
type: object
required:
- Name
- Inputs
- Path
- Format
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
PartitionKeys:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: Specifies native partitioning using a sequence of keys.
Path:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: A single Amazon S3 path to write to.
Compression:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and
"bzip").
Format:
allOf:
- $ref: '#/components/schemas/TargetFormat'
- description: Specifies the data output format for the target.
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/DirectSchemaChangePolicy'
- description: A policy that specifies update behavior for the crawler.
description: Specifies a data target that writes to Amazon S3.
SelectFields:
type: object
required:
- Name
- Inputs
- Paths
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The data inputs identified by their node names.
Paths:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: A JSON path to a variable in the data structure.
description: Specifies a transform that chooses the data property keys that you want to keep.
DropFields:
type: object
required:
- Name
- Inputs
- Paths
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The data inputs identified by their node names.
Paths:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: A JSON path to a variable in the data structure.
description: Specifies a transform that chooses the data property keys that you want to drop.
RenameField:
type: object
required:
- Name
- Inputs
- SourcePath
- TargetPath
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The data inputs identified by their node names.
SourcePath:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: A JSON path to a variable in the data structure for the source data.
TargetPath:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: A JSON path to a variable in the data structure for the target data.
description: Specifies a transform that renames a single data property key.
Spigot:
type: object
required:
- Name
- Inputs
- Path
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The data inputs identified by their node names.
Path:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
Topk:
allOf:
- $ref: '#/components/schemas/Topk'
- description: Specifies a number of records to write starting from the beginning of the dataset.
Prob:
allOf:
- $ref: '#/components/schemas/Prob'
- description: The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the
sample output.
description: Specifies a transform that writes samples of the data to an Amazon S3 bucket.
Join:
type: object
required:
- Name
- Inputs
- JoinType
- Columns
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/TwoInputs'
- description: The data inputs identified by their node names.
JoinType:
allOf:
- $ref: '#/components/schemas/JoinType'
- description: Specifies the type of join to be performed on the datasets.
Columns:
allOf:
- $ref: '#/components/schemas/JoinColumns'
- description: A list of the two columns to be joined.
description: Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and
left anti joins.
SplitFields:
type: object
required:
- Name
- Inputs
- Paths
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The data inputs identified by their node names.
Paths:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: A JSON path to a variable in the data structure.
description: 'Specifies a transform that splits data property keys into two DynamicFrames. The output is a collection of DynamicFrames: one with selected data property keys,
and one with the remaining data property keys.'
SelectFromCollection:
type: object
required:
- Name
- Inputs
- Index
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The data inputs identified by their node names.
Index:
allOf:
- $ref: '#/components/schemas/NonNegativeInt'
- description: The index for the DynamicFrame to be selected.
description: 'Specifies a transform that chooses one DynamicFrame from a collection of DynamicFrames. The output is the selected DynamicFrame '
FillMissingValues:
type: object
required:
- Name
- Inputs
- ImputedPath
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The data inputs identified by their node names.
ImputedPath:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: A JSON path to a variable in the data structure for the dataset that is imputed.
FilledPath:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: A JSON path to a variable in the data structure for the dataset that is filled.
description: Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train
the machine learning model that determines what the missing value should be.
Filter:
type: object
required:
- Name
- Inputs
- LogicalOperator
- Filters
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The data inputs identified by their node names.
LogicalOperator:
allOf:
- $ref: '#/components/schemas/FilterLogicalOperator'
- description: The operator used to filter rows by comparing the key value to a specified value.
Filters:
allOf:
- $ref: '#/components/schemas/FilterExpressions'
- description: Specifies a filter expression.
description: Specifies a transform that splits a dataset into two, based on a filter condition.
CustomCode:
type: object
required:
- Name
- Inputs
- Code
- ClassName
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/ManyInputs'
- description: The data inputs identified by their node names.
Code:
allOf:
- $ref: '#/components/schemas/ExtendedString'
- description: The custom code that is used to perform the data transformation.
ClassName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name defined for the custom code node class.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the custom code transform.
description: Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
SparkSQL:
type: object
required:
- Name
- Inputs
- SqlQuery
- SqlAliases
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/ManyInputs'
- description: The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming
restrictions.
SqlQuery:
allOf:
- $ref: '#/components/schemas/SqlQuery'
- description: A SQL query that must use Spark SQL syntax and return a single data set.
SqlAliases:
allOf:
- $ref: '#/components/schemas/SqlAliases'
- description: A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify
From as MyDataSource, and Alias as SqlName, then in your SQL you can do:
select * from SqlName
and that gets data from MyDataSource.
OutputSchemas: allOf: - $ref: '#/components/schemas/GlueSchemas' - description: Specifies the data schema for the SparkSQL transform. description: Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a singleDynamicFrame.
DirectKinesisSource:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data source.
WindowSize:
allOf:
- $ref: '#/components/schemas/BoxedPositiveInt'
- description: The amount of time to spend processing each micro batch.
DetectSchema:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: Whether to automatically determine the schema from the incoming data.
StreamingOptions:
allOf:
- $ref: '#/components/schemas/KinesisStreamingSourceOptions'
- description: Additional options for the Kinesis streaming data source.
DataPreviewOptions:
allOf:
- $ref: '#/components/schemas/StreamingDataPreviewOptions'
- description: Additional options for data preview.
description: Specifies a direct Amazon Kinesis data source.
DirectKafkaSource:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data store.
StreamingOptions:
allOf:
- $ref: '#/components/schemas/KafkaStreamingSourceOptions'
- description: Specifies the streaming options.
WindowSize:
allOf:
- $ref: '#/components/schemas/BoxedPositiveInt'
- description: The amount of time to spend processing each micro batch.
DetectSchema:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: Whether to automatically determine the schema from the incoming data.
DataPreviewOptions:
allOf:
- $ref: '#/components/schemas/StreamingDataPreviewOptions'
- description: Specifies options related to data preview for viewing a sample of your data.
description: Specifies an Apache Kafka data store.
DropNullFields:
type: object
required:
- Name
- Inputs
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The data inputs identified by their node names.
NullCheckBoxList:
allOf:
- $ref: '#/components/schemas/NullCheckBoxList'
- description: A structure that represents whether certain values are recognized as null values for removal.
NullTextList:
allOf:
- $ref: '#/components/schemas/NullValueFields'
- description: A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The DropNullFields transform removes custom null values only if both the value of the null placeholder and the datatype match the data.
DynamicFrame that will be merged with a staging DynamicFrame.
PrimaryKeys:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: The list of primary key fields to match records from the source and staging dynamic frames.
description: 'Specifies a transform that merges a DynamicFrame with a staging DynamicFrame based on the specified primary keys to identify records. Duplicate records (records
with the same primary keys) are not de-duplicated. '
Union:
type: object
required:
- Name
- Inputs
- UnionType
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the transform node.
Inputs:
allOf:
- $ref: '#/components/schemas/TwoInputs'
- description: The node ID inputs to the transform.
UnionType:
allOf:
- $ref: '#/components/schemas/UnionType'
- description: Indicates the type of Union transform.
Specify ALL to join all rows from data sources to the resulting DynamicFrame. The resulting union does not
remove duplicate rows.
Specify DISTINCT to remove duplicate rows in the resulting DynamicFrame.
Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
' OutputColumnName: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: 'Indicates the output column name that will contain any entity type detected in that row. ' SampleFraction: allOf: - $ref: '#/components/schemas/BoxedDoubleFraction' - description: 'Indicates the fraction of the data to sample when scanning for PII entities. ' ThresholdFraction: allOf: - $ref: '#/components/schemas/BoxedDoubleFraction' - description: 'Indicates the fraction of the data that must be met in order for a column to be identified as PII data. ' MaskValue: allOf: - $ref: '#/components/schemas/MaskValue' - description: 'Indicates the value that will replace the detected entity. ' description: Specifies a transform that identifies, removes or masks PII data. DropDuplicates: type: object required: - Name - Inputs properties: Name: allOf: - $ref: '#/components/schemas/NodeName' - description: The name of the transform node. Inputs: allOf: - $ref: '#/components/schemas/OneInput' - description: The data inputs identified by their node names. Columns: allOf: - $ref: '#/components/schemas/LimitedPathList' - description: The name of the columns to be merged or removed if repeating. description: 'Specifies a transform that removes rows of repeating data from a data set. ' GovernedCatalogTarget: type: object required: - Name - Inputs - Table - Database properties: Name: allOf: - $ref: '#/components/schemas/NodeName' - description: The name of the data target. Inputs: allOf: - $ref: '#/components/schemas/OneInput' - description: The nodes that are inputs to the data target. PartitionKeys: allOf: - $ref: '#/components/schemas/GlueStudioPathList' - description: Specifies native partitioning using a sequence of keys. Table: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: The name of the table in the database to write to. Database: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: The name of the database to write to. SchemaChangePolicy: allOf: - $ref: '#/components/schemas/CatalogSchemaChangePolicy' - description: A policy that specifies update behavior for the governed catalog. description: Specifies a data target that writes to Amazon S3 using the Glue Data Catalog. GovernedCatalogSource: type: object required: - Name - Database - Table properties: Name: allOf: - $ref: '#/components/schemas/NodeName' - description: The name of the data store. Database: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: The database to read from. Table: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: The database table to read from. PartitionPredicate: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to"" – empty by default.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/S3SourceAdditionalOptions'
- description: Specifies additional connection options.
description: Specifies the data store in the governed Glue Data Catalog.
MicrosoftSQLServerCatalogSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
description: Specifies a Microsoft SQL server data source in the Glue Data Catalog.
MySQLCatalogSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
description: Specifies a MySQL data source in the Glue Data Catalog.
OracleSQLCatalogSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
description: Specifies an Oracle data source in the Glue Data Catalog.
PostgreSQLCatalogSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
description: Specifies a PostgresSQL data source in the Glue Data Catalog.
MicrosoftSQLServerCatalogTarget:
type: object
required:
- Name
- Inputs
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to write to.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to write to.
description: Specifies a target that uses Microsoft SQL.
MySQLCatalogTarget:
type: object
required:
- Name
- Inputs
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to write to.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to write to.
description: Specifies a target that uses MySQL.
OracleSQLCatalogTarget:
type: object
required:
- Name
- Inputs
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to write to.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to write to.
description: Specifies a target that uses Oracle SQL.
PostgreSQLCatalogTarget:
type: object
required:
- Name
- Inputs
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to write to.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to write to.
description: Specifies a target that uses Postgres SQL.
DynamicTransform:
type: object
required:
- Name
- TransformName
- Inputs
- FunctionName
- Path
properties:
Name:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies the name of the dynamic transform.
TransformName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: Specifies the inputs for the dynamic transform that are required.
Parameters:
allOf:
- $ref: '#/components/schemas/TransformConfigParameterList'
- description: Specifies the parameters of the dynamic transform.
FunctionName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies the name of the function of the dynamic transform.
Path:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies the path of the dynamic transform source and config files.
Version:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: This field is not used and will be deprecated in future release.
description: Specifies the set of parameters needed to perform the dynamic transform.
EvaluateDataQuality:
type: object
required:
- Name
- Inputs
- Ruleset
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data quality evaluation.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The inputs of your data quality evaluation.
Ruleset:
allOf:
- $ref: '#/components/schemas/DQDLString'
- description: The ruleset for your data quality evaluation.
Output:
allOf:
- $ref: '#/components/schemas/DQTransformOutput'
- description: The output of your data quality evaluation.
PublishingOptions:
allOf:
- $ref: '#/components/schemas/DQResultsPublishingOptions'
- description: Options to configure how your results are published.
StopJobOnFailureOptions:
allOf:
- $ref: '#/components/schemas/DQStopJobOnFailureOptions'
- description: Options to configure how your job will stop if your data quality evaluation fails.
description: Specifies your data quality evaluation criteria.
S3CatalogHudiSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the Hudi data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
AdditionalHudiOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the Hudi source.
description: Specifies a Hudi data source that is registered in the Glue Data Catalog. The Hudi data source must be stored in Amazon S3.
S3HudiSource:
type: object
required:
- Name
- Paths
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the Hudi source.
Paths:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: A list of the Amazon S3 paths to read from.
AdditionalHudiOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/S3DirectSourceAdditionalOptions'
- description: Specifies additional options for the connector.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the Hudi source.
description: Specifies a Hudi data source stored in Amazon S3.
S3HudiCatalogTarget:
type: object
required:
- Name
- Inputs
- Table
- Database
- AdditionalOptions
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
PartitionKeys:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: Specifies native partitioning using a sequence of keys.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to write to.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to write to.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options for the connector.
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/CatalogSchemaChangePolicy'
- description: A policy that specifies update behavior for the crawler.
description: Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
S3HudiDirectTarget:
type: object
required:
- Name
- Inputs
- Path
- Compression
- Format
- AdditionalOptions
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
Path:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The Amazon S3 path of your Hudi data source to write to.
Compression:
allOf:
- $ref: '#/components/schemas/HudiTargetCompressionType'
- description: Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and
"bzip").
PartitionKeys:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: Specifies native partitioning using a sequence of keys.
Format:
allOf:
- $ref: '#/components/schemas/TargetFormat'
- description: Specifies the data output format for the target.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options for the connector.
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/DirectSchemaChangePolicy'
- description: A policy that specifies update behavior for the crawler.
description: Specifies a target that writes to a Hudi data source in Amazon S3.
DirectJDBCSource:
type: object
required:
- Name
- Database
- Table
- ConnectionName
- ConnectionType
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the JDBC source connection.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The database of the JDBC source connection.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The table of the JDBC source connection.
ConnectionName:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The connection name of the JDBC source.
ConnectionType:
allOf:
- $ref: '#/components/schemas/JDBCConnectionType'
- description: The connection type of the JDBC source.
RedshiftTmpDir:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The temp directory of the JDBC Redshift source.
description: Specifies the direct JDBC source connection.
S3CatalogDeltaSource:
type: object
required:
- Name
- Database
- Table
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the Delta Lake data source.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to read from.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to read from.
AdditionalDeltaOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the Delta Lake source.
description: Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
S3DeltaSource:
type: object
required:
- Name
- Paths
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the Delta Lake source.
Paths:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: A list of the Amazon S3 paths to read from.
AdditionalDeltaOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/S3DirectSourceAdditionalOptions'
- description: Specifies additional options for the connector.
OutputSchemas:
allOf:
- $ref: '#/components/schemas/GlueSchemas'
- description: Specifies the data schema for the Delta Lake source.
description: Specifies a Delta Lake data source stored in Amazon S3.
S3DeltaCatalogTarget:
type: object
required:
- Name
- Inputs
- Table
- Database
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
PartitionKeys:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: Specifies native partitioning using a sequence of keys.
Table:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the table in the database to write to.
Database:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The name of the database to write to.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options for the connector.
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/CatalogSchemaChangePolicy'
- description: A policy that specifies update behavior for the crawler.
description: Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
S3DeltaDirectTarget:
type: object
required:
- Name
- Inputs
- Path
- Compression
- Format
properties:
Name:
allOf:
- $ref: '#/components/schemas/NodeName'
- description: The name of the data target.
Inputs:
allOf:
- $ref: '#/components/schemas/OneInput'
- description: The nodes that are inputs to the data target.
PartitionKeys:
allOf:
- $ref: '#/components/schemas/GlueStudioPathList'
- description: Specifies native partitioning using a sequence of keys.
Path:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The Amazon S3 path of your Delta Lake data source to write to.
Compression:
allOf:
- $ref: '#/components/schemas/DeltaTargetCompressionType'
- description: Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and
"bzip").
Format:
allOf:
- $ref: '#/components/schemas/TargetFormat'
- description: Specifies the data output format for the target.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/AdditionalOptions'
- description: Specifies additional connection options for the connector.
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/DirectSchemaChangePolicy'
- description: A policy that specifies update behavior for the crawler.
description: Specifies a target that writes to a Delta Lake data source in Amazon S3.
CodeGenConfigurationNode:
type: object
properties:
AthenaConnectorSource:
allOf:
- $ref: '#/components/schemas/AthenaConnectorSource'
- description: Specifies a connector to an Amazon Athena data source.
JDBCConnectorSource:
allOf:
- $ref: '#/components/schemas/JDBCConnectorSource'
- description: Specifies a connector to a JDBC data source.
SparkConnectorSource:
allOf:
- $ref: '#/components/schemas/SparkConnectorSource'
- description: Specifies a connector to an Apache Spark data source.
CatalogSource:
allOf:
- $ref: '#/components/schemas/CatalogSource'
- description: Specifies a data store in the Glue Data Catalog.
RedshiftSource:
allOf:
- $ref: '#/components/schemas/RedshiftSource'
- description: Specifies an Amazon Redshift data store.
S3CatalogSource:
allOf:
- $ref: '#/components/schemas/S3CatalogSource'
- description: Specifies an Amazon S3 data store in the Glue Data Catalog.
S3CsvSource:
allOf:
- $ref: '#/components/schemas/S3CsvSource'
- description: Specifies a command-separated value (CSV) data store stored in Amazon S3.
S3JsonSource:
allOf:
- $ref: '#/components/schemas/S3JsonSource'
- description: Specifies a JSON data store stored in Amazon S3.
S3ParquetSource:
allOf:
- $ref: '#/components/schemas/S3ParquetSource'
- description: Specifies an Apache Parquet data store stored in Amazon S3.
RelationalCatalogSource:
allOf:
- $ref: '#/components/schemas/RelationalCatalogSource'
- description: Specifies a relational catalog data store in the Glue Data Catalog.
DynamoDBCatalogSource:
allOf:
- $ref: '#/components/schemas/DynamoDBCatalogSource'
- description: Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
JDBCConnectorTarget:
allOf:
- $ref: '#/components/schemas/JDBCConnectorTarget'
- description: Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
SparkConnectorTarget:
allOf:
- $ref: '#/components/schemas/SparkConnectorTarget'
- description: Specifies a target that uses an Apache Spark connector.
CatalogTarget:
allOf:
- $ref: '#/components/schemas/BasicCatalogTarget'
- description: Specifies a target that uses a Glue Data Catalog table.
RedshiftTarget:
allOf:
- $ref: '#/components/schemas/RedshiftTarget'
- description: Specifies a target that uses Amazon Redshift.
S3CatalogTarget:
allOf:
- $ref: '#/components/schemas/S3CatalogTarget'
- description: Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
S3GlueParquetTarget:
allOf:
- $ref: '#/components/schemas/S3GlueParquetTarget'
- description: Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
S3DirectTarget:
allOf:
- $ref: '#/components/schemas/S3DirectTarget'
- description: Specifies a data target that writes to Amazon S3.
ApplyMapping:
allOf:
- $ref: '#/components/schemas/ApplyMapping'
- description: Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose
which keys to drop from the dataset.
SelectFields:
allOf:
- $ref: '#/components/schemas/SelectFields'
- description: Specifies a transform that chooses the data property keys that you want to keep.
DropFields:
allOf:
- $ref: '#/components/schemas/DropFields'
- description: Specifies a transform that chooses the data property keys that you want to drop.
RenameField:
allOf:
- $ref: '#/components/schemas/RenameField'
- description: Specifies a transform that renames a single data property key.
Spigot:
allOf:
- $ref: '#/components/schemas/Spigot'
- description: Specifies a transform that writes samples of the data to an Amazon S3 bucket.
Join:
allOf:
- $ref: '#/components/schemas/Join'
- description: Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi,
and left anti joins.
SplitFields:
allOf:
- $ref: '#/components/schemas/SplitFields'
- description: 'Specifies a transform that splits data property keys into two DynamicFrames. The output is a collection of DynamicFrames: one with selected data property
keys, and one with the remaining data property keys.'
SelectFromCollection:
allOf:
- $ref: '#/components/schemas/SelectFromCollection'
- description: 'Specifies a transform that chooses one DynamicFrame from a collection of DynamicFrames. The output is the selected DynamicFrame '
FillMissingValues:
allOf:
- $ref: '#/components/schemas/FillMissingValues'
- description: Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to
train the machine learning model that determines what the missing value should be.
Filter:
allOf:
- $ref: '#/components/schemas/Filter'
- description: Specifies a transform that splits a dataset into two, based on a filter condition.
CustomCode:
allOf:
- $ref: '#/components/schemas/CustomCode'
- description: Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
SparkSQL:
allOf:
- $ref: '#/components/schemas/SparkSQL'
- description: Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame.
DirectKinesisSource:
allOf:
- $ref: '#/components/schemas/DirectKinesisSource'
- description: Specifies a direct Amazon Kinesis data source.
DirectKafkaSource:
allOf:
- $ref: '#/components/schemas/DirectKafkaSource'
- description: Specifies an Apache Kafka data store.
CatalogKinesisSource:
allOf:
- $ref: '#/components/schemas/CatalogKinesisSource'
- description: Specifies a Kinesis data source in the Glue Data Catalog.
CatalogKafkaSource:
allOf:
- $ref: '#/components/schemas/CatalogKafkaSource'
- description: Specifies an Apache Kafka data store in the Data Catalog.
DropNullFields:
allOf:
- $ref: '#/components/schemas/DropNullFields'
- description: Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such
as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
Merge:
allOf:
- $ref: '#/components/schemas/Merge'
- description: 'Specifies a transform that merges a DynamicFrame with a staging DynamicFrame based on the specified primary keys to identify records. Duplicate records
(records with the same primary keys) are not de-duplicated. '
Union:
allOf:
- $ref: '#/components/schemas/Union'
- description: Specifies a transform that combines the rows from two or more datasets into a single result.
PIIDetection:
allOf:
- $ref: '#/components/schemas/PIIDetection'
- description: Specifies a transform that identifies, removes or masks PII data.
Aggregate:
allOf:
- $ref: '#/components/schemas/Aggregate'
- description: Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
DropDuplicates:
allOf:
- $ref: '#/components/schemas/DropDuplicates'
- description: Specifies a transform that removes rows of repeating data from a data set.
GovernedCatalogTarget:
allOf:
- $ref: '#/components/schemas/GovernedCatalogTarget'
- description: Specifies a data target that writes to a goverened catalog.
GovernedCatalogSource:
allOf:
- $ref: '#/components/schemas/GovernedCatalogSource'
- description: Specifies a data source in a goverened Data Catalog.
MicrosoftSQLServerCatalogSource:
allOf:
- $ref: '#/components/schemas/MicrosoftSQLServerCatalogSource'
- description: Specifies a Microsoft SQL server data source in the Glue Data Catalog.
MySQLCatalogSource:
allOf:
- $ref: '#/components/schemas/MySQLCatalogSource'
- description: Specifies a MySQL data source in the Glue Data Catalog.
OracleSQLCatalogSource:
allOf:
- $ref: '#/components/schemas/OracleSQLCatalogSource'
- description: Specifies an Oracle data source in the Glue Data Catalog.
PostgreSQLCatalogSource:
allOf:
- $ref: '#/components/schemas/PostgreSQLCatalogSource'
- description: Specifies a PostgresSQL data source in the Glue Data Catalog.
MicrosoftSQLServerCatalogTarget:
allOf:
- $ref: '#/components/schemas/MicrosoftSQLServerCatalogTarget'
- description: Specifies a target that uses Microsoft SQL.
MySQLCatalogTarget:
allOf:
- $ref: '#/components/schemas/MySQLCatalogTarget'
- description: Specifies a target that uses MySQL.
OracleSQLCatalogTarget:
allOf:
- $ref: '#/components/schemas/OracleSQLCatalogTarget'
- description: Specifies a target that uses Oracle SQL.
PostgreSQLCatalogTarget:
allOf:
- $ref: '#/components/schemas/PostgreSQLCatalogTarget'
- description: Specifies a target that uses Postgres SQL.
DynamicTransform:
allOf:
- $ref: '#/components/schemas/DynamicTransform'
- description: Specifies a custom visual transform created by a user.
EvaluateDataQuality:
allOf:
- $ref: '#/components/schemas/EvaluateDataQuality'
- description: Specifies your data quality evaluation criteria.
S3CatalogHudiSource:
allOf:
- $ref: '#/components/schemas/S3CatalogHudiSource'
- description: Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
CatalogHudiSource:
allOf:
- $ref: '#/components/schemas/CatalogHudiSource'
- description: Specifies a Hudi data source that is registered in the Glue Data Catalog.
S3HudiSource:
allOf:
- $ref: '#/components/schemas/S3HudiSource'
- description: Specifies a Hudi data source stored in Amazon S3.
S3HudiCatalogTarget:
allOf:
- $ref: '#/components/schemas/S3HudiCatalogTarget'
- description: Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
S3HudiDirectTarget:
allOf:
- $ref: '#/components/schemas/S3HudiDirectTarget'
- description: Specifies a target that writes to a Hudi data source in Amazon S3.
DirectJDBCSource:
$ref: '#/components/schemas/DirectJDBCSource'
S3CatalogDeltaSource:
allOf:
- $ref: '#/components/schemas/S3CatalogDeltaSource'
- description: Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
CatalogDeltaSource:
allOf:
- $ref: '#/components/schemas/CatalogDeltaSource'
- description: Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
S3DeltaSource:
allOf:
- $ref: '#/components/schemas/S3DeltaSource'
- description: Specifies a Delta Lake data source stored in Amazon S3.
S3DeltaCatalogTarget:
allOf:
- $ref: '#/components/schemas/S3DeltaCatalogTarget'
- description: Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
S3DeltaDirectTarget:
allOf:
- $ref: '#/components/schemas/S3DeltaDirectTarget'
- description: Specifies a target that writes to a Delta Lake data source in Amazon S3.
description: ' CodeGenConfigurationNode enumerates all valid Node types. One and only one of its member variables can be populated.'
CodeGenConfigurationNodes:
type: object
additionalProperties:
$ref: '#/components/schemas/CodeGenConfigurationNode'
CodeGenIdentifier:
type: string
pattern: '[A-Za-z_][A-Za-z0-9_]*'
minLength: 1
maxLength: 255
CodeGenEdge:
type: object
required:
- Source
- Target
properties:
Source:
allOf:
- $ref: '#/components/schemas/CodeGenIdentifier'
- description: The ID of the node at which the edge starts.
Target:
allOf:
- $ref: '#/components/schemas/CodeGenIdentifier'
- description: The ID of the node at which the edge ends.
TargetParameter:
allOf:
- $ref: '#/components/schemas/CodeGenArgName'
- description: The target of the edge.
description: Represents a directional edge in a directed acyclic graph (DAG).
CodeGenNodeType:
type: string
CodeGenNodeArgs:
type: array
items:
$ref: '#/components/schemas/CodeGenNodeArg'
minItems: 0
maxItems: 50
Integer:
type: integer
CodeGenNode:
type: object
required:
- Id
- NodeType
- Args
properties:
Id:
allOf:
- $ref: '#/components/schemas/CodeGenIdentifier'
- description: A node identifier that is unique within the node's graph.
NodeType:
allOf:
- $ref: '#/components/schemas/CodeGenNodeType'
- description: The type of node that this is.
Args:
allOf:
- $ref: '#/components/schemas/CodeGenNodeArgs'
- description: Properties of the node, in the form of name-value pairs.
LineNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The line number of the node.
description: Represents a node in a directed acyclic graph (DAG)
CodeGenNodeArg:
type: object
required:
- Name
- Value
properties:
Name:
allOf:
- $ref: '#/components/schemas/CodeGenArgName'
- description: The name of the argument or property.
Value:
allOf:
- $ref: '#/components/schemas/CodeGenArgValue'
- description: The value of the argument or property.
Param:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: True if the value is used as a parameter.
description: An argument or property of a node.
ColumnTypeString:
type: string
minLength: 0
maxLength: 131072
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
CommentString:
type: string
minLength: 0
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
ParametersMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ParametersMapValue'
Column:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the Column.
Type:
allOf:
- $ref: '#/components/schemas/ColumnTypeString'
- description: The data type of the Column.
Comment:
allOf:
- $ref: '#/components/schemas/CommentString'
- description: A free-form text comment.
Parameters:
allOf:
- $ref: '#/components/schemas/ParametersMap'
- description: These key-value pairs define properties associated with the column.
description: A column in a Table.
ColumnError:
type: object
properties:
ColumnName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the column that failed.
Error:
allOf:
- $ref: '#/components/schemas/ErrorDetail'
- description: An error message with the reason for the failure of an operation.
description: Encapsulates a column name that failed and the reason for failure.
ColumnErrors:
type: array
items:
$ref: '#/components/schemas/ColumnError'
GenericBoundedDouble:
type: number
format: double
minimum: 0
maximum: 1
ColumnImportance:
type: object
properties:
ColumnName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of a column.
Importance:
allOf:
- $ref: '#/components/schemas/GenericBoundedDouble'
- description: The column importance score for the column, as a decimal.
description: A structure containing the column name and column importance score for a column.
Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.
ColumnImportanceList: type: array items: $ref: '#/components/schemas/ColumnImportance' minItems: 0 maxItems: 100 ColumnList: type: array items: $ref: '#/components/schemas/Column' PredicateString: type: string minLength: 0 maxLength: 2048 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' ColumnRowFilter: type: object properties: ColumnName: allOf: - $ref: '#/components/schemas/NameString' - description: A string containing the name of the column. RowFilterExpression: allOf: - $ref: '#/components/schemas/PredicateString' - description: A string containing the row-level filter expression. description: A filter that uses both column-level and row-level filtering. ColumnRowFilterList: type: array items: $ref: '#/components/schemas/ColumnRowFilter' TypeString: type: string minLength: 0 maxLength: 20000 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*' ColumnStatisticsData: type: object required: - Type properties: Type: allOf: - $ref: '#/components/schemas/ColumnStatisticsType' - description: The type of column statistics data. BooleanColumnStatisticsData: allOf: - $ref: '#/components/schemas/BooleanColumnStatisticsData' - description: Boolean column statistics data. DateColumnStatisticsData: allOf: - $ref: '#/components/schemas/DateColumnStatisticsData' - description: Date column statistics data. DecimalColumnStatisticsData: allOf: - $ref: '#/components/schemas/DecimalColumnStatisticsData' - description: " Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two's complement representations of the decimal's unscaled value. " DoubleColumnStatisticsData: allOf: - $ref: '#/components/schemas/DoubleColumnStatisticsData' - description: Double column statistics data. LongColumnStatisticsData: allOf: - $ref: '#/components/schemas/LongColumnStatisticsData' - description: Long column statistics data. StringColumnStatisticsData: allOf: - $ref: '#/components/schemas/StringColumnStatisticsData' - description: String column statistics data. BinaryColumnStatisticsData: allOf: - $ref: '#/components/schemas/BinaryColumnStatisticsData' - description: Binary column statistics data. description: Contains the individual types of column statistics data. Only one data object should be set and indicated by theType attribute.
ColumnStatistics:
type: object
required:
- ColumnName
- ColumnType
- AnalyzedTime
- StatisticsData
properties:
ColumnName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of column which statistics belong to.
ColumnType:
allOf:
- $ref: '#/components/schemas/TypeString'
- description: The data type of the column.
AnalyzedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The timestamp of when column statistics were generated.
StatisticsData:
allOf:
- $ref: '#/components/schemas/ColumnStatisticsData'
- description: A ColumnStatisticData object that contains the statistics data values.
description: Represents the generated column-level statistics for a table or partition.
ColumnStatisticsType:
type: string
enum:
- BOOLEAN
- DATE
- DECIMAL
- DOUBLE
- LONG
- STRING
- BINARY
DateColumnStatisticsData:
type: object
required:
- NumberOfNulls
- NumberOfDistinctValues
properties:
MinimumValue:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The lowest value in the column.
MaximumValue:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The highest value in the column.
NumberOfNulls:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of null values in the column.
NumberOfDistinctValues:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of distinct values in a column.
description: Defines column statistics supported for timestamp data columns.
DecimalColumnStatisticsData:
type: object
required:
- NumberOfNulls
- NumberOfDistinctValues
properties:
MinimumValue:
allOf:
- $ref: '#/components/schemas/DecimalNumber'
- description: The lowest value in the column.
MaximumValue:
allOf:
- $ref: '#/components/schemas/DecimalNumber'
- description: The highest value in the column.
NumberOfNulls:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of null values in the column.
NumberOfDistinctValues:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of distinct values in a column.
description: Defines column statistics supported for fixed-point number data columns.
DoubleColumnStatisticsData:
type: object
required:
- NumberOfNulls
- NumberOfDistinctValues
properties:
MinimumValue:
allOf:
- $ref: '#/components/schemas/Double'
- description: The lowest value in the column.
MaximumValue:
allOf:
- $ref: '#/components/schemas/Double'
- description: The highest value in the column.
NumberOfNulls:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of null values in the column.
NumberOfDistinctValues:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of distinct values in a column.
description: Defines column statistics supported for floating-point number data columns.
LongColumnStatisticsData:
type: object
required:
- NumberOfNulls
- NumberOfDistinctValues
properties:
MinimumValue:
allOf:
- $ref: '#/components/schemas/Long'
- description: The lowest value in the column.
MaximumValue:
allOf:
- $ref: '#/components/schemas/Long'
- description: The highest value in the column.
NumberOfNulls:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of null values in the column.
NumberOfDistinctValues:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of distinct values in a column.
description: Defines column statistics supported for integer data columns.
StringColumnStatisticsData:
type: object
required:
- MaximumLength
- AverageLength
- NumberOfNulls
- NumberOfDistinctValues
properties:
MaximumLength:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The size of the longest string in the column.
AverageLength:
allOf:
- $ref: '#/components/schemas/NonNegativeDouble'
- description: The average string length in the column.
NumberOfNulls:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of null values in the column.
NumberOfDistinctValues:
allOf:
- $ref: '#/components/schemas/NonNegativeLong'
- description: The number of distinct values in a column.
description: Defines column statistics supported for character sequence data values.
ColumnStatisticsError:
type: object
properties:
ColumnStatistics:
allOf:
- $ref: '#/components/schemas/ColumnStatistics'
- description: The ColumnStatistics of the column.
Error:
allOf:
- $ref: '#/components/schemas/ErrorDetail'
- description: An error message with the reason for the failure of an operation.
description: Encapsulates a ColumnStatistics object that failed and the reason for failure.
ColumnStatisticsErrors:
type: array
items:
$ref: '#/components/schemas/ColumnStatisticsError'
ColumnStatisticsList:
type: array
items:
$ref: '#/components/schemas/ColumnStatistics'
ColumnValuesString:
type: string
ColumnValueStringList:
type: array
items:
$ref: '#/components/schemas/ColumnValuesString'
CommitIdString:
type: string
minLength: 1
maxLength: 40
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
Comparator:
type: string
enum:
- EQUALS
- GREATER_THAN
- LESS_THAN
- GREATER_THAN_EQUALS
- LESS_THAN_EQUALS
Compatibility:
type: string
enum:
- NONE
- DISABLED
- BACKWARD
- BACKWARD_ALL
- FORWARD
- FORWARD_ALL
- FULL
- FULL_ALL
CompressionType:
type: string
enum:
- gzip
- bzip2
LogicalOperator:
type: string
enum:
- EQUALS
JobRunState:
type: string
enum:
- STARTING
- RUNNING
- STOPPING
- STOPPED
- SUCCEEDED
- FAILED
- TIMEOUT
- ERROR
- WAITING
CrawlState:
type: string
enum:
- RUNNING
- CANCELLING
- CANCELLED
- SUCCEEDED
- FAILED
- ERROR
Condition:
type: object
properties:
LogicalOperator:
allOf:
- $ref: '#/components/schemas/LogicalOperator'
- description: A logical operator.
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State:
allOf:
- $ref: '#/components/schemas/JobRunState'
- description: The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED, STOPPED, FAILED, and
TIMEOUT. The only crawler states that a trigger can listen for are SUCCEEDED, FAILED, and CANCELLED.
CrawlerName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the crawler to which this condition applies.
CrawlState:
allOf:
- $ref: '#/components/schemas/CrawlState'
- description: The state of the crawler to which this condition applies.
description: Defines a condition under which a trigger fires.
ConditionList:
type: array
items:
$ref: '#/components/schemas/Condition'
RecordsCount:
type: integer
ConfusionMatrix:
type: object
properties:
NumTruePositives:
allOf:
- $ref: '#/components/schemas/RecordsCount'
- description: The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
NumFalsePositives:
allOf:
- $ref: '#/components/schemas/RecordsCount'
- description: The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.
NumTrueNegatives:
allOf:
- $ref: '#/components/schemas/RecordsCount'
- description: The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.
NumFalseNegatives:
allOf:
- $ref: '#/components/schemas/RecordsCount'
- description: The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.
description: The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
DescriptionString: type: string minLength: 0 maxLength: 2048 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' ConnectionType: type: string enum: - JDBC - SFTP - MONGODB - KAFKA - NETWORK - MARKETPLACE - CUSTOM MatchCriteria: type: array items: $ref: '#/components/schemas/NameString' minItems: 0 maxItems: 10 ConnectionProperties: type: object minProperties: 0 maxProperties: 100 additionalProperties: $ref: '#/components/schemas/ValueString' PhysicalConnectionRequirements: type: object properties: SubnetId: allOf: - $ref: '#/components/schemas/NameString' - description: The subnet ID used by the connection. SecurityGroupIdList: allOf: - $ref: '#/components/schemas/SecurityGroupIdList' - description: The security group ID list used by the connection. AvailabilityZone: allOf: - $ref: '#/components/schemas/NameString' - description: The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future. description: Specifies the physical requirements for a connection. Connection: type: object properties: Name: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the connection definition. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: The description of the connection. ConnectionType: allOf: - $ref: '#/components/schemas/ConnectionType' - description: The type of the connection. Currently, SFTP is not supported. MatchCriteria: allOf: - $ref: '#/components/schemas/MatchCriteria' - description: A list of criteria that can be used in selecting this connection. ConnectionProperties: allOf: - $ref: '#/components/schemas/ConnectionProperties' - description: "These key-value pairs define parameters for the connection:
HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address
of the database host.
PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME - The name under which to log in to the database. The value string for USER_NAME is \"USERNAME\".
PASSWORD
- A password, if one is used, for the user name.
ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path
of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
JDBC_ENGINE
- The name of the JDBC engine to use.
JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
CONFIG_FILES - (Reserved
for future use.)
INSTANCE_ID - The instance ID to use.
JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the
client. The default is false.
CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate
the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM
format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for
the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length
must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN;
in Microsoft SQL Server, this is used as the hostNameInCertificate.
CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.
SECRET_ID - The secret ID used for the secret manager of credentials.
CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM
connection.
CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.
CONNECTOR_CLASS_NAME - The connector
class name for a MARKETPLACE or CUSTOM connection.
KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache
Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache
Kafka connection. Default value is \"true\".
KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA
and SHA512withRSA. Default value is \"false\".
KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication
(Optional).
KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).
KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_MECHANISM - \"SCRAM-SHA-512\"\
, \"GSSAPI\", or \"AWS_MSK_IAM\". These are the supported SASL Mechanisms.
KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL
SCRAM password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file.
A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation:
Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information,
such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
SecurityGroup, that are needed to make this connection successfully.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that this connection definition was created.
LastUpdatedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that this connection definition was updated.
LastUpdatedBy:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The user, group, or role that last updated this connection definition.
description: Defines a connection to a data source.
ConnectionInput:
type: object
required:
- Name
- ConnectionType
- ConnectionProperties
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the connection. Connection will not function as expected without a name.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: The description of the connection.
ConnectionType:
allOf:
- $ref: '#/components/schemas/ConnectionType'
- description: 'The type of the connection. Currently, these types are supported:
JDBC - Designates a connection to a database through Java Database Connectivity
(JDBC).
JDBC Connections use the following ConnectionParameters.
Required: All of (HOST, PORT, JDBC_ENGINE) or
JDBC_CONNECTION_URL.
Required: All of (USERNAME, PASSWORD) or SECRET_ID.
Optional: JDBC_ENFORCE_SSL,
CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
KAFKA - Designates a connection to an Apache Kafka streaming platform.
KAFKA Connections use the following ConnectionParameters.
Required:
KAFKA_BOOTSTRAP_SERVERS.
Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters
are used to configure SSL with KAFKA.
Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD,
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.
Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.
Optional: KAFKA_SASL_SCRAM_USERNAME,
KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.
Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These
parameters are used to configure SASL/GSSAPI authentication with KAFKA.
MONGODB - Designates a connection to a MongoDB document database.
MONGODB Connections use the following ConnectionParameters.
Required: CONNECTION_URL.
Required: All of (USERNAME,
PASSWORD) or SECRET_ID.
NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud
environment (Amazon VPC).
NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
MARKETPLACE Connections use the following ConnectionParameters.
Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME,
CONNECTION_URL.
Required for JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.
CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
SFTP is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
' MatchCriteria: allOf: - $ref: '#/components/schemas/MatchCriteria' - description: A list of criteria that can be used in selecting this connection. ConnectionProperties: allOf: - $ref: '#/components/schemas/ConnectionProperties' - description: These key-value pairs define parameters for the connection. PhysicalConnectionRequirements: allOf: - $ref: '#/components/schemas/PhysicalConnectionRequirements' - description: A map of physical connection requirements, such as virtual private cloud (VPC) andSecurityGroup, that are needed to successfully make this connection.
description: A structure that is used to specify a connection to create or update.
ConnectionList:
type: array
items:
$ref: '#/components/schemas/Connection'
ConnectionPasswordEncryption:
type: object
required:
- ReturnConnectionPasswordEncrypted
properties:
ReturnConnectionPasswordEncrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections.
This encryption takes effect independently from catalog encryption. '
AwsKmsKeyId:
allOf:
- $ref: '#/components/schemas/NameString'
- description: An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of CreateConnection and
UpdateConnection needs at least kms:Encrypt permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
description:The data structure used by the Data Catalog to encrypt the password as part of CreateConnection or UpdateConnection and store it in the
ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.
When a CreationConnection request arrives
containing a password, the Data Catalog first encrypts the password using your KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.
This encryption requires that you set KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.
ConnectionPropertyKey: type: string enum: - HOST - PORT - USERNAME - PASSWORD - ENCRYPTED_PASSWORD - JDBC_DRIVER_JAR_URI - JDBC_DRIVER_CLASS_NAME - JDBC_ENGINE - JDBC_ENGINE_VERSION - CONFIG_FILES - INSTANCE_ID - JDBC_CONNECTION_URL - JDBC_ENFORCE_SSL - CUSTOM_JDBC_CERT - SKIP_CUSTOM_JDBC_CERT_VALIDATION - CUSTOM_JDBC_CERT_STRING - CONNECTION_URL - KAFKA_BOOTSTRAP_SERVERS - KAFKA_SSL_ENABLED - KAFKA_CUSTOM_CERT - KAFKA_SKIP_CUSTOM_CERT_VALIDATION - KAFKA_CLIENT_KEYSTORE - KAFKA_CLIENT_KEYSTORE_PASSWORD - KAFKA_CLIENT_KEY_PASSWORD - ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - SECRET_ID - CONNECTOR_URL - CONNECTOR_TYPE - CONNECTOR_CLASS_NAME OrchestrationStringList: type: array items: $ref: '#/components/schemas/GenericString' ConnectionsList: type: object properties: Connections: allOf: - $ref: '#/components/schemas/OrchestrationStringList' - description: A list of connections used by the job. description: Specifies the connections used by a job. ContextWords: type: array items: $ref: '#/components/schemas/NameString' minItems: 1 maxItems: 20 LogGroup: type: string pattern: '[\.\-_/#A-Za-z0-9]+' minLength: 1 maxLength: 512 LogStream: type: string pattern: '[^:*]*' minLength: 1 maxLength: 512 Crawl: type: object properties: State: allOf: - $ref: '#/components/schemas/CrawlState' - description: The state of the crawler. StartedOn: allOf: - $ref: '#/components/schemas/TimestampValue' - description: The date and time on which the crawl started. CompletedOn: allOf: - $ref: '#/components/schemas/TimestampValue' - description: The date and time on which the crawl completed. ErrorMessage: allOf: - $ref: '#/components/schemas/DescriptionString' - description: The error message associated with the crawl. LogGroup: allOf: - $ref: '#/components/schemas/LogGroup' - description: The log group associated with the crawl. LogStream: allOf: - $ref: '#/components/schemas/LogStream' - description: The log stream associated with the crawl. description: The details of a crawl in the workflow. CrawlId: type: string CrawlList: type: array items: $ref: '#/components/schemas/Crawl' Role: type: string CrawlerTargets: type: object properties: S3Targets: allOf: - $ref: '#/components/schemas/S3TargetList' - description: Specifies Amazon Simple Storage Service (Amazon S3) targets. JdbcTargets: allOf: - $ref: '#/components/schemas/JdbcTargetList' - description: Specifies JDBC targets. MongoDBTargets: allOf: - $ref: '#/components/schemas/MongoDBTargetList' - description: Specifies Amazon DocumentDB or MongoDB targets. DynamoDBTargets: allOf: - $ref: '#/components/schemas/DynamoDBTargetList' - description: Specifies Amazon DynamoDB targets. CatalogTargets: allOf: - $ref: '#/components/schemas/CatalogTargetList' - description: Specifies Glue Data Catalog targets. DeltaTargets: allOf: - $ref: '#/components/schemas/DeltaTargetList' - description: Specifies Delta data store targets. description: Specifies data stores to crawl. DatabaseName: type: string RecrawlPolicy: type: object properties: RecrawlBehavior: allOf: - $ref: '#/components/schemas/RecrawlBehavior' - description:Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING
specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A
value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
cron expression used to specify the schedule (see Time-Based Schedules
for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).'
State:
allOf:
- $ref: '#/components/schemas/ScheduleState'
- description: The state of the schedule.
description: A scheduling object using a cron statement to schedule an event.
MillisecondsCount:
type: integer
LastCrawlInfo:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/LastCrawlStatus'
- description: Status of the last crawl.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: If an error occurred, the error information about the last crawl.
LogGroup:
allOf:
- $ref: '#/components/schemas/LogGroup'
- description: The log group for the last crawl.
LogStream:
allOf:
- $ref: '#/components/schemas/LogStream'
- description: The log stream for the last crawl.
MessagePrefix:
allOf:
- $ref: '#/components/schemas/MessagePrefix'
- description: The prefix for a message about this crawl.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time at which the crawl started.
description: Status and error information about the most recent crawl.
VersionId:
type: integer
CrawlerConfiguration:
type: string
CrawlerSecurityConfiguration:
type: string
minLength: 0
maxLength: 128
LakeFormationConfiguration:
type: object
properties:
UseLakeFormationCredentials:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: Required for cross account crawls. For same account crawls as the target data, this can be left as null.
description: Specifies Lake Formation configuration settings for the crawler.
Crawler:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the crawler.
Role:
allOf:
- $ref: '#/components/schemas/Role'
- description: The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
Targets:
allOf:
- $ref: '#/components/schemas/CrawlerTargets'
- description: A collection of targets to crawl.
DatabaseName:
allOf:
- $ref: '#/components/schemas/DatabaseName'
- description: The name of the database in which the crawler's output is stored.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the crawler.
Classifiers:
allOf:
- $ref: '#/components/schemas/ClassifierNameList'
- description: A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
RecrawlPolicy:
allOf:
- $ref: '#/components/schemas/RecrawlPolicy'
- description: A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
SchemaChangePolicy:
allOf:
- $ref: '#/components/schemas/SchemaChangePolicy'
- description: The policy that specifies update and delete behaviors for the crawler.
LineageConfiguration:
allOf:
- $ref: '#/components/schemas/LineageConfiguration'
- description: A configuration that specifies whether data lineage is enabled for the crawler.
State:
allOf:
- $ref: '#/components/schemas/CrawlerState'
- description: Indicates whether the crawler is running, or whether a run is pending.
TablePrefix:
allOf:
- $ref: '#/components/schemas/TablePrefix'
- description: The prefix added to the names of tables that are created.
Schedule:
allOf:
- $ref: '#/components/schemas/Schedule'
- description: For scheduled crawlers, the schedule when the crawler runs.
CrawlElapsedTime:
allOf:
- $ref: '#/components/schemas/MillisecondsCount'
- description: If the crawler is running, contains the total time elapsed since the last crawl began.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the crawler was created.
LastUpdated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the crawler was last updated.
LastCrawl:
allOf:
- $ref: '#/components/schemas/LastCrawlInfo'
- description: The status of the last crawl, and potentially error information if an error occurred.
Version:
allOf:
- $ref: '#/components/schemas/VersionId'
- description: The version of the crawler.
Configuration:
allOf:
- $ref: '#/components/schemas/CrawlerConfiguration'
- description: Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
CrawlerSecurityConfiguration:
allOf:
- $ref: '#/components/schemas/CrawlerSecurityConfiguration'
- description: The name of the SecurityConfiguration structure to be used by this crawler.
LakeFormationConfiguration:
allOf:
- $ref: '#/components/schemas/LakeFormationConfiguration'
- description: Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
description: Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source
in the Glue Data Catalog.
CrawlerHistoryState:
type: string
enum:
- RUNNING
- COMPLETED
- FAILED
- STOPPED
MessagePrefix:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
CrawlerHistory:
type: object
properties:
CrawlId:
allOf:
- $ref: '#/components/schemas/CrawlId'
- description: A UUID identifier for each crawl.
State:
allOf:
- $ref: '#/components/schemas/CrawlerHistoryState'
- description: The state of the crawl.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time on which the crawl started.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time on which the crawl ended.
Summary:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: If an error occurred, the error message associated with the crawl.
LogGroup:
allOf:
- $ref: '#/components/schemas/LogGroup'
- description: The log group associated with the crawl.
LogStream:
allOf:
- $ref: '#/components/schemas/LogStream'
- description: The log stream associated with the crawl.
MessagePrefix:
allOf:
- $ref: '#/components/schemas/MessagePrefix'
- description: The prefix for a CloudWatch message about this crawl.
DPUHour:
allOf:
- $ref: '#/components/schemas/NonNegativeDouble'
- description: The number of data processing units (DPU) used in hours for the crawl.
description: Contains the information for a run of a crawler.
CrawlerHistoryList:
type: array
items:
$ref: '#/components/schemas/CrawlerHistory'
CrawlerLineageSettings:
type: string
enum:
- ENABLE
- DISABLE
NonNegativeInteger:
type: integer
minimum: 0
CrawlerMetrics:
type: object
properties:
CrawlerName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the crawler.
TimeLeftSeconds:
allOf:
- $ref: '#/components/schemas/NonNegativeDouble'
- description: The estimated time left to complete a running crawl.
StillEstimating:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: True if the crawler is still estimating how long it will take to complete this run.
LastRuntimeSeconds:
allOf:
- $ref: '#/components/schemas/NonNegativeDouble'
- description: The duration of the crawler's most recent run, in seconds.
MedianRuntimeSeconds:
allOf:
- $ref: '#/components/schemas/NonNegativeDouble'
- description: The median duration of this crawler's runs, in seconds.
TablesCreated:
allOf:
- $ref: '#/components/schemas/NonNegativeInteger'
- description: The number of tables created by this crawler.
TablesUpdated:
allOf:
- $ref: '#/components/schemas/NonNegativeInteger'
- description: The number of tables updated by this crawler.
TablesDeleted:
allOf:
- $ref: '#/components/schemas/NonNegativeInteger'
- description: The number of tables deleted by this crawler.
description: Metrics for a specified crawler.
CrawlerMetricsList:
type: array
items:
$ref: '#/components/schemas/CrawlerMetrics'
CrawlerNodeDetails:
type: object
properties:
Crawls:
allOf:
- $ref: '#/components/schemas/CrawlList'
- description: A list of crawls represented by the crawl node.
description: The details of a Crawler node present in the workflow.
S3TargetList:
type: array
items:
$ref: '#/components/schemas/S3Target'
JdbcTargetList:
type: array
items:
$ref: '#/components/schemas/JdbcTarget'
MongoDBTargetList:
type: array
items:
$ref: '#/components/schemas/MongoDBTarget'
DynamoDBTargetList:
type: array
items:
$ref: '#/components/schemas/DynamoDBTarget'
DeltaTargetList:
type: array
items:
$ref: '#/components/schemas/DeltaTarget'
FieldName:
type: string
enum:
- CRAWL_ID
- STATE
- START_TIME
- END_TIME
- DPU_HOUR
FilterOperator:
type: string
enum:
- GT
- GE
- LT
- LE
- EQ
- NE
CrawlsFilter:
type: object
properties:
FieldName:
allOf:
- $ref: '#/components/schemas/FieldName'
- description: 'A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:
CRAWL_ID: A string representing the
UUID identifier for a crawl.
STATE: A string representing the state of the crawl.
START_TIME and END_TIME: The
epoch timestamp in milliseconds.
DPU_HOUR: The number of data processing unit (DPU) hours used for the crawl.
A defined comparator that operates on the value. The available operators are:
GT: Greater than.
GE: Greater than
or equal to.
LT: Less than.
LE: Less than or equal to.
EQ: Equal to.
NE:
Not equal to.
grok classifier for CreateClassifier to create.
CreateXMLClassifierRequest:
type: object
required:
- Classification
- Name
properties:
Classification:
allOf:
- $ref: '#/components/schemas/Classification'
- description: An identifier of the data format that the classifier matches.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
RowTag:
allOf:
- $ref: '#/components/schemas/RowTag'
- description: The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by />). An
empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but
<row item_a="A" item_b="B" /> is not).
description: Specifies an XML classifier for CreateClassifier to create.
CreateJsonClassifierRequest:
type: object
required:
- Name
- JsonPath
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
JsonPath:
allOf:
- $ref: '#/components/schemas/JsonPath'
- description: A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
description: Specifies a JSON classifier for CreateClassifier to create.
CreateCsvClassifierRequest:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
Delimiter:
allOf:
- $ref: '#/components/schemas/CsvColumnDelimiter'
- description: A custom symbol to denote what separates each column entry in the row.
QuoteSymbol:
allOf:
- $ref: '#/components/schemas/CsvQuoteSymbol'
- description: A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.
ContainsHeader:
allOf:
- $ref: '#/components/schemas/CsvHeaderOption'
- description: Indicates whether the CSV file contains a header.
Header:
allOf:
- $ref: '#/components/schemas/CsvHeader'
- description: A list of strings representing column names.
DisableValueTrimming:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies not to trim values before identifying the type of column values. The default value is true.
AllowSingleColumn:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Enables the processing of files that contain only one column.
CustomDatatypeConfigured:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Enables the configuration of custom datatypes.
CustomDatatypes:
allOf:
- $ref: '#/components/schemas/CustomDatatypes'
- description: Creates a list of supported custom datatypes.
description: Specifies a custom CSV classifier for CreateClassifier to create.
CronExpression:
type: string
CsvColumnDelimiter:
type: string
pattern: '[^\r\n]'
minLength: 1
maxLength: 1
CsvQuoteSymbol:
type: string
pattern: '[^\r\n]'
minLength: 1
maxLength: 1
CsvHeaderOption:
type: string
enum:
- UNKNOWN
- PRESENT
- ABSENT
CsvHeader:
type: array
items:
$ref: '#/components/schemas/NameString'
CustomDatatypes:
type: array
items:
$ref: '#/components/schemas/NameString'
DataQualityRulesetString:
type: string
minLength: 1
maxLength: 65536
DataQualityTargetTable:
type: object
required:
- TableName
- DatabaseName
properties:
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the Glue table.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database where the Glue table exists.
description: An object representing an Glue table.
DatabaseInput:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the database.
LocationUri:
allOf:
- $ref: '#/components/schemas/URI'
- description: 'The location of the database (for example, an HDFS path). '
Parameters:
allOf:
- $ref: '#/components/schemas/ParametersMap'
- description: These key-value pairs define parameters and properties of the database.
These key-value pairs define parameters and properties of the database.
CreateTableDefaultPermissions: allOf: - $ref: '#/components/schemas/PrincipalPermissionsList' - description: Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations. TargetDatabase: allOf: - $ref: '#/components/schemas/DatabaseIdentifier' - description: ADatabaseIdentifier structure that describes a target database for resource linking.
FederatedDatabase:
allOf:
- $ref: '#/components/schemas/FederatedDatabase'
- description: A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
description: The structure used to create or update a database.
RoleArn:
type: string
pattern: arn:aws:iam::\d{12}:role/.*
StringList:
type: array
items:
$ref: '#/components/schemas/GenericString'
PublicKeysList:
type: array
items:
$ref: '#/components/schemas/GenericString'
maxItems: 5
WorkerType:
type: string
enum:
- Standard
- G.1X
- G.2X
- G.025X
GlueVersionString:
type: string
pattern: ^\w+\.\w+$
minLength: 1
maxLength: 255
NullableInteger:
type: integer
MapValue:
type: object
minProperties: 0
maxProperties: 100
additionalProperties:
$ref: '#/components/schemas/GenericString'
GrokPattern:
type: string
minLength: 1
maxLength: 2048
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\t]*'
CustomPatterns:
type: string
minLength: 0
maxLength: 16000
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
UriString:
type: string
RoleString:
type: string
ExecutionProperty:
type: object
properties:
MaxConcurrentRuns:
allOf:
- $ref: '#/components/schemas/MaxConcurrentRuns'
- description: The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is
controlled by a service limit.
description: An execution property of a job.
JobCommand:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The name of the job command. For an Apache Spark ETL job, this must be glueetl. For a Python shell job, it must be pythonshell. For an Apache Spark
streaming ETL job, this must be gluestreaming.
ScriptLocation:
allOf:
- $ref: '#/components/schemas/ScriptLocationString'
- description: Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
PythonVersion:
allOf:
- $ref: '#/components/schemas/PythonVersionString'
- description: The Python version being used to run a Python shell job. Allowed values are 2 or 3.
description: Specifies code that runs when a job is run.
MaxRetries:
type: integer
NullableDouble:
type: number
format: double
ExecutionClass:
type: string
enum:
- FLEX
- STANDARD
maxLength: 16
SourceControlDetails:
type: object
properties:
Provider:
allOf:
- $ref: '#/components/schemas/SourceControlProvider'
- description: The provider for the remote repository.
Repository:
allOf:
- $ref: '#/components/schemas/Generic512CharString'
- description: The name of the remote repository that contains the job artifacts.
Owner:
allOf:
- $ref: '#/components/schemas/Generic512CharString'
- description: The owner of the remote repository that contains the job artifacts.
Branch:
allOf:
- $ref: '#/components/schemas/Generic512CharString'
- description: An optional branch in the remote repository.
Folder:
allOf:
- $ref: '#/components/schemas/Generic512CharString'
- description: An optional folder in the remote repository.
LastCommitId:
allOf:
- $ref: '#/components/schemas/Generic512CharString'
- description: The last commit ID for a commit in the remote repository.
AuthStrategy:
allOf:
- $ref: '#/components/schemas/SourceControlAuthStrategy'
- description: The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
AuthToken:
allOf:
- $ref: '#/components/schemas/Generic512CharString'
- description: The value of an authorization token.
description: The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
JsonPath:
type: string
GlueTables:
type: array
items:
$ref: '#/components/schemas/GlueTable'
minItems: 0
maxItems: 10
TransformParameters:
type: object
required:
- TransformType
properties:
TransformType:
allOf:
- $ref: '#/components/schemas/TransformType'
- description: The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
FindMatchesParameters: allOf: - $ref: '#/components/schemas/FindMatchesParameters' - description: The parameters for the find matches algorithm. description: The algorithm-specific parameters that are associated with the machine learning transform. TransformEncryption: type: object properties: MlUserDataEncryption: allOf: - $ref: '#/components/schemas/MLUserDataEncryption' - description: AnMLUserDataEncryption object containing the encryption mode and customer-provided KMS key ID.
TaskRunSecurityConfigurationName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the security configuration.
description: The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.
PartitionIndex: type: object required: - Keys - IndexName properties: Keys: allOf: - $ref: '#/components/schemas/KeyList' - description: The keys for the partition index. IndexName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the partition index. description: A structure for a partition index. SchemaRegistryNameString: type: string pattern: '[a-zA-Z0-9-_$#.]+' minLength: 1 maxLength: 255 GlueResourceArn: type: string pattern: arn:(aws|aws-us-gov|aws-cn):glue:.* minLength: 1 maxLength: 10240 RegistryId: type: object properties: RegistryName: allOf: - $ref: '#/components/schemas/SchemaRegistryNameString' - description: 'Name of the registry. Used only for lookup. One ofRegistryArn 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).
SchemaCheckpointNumber:
type: integer
minimum: 1
maximum: 100000
VersionLongNumber:
type: integer
minimum: 1
maximum: 100000
SchemaStatus:
type: string
enum:
- AVAILABLE
- PENDING
- DELETING
SchemaVersionIdString:
type: string
pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'
minLength: 36
maxLength: 36
SchemaVersionStatus:
type: string
enum:
- AVAILABLE
- PENDING
- FAILURE
- DELETING
DagNodes:
type: array
items:
$ref: '#/components/schemas/CodeGenNode'
DagEdges:
type: array
items:
$ref: '#/components/schemas/CodeGenEdge'
Language:
type: string
enum:
- PYTHON
- SCALA
PythonScript:
type: string
ScalaCode:
type: string
EncryptionConfiguration:
type: object
properties:
S3Encryption:
allOf:
- $ref: '#/components/schemas/S3EncryptionList'
- description: The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
CloudWatchEncryption:
allOf:
- $ref: '#/components/schemas/CloudWatchEncryption'
- description: The encryption configuration for Amazon CloudWatch.
JobBookmarksEncryption:
allOf:
- $ref: '#/components/schemas/JobBookmarksEncryption'
- description: The encryption configuration for job bookmarks.
description: Specifies an encryption configuration.
OrchestrationRoleArn:
type: string
pattern: arn:aws[^:]*:iam::[0-9]*:role/.+
minLength: 20
maxLength: 2048
SessionCommand:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
PythonVersion:
allOf:
- $ref: '#/components/schemas/PythonVersionString'
- description: Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
description: The SessionCommand that runs the job.
OrchestrationArgumentsMap:
type: object
minProperties: 0
maxProperties: 75
additionalProperties:
$ref: '#/components/schemas/OrchestrationArgumentsValue'
Session:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The ID of the session.
CreatedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The time and date when the session was created.
Status:
allOf:
- $ref: '#/components/schemas/SessionStatus'
- description: 'The session status. '
ErrorMessage:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: The error message displayed during the session.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: The description of the session.
Role:
allOf:
- $ref: '#/components/schemas/OrchestrationRoleArn'
- description: The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
Command:
allOf:
- $ref: '#/components/schemas/SessionCommand'
- description: The command object.See SessionCommand.
DefaultArguments:
allOf:
- $ref: '#/components/schemas/OrchestrationArgumentsMap'
- description: 'A map array of key-value pairs. Max is 75 pairs. '
Connections:
allOf:
- $ref: '#/components/schemas/ConnectionsList'
- description: The number of connections used for the session.
Progress:
allOf:
- $ref: '#/components/schemas/DoubleValue'
- description: The code execution progress of the session.
MaxCapacity:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: 'The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity
and 16 GB memory. '
SecurityConfiguration:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the SecurityConfiguration structure to be used with the session.
GlueVersion:
allOf:
- $ref: '#/components/schemas/GlueVersionString'
- description: The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
description: The period in which a remote Spark runtime environment is running.
TableInput:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The table name. For Hive compatibility, this is folded to lowercase when it is stored.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the table.
Owner:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
LastAccessTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that the table was accessed.
LastAnalyzedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that column statistics were computed for this table.
Retention:
allOf:
- $ref: '#/components/schemas/NonNegativeInteger'
- description: The retention time for this table.
StorageDescriptor:
allOf:
- $ref: '#/components/schemas/StorageDescriptor'
- description: A storage descriptor containing information about the physical storage of this table.
PartitionKeys:
allOf:
- $ref: '#/components/schemas/ColumnList'
- description: 'A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not
specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
VIRTUAL_VIEW, certain Athena configuration encoded in
base64.
ViewExpandedText:
allOf:
- $ref: '#/components/schemas/ViewTextString'
- description: Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType:
allOf:
- $ref: '#/components/schemas/TableTypeString'
- description: The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by
Lake Formation. The Glue Data Catalog understands GOVERNED.
TableIdentifier structure that describes a target table for resource linking.
description: A structure used to define a table.
PartitionIndexList:
type: array
items:
$ref: '#/components/schemas/PartitionIndex'
maxItems: 3
TriggerType:
type: string
enum:
- SCHEDULED
- CONDITIONAL
- ON_DEMAND
- EVENT
Predicate:
type: object
properties:
Logical:
allOf:
- $ref: '#/components/schemas/Logical'
- description: An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions:
allOf:
- $ref: '#/components/schemas/ConditionList'
- description: A list of the conditions that determine when the trigger will fire.
description: Defines the predicate of the trigger, which determines when it fires.
EventBatchingCondition:
type: object
required:
- BatchSize
properties:
BatchSize:
allOf:
- $ref: '#/components/schemas/BatchSize'
- description: Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow:
allOf:
- $ref: '#/components/schemas/BatchWindow'
- description: Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
description: Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
UserDefinedFunctionInput:
type: object
properties:
FunctionName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the function.
ClassName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The Java class that contains the function code.
OwnerName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The owner of the function.
OwnerType:
allOf:
- $ref: '#/components/schemas/PrincipalType'
- description: The owner type.
ResourceUris:
allOf:
- $ref: '#/components/schemas/ResourceUriList'
- description: The resource URIs for the function.
description: A structure used to create or update a user-defined function.
WorkflowRunProperties:
type: object
additionalProperties:
$ref: '#/components/schemas/GenericString'
RowTag:
type: string
CreatedTimestamp:
type: string
ManyInputs:
type: array
items:
$ref: '#/components/schemas/NodeId'
minItems: 1
ExtendedString:
type: string
pattern: '[\s\S]*'
CustomEntityType:
type: object
required:
- Name
- RegexString
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
RegexString:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A regular expression string that is used for detecting sensitive data in a custom pattern.
ContextWords:
allOf:
- $ref: '#/components/schemas/ContextWords'
- description: A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
description: An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data. DQDLString: type: string pattern: ([\u0020-\u007E\r\s\n])* minLength: 1 maxLength: 65536 GenericLimitedString: type: string pattern: '[A-Za-z0-9_-]*' DQResultsPublishingOptions: type: object properties: EvaluationContext: allOf: - $ref: '#/components/schemas/GenericLimitedString' - description: The context of the evaluation. ResultsS3Prefix: allOf: - $ref: '#/components/schemas/EnclosedInStringProperty' - description: The Amazon S3 prefix prepended to the results. CloudWatchMetricsEnabled: allOf: - $ref: '#/components/schemas/BoxedBoolean' - description: Enable metrics for your data quality results. ResultsPublishingEnabled: allOf: - $ref: '#/components/schemas/BoxedBoolean' - description: Enable publishing for your data quality results. description: Options to configure how your data quality evaluation results are published. DQStopJobOnFailureTiming: type: string enum: - Immediate - AfterDataLoad DQStopJobOnFailureOptions: type: object properties: StopJobOnFailureTiming: allOf: - $ref: '#/components/schemas/DQStopJobOnFailureTiming' - description: When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad. description: Options to configure how your job will stop if your data quality evaluation fails. DQTransformOutput: type: string enum: - PrimaryInput - EvaluationResults EncryptionAtRest: type: object required: - CatalogEncryptionMode properties: CatalogEncryptionMode: allOf: - $ref: '#/components/schemas/CatalogEncryptionMode' - description: The encryption-at-rest mode for encrypting Data Catalog data. SseAwsKmsKeyId: allOf: - $ref: '#/components/schemas/NameString' - description: The ID of the KMS key to use for encryption at rest. description: Specifies the encryption-at-rest configuration for the Data Catalog. DataCatalogEncryptionSettings: type: object properties: EncryptionAtRest: allOf: - $ref: '#/components/schemas/EncryptionAtRest' - description: Specifies the encryption-at-rest configuration for the Data Catalog. ConnectionPasswordEncryption: allOf: - $ref: '#/components/schemas/ConnectionPasswordEncryption' - description: When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part ofCreateConnection or
UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.
description: Contains configuration information for maintaining Data Catalog security.
DataLakePrincipalString:
type: string
minLength: 1
maxLength: 255
DataLakePrincipal:
type: object
properties:
DataLakePrincipalIdentifier:
allOf:
- $ref: '#/components/schemas/DataLakePrincipalString'
- description: An identifier for the Lake Formation principal.
description: The Lake Formation principal.
DataQualityEvaluationRunAdditionalRunOptions:
type: object
properties:
CloudWatchMetricsEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Whether or not to enable CloudWatch metrics.
ResultsS3Prefix:
allOf:
- $ref: '#/components/schemas/UriString'
- description: Prefix for Amazon S3 to store results.
description: Additional run options you can specify for an evaluation run.
DataSource:
type: object
required:
- GlueTable
properties:
GlueTable:
allOf:
- $ref: '#/components/schemas/GlueTable'
- description: An Glue table.
description: A data source (an Glue table) for which you want data quality results.
DataQualityRuleResults:
type: array
items:
$ref: '#/components/schemas/DataQualityRuleResult'
minItems: 1
maxItems: 2000
DataQualityResult:
type: object
properties:
ResultId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: A unique result ID for the data quality result.
Score:
allOf:
- $ref: '#/components/schemas/GenericBoundedDouble'
- description: An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: The table associated with the data quality result, if any.
RulesetName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the ruleset associated with the data quality result.
EvaluationContext:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes,
the evaluationContext can differentiate the nodes.
StartedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this data quality run started.
CompletedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this data quality run completed.
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The job name associated with the data quality result, if any.
JobRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The job run ID associated with the data quality result, if any.
RulesetEvaluationRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run ID for the ruleset evaluation for this data quality result.
RuleResults:
allOf:
- $ref: '#/components/schemas/DataQualityRuleResults'
- description: 'A list of DataQualityRuleResult objects representing the results for each rule. '
description: Describes a data quality result.
DataQualityResultDescription:
type: object
properties:
ResultId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique result ID for this data quality result.
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: The table name associated with the data quality result.
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The job name associated with the data quality result.
JobRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The job run ID associated with the data quality result.
StartedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the run started for this data quality result.
description: Describes a data quality result.
DataQualityResultDescriptionList:
type: array
items:
$ref: '#/components/schemas/DataQualityResultDescription'
DataQualityResultFilterCriteria:
type: object
properties:
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: Filter results by the specified data source. For example, retrieving all results for an Glue table.
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Filter results by the specified job name.
JobRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: Filter results by the specified job run ID.
StartedAfter:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter results by runs that started after this time.
StartedBefore:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter results by runs that started before this time.
description: Criteria used to return data quality results.
DataQualityResultIdList:
type: array
items:
$ref: '#/components/schemas/HashString'
minItems: 1
maxItems: 10
DataQualityRuleRecommendationRunDescription:
type: object
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
Status:
allOf:
- $ref: '#/components/schemas/TaskStatusType'
- description: The status for this run.
StartedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when this run started.
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: The data source (Glue table) associated with the recommendation run.
description: Describes the result of a data quality rule recommendation run.
DataQualityRuleRecommendationRunFilter:
type: object
required:
- DataSource
properties:
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: Filter based on a specified data source (Glue table).
StartedBefore:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter based on time for results started before provided time.
StartedAfter:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter based on time for results started after provided time.
description: A filter for listing data quality recommendation runs.
DataQualityRuleRecommendationRunList:
type: array
items:
$ref: '#/components/schemas/DataQualityRuleRecommendationRunDescription'
DataQualityRuleResultStatus:
type: string
enum:
- PASS
- FAIL
- ERROR
DataQualityRuleResult:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the data quality rule.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the data quality rule.
EvaluationMessage:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: An evaluation message.
Result:
allOf:
- $ref: '#/components/schemas/DataQualityRuleResultStatus'
- description: A pass or fail status for the rule.
description: Describes the result of the evaluation of a data quality rule.
DataQualityRulesetEvaluationRunDescription:
type: object
properties:
RunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique run identifier associated with this run.
Status:
allOf:
- $ref: '#/components/schemas/TaskStatusType'
- description: The status for this run.
StartedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when the run started.
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: The data source (an Glue table) associated with the run.
description: Describes the result of a data quality ruleset evaluation run.
DataQualityRulesetEvaluationRunFilter:
type: object
required:
- DataSource
properties:
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- description: Filter based on a data source (an Glue table) associated with the run.
StartedBefore:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter results by runs that started before this time.
StartedAfter:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter results by runs that started after this time.
description: The filter criteria.
DataQualityRulesetEvaluationRunList:
type: array
items:
$ref: '#/components/schemas/DataQualityRulesetEvaluationRunDescription'
DataQualityRulesetFilterCriteria:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the ruleset filter criteria.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: The description of the ruleset filter criteria.
CreatedBefore:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter on rulesets created before this date.
CreatedAfter:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter on rulesets created after this date.
LastModifiedBefore:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter on rulesets last modified before this date.
LastModifiedAfter:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter on rulesets last modified after this date.
TargetTable:
allOf:
- $ref: '#/components/schemas/DataQualityTargetTable'
- description: The name and database name of the target table.
description: The criteria used to filter data quality rulesets.
DataQualityRulesetListDetails:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the data quality ruleset.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the data quality ruleset.
CreatedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time the data quality ruleset was created.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time the data quality ruleset was last modified.
TargetTable:
allOf:
- $ref: '#/components/schemas/DataQualityTargetTable'
- description: An object representing an Glue table.
RecommendationRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
RuleCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The number of rules in the ruleset.
description: Describes a data quality ruleset returned by GetDataQualityRuleset.
DataQualityRulesetList:
type: array
items:
$ref: '#/components/schemas/DataQualityRulesetListDetails'
GlueTable:
type: object
required:
- DatabaseName
- TableName
properties:
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A database name in the Glue Data Catalog.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A table name in the Glue Data Catalog.
CatalogId:
allOf:
- $ref: '#/components/schemas/NameString'
- description: A unique identifier for the Glue Data Catalog.
ConnectionName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the connection to the Glue Data Catalog.
AdditionalOptions:
allOf:
- $ref: '#/components/schemas/GlueTableAdditionalOptions'
- description: 'Additional options for the table. Currently there are two keys supported:
pushDownPredicate: to filter on partitions without having to list and
read all the files in your dataset.
catalogPartitionPredicate: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
DatabaseIdentifier structure that describes a target database for resource linking.
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the database resides.
FederatedDatabase:
allOf:
- $ref: '#/components/schemas/FederatedDatabase'
- description: A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
description: The Database object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.
DatabaseList:
type: array
items:
$ref: '#/components/schemas/Database'
Datatype:
type: object
required:
- Id
- Label
properties:
Id:
allOf:
- $ref: '#/components/schemas/GenericLimitedString'
- description: The datatype of the value.
Label:
allOf:
- $ref: '#/components/schemas/GenericLimitedString'
- description: A label assigned to the datatype.
description: A structure representing the datatype of the value.
DecimalNumber:
type: object
required:
- UnscaledValue
- Scale
properties:
UnscaledValue:
allOf:
- $ref: '#/components/schemas/Blob'
- description: The unscaled numeric value.
Scale:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The scale that determines where the decimal point falls in the unscaled value.
description: Contains a numeric value in decimal format.
DeleteBehavior:
type: string
enum:
- LOG
- DELETE_FROM_DATABASE
- DEPRECATE_IN_DATABASE
ValueStringList:
type: array
items:
$ref: '#/components/schemas/ValueString'
RegistryStatus:
type: string
enum:
- AVAILABLE
- DELETING
SchemaId:
type: object
properties:
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the schema registry that contains the schema.
description: The unique ID of the schema in the Glue schema registry.
VersionsString:
type: string
pattern: '[1-9][0-9]*|[1-9][0-9]*-[1-9][0-9]*'
minLength: 1
maxLength: 100000
SchemaVersionErrorList:
type: array
items:
$ref: '#/components/schemas/SchemaVersionErrorItem'
PathList:
type: array
items:
$ref: '#/components/schemas/Path'
DeltaTarget:
type: object
properties:
DeltaTables:
allOf:
- $ref: '#/components/schemas/PathList'
- description: A list of the Amazon S3 paths to the Delta tables.
ConnectionName:
allOf:
- $ref: '#/components/schemas/ConnectionName'
- description: The name of the connection to use to connect to the Delta table target.
WriteManifest:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
description: Specifies a Delta data store to crawl one or more Delta tables.
DeltaTargetCompressionType:
type: string
enum:
- uncompressed
- snappy
DescriptionStringRemovable:
type: string
minLength: 0
maxLength: 2048
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
DevEndpoint:
type: object
properties:
EndpointName:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The name of the DevEndpoint.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/StringList'
- description: A list of security group identifiers used in this DevEndpoint.
SubnetId:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The subnet ID for this DevEndpoint.
YarnEndpointAddress:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The YARN endpoint address used by this DevEndpoint.
PrivateAddress:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is
present only when you create the DevEndpoint within your VPC.
ZeppelinRemoteSparkInterpreterPort:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The Apache Zeppelin port for the remote Apache Spark interpreter.
PublicAddress:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC)
DevEndpoint.
Status:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The current status of this 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.
DevEndpoint.
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 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 currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
You can only use pure Java/Scala
libraries with a DevEndpoint.
DevEndpoint.
LastUpdateStatus:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The status of the last update.
CreatedTimestamp:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The point in time at which this DevEndpoint was created.
LastModifiedTimestamp:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The point in time at which this DevEndpoint was last modified.
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 DevEndpoints for authentication. Using 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 operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the
addPublicKeys attribute.
SecurityConfiguration structure to be used with this DevEndpoint.
Arguments:
allOf:
- $ref: '#/components/schemas/MapValue'
- description: 'A map of arguments used to configure the 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.
The paths to one or more Python libraries in an Amazon Simple Storage Service (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 currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
You can only use pure Java/Scala
libraries with a DevEndpoint.
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to
true.
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
description: Specifies an Amazon DynamoDB table to crawl. Edge: type: object properties: SourceId: allOf: - $ref: '#/components/schemas/NameString' - description: The unique of the node within the workflow where the edge starts. DestinationId: allOf: - $ref: '#/components/schemas/NameString' - description: The unique of the node within the workflow where the edge ends. description: An edge represents a directed connection between two Glue components that are part of the workflow the edge belongs to. EdgeList: type: array items: $ref: '#/components/schemas/Edge' JdbcMetadataEntry: type: string enum: - COMMENTS - RAWTYPES EnableAdditionalMetadata: type: array items: $ref: '#/components/schemas/JdbcMetadataEntry' EnableHybridValues: type: string enum: - 'TRUE' - 'FALSE' EnclosedInStringPropertiesMinOne: type: array items: $ref: '#/components/schemas/EnclosedInStringProperty' S3EncryptionList: type: array items: $ref: '#/components/schemas/S3Encryption' JobBookmarksEncryption: type: object properties: JobBookmarksEncryptionMode: allOf: - $ref: '#/components/schemas/JobBookmarksEncryptionMode' - description: The encryption mode to use for job bookmarks data. KmsKeyArn: allOf: - $ref: '#/components/schemas/KmsKeyArn' - description: The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data. description: Specifies how job bookmark data should be encrypted. ErrorCodeString: type: string ErrorMessageString: type: string ErrorDetails: type: object properties: ErrorCode: allOf: - $ref: '#/components/schemas/ErrorCodeString' - description: The error code for an error. ErrorMessage: allOf: - $ref: '#/components/schemas/ErrorMessageString' - description: The error message for an error. description: An object containing error details. TransformType: type: string enum: - FIND_MATCHES FindMatchesMetrics: type: object properties: AreaUnderPRCurve: allOf: - $ref: '#/components/schemas/GenericBoundedDouble' - description:The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.
For more information, see Precision and recall in Wikipedia.
Precision: allOf: - $ref: '#/components/schemas/GenericBoundedDouble' - description:The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
For more information, see Precision and recall in Wikipedia.
Recall: allOf: - $ref: '#/components/schemas/GenericBoundedDouble' - description:The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.
For more information, see Precision and recall in Wikipedia.
F1: allOf: - $ref: '#/components/schemas/GenericBoundedDouble' - description:The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.
For more information, see F1 score in Wikipedia.
ConfusionMatrix: allOf: - $ref: '#/components/schemas/ConfusionMatrix' - description:The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
ColumnImportances: allOf: - $ref: '#/components/schemas/ColumnImportanceList' - description: A list ofColumnImportance structures containing column importance metrics, sorted in order of descending importance.
description: The evaluation metrics for the find matches algorithm. The quality of your machine learning transform is measured by getting your transform to predict some matches and comparing the
results to known matches from the same dataset. The quality metrics are based on a subset of your data, so they are not precise.
EvaluationMetrics:
type: object
required:
- TransformType
properties:
TransformType:
allOf:
- $ref: '#/components/schemas/TransformType'
- description: The type of machine learning transform.
FindMatchesMetrics:
allOf:
- $ref: '#/components/schemas/FindMatchesMetrics'
- description: The evaluation metrics for the find matches algorithm.
description: Evaluation metrics provide an estimate of the quality of your machine learning transform.
MaxConcurrentRuns:
type: integer
ExecutionTime:
type: integer
ExistCondition:
type: string
enum:
- MUST_EXIST
- NOT_EXIST
- NONE
ExportLabelsTaskRunProperties:
type: object
properties:
OutputS3Path:
allOf:
- $ref: '#/components/schemas/UriString'
- description: The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
description: Specifies configuration properties for an exporting labels task run.
FederationIdentifier:
type: string
minLength: 1
maxLength: 512
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
FederatedTable:
type: object
properties:
Identifier:
allOf:
- $ref: '#/components/schemas/FederationIdentifier'
- description: A unique identifier for the federated table.
DatabaseIdentifier:
allOf:
- $ref: '#/components/schemas/FederationIdentifier'
- description: A unique identifier for the federated database.
ConnectionName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the connection to the external metastore.
description: A table that points to an entity outside the Glue Data Catalog.
FieldType:
type: string
FilterLogicalOperator:
type: string
enum:
- AND
- OR
FilterExpressions:
type: array
items:
$ref: '#/components/schemas/FilterExpression'
FilterOperation:
type: string
enum:
- EQ
- LT
- GT
- LTE
- GTE
- REGEX
- ISNULL
FilterValues:
type: array
items:
$ref: '#/components/schemas/FilterValue'
FilterExpression:
type: object
required:
- Operation
- Values
properties:
Operation:
allOf:
- $ref: '#/components/schemas/FilterOperation'
- description: The type of operation to perform in the expression.
Negated:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: Whether the expression is to be negated.
Values:
allOf:
- $ref: '#/components/schemas/FilterValues'
- description: A list of filter values.
description: Specifies a filter expression.
FilterString:
type: string
minLength: 0
maxLength: 2048
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
FilterValueType:
type: string
enum:
- COLUMNEXTRACTED
- CONSTANT
FilterValue:
type: object
required:
- Type
- Value
properties:
Type:
allOf:
- $ref: '#/components/schemas/FilterValueType'
- description: The type of filter value.
Value:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: The value to be associated.
description: 'Represents a single entry in the list of values for a FilterExpression. '
FindMatchesParameters:
type: object
properties:
PrimaryKeyColumnName:
allOf:
- $ref: '#/components/schemas/ColumnNameString'
- description: The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
PrecisionRecallTradeoff:
allOf:
- $ref: '#/components/schemas/GenericBoundedDouble'
- description: The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
AccuracyCostTradeoff: allOf: - $ref: '#/components/schemas/GenericBoundedDouble' - description:The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A
value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a
less accurate FindMatches transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
EnforceProvidedLabels: allOf: - $ref: '#/components/schemas/NullableBoolean' - description:The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces
the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure
all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
description: The parameters to configure the find matches transform. FindMatchesTaskRunProperties: type: object properties: JobId: allOf: - $ref: '#/components/schemas/HashString' - description: The job ID for the Find Matches task run. JobName: allOf: - $ref: '#/components/schemas/NameString' - description: The name assigned to the job for the Find Matches task run. JobRunId: allOf: - $ref: '#/components/schemas/HashString' - description: The job run ID for the Find Matches task run. description: Specifies configuration properties for a Find Matches task run. FormatString: type: string maxLength: 128 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*' PageSize: type: integer minimum: 1 maximum: 1000 Token: type: string GetColumnNamesList: type: array items: $ref: '#/components/schemas/NameString' minItems: 0 maxItems: 100 GetConnectionsFilter: type: object properties: MatchCriteria: allOf: - $ref: '#/components/schemas/MatchCriteria' - description: A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned. ConnectionType: allOf: - $ref: '#/components/schemas/ConnectionType' - description: The type of connections to return. Currently, SFTP is not supported. description: Filters the connection definitions that are returned by theGetConnections API operation.
RulesetNames:
type: array
items:
$ref: '#/components/schemas/NameString'
minItems: 1
maxItems: 10
ResourceShareType:
type: string
enum:
- FOREIGN
- ALL
- FEDERATED
JobName:
type: string
RunId:
type: string
JobBookmarkEntry:
type: object
properties:
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: The name of the job in question.
Version:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The version of the job.
Run:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The run ID number.
Attempt:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The attempt ID number.
PreviousRunId:
allOf:
- $ref: '#/components/schemas/RunId'
- description: The unique run identifier associated with the previous job run.
RunId:
allOf:
- $ref: '#/components/schemas/RunId'
- description: The run ID number.
JobBookmark:
allOf:
- $ref: '#/components/schemas/JsonValue'
- description: The bookmark itself.
description: Defines a point that a job can resume processing.
Job:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name you assign to this job definition.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the job.
LogUri:
allOf:
- $ref: '#/components/schemas/UriString'
- description: This field is reserved for future use.
Role:
allOf:
- $ref: '#/components/schemas/RoleString'
- description: The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
CreatedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The time and date that this job definition was created.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The last point in time when this job definition was modified.
ExecutionProperty:
allOf:
- $ref: '#/components/schemas/ExecutionProperty'
- description: An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
Command:
allOf:
- $ref: '#/components/schemas/JobCommand'
- description: The JobCommand that runs this job.
DefaultArguments:
allOf:
- $ref: '#/components/schemas/GenericMap'
- description: The default arguments for this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
NonOverridableArguments: allOf: - $ref: '#/components/schemas/GenericMap' - description: Non-overridable arguments for this job, specified as name-value pairs. Connections: allOf: - $ref: '#/components/schemas/ConnectionsList' - description: The connections used for this job. MaxRetries: allOf: - $ref: '#/components/schemas/MaxRetries' - description: The maximum number of times to retry this job after a JobRun fails. AllocatedCapacity: allOf: - $ref: '#/components/schemas/IntegerValue' - deprecated: true description:This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
This property is deprecated, use MaxCapacity instead. Timeout: allOf: - $ref: '#/components/schemas/Timeout' - description: The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and entersTIMEOUT status. The default is 2,880
minutes (48 hours).
MaxCapacity:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Do not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for
MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python
shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job
(JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs.
This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should
specify a Worker type and the Number of workers.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
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.
For the
G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume
streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
workerType that are allocated when a job runs.
SecurityConfiguration:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the SecurityConfiguration structure to be used with this job.
NotificationProperty:
allOf:
- $ref: '#/components/schemas/NotificationProperty'
- description: Specifies configuration properties of a job notification.
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 jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CodeGenConfigurationNodes: allOf: - $ref: '#/components/schemas/CodeGenConfigurationNodes' - description: The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based. ExecutionClass: allOf: - $ref: '#/components/schemas/ExecutionClass' - description:Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue
version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark
jobs.
JobRunId specified in the StartJobRun action.
TriggerName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the trigger that started this job run.
JobName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the job definition being used in this run.
StartedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The date and time at which this job run was started.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The last time that this job run was modified.
CompletedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The date and time that this job run completed.
JobRunState:
allOf:
- $ref: '#/components/schemas/JobRunState'
- description: The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
Arguments:
allOf:
- $ref: '#/components/schemas/GenericMap'
- description: The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage: allOf: - $ref: '#/components/schemas/ErrorString' - description: An error message associated with this job run. PredecessorRuns: allOf: - $ref: '#/components/schemas/PredecessorList' - description: A list of predecessors to this job run. AllocatedCapacity: allOf: - $ref: '#/components/schemas/IntegerValue' - deprecated: true description:This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
This property is deprecated, use MaxCapacity instead. ExecutionTime: allOf: - $ref: '#/components/schemas/ExecutionTime' - description: The amount of time (in seconds) that the job run consumed resources. Timeout: allOf: - $ref: '#/components/schemas/Timeout' - description:The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
This value overrides the timeout value set in the parent job.
Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
MaxCapacity: allOf: - $ref: '#/components/schemas/NullableDouble' - description:The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Do not set Max Capacity if
using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job
or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is
0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job
type cannot have a fractional DPU allocation.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
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 provides 4 vCPU, 16
GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
executor per worker.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We
recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
workerType that are allocated when a job runs.
SecurityConfiguration:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the
default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words,
/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration is used to encrypt the log group.
NotificationProperty:
allOf:
- $ref: '#/components/schemas/NotificationProperty'
- description: Specifies configuration properties of a job run notification.
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 jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
DPUSeconds: allOf: - $ref: '#/components/schemas/NullableDouble' - description: This field populates only for Auto Scaling job runs, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 forG.1X, 2 for G.2X, or 0.25 for G.025X workers). This value may be different than the executionEngineRuntime *
MaxCapacity as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity. Therefore, it is possible
that the value of DPUSeconds is less than executionEngineRuntime * MaxCapacity.
ExecutionClass:
allOf:
- $ref: '#/components/schemas/ExecutionClass'
- description: Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue
version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark
jobs.
Map<Column, Type> object is an array of key-value pairs representing the schema this transform accepts,
where Column is the name of a column, and Type is the type of the data such as an integer or string. Has an upper bound of 100 columns.
description: The criteria used to filter the machine learning transforms.
TransformSortCriteria:
type: object
required:
- Column
- SortDirection
properties:
Column:
allOf:
- $ref: '#/components/schemas/TransformSortColumnType'
- description: The column to be used in the sorting criteria that are associated with the machine learning transform.
SortDirection:
allOf:
- $ref: '#/components/schemas/SortDirectionType'
- description: The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
description: The sorting criteria that are associated with the machine learning transform.
TransformList:
type: array
items:
$ref: '#/components/schemas/MLTransform'
Location:
type: object
properties:
Jdbc:
allOf:
- $ref: '#/components/schemas/CodeGenNodeArgs'
- description: A JDBC location.
S3:
allOf:
- $ref: '#/components/schemas/CodeGenNodeArgs'
- description: An Amazon Simple Storage Service (Amazon S3) location.
DynamoDB:
allOf:
- $ref: '#/components/schemas/CodeGenNodeArgs'
- description: An Amazon DynamoDB table location.
description: The location of resources.
MappingList:
type: array
items:
$ref: '#/components/schemas/MappingEntry'
PartitionIndexDescriptorList:
type: array
items:
$ref: '#/components/schemas/PartitionIndexDescriptor'
Partition:
type: object
properties:
Values:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: The values of the partition.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database in which to create the partition.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database table in which to create the partition.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time at which the partition was created.
LastAccessTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time at which the partition was accessed.
StorageDescriptor:
allOf:
- $ref: '#/components/schemas/StorageDescriptor'
- description: Provides information about the physical location where the partition is stored.
Parameters:
allOf:
- $ref: '#/components/schemas/ParametersMap'
- description: These key-value pairs define partition parameters.
LastAnalyzedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time at which column statistics were computed for this partition.
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the partition resides.
description: Represents a slice of table data.
Segment:
type: object
required:
- SegmentNumber
- TotalSegments
properties:
SegmentNumber:
allOf:
- $ref: '#/components/schemas/NonNegativeInteger'
- description: The zero-based index number of the segment. For example, if the total number of segments is 4, SegmentNumber values range from 0 through 3.
TotalSegments:
allOf:
- $ref: '#/components/schemas/TotalSegmentsInteger'
- description: The total number of segments.
description: Defines a non-overlapping region of a table's partitions, allowing multiple requests to be run in parallel.
UpdatedTimestamp:
type: string
GetResourcePoliciesResponseList:
type: array
items:
$ref: '#/components/schemas/GluePolicy'
GluePolicy:
type: object
properties:
PolicyInJson:
allOf:
- $ref: '#/components/schemas/PolicyJsonString'
- description: Contains the requested policy document, in JSON format.
PolicyHash:
allOf:
- $ref: '#/components/schemas/HashString'
- description: Contains the hash value associated with this policy.
CreateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time at which the policy was created.
UpdateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time at which the policy was last updated.
description: A structure for returning a resource policy.
PolicyJsonString:
type: string
minLength: 2
SchemaVersionNumber:
type: object
properties:
LatestVersion:
allOf:
- $ref: '#/components/schemas/LatestSchemaVersionBoolean'
- description: The latest version available for the schema.
VersionNumber:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The version number of the schema.
description: A structure containing the schema version information.
SchemaDiffType:
type: string
enum:
- SYNTAX_DIFF
SchemaDefinitionDiff:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 340000
SecurityConfiguration:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the security configuration.
CreatedTimeStamp:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The time at which this security configuration was created.
EncryptionConfiguration:
allOf:
- $ref: '#/components/schemas/EncryptionConfiguration'
- description: The encryption configuration associated with this security configuration.
description: Specifies a security configuration.
SecurityConfigurationList:
type: array
items:
$ref: '#/components/schemas/SecurityConfiguration'
Statement:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The ID of the statement.
Code:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The execution code of the statement.
State:
allOf:
- $ref: '#/components/schemas/StatementState'
- description: The state while request is actioned.
Output:
allOf:
- $ref: '#/components/schemas/StatementOutput'
- description: The output in JSON.
Progress:
allOf:
- $ref: '#/components/schemas/DoubleValue'
- description: The code execution progress.
StartedOn:
allOf:
- $ref: '#/components/schemas/LongValue'
- description: The unix time and date that the job definition was started.
CompletedOn:
allOf:
- $ref: '#/components/schemas/LongValue'
- description: The unix time and date that the job definition was completed.
description: The statement or request for a particular action to occur in a session.
Table:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the table.
Owner:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The owner of the table.
CreateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the table definition was created in the Data Catalog.
UpdateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that the table was updated.
LastAccessTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that column statistics were computed for this table.
Retention:
allOf:
- $ref: '#/components/schemas/NonNegativeInteger'
- description: The retention time for this table.
StorageDescriptor:
allOf:
- $ref: '#/components/schemas/StorageDescriptor'
- description: A storage descriptor containing information about the physical storage of this table.
PartitionKeys:
allOf:
- $ref: '#/components/schemas/ColumnList'
- description: 'A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not
specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
VIRTUAL_VIEW, certain Athena configuration encoded in
base64.
ViewExpandedText:
allOf:
- $ref: '#/components/schemas/ViewTextString'
- description: Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType:
allOf:
- $ref: '#/components/schemas/TableTypeString'
- description: The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by
Lake Formation. The Glue Data Catalog understands GOVERNED.
TableIdentifier structure that describes a target table for resource linking.
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the table resides.
VersionId:
allOf:
- $ref: '#/components/schemas/VersionString'
- description: The ID of the table version.
FederatedTable:
allOf:
- $ref: '#/components/schemas/FederatedTable'
- description: A FederatedTable structure that references an entity outside the Glue Data Catalog.
description: Represents a collection of related data organized in columns and rows.
TableVersion:
type: object
properties:
Table:
allOf:
- $ref: '#/components/schemas/Table'
- description: The table in question.
VersionId:
allOf:
- $ref: '#/components/schemas/VersionString'
- description: The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.
description: Specifies a version of a table.
GetTableVersionsList:
type: array
items:
$ref: '#/components/schemas/TableVersion'
TableList:
type: array
items:
$ref: '#/components/schemas/Table'
Trigger:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the trigger.
WorkflowName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the workflow associated with the trigger.
Id:
allOf:
- $ref: '#/components/schemas/IdString'
- description: Reserved for future use.
Type:
allOf:
- $ref: '#/components/schemas/TriggerType'
- description: The type of trigger that this is.
State:
allOf:
- $ref: '#/components/schemas/TriggerState'
- description: The current state of the trigger.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of this trigger.
Schedule:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: 'A cron expression used to specify the schedule (see Time-Based Schedules
for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).'
Actions:
allOf:
- $ref: '#/components/schemas/ActionList'
- description: The actions initiated by this trigger.
Predicate:
allOf:
- $ref: '#/components/schemas/Predicate'
- description: The predicate of this trigger, which defines when it will fire.
EventBatchingCondition:
allOf:
- $ref: '#/components/schemas/EventBatchingCondition'
- description: Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
description: Information about a specific trigger.
PermissionTypeList:
type: array
items:
$ref: '#/components/schemas/PermissionType'
minItems: 1
maxItems: 255
UnfilteredPartitionList:
type: array
items:
$ref: '#/components/schemas/UnfilteredPartition'
UserDefinedFunction:
type: object
properties:
FunctionName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the function.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database that contains the function.
ClassName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The Java class that contains the function code.
OwnerName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The owner of the function.
OwnerType:
allOf:
- $ref: '#/components/schemas/PrincipalType'
- description: The owner type.
CreateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time at which the function was created.
ResourceUris:
allOf:
- $ref: '#/components/schemas/ResourceUriList'
- description: The resource URIs for the function.
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the function resides.
description: Represents the equivalent of a Hive user-defined function (UDF) definition.
UserDefinedFunctionList:
type: array
items:
$ref: '#/components/schemas/UserDefinedFunction'
Workflow:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the workflow.
Description:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A description of the workflow.
DefaultRunProperties:
allOf:
- $ref: '#/components/schemas/WorkflowRunProperties'
- description: A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the
properties for the next jobs in the flow.
CreatedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The date and time when the workflow was created.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The date and time when the workflow was last modified.
LastRun:
allOf:
- $ref: '#/components/schemas/WorkflowRun'
- description: The information about the last execution of the workflow.
Graph:
allOf:
- $ref: '#/components/schemas/WorkflowGraph'
- description: The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
MaxConcurrentRuns:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any
of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
BlueprintDetails:
allOf:
- $ref: '#/components/schemas/BlueprintDetails'
- description: This structure indicates the details of the blueprint that this particular workflow is created from.
description: A workflow is a collection of multiple dependent Glue jobs and crawlers that are run to complete a complex ETL task. A workflow manages the execution and monitoring of all its jobs
and crawlers.
WorkflowRun:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the workflow that was run.
WorkflowRunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The ID of this workflow run.
PreviousRunId:
allOf:
- $ref: '#/components/schemas/IdString'
- description: The ID of the previous workflow run.
WorkflowRunProperties:
allOf:
- $ref: '#/components/schemas/WorkflowRunProperties'
- description: The workflow run properties which were set during the run.
StartedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The date and time when the workflow run was started.
CompletedOn:
allOf:
- $ref: '#/components/schemas/TimestampValue'
- description: The date and time when the workflow run completed.
Status:
allOf:
- $ref: '#/components/schemas/WorkflowRunStatus'
- description: The status of the workflow run.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/ErrorString'
- description: 'This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."'
Statistics:
allOf:
- $ref: '#/components/schemas/WorkflowRunStatistics'
- description: The statistics of the run.
Graph:
allOf:
- $ref: '#/components/schemas/WorkflowGraph'
- description: The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
StartingEventBatchCondition:
allOf:
- $ref: '#/components/schemas/StartingEventBatchCondition'
- description: The batch condition that started the workflow run.
description: A workflow run is an execution of a workflow providing all the runtime information.
WorkflowRuns:
type: array
items:
$ref: '#/components/schemas/WorkflowRun'
minItems: 1
maxItems: 1000
GlueRecordType:
type: string
enum:
- DATE
- STRING
- TIMESTAMP
- INT
- FLOAT
- LONG
- BIGDECIMAL
- BYTE
- SHORT
- DOUBLE
GlueStudioSchemaColumnList:
type: array
items:
$ref: '#/components/schemas/GlueStudioSchemaColumn'
GlueSchema:
type: object
properties:
Columns:
allOf:
- $ref: '#/components/schemas/GlueStudioSchemaColumnList'
- description: Specifies the column definitions that make up a Glue schema.
description: Specifies a user-defined schema when a schema cannot be determined by Glue.
GlueStudioColumnNameString:
type: string
minLength: 0
maxLength: 1024
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
GlueStudioSchemaColumn:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/GlueStudioColumnNameString'
- description: The name of the column in the Glue Studio schema.
Type:
allOf:
- $ref: '#/components/schemas/ColumnTypeString'
- description: The hive type for this column in the Glue Studio schema.
description: Specifies a single column in a Glue schema definition.
GlueTableAdditionalOptions:
type: object
minProperties: 1
maxProperties: 10
additionalProperties:
$ref: '#/components/schemas/DescriptionString'
S3SourceAdditionalOptions:
type: object
properties:
BoundedSize:
allOf:
- $ref: '#/components/schemas/BoxedLong'
- description: Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles:
allOf:
- $ref: '#/components/schemas/BoxedLong'
- description: Sets the upper limit for the target number of files that will be processed.
description: Specifies additional connection options for the Amazon S3 data store.
HudiTargetCompressionType:
type: string
enum:
- gzip
- lzo
- uncompressed
- snappy
ReplaceBoolean:
type: boolean
ImportLabelsTaskRunProperties:
type: object
properties:
InputS3Path:
allOf:
- $ref: '#/components/schemas/UriString'
- description: The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
Replace:
allOf:
- $ref: '#/components/schemas/ReplaceBoolean'
- description: Indicates whether to overwrite your existing labels.
description: Specifies configuration properties for an importing labels task run.
IntegerFlag:
type: integer
minimum: 0
maximum: 1
JDBCDataTypeMapping:
type: object
additionalProperties:
$ref: '#/components/schemas/GlueRecordType'
JDBCConnectorOptions:
type: object
properties:
FilterPredicate:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Extra condition clause to filter data from source. For example:
BillingCity='Mountain View'
When using a query instead of a table name, you
should validate that the query works with the specified filterPredicate.
lowerBound, upperBound, and
numPartitions. This option works the same way as in the Spark SQL JDBC reader.
LowerBound:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The minimum value of partitionColumn that is used to decide partition stride.
UpperBound:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The maximum value of partitionColumn that is used to decide partition stride.
NumPartitions:
allOf:
- $ref: '#/components/schemas/BoxedNonNegativeLong'
- description: The number of partitions. This value, along with lowerBound (inclusive) and upperBound (exclusive), form partition strides for generated
WHERE clause expressions that are used to split the partitionColumn.
JobBookmarkKeys:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: The name of the job bookmark keys on which to sort.
JobBookmarkKeysSortOrder:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies an ascending or descending sort order.
DataTypeMapping:
allOf:
- $ref: '#/components/schemas/JDBCDataTypeMapping'
- description: Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"} maps data
fields of JDBC type FLOAT into the Java String type by calling the ResultSet.getString() method of the driver, and uses it to build the Glue
record. The ResultSet object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand
how the driver performs the conversions.
description: Additional connection options for the connector.
SqlQuery:
type: string
x-pattern: \([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\s]\)*
JDBCDataType:
type: string
enum:
- ARRAY
- BIGINT
- BINARY
- BIT
- BLOB
- BOOLEAN
- CHAR
- CLOB
- DATALINK
- DATE
- DECIMAL
- DISTINCT
- DOUBLE
- FLOAT
- INTEGER
- JAVA_OBJECT
- LONGNVARCHAR
- LONGVARBINARY
- LONGVARCHAR
- NCHAR
- NCLOB
- 'NULL'
- NUMERIC
- NVARCHAR
- OTHER
- REAL
- REF
- REF_CURSOR
- ROWID
- SMALLINT
- SQLXML
- STRUCT
- TIME
- TIME_WITH_TIMEZONE
- TIMESTAMP
- TIMESTAMP_WITH_TIMEZONE
- TINYINT
- VARBINARY
- VARCHAR
JdbcTarget:
type: object
properties:
ConnectionName:
allOf:
- $ref: '#/components/schemas/ConnectionName'
- description: The name of the connection to use to connect to the JDBC target.
Path:
allOf:
- $ref: '#/components/schemas/Path'
- description: The path of the JDBC target.
Exclusions:
allOf:
- $ref: '#/components/schemas/PathList'
- description: A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a
Crawler.
EnableAdditionalMetadata:
allOf:
- $ref: '#/components/schemas/EnableAdditionalMetadata'
- description: Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level
datatype. COMMENTS provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
description: Specifies a JDBC data store to crawl. JsonValue: type: string JobBookmarksEncryptionMode: type: string enum: - DISABLED - CSE-KMS ScriptLocationString: type: string maxLength: 400000 PythonVersionString: type: string pattern: ^([2-3]|3[.]9)$ JobNodeDetails: type: object properties: JobRuns: allOf: - $ref: '#/components/schemas/JobRunList' - description: The information for the job runs represented by the job node. description: The details of a Job node present in the workflow. PredecessorList: type: array items: $ref: '#/components/schemas/Predecessor' JobUpdate: type: object properties: Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: Description of the job being defined. LogUri: allOf: - $ref: '#/components/schemas/UriString' - description: This field is reserved for future use. Role: allOf: - $ref: '#/components/schemas/RoleString' - description: The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required). ExecutionProperty: allOf: - $ref: '#/components/schemas/ExecutionProperty' - description: AnExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
Command:
allOf:
- $ref: '#/components/schemas/JobCommand'
- description: The JobCommand that runs this job (required).
DefaultArguments:
allOf:
- $ref: '#/components/schemas/GenericMap'
- description: The default arguments for this job.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
NonOverridableArguments: allOf: - $ref: '#/components/schemas/GenericMap' - description: Non-overridable arguments for this job, specified as name-value pairs. Connections: allOf: - $ref: '#/components/schemas/ConnectionsList' - description: The connections used for this job. MaxRetries: allOf: - $ref: '#/components/schemas/MaxRetries' - description: The maximum number of times to retry this job if it fails. AllocatedCapacity: allOf: - $ref: '#/components/schemas/IntegerValue' - deprecated: true description:This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
This property is deprecated, use MaxCapacity instead. Timeout: allOf: - $ref: '#/components/schemas/Timeout' - description: The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and entersTIMEOUT status. The default is 2,880
minutes (48 hours).
MaxCapacity:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Do not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for
MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job
(JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job
(JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs.
This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should
specify a Worker type and the Number of workers.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
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.
For the
G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume
streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
workerType that are allocated when a job runs.
SecurityConfiguration:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the SecurityConfiguration structure to be used with this job.
NotificationProperty:
allOf:
- $ref: '#/components/schemas/NotificationProperty'
- description: Specifies the configuration properties of a job notification.
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 jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
CodeGenConfigurationNodes: allOf: - $ref: '#/components/schemas/CodeGenConfigurationNodes' - description: The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based. ExecutionClass: allOf: - $ref: '#/components/schemas/ExecutionClass' - description:Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue
version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark
jobs.
TransformParameters object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and
your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
EvaluationMetrics:
allOf:
- $ref: '#/components/schemas/EvaluationMetrics'
- description: An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
LabelCount:
allOf:
- $ref: '#/components/schemas/LabelCount'
- description: A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling
file.
Schema:
allOf:
- $ref: '#/components/schemas/TransformSchema'
- description: A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
Role:
allOf:
- $ref: '#/components/schemas/RoleString'
- description: The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either
NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither
NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice
versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value
other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The type of predefined worker that is allocated when a task of this transform runs. 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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory
and a 128GB disk, and 1 executor per worker.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and
WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If
MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then
NumberOfWorkers is required (and vice versa).
MaxCapacity and NumberOfWorkers must both be at least 1.
The number of workers of a defined workerType that are allocated when a task of the transform runs.
If WorkerType is set, then
NumberOfWorkers is required (and vice versa).
MLTaskRun of the machine learning transform fails.
TransformEncryption:
allOf:
- $ref: '#/components/schemas/TransformEncryption'
- description: The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
description: A structure for a machine learning transform.
MLUserDataEncryptionModeString:
type: string
enum:
- DISABLED
- SSE-KMS
MLUserDataEncryption:
type: object
required:
- MlUserDataEncryptionMode
properties:
MlUserDataEncryptionMode:
allOf:
- $ref: '#/components/schemas/MLUserDataEncryptionModeString'
- description: 'The encryption mode applied to user data. Valid values are:
DISABLED: encryption is disabled
SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
FromPath.
FromPath:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: The table or column to be modified.
FromType:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The type of the data to be modified.
ToType:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: The data type that the data is to be modified to.
Dropped:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: If true, then the column is removed.
Children:
allOf:
- $ref: '#/components/schemas/Mappings'
- description: "Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping,
but its FromPath will be the parent's FromPath plus the FromPath from this structure.
For the children part, suppose you have the structure:
{ \"FromPath\": \"OuterStructure\", \"ToKey\": \"OuterStructure\", \"ToType\": \"Struct\", \"Dropped\": false, \"Chidlren\": [{ \"FromPath\": \"inner\", \"ToKey\": \"inner\", \"\
ToType\": \"Double\", \"Dropped\": false, }] }
You can specify a Mapping that looks like:
{ \"FromPath\": \"OuterStructure\", \"ToKey\": \"OuterStructure\"\
, \"ToType\": \"Struct\", \"Dropped\": false, \"Chidlren\": [{ \"FromPath\": \"inner\", \"ToKey\": \"inner\", \"ToType\": \"Double\", \"Dropped\": false, }] }
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to
true.
== 1), or in descending order (==0).
description: Specifies the sort order of a sorted column.
OrderList:
type: array
items:
$ref: '#/components/schemas/Order'
OtherMetadataValueListItem:
type: object
properties:
MetadataValue:
allOf:
- $ref: '#/components/schemas/MetadataValueString'
- description: The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
CreatedTime:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: The time at which the entry was created.
description: A structure containing other metadata for a schema version belonging to the same metadata key.
PiiType:
type: string
enum:
- RowAudit
- RowMasking
- ColumnAudit
- ColumnMasking
ParamType:
type: string
enum:
- str
- int
- float
- complex
- bool
- list
- 'null'
ParametersMapValue:
type: string
maxLength: 512000
ParquetCompressionType:
type: string
enum:
- snappy
- lzo
- gzip
- uncompressed
- none
StorageDescriptor:
type: object
properties:
Columns:
allOf:
- $ref: '#/components/schemas/ColumnList'
- description: A list of the Columns in the table.
Location:
allOf:
- $ref: '#/components/schemas/LocationString'
- description: The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations:
allOf:
- $ref: '#/components/schemas/LocationStringList'
- description: A list of locations that point to the path where a Delta table is located.
InputFormat:
allOf:
- $ref: '#/components/schemas/FormatString'
- description: 'The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.'
OutputFormat:
allOf:
- $ref: '#/components/schemas/FormatString'
- description: 'The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.'
Compressed:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: ' True if the data in the table is compressed, or False if not.'
NumberOfBuckets:
allOf:
- $ref: '#/components/schemas/Integer'
- description: Must be specified if the table contains any dimension columns.
SerdeInfo:
allOf:
- $ref: '#/components/schemas/SerDeInfo'
- description: The serialization/deserialization (SerDe) information.
BucketColumns:
allOf:
- $ref: '#/components/schemas/NameStringList'
- description: A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns:
allOf:
- $ref: '#/components/schemas/OrderList'
- description: A list specifying the sort order of each bucket in the table.
Parameters:
allOf:
- $ref: '#/components/schemas/ParametersMap'
- description: The user-supplied properties in key-value form.
SkewedInfo:
allOf:
- $ref: '#/components/schemas/SkewedInfo'
- description: The information about values that appear frequently in a column (skewed values).
StoredAsSubDirectories:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: ' True if the table data is stored in subdirectories, or False if not.'
SchemaReference:
allOf:
- $ref: '#/components/schemas/SchemaReference'
- description: An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
description: Describes the physical storage of table data. PartitionError: type: object properties: PartitionValues: allOf: - $ref: '#/components/schemas/ValueStringList' - description: The values that define the partition. ErrorDetail: allOf: - $ref: '#/components/schemas/ErrorDetail' - description: The details about the partition error. description: Contains information about a partition error. PartitionIndexStatus: type: string enum: - CREATING - ACTIVE - DELETING - FAILED PartitionIndexDescriptor: type: object required: - IndexName - Keys - IndexStatus properties: IndexName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the partition index. Keys: allOf: - $ref: '#/components/schemas/KeySchemaElementList' - description: A list of one or more keys, asKeySchemaElement structures, for the partition index.
IndexStatus:
allOf:
- $ref: '#/components/schemas/PartitionIndexStatus'
- description: 'The status of the partition index.
The possible statuses are:
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
ACTIVE: The index creation succeeds.
FAILED: The index creation fails.
DELETING: The index is deleted from the list of indexes.
arn:aws:sqs:region:account:sqs.
DlqEventQueueArn:
allOf:
- $ref: '#/components/schemas/EventQueueArn'
- description: A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
description: Specifies a data store in Amazon Simple Storage Service (Amazon S3).
ScheduleState:
type: string
enum:
- SCHEDULED
- NOT_SCHEDULED
- TRANSITIONING
UpdateBehavior:
type: string
enum:
- LOG
- UPDATE_IN_DATABASE
SchemaColumn:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/ColumnNameString'
- description: The name of the column.
DataType:
allOf:
- $ref: '#/components/schemas/ColumnTypeString'
- description: The type of data in the column.
description: A key-value pair representing a column and data type that this transform can run against. The Schema parameter of the MLTransform may contain up to 100 of
these structures.
SchemaListItem:
type: object
properties:
RegistryName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: the name of the registry where the schema resides.
SchemaName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the schema.
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) for the schema.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description for the schema.
SchemaStatus:
allOf:
- $ref: '#/components/schemas/SchemaStatus'
- description: The status of the schema.
CreatedTime:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: The date and time that a schema was created.
UpdatedTime:
allOf:
- $ref: '#/components/schemas/UpdatedTimestamp'
- description: The date and time that a schema was updated.
description: An object that contains minimal details for a schema.
SchemaReference:
type: object
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaVersionId:
allOf:
- $ref: '#/components/schemas/SchemaVersionIdString'
- description: The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The version number of the schema.
description: An object that references a schema stored in the Glue Schema Registry.
SchemaVersionErrorItem:
type: object
properties:
VersionNumber:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The version number of the schema.
ErrorDetails:
allOf:
- $ref: '#/components/schemas/ErrorDetails'
- description: The details of the error for the schema version.
description: An object that contains the error details for an operation on a schema version.
SchemaVersionListItem:
type: object
properties:
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema.
SchemaVersionId:
allOf:
- $ref: '#/components/schemas/SchemaVersionIdString'
- description: The unique identifier of the schema version.
VersionNumber:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The version number of the schema.
Status:
allOf:
- $ref: '#/components/schemas/SchemaVersionStatus'
- description: The status of the schema version.
CreatedTime:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: The date and time the schema version was created.
description: An object containing the details about a schema version.
SearchPropertyPredicates:
type: array
items:
$ref: '#/components/schemas/PropertyPredicate'
SortCriteria:
type: array
items:
$ref: '#/components/schemas/SortCriterion'
minItems: 0
maxItems: 1
TotalSegmentsInteger:
type: integer
minimum: 1
maximum: 10
SerDeInfo:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the SerDe.
SerializationLibrary:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters:
allOf:
- $ref: '#/components/schemas/ParametersMap'
- description: These key-value pairs define initialization parameters for the SerDe.
description: Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
SessionStatus:
type: string
enum:
- PROVISIONING
- READY
- FAILED
- TIMEOUT
- STOPPING
- STOPPED
SkewedInfo:
type: object
properties:
SkewedColumnNames:
allOf:
- $ref: '#/components/schemas/NameStringList'
- description: A list of names of columns that contain skewed values.
SkewedColumnValues:
allOf:
- $ref: '#/components/schemas/ColumnValueStringList'
- description: A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps:
allOf:
- $ref: '#/components/schemas/LocationMap'
- description: A mapping of skewed values to the columns that contain them.
description: Specifies skewed values in a table. Skewed values are those that occur with very high frequency.
Sort:
type: string
enum:
- ASC
- DESC
SortCriterion:
type: object
properties:
FieldName:
allOf:
- $ref: '#/components/schemas/ValueString'
- description: The name of the field on which to sort.
Sort:
allOf:
- $ref: '#/components/schemas/Sort'
- description: An ascending or descending sort.
description: Specifies a field to sort by and a sort order.
SortDirectionType:
type: string
enum:
- DESCENDING
- ASCENDING
SourceControlAuthStrategy:
type: string
enum:
- PERSONAL_ACCESS_TOKEN
- AWS_SECRETS_MANAGER
SourceControlProvider:
type: string
enum:
- GITHUB
- AWS_CODE_COMMIT
SqlAliases:
type: array
items:
$ref: '#/components/schemas/SqlAlias'
Topk:
type: integer
minimum: 0
maximum: 100
SqlAlias:
type: object
required:
- From
- Alias
properties:
From:
allOf:
- $ref: '#/components/schemas/NodeId'
- description: A table, or a column in a table.
Alias:
allOf:
- $ref: '#/components/schemas/EnclosedInStringPropertyWithQuote'
- description: A temporary name given to a table, or a column in a table.
description: 'Represents a single entry in the list of values for SqlAliases. '
StartingEventBatchCondition:
type: object
properties:
BatchSize:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: Number of events in the batch.
BatchWindow:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: Duration of the batch window in seconds.
description: The batch condition that started the workflow run. Either the number of events in the batch size arrived, in which case the BatchSize member is non-zero, or the batch window
expired, in which case the BatchWindow member is non-zero.
StatementState:
type: string
enum:
- WAITING
- RUNNING
- AVAILABLE
- CANCELLING
- CANCELLED
- ERROR
StatementOutput:
type: object
properties:
Data:
allOf:
- $ref: '#/components/schemas/StatementOutputData'
- description: The code execution output.
ExecutionCount:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: The execution count of the output.
Status:
allOf:
- $ref: '#/components/schemas/StatementState'
- description: The status of the code execution output.
ErrorName:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The name of the error in the output.
ErrorValue:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The error value of the output.
Traceback:
allOf:
- $ref: '#/components/schemas/OrchestrationStringList'
- description: The traceback of the output.
description: The code execution output in JSON format.
StatementOutputData:
type: object
properties:
TextPlain:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The code execution output in text format.
description: The code execution output in JSON format.
ViewTextString:
type: string
maxLength: 409600
TableTypeString:
type: string
maxLength: 255
TableIdentifier:
type: object
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the table resides.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database that contains the target table.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the target table.
description: A structure that describes a target table for resource linking.
TableError:
type: object
properties:
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table. For Hive compatibility, this must be entirely lowercase.
ErrorDetail:
allOf:
- $ref: '#/components/schemas/ErrorDetail'
- description: The details about the error.
description: An error record for table operations.
TableVersionError:
type: object
properties:
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table in question.
VersionId:
allOf:
- $ref: '#/components/schemas/VersionString'
- description: The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.
ErrorDetail:
allOf:
- $ref: '#/components/schemas/ErrorDetail'
- description: The details about the error.
description: An error record for table-version operations.
TagKey:
type: string
minLength: 1
maxLength: 128
TagKeysList:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 0
maxItems: 50
TagValue:
type: string
minLength: 0
maxLength: 256
TaskRun:
type: object
properties:
TransformId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier for the transform.
TaskRunId:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The unique identifier for this task run.
Status:
allOf:
- $ref: '#/components/schemas/TaskStatusType'
- description: The current status of the requested task run.
LogGroupName:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The names of the log group for secure logging, associated with this task run.
Properties:
allOf:
- $ref: '#/components/schemas/TaskRunProperties'
- description: Specifies configuration properties associated with this task run.
ErrorString:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The list of error strings associated with this task run.
StartedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time that this task run started.
LastModifiedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last point in time that the requested task run was updated.
CompletedOn:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last point in time that the requested task run was completed.
ExecutionTime:
allOf:
- $ref: '#/components/schemas/ExecutionTime'
- description: The amount of time (in seconds) that the task run consumed resources.
description: The sampling parameters that are associated with the machine learning transform.
TaskType:
type: string
enum:
- EVALUATION
- LABELING_SET_GENERATION
- IMPORT_LABELS
- EXPORT_LABELS
- FIND_MATCHES
TaskRunSortColumnType:
type: string
enum:
- TASK_RUN_TYPE
- STATUS
- STARTED
TransformConfigParameter:
type: object
required:
- Name
- Type
properties:
Name:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies the name of the parameter in the config file of the dynamic transform.
Type:
allOf:
- $ref: '#/components/schemas/ParamType'
- description: Specifies the parameter type in the config file of the dynamic transform.
ValidationRule:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies the validation rule in the config file of the dynamic transform.
ValidationMessage:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperty'
- description: Specifies the validation message in the config file of the dynamic transform.
Value:
allOf:
- $ref: '#/components/schemas/EnclosedInStringProperties'
- description: Specifies the value of the parameter in the config file of the dynamic transform.
ListType:
allOf:
- $ref: '#/components/schemas/ParamType'
- description: Specifies the list type of the parameter in the config file of the dynamic transform.
IsOptional:
allOf:
- $ref: '#/components/schemas/BoxedBoolean'
- description: Specifies whether the parameter is optional or not in the config file of the dynamic transform.
description: Specifies the parameters in the config file of the dynamic transform.
TransformSortColumnType:
type: string
enum:
- NAME
- TRANSFORM_TYPE
- STATUS
- CREATED
- LAST_MODIFIED
TriggerState:
type: string
enum:
- CREATING
- CREATED
- ACTIVATING
- ACTIVATED
- DEACTIVATING
- DEACTIVATED
- DELETING
- UPDATING
TriggerUpdate:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Reserved for future use.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of this trigger.
Schedule:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: 'A cron expression used to specify the schedule (see Time-Based Schedules
for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).'
Actions:
allOf:
- $ref: '#/components/schemas/ActionList'
- description: The actions initiated by this trigger.
Predicate:
allOf:
- $ref: '#/components/schemas/Predicate'
- description: The predicate of this trigger, which defines when it will fire.
EventBatchingCondition:
allOf:
- $ref: '#/components/schemas/EventBatchingCondition'
- description: Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
description: A structure used to provide information used to update a trigger. This object updates the previous trigger definition by overwriting it completely.
UnfilteredPartition:
type: object
properties:
Partition:
allOf:
- $ref: '#/components/schemas/Partition'
- description: The partition object.
AuthorizedColumns:
allOf:
- $ref: '#/components/schemas/NameStringList'
- description: The list of columns the user has permissions to access.
IsRegisteredWithLakeFormation:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: A Boolean value indicating that the partition location is registered with Lake Formation.
description: A partition that contains unfiltered metadata.
UnionType:
type: string
enum:
- ALL
- DISTINCT
UpdateGrokClassifierRequest:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the GrokClassifier.
Classification:
allOf:
- $ref: '#/components/schemas/Classification'
- description: An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
GrokPattern:
allOf:
- $ref: '#/components/schemas/GrokPattern'
- description: The grok pattern used by this classifier.
CustomPatterns:
allOf:
- $ref: '#/components/schemas/CustomPatterns'
- description: Optional custom grok patterns used by this classifier.
description: Specifies a grok classifier to update when passed to UpdateClassifier.
UpdateXMLClassifierRequest:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
Classification:
allOf:
- $ref: '#/components/schemas/Classification'
- description: An identifier of the data format that the classifier matches.
RowTag:
allOf:
- $ref: '#/components/schemas/RowTag'
- description: The XML tag designating the element that contains each record in an XML document being parsed. This cannot identify a self-closing element (closed by />). An
empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but
<row item_a="A" item_b="B" /> is not).
description: Specifies an XML classifier to be updated.
UpdateJsonClassifierRequest:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
JsonPath:
allOf:
- $ref: '#/components/schemas/JsonPath'
- description: A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
description: Specifies a JSON classifier to be updated.
UpdateCsvClassifierRequest:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the classifier.
Delimiter:
allOf:
- $ref: '#/components/schemas/CsvColumnDelimiter'
- description: A custom symbol to denote what separates each column entry in the row.
QuoteSymbol:
allOf:
- $ref: '#/components/schemas/CsvQuoteSymbol'
- description: A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
ContainsHeader:
allOf:
- $ref: '#/components/schemas/CsvHeaderOption'
- description: Indicates whether the CSV file contains a header.
Header:
allOf:
- $ref: '#/components/schemas/CsvHeader'
- description: A list of strings representing column names.
DisableValueTrimming:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies not to trim values before identifying the type of column values. The default value is true.
AllowSingleColumn:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Enables the processing of files that contain only one column.
CustomDatatypeConfigured:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Specifies the configuration of custom datatypes.
CustomDatatypes:
allOf:
- $ref: '#/components/schemas/CustomDatatypes'
- description: Specifies a list of supported custom datatypes.
description: Specifies a custom CSV classifier to be updated.
UpdateColumnStatisticsList:
type: array
items:
$ref: '#/components/schemas/ColumnStatistics'
minItems: 0
maxItems: 25
WorkflowGraph:
type: object
properties:
Nodes:
allOf:
- $ref: '#/components/schemas/NodeList'
- description: A list of the the Glue components belong to the workflow represented as nodes.
Edges:
allOf:
- $ref: '#/components/schemas/EdgeList'
- description: A list of all the directed connections between the nodes belonging to the workflow.
description: A workflow graph represents the complete workflow containing all the Glue components present in the workflow and all the directed connections between them.
WorkflowRunStatus:
type: string
enum:
- RUNNING
- COMPLETED
- STOPPING
- STOPPED
- ERROR
WorkflowRunStatistics:
type: object
properties:
TotalActions:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: Total number of Actions in the workflow run.
TimeoutActions:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: Total number of Actions that timed out.
FailedActions:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: Total number of Actions that have failed.
StoppedActions:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: Total number of Actions that have stopped.
SucceededActions:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: Total number of Actions that have succeeded.
RunningActions:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: Total number Actions in running state.
ErroredActions:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: Indicates the count of job runs in the ERROR state in the workflow run.
WaitingActions:
allOf:
- $ref: '#/components/schemas/IntegerValue'
- description: Indicates the count of job runs in WAITING state in the workflow run.
description: Workflow run statistics provides statistics about the workflow run.
security:
- hmac: []