Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transfer.Types.ExecutionError

Description

Synopsis

data ExecutionError = ExecutionError' {
- type' :: ExecutionErrorType
- message :: Text
}
newExecutionError :: ExecutionErrorType -> Text -> ExecutionError
executionError_type :: Lens' ExecutionError ExecutionErrorType
executionError_message :: Lens' ExecutionError Text

Documentation

data ExecutionError Source #

Specifies the error message and type, for an error that occurs during the execution of the workflow.

See: newExecutionError smart constructor.

Constructors

ExecutionError'

Fields

type' :: ExecutionErrorType
Specifies the error type.
- ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.
- BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.
- CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.
- INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.
- NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.
- PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.
- TIMEOUT: occurs when the execution times out.
  You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).
- THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.
message :: Text
Specifies the descriptive message that corresponds to the ErrorType.

Instances

Instances details

FromJSON ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods parseJSON :: Value -> Parser ExecutionError # parseJSONList :: Value -> Parser [ExecutionError] #
Generic ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Associated Types type Rep ExecutionError :: Type -> Type # Methods from :: ExecutionError -> Rep ExecutionError x # to :: Rep ExecutionError x -> ExecutionError #
Read ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods readsPrec :: Int -> ReadS ExecutionError # readList :: ReadS [ExecutionError] # readPrec :: ReadPrec ExecutionError # readListPrec :: ReadPrec [ExecutionError] #
Show ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods showsPrec :: Int -> ExecutionError -> ShowS # show :: ExecutionError -> String # showList :: [ExecutionError] -> ShowS #
NFData ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods rnf :: ExecutionError -> () #
Eq ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods (==) :: ExecutionError -> ExecutionError -> Bool # (/=) :: ExecutionError -> ExecutionError -> Bool #
Hashable ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods hashWithSalt :: Int -> ExecutionError -> Int # hash :: ExecutionError -> Int #
type Rep ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError type Rep ExecutionError = D1 ('MetaData "ExecutionError" "Amazonka.Transfer.Types.ExecutionError" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ExecutionError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExecutionErrorType) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newExecutionError Source #

Arguments

:: ExecutionErrorType	`$sel:type':ExecutionError'`
-> Text	`$sel:message:ExecutionError'`
-> ExecutionError

Create a value of ExecutionError 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:type':ExecutionError', executionError_type - Specifies the error type.

ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.
BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.
CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.
INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.
NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.
PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.
TIMEOUT: occurs when the execution times out.
You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).
THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

$sel:message:ExecutionError', executionError_message - Specifies the descriptive message that corresponds to the ErrorType.

executionError_type :: Lens' ExecutionError ExecutionErrorType Source #

Specifies the error type.

ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.
BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.
CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.
INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.
NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.
PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.
TIMEOUT: occurs when the execution times out.
You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).
THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

executionError_message :: Lens' ExecutionError Text Source #

Specifies the descriptive message that corresponds to the ErrorType.