RDS / Client / cancel_export_task

cancel_export_task#

RDS.Client.cancel_export_task(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.cancel_export_task(
    ExportTaskIdentifier='string'
)
Parameters:

ExportTaskIdentifier (string) –

[REQUIRED]

The identifier of the snapshot or cluster export task to cancel.

Return type:

dict

Returns:

Response Syntax

{
    'ExportTaskIdentifier': 'string',
    'SourceArn': 'string',
    'ExportOnly': [
        'string',
    ],
    'SnapshotTime': datetime(2015, 1, 1),
    'TaskStartTime': datetime(2015, 1, 1),
    'TaskEndTime': datetime(2015, 1, 1),
    'S3Bucket': 'string',
    'S3Prefix': 'string',
    'IamRoleArn': 'string',
    'KmsKeyId': 'string',
    'Status': 'string',
    'PercentProgress': 123,
    'TotalExtractedDataInGB': 123,
    'FailureCause': 'string',
    'WarningMessage': 'string',
    'SourceType': 'SNAPSHOT'|'CLUSTER'
}

Response Structure

  • (dict) –

    Contains the details of a snapshot or cluster export to Amazon S3.

    This data type is used as a response element in the DescribeExportTasks action.

    • ExportTaskIdentifier (string) –

      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 (string) –

      The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

    • ExportOnly (list) –

      The data exported from the snapshot or cluster. Valid values are the following:

      • 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.

      • (string) –

    • SnapshotTime (datetime) –

      The time that the snapshot was created.

    • TaskStartTime (datetime) –

      The time that the snapshot or cluster export task started.

    • TaskEndTime (datetime) –

      The time that the snapshot or cluster export task ended.

    • S3Bucket (string) –

      The Amazon S3 bucket that the snapshot or cluster is exported to.

    • S3Prefix (string) –

      The Amazon S3 bucket prefix that is the file name and path of the exported data.

    • IamRoleArn (string) –

      The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

    • KmsKeyId (string) –

      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 (string) –

      The progress status of the export task. The status can be one of the following:

      • CANCELED

      • CANCELING

      • COMPLETE

      • FAILED

      • IN_PROGRESS

      • STARTING

    • PercentProgress (integer) –

      The progress of the snapshot or cluster export task as a percentage.

    • TotalExtractedDataInGB (integer) –

      The total amount of data exported, in gigabytes.

    • FailureCause (string) –

      The reason the export failed, if it failed.

    • WarningMessage (string) –

      A warning about the snapshot or cluster export task.

    • SourceType (string) –

      The type of source for the export.

Exceptions

  • RDS.Client.exceptions.ExportTaskNotFoundFault

  • RDS.Client.exceptions.InvalidExportTaskStateFault