Class: Aws::RDS::Types::DescribeExportTasksMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#export_task_identifier ⇒ String

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

Returns:

  • (String) 


14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14086

class DescribeExportTasksMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :filters,
  :marker,
  :max_records,
  :source_type)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

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

Returns:



14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14086

class DescribeExportTasksMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :filters,
  :marker,
  :max_records,
  :source_type)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14086

class DescribeExportTasksMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :filters,
  :marker,
  :max_records,
  :source_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_records ⇒ 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.

Returns:

  • (Integer) 


14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14086

class DescribeExportTasksMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :filters,
  :marker,
  :max_records,
  :source_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_arn ⇒ String

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

Returns:

  • (String) 


14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14086

class DescribeExportTasksMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :filters,
  :marker,
  :max_records,
  :source_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_type ⇒ String

The type of source for the export.

Returns:

  • (String) 


14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14086

class DescribeExportTasksMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :filters,
  :marker,
  :max_records,
  :source_type)
  SENSITIVE = []
  include Aws::Structure
end