describe_export_tasks¶
Operation¶
async
¶
describe_export_tasks(input: DescribeExportTasksInput, plugins: list[Plugin] | None = None) -> DescribeExportTasksOutput
Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeExportTasksInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeExportTasksOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeExportTasksInput structure.
Attributes¶
class-attribute
instance-attribute
¶
export_task_identifier: str | None = ...
The identifier of the snapshot or cluster export task to be described.
class-attribute
instance-attribute
¶
filters: list[Filter] | None = ...
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
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
class-attribute
instance-attribute
¶
max_records: int | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeExportTasksOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
export_tasks: list[ExportTask] | None = ...
Information about an export of a snapshot or cluster to Amazon S3.
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.