CompletionReport
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.
Contents
- Enabled
-
Set
Enabled
toTrue
to generate aCompletionReport
when the task completes. If set totrue
, then you need to provide a reportScope
,Path
, andFormat
. SetEnabled
toFalse
if you do not want aCompletionReport
generated when the task completes.Type: Boolean
Required: Yes
- Format
-
Required if
Enabled
is set totrue
. Specifies the format of theCompletionReport
.REPORT_CSV_20191124
is the only format currently supported. WhenFormat
is set toREPORT_CSV_20191124
, theCompletionReport
is provided in CSV format, and is delivered to{path}/task-{id}/failures.csv
.Type: String
Valid Values:
REPORT_CSV_20191124
Required: No
- Path
-
Required if
Enabled
is set totrue
. 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. ThePath
you provide must be located within the file system’s ExportPath. An examplePath
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.Type: String
Length Constraints: Minimum length of 3. Maximum length of 4357.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{3,4357}$
Required: No
- Scope
-
Required if
Enabled
is set totrue
. Specifies the scope of theCompletionReport
;FAILED_FILES_ONLY
is the only scope currently supported. WhenScope
is set toFAILED_FILES_ONLY
, theCompletionReport
only contains information about files that the data repository task failed to process.Type: String
Valid Values:
FAILED_FILES_ONLY
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: