Class: Aws::DataSync::Types::TaskReportConfig

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-datasync/types.rb

Overview

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

For more information, see [Task reports].

[1]: docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination ⇒ Types::ReportDestination

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see [Task reports].

[1]: docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html#task-report-access

Returns:



5170
5171
5172
5173
5174
5175
5176
5177
5178
 
# File 'lib/aws-sdk-datasync/types.rb', line 5170

class TaskReportConfig < Struct.new(
  :destination,
  :output_type,
  :report_level,
  :object_version_ids,
  :overrides)
  SENSITIVE = []
  include Aws::Structure
end

#object_version_ids ⇒ String

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you [enable versioning on your bucket]. Keep in mind that setting this to ‘INCLUDE` can increase the duration of your task execution.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html

Returns:

  • (String) 


5170
5171
5172
5173
5174
5175
5176
5177
5178
 
# File 'lib/aws-sdk-datasync/types.rb', line 5170

class TaskReportConfig < Struct.new(
  :destination,
  :output_type,
  :report_level,
  :object_version_ids,
  :overrides)
  SENSITIVE = []
  include Aws::Structure
end

#output_type ⇒ String

Specifies the type of task report that you want:

  • ‘SUMMARY_ONLY`: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

  • ‘STANDARD`: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Returns:

  • (String) 


5170
5171
5172
5173
5174
5175
5176
5177
5178
 
# File 'lib/aws-sdk-datasync/types.rb', line 5170

class TaskReportConfig < Struct.new(
  :destination,
  :output_type,
  :report_level,
  :object_version_ids,
  :overrides)
  SENSITIVE = []
  include Aws::Structure
end

#overrides ⇒ Types::ReportOverrides

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

Returns:



5170
5171
5172
5173
5174
5175
5176
5177
5178
 
# File 'lib/aws-sdk-datasync/types.rb', line 5170

class TaskReportConfig < Struct.new(
  :destination,
  :output_type,
  :report_level,
  :object_version_ids,
  :overrides)
  SENSITIVE = []
  include Aws::Structure
end

#report_level ⇒ String

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.

  • ‘ERRORS_ONLY`: A report shows what DataSync was unable to transfer, skip, verify, and delete.

  • ‘SUCCESSES_AND_ERRORS`: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Returns:

  • (String) 


5170
5171
5172
5173
5174
5175
5176
5177
5178
 
# File 'lib/aws-sdk-datasync/types.rb', line 5170

class TaskReportConfig < Struct.new(
  :destination,
  :output_type,
  :report_level,
  :object_version_ids,
  :overrides)
  SENSITIVE = []
  include Aws::Structure
end