Amazonka.FSx.Types.CompletionReport

Documentation

data 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.

See: newCompletionReport smart constructor.

Constructors

CompletionReport'

Fields

• format :: Maybe ReportFormat

  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 :: Maybe Text

  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://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. To learn more about a file system's ExportPath, see .

• scope :: Maybe ReportScope

  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.

• enabled :: Bool

  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.

Instances

FromJSON CompletionReport

Defined in Amazonka.FSx.Types.CompletionReport

Methods

parseJSON :: Value -> Parser CompletionReport

parseJSONList :: Value -> Parser [CompletionReport]

ToJSON CompletionReport

Defined in Amazonka.FSx.Types.CompletionReport

Methods

toJSON :: CompletionReport -> Value

toEncoding :: CompletionReport -> Encoding

toJSONList :: [CompletionReport] -> Value

toEncodingList :: [CompletionReport] -> Encoding

Generic CompletionReport

Defined in Amazonka.FSx.Types.CompletionReport

Associated Types

type Rep CompletionReport :: Type -> Type

Methods

from :: CompletionReport -> Rep CompletionReport x

to :: Rep CompletionReport x -> CompletionReport

Read CompletionReport

Defined in Amazonka.FSx.Types.CompletionReport

Methods

readsPrec :: Int -> ReadS CompletionReport

readList :: ReadS [CompletionReport]

readPrec :: ReadPrec CompletionReport

readListPrec :: ReadPrec [CompletionReport]

Show CompletionReport

Defined in Amazonka.FSx.Types.CompletionReport

Methods

showsPrec :: Int -> CompletionReport -> ShowS

show :: CompletionReport -> String

showList :: [CompletionReport] -> ShowS

NFData CompletionReport

Defined in Amazonka.FSx.Types.CompletionReport

Methods

rnf :: CompletionReport -> ()

Eq CompletionReport

Defined in Amazonka.FSx.Types.CompletionReport

Methods

(==) :: CompletionReport -> CompletionReport -> Bool

(/=) :: CompletionReport -> CompletionReport -> Bool

Hashable CompletionReport

Defined in Amazonka.FSx.Types.CompletionReport

Methods

hashWithSalt :: Int -> CompletionReport -> Int

hash :: CompletionReport -> Int

type Rep CompletionReport

Defined in Amazonka.FSx.Types.CompletionReport

type Rep CompletionReport = D1 ('MetaData "CompletionReport" "Amazonka.FSx.Types.CompletionReport" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CompletionReport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReportFormat)) :*: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReportScope)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newCompletionReport

Arguments

:: Bool

$sel:enabled:CompletionReport'

-> CompletionReport

Create a value of CompletionReport with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:format:CompletionReport', completionReport_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.

$sel:path:CompletionReport', completionReport_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://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. To learn more about a file system's ExportPath, see .

$sel:scope:CompletionReport', completionReport_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.

$sel:enabled:CompletionReport', completionReport_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.

completionReport_format :: Lens' CompletionReport (Maybe ReportFormat)

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.

completionReport_path :: Lens' CompletionReport (Maybe Text)

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://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. To learn more about a file system's ExportPath, see .

completionReport_scope :: Lens' CompletionReport (Maybe ReportScope)

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.

completionReport_enabled :: Lens' CompletionReport Bool

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.