Amazon RDS Rds Export Task API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Export Task API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database Service. 3 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://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Export Task
paths:
  /?Action=CancelExportTask:
    post:
      operationId: CancelExportTask
      summary: Cancel Export Task
      description: Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ExportTask'
              example:
                ExportTaskIdentifier: my-s3-export-1
                SourceArn: arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot
                SnapshotTime: '2019-03-24T20:01:09.815Z'
                S3Bucket: mybucket
                S3Prefix: ''
                IamRoleArn: arn:aws:iam::123456789012:role/service-role/export-snap-S3-role
                KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff
                Status: CANCELING
                PercentProgress: 0
                TotalExtractedDataInGB: 0
        '404':
          description: ExportTaskNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ExportTaskNotFoundFault'
        '400':
          description: InvalidExportTaskStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidExportTaskStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CancelExportTask
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CancelExportTaskMessage'
            example:
              ExportTaskIdentifier: my-s3-export-1
      tags:
      - Export Task
  /?Action=DescribeExportTasks:
    post:
      operationId: DescribeExportTasks
      summary: Describe Export Tasks
      description: Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ExportTasksMessage'
              example:
                ExportTasks:
                - ExportTaskIdentifier: test-snapshot-export
                  SourceArn: arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot
                  SnapshotTime: '2020-03-02T18:26:28.163Z'
                  TaskStartTime: '2020-03-02T18:57:56.896Z'
                  TaskEndTime: '2020-03-02T19:10:31.985Z'
                  S3Bucket: mybucket
                  S3Prefix: ''
                  IamRoleArn: arn:aws:iam::123456789012:role/service-role/ExportRole
                  KmsKeyId: arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff
                  Status: COMPLETE
                  PercentProgress: 100
                  TotalExtractedDataInGB: 0
                - ExportTaskIdentifier: my-s3-export
                  SourceArn: arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test
                  SnapshotTime: '2020-03-27T20:48:42.023Z'
                  S3Bucket: mybucket
                  S3Prefix: ''
                  IamRoleArn: arn:aws:iam::123456789012:role/service-role/ExportRole
                  KmsKeyId: arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff
                  Status: STARTING
                  PercentProgress: 0
                  TotalExtractedDataInGB: 0
        '404':
          description: ExportTaskNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ExportTaskNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeExportTasks
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeExportTasksMessage'
      tags:
      - Export Task
  /?Action=StartExportTask:
    post:
      operationId: StartExportTask
      summary: Start Export Task
      description: Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket. You can't export snapshot data from RDS Custom DB instances. For more information, see Supported Regions and DB engines for exporting snapshots to S3 in Amazon RDS. For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide. For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ExportTask'
              example:
                ExportTaskIdentifier: my-s3-export
                SourceArn: arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test
                SnapshotTime: '2020-03-27T20:48:42.023Z'
                S3Bucket: mybucket
                IamRoleArn: arn:aws:iam::123456789012:role/service-role/ExportRole
                KmsKeyId: arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff
                Status: STARTING
                PercentProgress: 0
                TotalExtractedDataInGB: 0
        '404':
          description: DBClusterNotFoundFault; DBClusterSnapshotNotFoundFault; DBSnapshotNotFoundFault; IamRoleNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
        '400':
          description: ExportTaskAlreadyExistsFault; IamRoleMissingPermissionsFault; InvalidExportOnlyFault; InvalidExportSourceStateFault; InvalidS3BucketFault; KMSKeyNotAccessibleFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ExportTaskAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: StartExportTask
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/StartExportTaskMessage'
            example:
              ExportTaskIdentifier: my-s3-export
              SourceArn: arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test
              S3BucketName: mybucket
              IamRoleArn: arn:aws:iam::123456789012:role/service-role/ExportRole
              KmsKeyId: arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff
      tags:
      - Export Task
components:
  schemas:
    CancelExportTaskMessage:
      type: object
      properties:
        ExportTaskIdentifier:
          type: string
          description: The identifier of the snapshot or cluster export task to cancel.
      required:
      - ExportTaskIdentifier
    DBClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    InvalidExportTaskStateFault:
      type: object
      properties:
        message:
          type: string
    StartExportTaskMessage:
      type: object
      properties:
        ExportTaskIdentifier:
          type: string
          description: A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.
        SourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
        S3BucketName:
          type: string
          description: The name of the Amazon S3 bucket to export the snapshot or cluster data to.
        IamRoleArn:
          type: string
          description: 'The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster. In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket: s3:PutObject* s3:GetObject* s3:ListBucket s3:DeleteObject* s3:GetBucketLocation In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3: arn:aws:s3:::your-s3-bucket arn:aws:s3:::your-s3-bucket/*'
        KmsKeyId:
          type: string
          description: 'The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy: kms:CreateGrant kms:DescribeKey'
        S3Prefix:
          type: string
          description: The Amazon S3 bucket prefix to use as the file name and path of the exported data.
        ExportOnly:
          type: array
          items:
            type: string
          description: 'The data to be exported from the snapshot or cluster. If this parameter isn''t provided, all of the data is exported. Valid Values: database - Export all the data from a specified database. database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. database.schema.table table-name - Export a table of the database schema. This format is valid only for R'
      required:
      - ExportTaskIdentifier
      - SourceArn
      - S3BucketName
      - IamRoleArn
      - KmsKeyId
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: One or more filter values. Filter values are case-sensitive.
      required:
      - Name
      - Values
    ExportTask:
      type: object
      properties:
        ExportTaskIdentifier:
          type: string
          description: A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
        SourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
        ExportOnly:
          type: array
          items:
            type: string
          description: 'The data exported from the snapshot or cluster. Valid Values: database - Export all the data from a specified database. database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.'
        SnapshotTime:
          type: string
          format: date-time
          description: The time when the snapshot was created.
        TaskStartTime:
          type: string
          format: date-time
          description: The time when the snapshot or cluster export task started.
        TaskEndTime:
          type: string
          format: date-time
          description: The time when the snapshot or cluster export task ended.
        S3Bucket:
          type: string
          description: The Amazon S3 bucket where the snapshot or cluster is exported to.
        S3Prefix:
          type: string
          description: The Amazon S3 bucket prefix that is the file name and path of the exported data.
        IamRoleArn:
          type: string
          description: The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
        KmsKeyId:
          type: string
          description: The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
        Status:
          type: string
          description: 'The progress status of the export task. The status can be one of the following: CANCELED CANCELING COMPLETE FAILED IN_PROGRESS STARTING'
        PercentProgress:
          type: integer
          description: The progress of the snapshot or cluster export task as a percentage.
        TotalExtractedDataInGB:
          type: integer
          description: The total amount of data exported, in gigabytes.
        FailureCause:
          type: string
          description: The reason the export failed, if it failed.
        WarningMessage:
          type: string
          description: A warning about the snapshot or cluster export task.
        SourceType:
          type: string
          enum:
          - SNAPSHOT
          - CLUSTER
          description: The type of source for the export.
    ExportTasksMessage:
      type: object
      properties:
        Marker:
          type: string
          description: A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.
        ExportTasks:
          type: array
          items:
            $ref: '#/components/schemas/ExportTask'
          description: Information about an export of a snapshot or cluster to Amazon S3.
    DescribeExportTasksMessage:
      type: object
      properties:
        ExportTaskIdentifier:
          type: string
          description: The identifier of the snapshot or cluster export task to be described.
        SourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive. Supported filters include the following: export-task-identifier - An identifier for the snapshot or cluster export task. s3-bucket - The Amazon S3 bucket the data is exported to. source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. status - The status of the export task. Must be lowercase. Valid statuses are the following: canceled canceling complete fail'
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
        MaxRecords:
          type: integer
          description: 'The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
        SourceType:
          type: string
          enum:
          - SNAPSHOT
          - CLUSTER
          description: The type of source for the export.
    ExportTaskNotFoundFault:
      type: object
      properties:
        message:
          type: string
    ExportTaskAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
  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: rds
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/rds/service/2014-10-31/rds-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)