AWS Glue Glue Integration API
The Glue Integration API from AWS Glue — 4 operation(s) for glue integration.
The Glue Integration API from AWS Glue — 4 operation(s) for glue integration.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/aws-glue:aws-glue-integration-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: AWS Glue Integration API
version: '2017-03-31'
description: Generated from AWS's published Smithy model for AWS Glue. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://glue.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Integration
paths:
/#CreateIntegration:
post:
operationId: CreateIntegration
summary: Create Integration
description: 'Creates a Zero-ETL integration in the caller''s account between two resources with Amazon Resource Names (ARNs): the SourceArn and TargetArn.'
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateIntegrationResponse'
'400':
description: AccessDeniedException; ConflictException; EntityNotFoundException; InvalidInputException; KMSKeyNotAccessibleFault; ResourceNumberLimitExceededException; ValidationException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: IntegrationConflictOperationFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/IntegrationConflictOperationFault'
'402':
description: IntegrationQuotaExceededFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/IntegrationQuotaExceededFault'
'500':
description: InternalServerException; InternalServiceException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.CreateIntegration
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateIntegrationRequest'
tags:
- Integration
/#DeleteIntegration:
post:
operationId: DeleteIntegration
summary: Delete Integration
description: Deletes the specified Zero-ETL integration.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteIntegrationResponse'
'400':
description: AccessDeniedException; ConflictException; EntityNotFoundException; InvalidInputException; InvalidIntegrationStateFault; InvalidStateException; ValidationException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: IntegrationConflictOperationFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/IntegrationConflictOperationFault'
'404':
description: IntegrationNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/IntegrationNotFoundFault'
'500':
description: InternalServerException; InternalServiceException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DeleteIntegration
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteIntegrationRequest'
tags:
- Integration
/#DescribeIntegrations:
post:
operationId: DescribeIntegrations
summary: Describe Integrations
description: The API is used to retrieve a list of integrations.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeIntegrationsResponse'
'400':
description: AccessDeniedException; EntityNotFoundException; InvalidInputException; ValidationException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'404':
description: IntegrationNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/IntegrationNotFoundFault'
'500':
description: InternalServerException; InternalServiceException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.DescribeIntegrations
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeIntegrationsRequest'
tags:
- Integration
/#ModifyIntegration:
post:
operationId: ModifyIntegration
summary: Modify Integration
description: Modifies a Zero-ETL integration in the caller's account.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ModifyIntegrationResponse'
'400':
description: AccessDeniedException; ConflictException; EntityNotFoundException; InvalidInputException; InvalidIntegrationStateFault; InvalidStateException; ValidationException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: IntegrationConflictOperationFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/IntegrationConflictOperationFault'
'404':
description: IntegrationNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/IntegrationNotFoundFault'
'500':
description: InternalServerException; InternalServiceException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.ModifyIntegration
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ModifyIntegrationRequest'
tags:
- Integration
components:
schemas:
DeleteIntegrationRequest:
type: object
properties:
IntegrationIdentifier:
type: string
description: The Amazon Resource Name (ARN) for the integration.
required:
- IntegrationIdentifier
IntegrationNotFoundFault:
type: object
properties:
Message:
type: string
description: A message describing the problem.
DeleteIntegrationResponse:
type: object
properties:
SourceArn:
type: string
description: The ARN of the source for the integration.
TargetArn:
type: string
description: The ARN of the target for the integration.
IntegrationName:
type: string
description: A unique name for an integration in Glue.
Description:
type: string
description: A description of the integration.
IntegrationArn:
type: string
description: The Amazon Resource Name (ARN) for the integration.
KmsKeyId:
type: string
description: The ARN of a KMS key used for encrypting the channel.
AdditionalEncryptionContext:
type: object
additionalProperties:
type: string
description: An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Metadata assigned to the resource consisting of a list of key-value pairs.
Status:
type: string
enum:
- CREATING
- ACTIVE
- MODIFYING
- FAILED
- DELETING
- SYNCING
- NEEDS_ATTENTION
description: 'The status of the integration being deleted. The possible statuses are: CREATING: The integration is being created. ACTIVE: The integration creation succeeds. MODIFYING: The integration is being modified. FAILED: The integration creation fails. DELETING: The integration is deleted. SYNCING: The integration is synchronizing. NEEDS_ATTENTION: The integration needs attention, such as synchronization.'
CreateTime:
type: string
format: date-time
description: The time when the integration was created, in UTC.
Errors:
type: array
items:
$ref: '#/components/schemas/IntegrationError'
description: A list of errors associated with the integration.
DataFilter:
type: string
description: Selects source tables for the integration using Maxwell filter syntax.
required:
- SourceArn
- TargetArn
- IntegrationName
- IntegrationArn
- Status
- CreateTime
Tag:
type: object
properties:
key:
type: string
description: The tag key. The key is required when you create a tag on an object. The key is case-sensitive, and must not contain the prefix aws.
value:
type: string
description: The tag value. The value is optional when you create a tag on an object. The value is case-sensitive, and must not contain the prefix aws.
DescribeIntegrationsRequest:
type: object
properties:
IntegrationIdentifier:
type: string
description: The Amazon Resource Name (ARN) for the integration.
Marker:
type: string
description: A value that indicates the starting point for the next set of response records in a subsequent request.
MaxRecords:
type: integer
description: The total number of items to return in the output.
Filters:
type: array
items:
$ref: '#/components/schemas/IntegrationFilter'
description: A list of key and values, to filter down the results. Supported keys are "Status", "IntegrationName", and "SourceArn". IntegrationName is limited to only one value.
CreateIntegrationRequest:
type: object
properties:
IntegrationName:
type: string
description: A unique name for an integration in Glue.
SourceArn:
type: string
description: The ARN of the source resource for the integration.
TargetArn:
type: string
description: The ARN of the target resource for the integration.
Description:
type: string
description: A description of the integration.
DataFilter:
type: string
description: Selects source tables for the integration using Maxwell filter syntax.
KmsKeyId:
type: string
description: The ARN of a KMS key used for encrypting the channel.
AdditionalEncryptionContext:
type: object
additionalProperties:
type: string
description: An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId is provided.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Metadata assigned to the resource consisting of a list of key-value pairs.
IntegrationConfig:
$ref: '#/components/schemas/IntegrationConfig'
required:
- IntegrationName
- SourceArn
- TargetArn
DescribeIntegrationsResponse:
type: object
properties:
Integrations:
type: array
items:
$ref: '#/components/schemas/Integration'
description: A list of zero-ETL integrations.
Marker:
type: string
description: A value that indicates the starting point for the next set of response records in a subsequent request.
IntegrationFilter:
type: object
properties:
Name:
type: string
description: The name of the filter.
Values:
type: array
items:
type: string
description: A list of filter values.
IntegrationConfig:
type: object
properties:
RefreshInterval:
type: string
description: Specifies the frequency at which CDC (Change Data Capture) pulls or incremental loads should occur. This parameter provides flexibility to align the refresh rate with your specific data update patterns, system load considerations, and performance optimization goals. Time increment can be set from 15 minutes to 8640 minutes (six days).
SourceProperties:
type: object
additionalProperties:
type: string
description: A collection of key-value pairs that specify additional properties for the integration source. These properties provide configuration options that can be used to customize the behavior of the ODB source during data integration operations.
ContinuousSync:
type: boolean
description: Enables continuous synchronization for on-demand data extractions from SaaS applications to Amazon Web Services data services like Amazon Redshift and Amazon S3.
TargetNamespace:
type: string
description: 'An optional custom namespace for the integration''s target. Supply this parameter only when the target is an Amazon S3 Tables table bucket; it is not accepted for other target types. The integration replicates data into the namespace you specify, reusing it if it already exists. If you omit this parameter, the target namespace defaults to zetl_ followed by the integration ID, with hyphens converted to underscores. The value is immutable after the integration is created; ModifyIntegration rejects changes to it. It must be a valid Amazon S3 Tables namespace name: 1 to 255 characters using lowerca'
Integration:
type: object
properties:
SourceArn:
type: string
description: The ARN for the source of the integration.
TargetArn:
type: string
description: The ARN for the target of the integration.
Description:
type: string
description: A description for the integration.
IntegrationName:
type: string
description: A unique name for the integration.
IntegrationArn:
type: string
description: The Amazon Resource Name (ARN) for the integration.
KmsKeyId:
type: string
description: The ARN of a KMS key used for encrypting the channel.
AdditionalEncryptionContext:
type: object
additionalProperties:
type: string
description: An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId is provided.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Metadata assigned to the resource consisting of a list of key-value pairs.
Status:
type: string
enum:
- CREATING
- ACTIVE
- MODIFYING
- FAILED
- DELETING
- SYNCING
- NEEDS_ATTENTION
description: 'The possible statuses are: CREATING: The integration is being created. ACTIVE: The integration creation succeeds. MODIFYING: The integration is being modified. FAILED: The integration creation fails. DELETING: The integration is deleted. SYNCING: The integration is synchronizing. NEEDS_ATTENTION: The integration needs attention, such as synchronization.'
CreateTime:
type: string
format: date-time
description: The time that the integration was created, in UTC.
IntegrationConfig:
$ref: '#/components/schemas/IntegrationConfig'
Errors:
type: array
items:
$ref: '#/components/schemas/IntegrationError'
description: A list of errors associated with the integration.
DataFilter:
type: string
description: Selects source tables for the integration using Maxwell filter syntax.
required:
- SourceArn
- TargetArn
- IntegrationName
- IntegrationArn
- Status
- CreateTime
ModifyIntegrationRequest:
type: object
properties:
IntegrationIdentifier:
type: string
description: The Amazon Resource Name (ARN) for the integration.
Description:
type: string
description: A description of the integration.
DataFilter:
type: string
description: Selects source tables for the integration using Maxwell filter syntax.
IntegrationConfig:
$ref: '#/components/schemas/IntegrationConfig'
IntegrationName:
type: string
description: A unique name for an integration in Glue.
required:
- IntegrationIdentifier
IntegrationQuotaExceededFault:
type: object
properties:
Message:
type: string
description: A message describing the problem.
IntegrationError:
type: object
properties:
ErrorCode:
type: string
description: The code associated with this error.
ErrorMessage:
type: string
description: A message describing the error.
IntegrationConflictOperationFault:
type: object
properties:
Message:
type: string
description: A message describing the problem.
CreateIntegrationResponse:
type: object
properties:
SourceArn:
type: string
description: The ARN of the source resource for the integration.
TargetArn:
type: string
description: The ARN of the target resource for the integration.
IntegrationName:
type: string
description: A unique name for an integration in Glue.
Description:
type: string
description: A description of the integration.
IntegrationArn:
type: string
description: The Amazon Resource Name (ARN) for the created integration.
KmsKeyId:
type: string
description: The ARN of a KMS key used for encrypting the channel.
AdditionalEncryptionContext:
type: object
additionalProperties:
type: string
description: An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Metadata assigned to the resource consisting of a list of key-value pairs.
Status:
type: string
enum:
- CREATING
- ACTIVE
- MODIFYING
- FAILED
- DELETING
- SYNCING
- NEEDS_ATTENTION
description: 'The status of the integration being created. The possible statuses are: CREATING: The integration is being created. ACTIVE: The integration creation succeeds. MODIFYING: The integration is being modified. FAILED: The integration creation fails. DELETING: The integration is deleted. SYNCING: The integration is synchronizing. NEEDS_ATTENTION: The integration needs attention, such as synchronization.'
CreateTime:
type: string
format: date-time
description: The time when the integration was created, in UTC.
Errors:
type: array
items:
$ref: '#/components/schemas/IntegrationError'
description: A list of errors associated with the integration creation.
DataFilter:
type: string
description: Selects source tables for the integration using Maxwell filter syntax.
IntegrationConfig:
$ref: '#/components/schemas/IntegrationConfig'
required:
- SourceArn
- TargetArn
- IntegrationName
- IntegrationArn
- Status
- CreateTime
AccessDeniedException:
type: object
properties:
Message:
type: string
description: A message describing the problem.
ResourceNotFoundException:
type: object
properties:
Message:
type: string
description: A message describing the problem.
InternalServerException:
type: object
properties:
Message:
type: string
description: A message describing the problem.
ModifyIntegrationResponse:
type: object
properties:
SourceArn:
type: string
description: The ARN of the source for the integration.
TargetArn:
type: string
description: The ARN of the target for the integration.
IntegrationName:
type: string
description: A unique name for an integration in Glue.
Description:
type: string
description: A description of the integration.
IntegrationArn:
type: string
description: The Amazon Resource Name (ARN) for the integration.
KmsKeyId:
type: string
description: The ARN of a KMS key used for encrypting the channel.
AdditionalEncryptionContext:
type: object
additionalProperties:
type: string
description: An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Metadata assigned to the resource consisting of a list of key-value pairs.
Status:
type: string
enum:
- CREATING
- ACTIVE
- MODIFYING
- FAILED
- DELETING
- SYNCING
- NEEDS_ATTENTION
description: 'The status of the integration being modified. The possible statuses are: CREATING: The integration is being created. ACTIVE: The integration creation succeeds. MODIFYING: The integration is being modified. FAILED: The integration creation fails. DELETING: The integration is deleted. SYNCING: The integration is synchronizing. NEEDS_ATTENTION: The integration needs attention, such as synchronization.'
CreateTime:
type: string
format: date-time
description: The time when the integration was created, in UTC.
Errors:
type: array
items:
$ref: '#/components/schemas/IntegrationError'
description: A list of errors associated with the integration modification.
DataFilter:
type: string
description: Selects source tables for the integration using Maxwell filter syntax.
IntegrationConfig:
$ref: '#/components/schemas/IntegrationConfig'
required:
- SourceArn
- TargetArn
- IntegrationName
- IntegrationArn
- Status
- CreateTime
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: glue
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/glue/service/2017-03-31/glue-2017-03-31.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)