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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-s3:amazon-s3-maintenance-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon Simple Storage Service Maintenance API
  version: '2006-03-01'
  description: Generated from AWS's published Smithy model for Amazon Simple Storage Service. 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://s3tables.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /buckets/{tableBucketARN}/maintenance:
    get:
      operationId: GetTableBucketMaintenanceConfiguration
      summary: Get Table Bucket Maintenance Configuration
      description: Gets details about a maintenance configuration for a given table bucket. For more information, see Amazon
        S3 table bucket maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableBucketMaintenanceConfiguration
        permission to use this operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTableBucketMaintenanceConfigurationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3TablesBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3TablesNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTableBucketMaintenanceConfigurationRequest'
      tags:
      - Maintenance
  /buckets/{tableBucketARN}/maintenance/{type}:
    put:
      operationId: PutTableBucketMaintenanceConfiguration
      summary: Put Table Bucket Maintenance Configuration
      description: Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket.
        For more information, see Amazon S3 table bucket maintenance in the Amazon Simple Storage Service User Guide. Permissions
        You must have the s3tables:PutTableBucketMaintenanceConfiguration permission to use this operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3TablesBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3TablesNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutTableBucketMaintenanceConfigurationRequest'
      tags:
      - Maintenance
  /tables/{tableBucketARN}/{namespace}/{name}/maintenance:
    get:
      operationId: GetTableMaintenanceConfiguration
      summary: Get Table Maintenance Configuration
      description: Gets details about the maintenance configuration of a table. For more information, see S3 Tables maintenance
        in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableMaintenanceConfiguration
        permission to use this operation. You must have the s3tables:GetTableData permission to use set the compaction strategy
        to sort or zorder.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTableMaintenanceConfigurationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3TablesBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3TablesNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTableMaintenanceConfigurationRequest'
      tags:
      - Maintenance
  /tables/{tableBucketARN}/{namespace}/{name}/maintenance/{type}:
    put:
      operationId: PutTableMaintenanceConfiguration
      summary: Put Table Maintenance Configuration
      description: Creates a new maintenance configuration or replaces an existing maintenance configuration for a table.
        For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide. Permissions You must
        have the s3tables:PutTableMaintenanceConfiguration permission to use this operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3TablesBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3TablesNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutTableMaintenanceConfigurationRequest'
      tags:
      - Maintenance
components:
  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: s3tables
  schemas:
    ConflictException:
      type: object
      properties:
        message:
          type: string
    ForbiddenException:
      type: object
      properties:
        message:
          type: string
    GetTableBucketMaintenanceConfigurationRequest:
      type: object
      properties:
        tableBucketARN:
          type: string
          description: The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.
      required:
      - tableBucketARN
    GetTableBucketMaintenanceConfigurationResponse:
      type: object
      properties:
        tableBucketARN:
          type: string
          description: The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.
        configuration:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TableBucketMaintenanceConfigurationValue'
          description: Details about the maintenance configuration for the table bucket.
      required:
      - tableBucketARN
      - configuration
    GetTableMaintenanceConfigurationRequest:
      type: object
      properties:
        tableBucketARN:
          type: string
          description: The Amazon Resource Name (ARN) of the table bucket.
        namespace:
          type: string
          description: The namespace associated with the table.
        name:
          type: string
          description: The name of the table.
      required:
      - tableBucketARN
      - namespace
      - name
    GetTableMaintenanceConfigurationResponse:
      type: object
      properties:
        tableARN:
          type: string
          description: The Amazon Resource Name (ARN) of the table.
        configuration:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TableMaintenanceConfigurationValue'
          description: Details about the maintenance configuration for the table bucket.
      required:
      - tableARN
      - configuration
    IcebergCompactionSettings:
      type: object
      properties:
        targetFileSizeMB:
          type: integer
          description: The target file size for the table in MB.
        strategy:
          type: string
          enum:
          - auto
          - binpack
          - sort
          - z-order
          description: The compaction strategy to use for the table. This determines how files are selected and combined during
            compaction operations.
    IcebergSnapshotManagementSettings:
      type: object
      properties:
        minSnapshotsToKeep:
          type: integer
          description: The minimum number of snapshots to keep.
        maxSnapshotAgeHours:
          type: integer
          description: The maximum age of a snapshot before it can be expired.
    IcebergUnreferencedFileRemovalSettings:
      type: object
      properties:
        unreferencedDays:
          type: integer
          description: The number of days an object has to be unreferenced before it is marked as non-current.
        nonCurrentDays:
          type: integer
          description: The number of days an object has to be non-current before it is deleted.
    InternalServerErrorException:
      type: object
      properties:
        message:
          type: string
    PutTableBucketMaintenanceConfigurationRequest:
      type: object
      properties:
        tableBucketARN:
          type: string
          description: The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.
        type:
          type: string
          enum:
          - icebergUnreferencedFileRemoval
          description: The type of the maintenance configuration.
        value:
          $ref: '#/components/schemas/TableBucketMaintenanceConfigurationValue'
      required:
      - tableBucketARN
      - type
      - value
    PutTableMaintenanceConfigurationRequest:
      type: object
      properties:
        tableBucketARN:
          type: string
          description: The Amazon Resource Name (ARN) of the table associated with the maintenance configuration.
        namespace:
          type: string
          description: The namespace of the table.
        name:
          type: string
          description: The name of the table.
        type:
          type: string
          enum:
          - icebergCompaction
          - icebergSnapshotManagement
          description: The type of the maintenance configuration.
        value:
          $ref: '#/components/schemas/TableMaintenanceConfigurationValue'
      required:
      - tableBucketARN
      - namespace
      - name
      - type
      - value
    S3TablesBadRequestException:
      type: object
      properties:
        message:
          type: string
    S3TablesNotFoundException:
      type: object
      properties:
        message:
          type: string
    TableBucketMaintenanceConfigurationValue:
      type: object
      properties:
        status:
          type: string
          enum:
          - enabled
          - disabled
          description: The status of the maintenance configuration.
        settings:
          $ref: '#/components/schemas/TableBucketMaintenanceSettings'
    TableBucketMaintenanceSettings:
      type: object
      properties:
        icebergUnreferencedFileRemoval:
          $ref: '#/components/schemas/IcebergUnreferencedFileRemovalSettings'
      description: Exactly one member is set.
    TableMaintenanceConfigurationValue:
      type: object
      properties:
        status:
          type: string
          enum:
          - enabled
          - disabled
          description: The status of the maintenance configuration.
        settings:
          $ref: '#/components/schemas/TableMaintenanceSettings'
    TableMaintenanceSettings:
      type: object
      properties:
        icebergCompaction:
          $ref: '#/components/schemas/IcebergCompactionSettings'
        icebergSnapshotManagement:
          $ref: '#/components/schemas/IcebergSnapshotManagementSettings'
      description: Exactly one member is set.
    TooManyRequestsException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/s3tables/service/2018-05-10/s3tables-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)