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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeExportTasksMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass DescribeExportTasksMessage data as a hash:

{
  export_task_identifier: "String",
  source_arn: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  marker: "String",
  max_records: 1,
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #export_task_identifier ⇒ String

  The identifier of the snapshot export task to be described.

• #filters ⇒ Array<Types::Filter>

  Filters specify one or more snapshot exports to describe.

• #marker ⇒ String

  An optional pagination token provided by a previous `DescribeExportTasks` request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

• #source_arn ⇒ String

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

Instance Attribute Details

#export_task_identifier ⇒ String

The identifier of the snapshot export task to be described.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 12511

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

#filters ⇒ Array<Types::Filter>

Filters specify one or more snapshot 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 export task.

• `s3-bucket` - The Amazon S3 bucket the snapshot is exported to.

• `source-arn` - The Amazon Resource Name (ARN) of the snapshot 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:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-rds/types.rb', line 12511

class DescribeExportTasksMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :filters,
  :marker,
  :max_records)
  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)

# File 'lib/aws-sdk-rds/types.rb', line 12511

class DescribeExportTasksMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :filters,
  :marker,
  :max_records)
  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)

# File 'lib/aws-sdk-rds/types.rb', line 12511

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

#source_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 12511

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