AWS Glue Glue Integration Table Property API

openapi: 3.2.0
info:
  title: AWS Glue Integration Table Property API
  version: '2017-03-31'
  description: Generated from AWS's published Smithy model for AWS Glue. 5 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 Table Property
paths:
  /#CreateIntegrationTableProperties:
    post:
      operationId: CreateIntegrationTableProperties
      summary: Create Integration Table Properties
      description: This API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateIntegrationTablePropertiesResponse'
        '400':
          description: AccessDeniedException; EntityNotFoundException; InvalidInputException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.CreateIntegrationTableProperties
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateIntegrationTablePropertiesRequest'
      tags:
      - Integration Table Property
  /#DeleteIntegrationTableProperties:
    post:
      operationId: DeleteIntegrationTableProperties
      summary: Delete Integration Table Properties
      description: Deletes the table properties that have been created for the tables that need to be replicated.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteIntegrationTablePropertiesResponse'
        '400':
          description: AccessDeniedException; EntityNotFoundException; InvalidInputException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.DeleteIntegrationTableProperties
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteIntegrationTablePropertiesRequest'
      tags:
      - Integration Table Property
  /#GetIntegrationTableProperties:
    post:
      operationId: GetIntegrationTableProperties
      summary: Get Integration Table Properties
      description: This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetIntegrationTablePropertiesResponse'
        '400':
          description: AccessDeniedException; EntityNotFoundException; InvalidInputException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.GetIntegrationTableProperties
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetIntegrationTablePropertiesRequest'
      tags:
      - Integration Table Property
  /#ListIntegrationTableProperties:
    post:
      operationId: ListIntegrationTableProperties
      summary: List Integration Table Properties
      description: Lists the integration table properties in your account. This operation supports filtering and pagination.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListIntegrationTablePropertiesResponse'
        '400':
          description: AccessDeniedException; EntityNotFoundException; InvalidInputException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.ListIntegrationTableProperties
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListIntegrationTablePropertiesRequest'
      tags:
      - Integration Table Property
  /#UpdateIntegrationTableProperties:
    post:
      operationId: UpdateIntegrationTableProperties
      summary: Update Integration Table Properties
      description: This API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively. The override will be reflected across all the integrations using same ResourceArn and source table.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateIntegrationTablePropertiesResponse'
        '400':
          description: AccessDeniedException; EntityNotFoundException; InvalidInputException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.UpdateIntegrationTableProperties
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateIntegrationTablePropertiesRequest'
      tags:
      - Integration Table Property
components:
  schemas:
    IntegrationTablePropertiesFilter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Supported filter keys are SourceArn, TargetArn, SourceTableName, and TargetTableName.
        Values:
          type: array
          items:
            type: string
          description: A list of filter values.
    ListIntegrationTablePropertiesResponse:
      type: object
      properties:
        IntegrationTablePropertiesList:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationTableProperties'
          description: A list of integration table properties meeting the filter criteria.
        Marker:
          type: string
          description: The pagination token for the next page. Returns null if there are no more results.
    IntegrationPartition:
      type: object
      properties:
        FieldName:
          type: string
          description: The field name used to partition data on the target. Avoid using columns that have unique values for each row (for example, `LastModifiedTimestamp`, `SystemModTimeStamp`) as the partition column. These columns are not suitable for partitioning because they create a large number of small partitions, which can lead to performance issues.
        FunctionSpec:
          type: string
          description: 'Specifies the function used to partition data on the target. The accepted values for this parameter are: identity - Uses source values directly without transformation year - Extracts the year from timestamp values (e.g., 2023) month - Extracts the month from timestamp values (e.g., 2023-01) day - Extracts the day from timestamp values (e.g., 2023-01-15) hour - Extracts the hour from timestamp values (e.g., 2023-01-15-14)'
        ConversionSpec:
          type: string
          description: 'Specifies the timestamp format of the source data. Valid values are: epoch_sec - Unix epoch timestamp in seconds epoch_milli - Unix epoch timestamp in milliseconds iso - ISO 8601 formatted timestamp Only specify ConversionSpec when using timestamp-based partition functions (year, month, day, or hour). Glue Zero-ETL uses this parameter to correctly transform source data into timestamp format before partitioning. Do not use high-cardinality columns with the identity partition function. High-cardinality columns include: Primary keys Timestamp fields (such as LastModifiedTimestamp, CreatedDate) Sy'
    GetIntegrationTablePropertiesRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
        TableName:
          type: string
          description: The name of the table to be replicated.
      required:
      - ResourceArn
      - TableName
    TargetTableConfig:
      type: object
      properties:
        UnnestSpec:
          type: string
          enum:
          - TOPLEVEL
          - FULL
          - NOUNNEST
          description: 'Specifies how nested objects are flattened to top-level elements. Valid values are: "TOPLEVEL", "FULL", or "NOUNNEST".'
        PartitionSpec:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationPartition'
          description: Determines the file layout on the target.
        TargetTableName:
          type: string
          description: The optional name of a target table.
        IntegrationArn:
          type: string
          description: The ARN of the integration that owns this target table configuration.
    UpdateIntegrationTablePropertiesResponse:
      type: object
      properties: {}
    GetIntegrationTablePropertiesResponse:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
        TableName:
          type: string
          description: The name of the table to be replicated.
        SourceTableConfig:
          $ref: '#/components/schemas/SourceTableConfig'
        TargetTableConfig:
          $ref: '#/components/schemas/TargetTableConfig'
    DeleteIntegrationTablePropertiesRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The connection ARN of the source, or the database ARN of the target.
        TableName:
          type: string
          description: The name of the table to be replicated.
      required:
      - ResourceArn
      - TableName
    IntegrationTableProperties:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The connection ARN of the source, or the database ARN of the target.
        TableName:
          type: string
          description: The name of the source table to be replicated.
        SourceTableConfig:
          $ref: '#/components/schemas/SourceTableConfig'
        TargetTableConfig:
          $ref: '#/components/schemas/TargetTableConfig'
      required:
      - ResourceArn
      - TableName
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    AccessDeniedException:
      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.
    SourceTableConfig:
      type: object
      properties:
        Fields:
          type: array
          items:
            type: string
          description: A list of fields used for column-level filtering. Currently unsupported.
        FilterPredicate:
          type: string
          description: A condition clause used for row-level filtering. Currently unsupported.
        PrimaryKey:
          type: array
          items:
            type: string
          description: Provide the primary key set for this table. Currently supported specifically for SAP EntityOf entities upon request. Contact Amazon Web Services Support to make this feature available.
        RecordUpdateField:
          type: string
          description: Incremental pull timestamp-based field. Currently unsupported.
    DeleteIntegrationTablePropertiesResponse:
      type: object
      properties: {}
    CreateIntegrationTablePropertiesResponse:
      type: object
      properties: {}
    CreateIntegrationTablePropertiesRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target table for which to create integration table properties. Currently, this API only supports creating integration table properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for creating integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
        TableName:
          type: string
          description: The name of the table to be replicated.
        SourceTableConfig:
          $ref: '#/components/schemas/SourceTableConfig'
        TargetTableConfig:
          $ref: '#/components/schemas/TargetTableConfig'
      required:
      - ResourceArn
      - TableName
    ListIntegrationTablePropertiesRequest:
      type: object
      properties:
        Marker:
          type: string
          description: The pagination token for the next page of results. The initial value is null.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationTablePropertiesFilter'
          description: A list of filters. Supported filter keys are SourceArn, TargetArn, SourceTableName, and TargetTableName.
        MaxRecords:
          type: integer
          description: The maximum number of records to return in the response.
    UpdateIntegrationTablePropertiesRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The connection ARN of the source, or the database ARN of the target.
        TableName:
          type: string
          description: The name of the table to be replicated.
        SourceTableConfig:
          $ref: '#/components/schemas/SourceTableConfig'
        TargetTableConfig:
          $ref: '#/components/schemas/TargetTableConfig'
      required:
      - ResourceArn
      - TableName
  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)