Class: Aws::Backup::Types::ReportJob

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::ReportJob

Defined in:

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

Overview

Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #completion_time ⇒ Time

  The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC).

• #creation_time ⇒ Time

  The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC).

• #report_destination ⇒ Types::ReportDestination

  The S3 bucket name and S3 keys for the destination where the report job publishes the report.

• #report_job_id ⇒ String

  The identifier for a report job.

• #report_plan_arn ⇒ String

  An Amazon Resource Name (ARN) that uniquely identifies a resource.

• #report_template ⇒ String

  Identifies the report template for the report.

• #status ⇒ String

  The status of a report job.

• #status_message ⇒ String

  A message explaining the status of the report job.

Instance Attribute Details

#completion_time ⇒ Time

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is 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 8553

class ReportJob < Struct.new(
  :report_job_id,
  :report_plan_arn,
  :report_template,
  :creation_time,
  :completion_time,
  :status,
  :status_message,
  :report_destination)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is 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 8553

class ReportJob < Struct.new(
  :report_job_id,
  :report_plan_arn,
  :report_template,
  :creation_time,
  :completion_time,
  :status,
  :status_message,
  :report_destination)
  SENSITIVE = []
  include Aws::Structure
end

#report_destination ⇒ Types::ReportDestination

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

Returns:

• (Types::ReportDestination)

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

class ReportJob < Struct.new(
  :report_job_id,
  :report_plan_arn,
  :report_template,
  :creation_time,
  :completion_time,
  :status,
  :status_message,
  :report_destination)
  SENSITIVE = []
  include Aws::Structure
end

#report_job_id ⇒ String

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

Returns:

• (String)

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

class ReportJob < Struct.new(
  :report_job_id,
  :report_plan_arn,
  :report_template,
  :creation_time,
  :completion_time,
  :status,
  :status_message,
  :report_destination)
  SENSITIVE = []
  include Aws::Structure
end

#report_plan_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Returns:

• (String)

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

class ReportJob < Struct.new(
  :report_job_id,
  :report_plan_arn,
  :report_template,
  :creation_time,
  :completion_time,
  :status,
  :status_message,
  :report_destination)
  SENSITIVE = []
  include Aws::Structure
end

#report_template ⇒ String

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

Returns:

• (String)

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

class ReportJob < Struct.new(
  :report_job_id,
  :report_plan_arn,
  :report_template,
  :creation_time,
  :completion_time,
  :status,
  :status_message,
  :report_destination)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

Returns:

• (String)

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

class ReportJob < Struct.new(
  :report_job_id,
  :report_plan_arn,
  :report_template,
  :creation_time,
  :completion_time,
  :status,
  :status_message,
  :report_destination)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A message explaining the status of the report job.

Returns:

• (String)

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

class ReportJob < Struct.new(
  :report_job_id,
  :report_plan_arn,
  :report_template,
  :creation_time,
  :completion_time,
  :status,
  :status_message,
  :report_destination)
  SENSITIVE = []
  include Aws::Structure
end