Class: Aws::Backup::Types::BackupJobSummary

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::BackupJobSummary

Defined in:

gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

This is a summary of jobs created or running within the most recent 30 days.

The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The account ID that owns the jobs within the summary.

• #count ⇒ Integer

  The value as a number of jobs in a job summary.

• #end_time ⇒ Time

  The value of time in number format of a job end time.

• #message_category ⇒ String

  This parameter is the job count for the specified message category.

• #region ⇒ String

  The Amazon Web Services Regions within the job summary.

• #resource_type ⇒ String

  This value is the job count for the specified resource type.

• #start_time ⇒ Time

  The value of time in number format of a job start time.

• #state ⇒ String

  This value is job count for jobs with the specified state.

Instance Attribute Details

#account_id ⇒ String

The account ID that owns the jobs within the summary.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 353

class BackupJobSummary < Struct.new(
  :region,
  :account_id,
  :state,
  :resource_type,
  :message_category,
  :count,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#count ⇒ Integer

The value as a number of jobs in a job summary.

Returns:

• (Integer)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 353

class BackupJobSummary < Struct.new(
  :region,
  :account_id,
  :state,
  :resource_type,
  :message_category,
  :count,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The value of time in number format of a job end time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 353

class BackupJobSummary < Struct.new(
  :region,
  :account_id,
  :state,
  :resource_type,
  :message_category,
  :count,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#message_category ⇒ String

This parameter is the job count for the specified message category.

Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of 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.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 353

class BackupJobSummary < Struct.new(
  :region,
  :account_id,
  :state,
  :resource_type,
  :message_category,
  :count,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

The Amazon Web Services Regions within the job summary.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 353

class BackupJobSummary < Struct.new(
  :region,
  :account_id,
  :state,
  :resource_type,
  :message_category,
  :count,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 353

class BackupJobSummary < Struct.new(
  :region,
  :account_id,
  :state,
  :resource_type,
  :message_category,
  :count,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The value of time in number format of a job start time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 353

class BackupJobSummary < Struct.new(
  :region,
  :account_id,
  :state,
  :resource_type,
  :message_category,
  :count,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

This value is job count for jobs with the specified state.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 353

class BackupJobSummary < Struct.new(
  :region,
  :account_id,
  :state,
  :resource_type,
  :message_category,
  :count,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end