Class: Aws::Backup::Types::ListRestoreJobSummariesInput

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

Returns:

  • (String)


5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5817

class ListRestoreJobSummariesInput < Struct.new(
  :account_id,
  :state,
  :resource_type,
  :aggregation_period,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#aggregation_periodString

The period for the returned results.

  • ONE_DAY - The daily job count for the prior 14 days.

  • SEVEN_DAYS - The aggregated job count for the prior 7 days.

  • FOURTEEN_DAYS - The aggregated job count for prior 14 days.

Returns:

  • (String)


5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5817

class ListRestoreJobSummariesInput < Struct.new(
  :account_id,
  :state,
  :resource_type,
  :aggregation_period,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

Returns:

  • (Integer)


5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5817

class ListRestoreJobSummariesInput < Struct.new(
  :account_id,
  :state,
  :resource_type,
  :aggregation_period,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (String)


5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5817

class ListRestoreJobSummariesInput < Struct.new(
  :account_id,
  :state,
  :resource_type,
  :aggregation_period,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Returns:

  • (String)


5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5817

class ListRestoreJobSummariesInput < Struct.new(
  :account_id,
  :state,
  :resource_type,
  :aggregation_period,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Returns:

  • (String)


5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5817

class ListRestoreJobSummariesInput < Struct.new(
  :account_id,
  :state,
  :resource_type,
  :aggregation_period,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end