RDS / Client / describe_export_tasks

describe_export_tasks#

RDS.Client.describe_export_tasks(**kwargs)#

Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.

Request Syntax

response = client.describe_export_tasks(
    ExportTaskIdentifier='string',
    SourceArn='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123,
    SourceType='SNAPSHOT'|'CLUSTER'
)

Parameters:

ExportTaskIdentifier (string) – The identifier of the snapshot or cluster export task to be described.
SourceArn (string) – The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
Filters (list) –
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
  - failed
  - in_progress
  - starting
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
  
  Note
  Currently, wildcards are not supported in filters.
  
  The following actions can be filtered:
  - DescribeDBClusterBacktracks
  - DescribeDBClusterEndpoints
  - DescribeDBClusters
  - DescribeDBInstances
  - DescribeDBRecommendations
  - DescribeDBShardGroups
  - DescribePendingMaintenanceActions
  - Name (string) – [REQUIRED]
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) – [REQUIRED]
    
    One or more filter values. Filter values are case-sensitive.
    - (string) –
Marker (string) – 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 (integer) –
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 (string) – The type of source for the export.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'ExportTasks': [
        {
            '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) –
- Marker (string) –
  
  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 (list) –
  
  Information about an export of a snapshot or cluster to Amazon S3.
  - (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 operation.
    - 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:
      - 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 when the snapshot was created.
    - TaskStartTime (datetime) –
      
      The time when the snapshot or cluster export task started.
    - TaskEndTime (datetime) –
      
      The time when the snapshot or cluster export task ended.
    - S3Bucket (string) –
      
      The Amazon S3 bucket where 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