CompletionReport Class | AWS SDK for .NET V3

Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

Inheritance Hierarchy

System.Object
Amazon.FSx.Model.CompletionReport

Namespace: Amazon.FSx.Model
Assembly: AWSSDK.FSx.dll
Version: 3.x.y.z

Syntax

public class CompletionReport

The CompletionReport type exposes the following members

Constructors

	Name	Description
	CompletionReport()

Properties

Name	Type	Description
Enabled	System.Boolean	Gets and sets the property Enabled. Set `Enabled` to `True` to generate a `CompletionReport` when the task completes. If set to `true`, then you need to provide a report `Scope`, `Path`, and `Format`. Set `Enabled` to `False` if you do not want a `CompletionReport` generated when the task completes.
Format	Amazon.FSx.ReportFormat	Gets and sets the property Format. Required if `Enabled` is set to `true`. Specifies the format of the `CompletionReport`. `REPORT_CSV_20191124` is the only format currently supported. When `Format` is set to `REPORT_CSV_20191124`, the `CompletionReport` is provided in CSV format, and is delivered to `{path}/task-{id}/failures.csv`.
Path	System.String	Gets and sets the property Path. Required if `Enabled` is set to `true`. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The `Path` you provide must be located within the file system’s ExportPath. An example `Path` value is "s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.
Scope	Amazon.FSx.ReportScope	Gets and sets the property Scope. Required if `Enabled` is set to `true`. Specifies the scope of the `CompletionReport`; `FAILED_FILES_ONLY` is the only scope currently supported. When `Scope` is set to `FAILED_FILES_ONLY`, the `CompletionReport` only contains information about files that the data repository task failed to process.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5