Class: Aws::Backup::Types::ListBackupJobSummariesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::ListBackupJobSummariesInput
- Defined in:
- gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#account_id ⇒ String
Returns the job count for the specified account.
-
#aggregation_period ⇒ String
The period for the returned results.
-
#max_results ⇒ Integer
The maximum number of items to be returned.
-
#message_category ⇒ String
This parameter returns the job count for the specified message category.
-
#next_token ⇒ String
The next item following a partial list of returned resources.
-
#resource_type ⇒ String
Returns the job count for the specified resource type.
-
#state ⇒ String
This parameter returns the job count for jobs with the specified state.
Instance Attribute Details
#account_id ⇒ String
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.
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4748 class ListBackupJobSummariesInput < Struct.new( :account_id, :state, :resource_type, :message_category, :aggregation_period, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |
#aggregation_period ⇒ String
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.
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4748 class ListBackupJobSummariesInput < Struct.new( :account_id, :state, :resource_type, :message_category, :aggregation_period, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4748 class ListBackupJobSummariesInput < Struct.new( :account_id, :state, :resource_type, :message_category, :aggregation_period, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |
#message_category ⇒ String
This parameter returns the job count for the specified message category.
Example accepted strings include AccessDenied
, Success
, and
InvalidParameters
. See Monitoring for a list of accepted
MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL
aggregates job counts for all message categories and
returns the sum.
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4748 class ListBackupJobSummariesInput < Struct.new( :account_id, :state, :resource_type, :message_category, :aggregation_period, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
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.
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4748 class ListBackupJobSummariesInput < Struct.new( :account_id, :state, :resource_type, :message_category, :aggregation_period, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |
#resource_type ⇒ String
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.
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4748 class ListBackupJobSummariesInput < Struct.new( :account_id, :state, :resource_type, :message_category, :aggregation_period, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |
#state ⇒ String
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.
Completed with issues
is a status found only in the Backup
console. For API, this status refers to jobs with a state of
COMPLETED
and a MessageCategory
with a value other than
SUCCESS
; that is, the status is completed but comes with a status
message. To obtain the job count for Completed with issues
, run
two GET requests, and subtract the second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4748 class ListBackupJobSummariesInput < Struct.new( :account_id, :state, :resource_type, :message_category, :aggregation_period, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |