AWS Glue Glue Asset API

openapi: 3.2.0
info:
  title: AWS Glue Asset 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: Asset
paths:
  /#DeleteAsset:
    post:
      operationId: DeleteAsset
      summary: Delete Asset
      description: Deletes an asset from Glue Data Catalog.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAssetResponse'
        '400':
          description: AccessDeniedException; ConcurrentModificationException; InvalidInputException; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.DeleteAsset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAssetRequest'
      tags:
      - Asset
  /#GetAsset:
    post:
      operationId: GetAsset
      summary: Get Asset
      description: Retrieves the metadata for an asset in Glue Data Catalog, including its forms, additional attachments, and associated glossary terms.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetAssetOutput'
        '400':
          description: AccessDeniedException; EntityNotFoundException; InvalidInputException; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetAsset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetAssetInput'
      tags:
      - Asset
  /#PutAsset:
    post:
      operationId: PutAsset
      summary: Put Asset
      description: Creates or updates an asset in Glue Data Catalog. If the asset already exists, this operation updates it; otherwise, a new asset is created.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutAssetResponse'
        '400':
          description: AccessDeniedException; ConcurrentModificationException; EntityNotFoundException; InvalidInputException; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.PutAsset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutAssetRequest'
      tags:
      - Asset
  /#SearchAssets:
    post:
      operationId: SearchAssets
      summary: Search Assets
      description: Searches for assets in Glue Data Catalog using full-text search, filters, sorting, and aggregations. Returns matching assets with relevance-ranked results.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SearchAssetsOutput'
        '400':
          description: AccessDeniedException; InvalidInputException; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.SearchAssets
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/SearchAssetsInput'
      tags:
      - Asset
  /#UpdateAsset:
    post:
      operationId: UpdateAsset
      summary: Update Asset
      description: Updates the name and description of an existing asset in Glue Data Catalog. Only the fields that you provide are updated.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateAssetResponse'
        '400':
          description: AccessDeniedException; ConcurrentModificationException; EntityNotFoundException; InvalidInputException; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.UpdateAsset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateAssetRequest'
      tags:
      - Asset
components:
  schemas:
    SearchAssetsInput:
      type: object
      properties:
        SearchText:
          type: string
          description: The text to search for. At least one of searchText or filterClause must be provided.
        MaxResults:
          type: integer
          description: The maximum number of results to return in the response.
        NextToken:
          type: string
          description: A continuation token, if this is a continuation call.
        Sort:
          $ref: '#/components/schemas/SearchSort'
        FilterClause:
          $ref: '#/components/schemas/SearchFilterClause'
    SearchResultItem:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the matched asset.
        AssetName:
          type: string
          description: The name of the matched asset.
        AssetDescription:
          type: string
          description: The description of the matched asset.
        UpdatedAt:
          type: string
          format: date-time
          description: The timestamp at which the matched asset was last updated.
        AssetTypeId:
          type: string
          description: The identifier of the asset type for the matched asset.
    GetAssetOutput:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the asset.
        Name:
          type: string
          description: The name of the asset.
        Description:
          type: string
          description: The description of the asset.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp at which the asset was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The timestamp at which the asset was last updated.
        AssetTypeId:
          type: string
          description: The identifier of the asset type for this asset.
        GlossaryTerms:
          type: array
          items:
            type: string
          description: The identifiers of the glossary terms associated with the asset.
        Forms:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AssetFormEntry'
          description: The forms on the asset, keyed by form name.
        Attachments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AssetFormEntry'
          description: Additional attachments on the asset for more context, keyed by attachment name.
        IterableForms:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/IterableFormEntry'
          description: The iterable forms available on the asset, keyed by form name (for example, columns). Use the form name with ListIterableForms or BatchGetIterableForms to retrieve the form's items.
      required:
      - Id
      - AssetTypeId
    SearchFilterValue:
      type: object
      properties:
        StringValue:
          type: string
          description: A string filter value.
        LongValue:
          type: integer
          description: A long integer filter value.
      description: Exactly one member is set.
    DeleteAssetRequest:
      type: object
      properties:
        Identifier:
          type: string
          description: The unique identifier of the asset to delete.
      required:
      - Identifier
    SearchAttributeFilter:
      type: object
      properties:
        Attribute:
          type: string
          description: The attribute name to filter on.
        Operator:
          type: string
          enum:
          - equals
          - greaterThan
          - greaterThanOrEquals
          - lessThan
          - lessThanOrEquals
          - notExists
          description: The comparison operator. Valid values are equals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, and notExists.
        Value:
          $ref: '#/components/schemas/SearchFilterValue'
      required:
      - Attribute
      - Operator
    DeleteAssetResponse:
      type: object
      properties: {}
    SearchSort:
      type: object
      properties:
        Attribute:
          type: string
          description: The attribute to sort by.
        Order:
          type: string
          enum:
          - ASCENDING
          - DESCENDING
          description: The sort order. Valid values are ASCENDING and DESCENDING.
      required:
      - Attribute
    UpdateAssetRequest:
      type: object
      properties:
        Identifier:
          type: string
          description: The unique identifier of the asset to update.
        Name:
          type: string
          description: The new name of the asset.
        Description:
          type: string
          description: The new description of the asset.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - Identifier
    SearchAssetsOutput:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultItem'
          description: The list of assets matching the search criteria.
        NextToken:
          type: string
          description: A continuation token, present if the current segment is not the last.
    GetAssetInput:
      type: object
      properties:
        Identifier:
          type: string
          description: The unique identifier of the asset to retrieve.
      required:
      - Identifier
    PutAssetResponse:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the asset.
        Name:
          type: string
          description: The name of the asset.
        Description:
          type: string
          description: The description of the asset.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp at which the asset was created.
        Forms:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AssetFormEntry'
          description: The forms attached to the asset, keyed by form name.
      required:
      - Id
      - Name
    IterableFormEntry:
      type: object
      properties:
        FormTypeId:
          type: string
          description: The form type identifier of the iterable form (for example, columns), used to retrieve its items via ListIterableForms or BatchGetIterableForms.
    SearchMapFilter:
      type: object
      properties:
        Attribute:
          type: string
          description: The map attribute name to filter on.
        Key:
          type: string
          description: The key within the map attribute to filter on.
        Value:
          $ref: '#/components/schemas/SearchMapFilterValue'
      required:
      - Attribute
      - Key
      - Value
    SearchMapFilterValue:
      type: object
      properties:
        StringValue:
          type: string
          description: A string filter value.
      description: Exactly one member is set.
    SearchFilterClause:
      type: object
      properties:
        AndAllFilters:
          type: array
          items:
            $ref: '#/components/schemas/SearchFilterClause'
          description: A list of filter clauses that must all match (logical AND).
        OrAnyFilters:
          type: array
          items:
            $ref: '#/components/schemas/SearchFilterClause'
          description: A list of filter clauses where at least one must match (logical OR).
        AttributeFilter:
          $ref: '#/components/schemas/SearchAttributeFilter'
        MapFilter:
          $ref: '#/components/schemas/SearchMapFilter'
      description: Exactly one member is set.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    AssetFormEntry:
      type: object
      properties:
        FormTypeId:
          type: string
          description: The identifier of the form type that defines this form's schema.
        Content:
          type: string
          description: The JSON content of the form, conforming to the schema of the specified form type.
    PutAssetRequest:
      type: object
      properties:
        AssetTypeId:
          type: string
          description: The identifier of the asset type for the asset.
        Identifier:
          type: string
          description: The unique identifier of the asset. If an asset with this identifier already exists, it is updated.
        Name:
          type: string
          description: The name of the asset.
        Description:
          type: string
          description: The description of the asset.
        Forms:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AssetFormEntry'
          description: The forms to set on the asset, keyed by form name. Each entry specifies the form type and its JSON content.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - AssetTypeId
      - Identifier
      - Name
      - Forms
    UpdateAssetResponse:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the asset.
        Name:
          type: string
          description: The name of the asset.
        Description:
          type: string
          description: The description of the asset.
        UpdatedAt:
          type: string
          format: date-time
          description: The timestamp at which the asset was last updated.
      required:
      - Id
  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)