Skip to content

DescribeExportTasksMessage

Source code in docs_src/capo_rds/types/describe_export_tasks_message.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class DescribeExportTasksMessage(TypedDict, closed=True):
    export_task_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The identifier of the snapshot or cluster export task to be described.</p>"""
    source_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p>"""
    filters: NotRequired["capo_rds.types.filter_list.FilterList"]
    """<p>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.</p> <p>Supported filters include the following:</p> <ul> <li> <p> <code>export-task-identifier</code> - An identifier for the snapshot or cluster export task.</p> </li> <li> <p> <code>s3-bucket</code> - The Amazon S3 bucket the data is exported to.</p> </li> <li> <p> <code>source-arn</code> - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p> </li> <li> <p> <code>status</code> - The status of the export task. Must be lowercase. Valid statuses are the following:</p> <ul> <li> <p> <code>canceled</code> </p> </li> <li> <p> <code>canceling</code> </p> </li> <li> <p> <code>complete</code> </p> </li> <li> <p> <code>failed</code> </p> </li> <li> <p> <code>in_progress</code> </p> </li> <li> <p> <code>starting</code> </p> </li> </ul> </li> </ul>"""
    marker: NotRequired["capo_rds.types.string.String"]
    """<p>An optional pagination token provided by a previous <code>DescribeExportTasks</code> request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter.</p>"""
    max_records: NotRequired["capo_rds.types.max_records.MaxRecords"]
    """<p>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 <code>DescribeExportTasks</code> request to retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"""
    source_type: NotRequired["capo_rds.types.export_source_type.ExportSourceType"]
    """<p>The type of source for the export.</p>"""

export_task_identifier instance-attribute 

export_task_identifier: NotRequired[String]

The identifier of the snapshot or cluster export task to be described.

filters instance-attribute 

filters: NotRequired[FilterList]

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

marker instance-attribute 

marker: NotRequired[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.

max_records instance-attribute 

max_records: NotRequired[MaxRecords]

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.

source_arn instance-attribute 

source_arn: NotRequired[String]

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

source_type instance-attribute 

source_type: NotRequired[ExportSourceType]

The type of source for the export.