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

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

Overview

Note:

When making an API call, you may pass JobReport data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

Returns:

  • (String)


2217
2218
2219
2220
2221
2222
2223
2224
2225
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2217

class JobReport < Struct.new(
  :bucket,
  :format,
  :enabled,
  :prefix,
  :report_scope)
  SENSITIVE = []
  include Aws::Structure
end

#enabledBoolean

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

Returns:

  • (Boolean)


2217
2218
2219
2220
2221
2222
2223
2224
2225
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2217

class JobReport < Struct.new(
  :bucket,
  :format,
  :enabled,
  :prefix,
  :report_scope)
  SENSITIVE = []
  include Aws::Structure
end

#formatString

The format of the specified job-completion report.

Returns:

  • (String)


2217
2218
2219
2220
2221
2222
2223
2224
2225
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2217

class JobReport < Struct.new(
  :bucket,
  :format,
  :enabled,
  :prefix,
  :report_scope)
  SENSITIVE = []
  include Aws::Structure
end

#prefixString

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)


2217
2218
2219
2220
2221
2222
2223
2224
2225
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2217

class JobReport < Struct.new(
  :bucket,
  :format,
  :enabled,
  :prefix,
  :report_scope)
  SENSITIVE = []
  include Aws::Structure
end

#report_scopeString

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

Returns:

  • (String)


2217
2218
2219
2220
2221
2222
2223
2224
2225
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2217

class JobReport < Struct.new(
  :bucket,
  :format,
  :enabled,
  :prefix,
  :report_scope)
  SENSITIVE = []
  include Aws::Structure
end