You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3Control::Types::JobReport

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing JobReport as input to an Aws::Client method, you can use a vanilla Hash:

{
  bucket: "S3BucketArnString",
  format: "Report_CSV_20180820", # accepts Report_CSV_20180820
  enabled: false, # required
  prefix: "ReportPrefixString",
  report_scope: "AllTasks", # accepts AllTasks, FailedTasksOnly
}

Contains the configuration parameters for a job-completion report.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

#enabled ⇒ Boolean

Indicates whether the specified job will generate a job-completion report.

Returns:

  • (Boolean) —

    Indicates whether the specified job will generate a job-completion report.

#format ⇒ String

The format of the specified job-completion report.

Possible values:

  • Report_CSV_20180820

Returns:

  • (String) —

    The format of the specified job-completion report.

#prefix ⇒ String

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Returns:

  • (String) —

    An optional prefix to describe where in the specified bucket the job-completion report will be stored.

#report_scope ⇒ String

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

Possible values:

  • AllTasks
  • FailedTasksOnly

Returns:

  • (String) —

    Indicates whether the job-completion report will include details of all tasks or only failed tasks.