Class: Aws::Backup::Types::ListReportJobsInput

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

Overview

Note:

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

{
  by_report_plan_name: "ReportPlanName",
  by_creation_before: Time.now,
  by_creation_after: Time.now,
  by_status: "string",
  max_results: 1,
  next_token: "string",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#by_creation_afterTime

Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

Returns:

  • (Time)


4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4641

class ListReportJobsInput < Struct.new(
  :by_report_plan_name,
  :by_creation_before,
  :by_creation_after,
  :by_status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#by_creation_beforeTime

Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

Returns:

  • (Time)


4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4641

class ListReportJobsInput < Struct.new(
  :by_report_plan_name,
  :by_creation_before,
  :by_creation_after,
  :by_status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#by_report_plan_nameString

Returns only report jobs with the specified report plan name.

Returns:

  • (String)


4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4641

class ListReportJobsInput < Struct.new(
  :by_report_plan_name,
  :by_creation_before,
  :by_creation_after,
  :by_status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#by_statusString

Returns only report jobs that are in the specified status. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

Returns:

  • (String)


4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4641

class ListReportJobsInput < Struct.new(
  :by_report_plan_name,
  :by_creation_before,
  :by_creation_after,
  :by_status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

Returns:

  • (Integer)


4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4641

class ListReportJobsInput < Struct.new(
  :by_report_plan_name,
  :by_creation_before,
  :by_creation_after,
  :by_status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

  • (String)


4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4641

class ListReportJobsInput < Struct.new(
  :by_report_plan_name,
  :by_creation_before,
  :by_creation_after,
  :by_status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end