Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Amplify.Types.Step

Description

Synopsis

data Step = Step' {
- logUrl :: Maybe Text
- context :: Maybe Text
- testArtifactsUrl :: Maybe Text
- artifactsUrl :: Maybe Text
- testConfigUrl :: Maybe Text
- screenshots :: Maybe (HashMap Text Text)
- statusReason :: Maybe Text
- stepName :: Text
- startTime :: POSIX
- status :: JobStatus
- endTime :: POSIX
}
newStep :: Text -> UTCTime -> JobStatus -> UTCTime -> Step
step_logUrl :: Lens' Step (Maybe Text)
step_context :: Lens' Step (Maybe Text)
step_testArtifactsUrl :: Lens' Step (Maybe Text)
step_artifactsUrl :: Lens' Step (Maybe Text)
step_testConfigUrl :: Lens' Step (Maybe Text)
step_screenshots :: Lens' Step (Maybe (HashMap Text Text))
step_statusReason :: Lens' Step (Maybe Text)
step_stepName :: Lens' Step Text
step_startTime :: Lens' Step UTCTime
step_status :: Lens' Step JobStatus
step_endTime :: Lens' Step UTCTime

Documentation

data Step Source #

Describes an execution step, for an execution job, for an Amplify app.

See: newStep smart constructor.

Constructors

Step'

Fields

logUrl :: Maybe Text
The URL to the logs for the execution step.
context :: Maybe Text
The context for the current step. Includes a build image if the step is build.
testArtifactsUrl :: Maybe Text
The URL to the test artifact for the execution step.
artifactsUrl :: Maybe Text
The URL to the artifact for the execution step.
testConfigUrl :: Maybe Text
The URL to the test configuration for the execution step.
screenshots :: Maybe (HashMap Text Text)
The list of screenshot URLs for the execution step, if relevant.
statusReason :: Maybe Text
The reason for the current step status.
stepName :: Text
The name of the execution step.
startTime :: POSIX
The start date and time of the execution step.
status :: JobStatus
The status of the execution step.
endTime :: POSIX
The end date and time of the execution step.

Instances

Instances details

Eq Step Source #
Instance details Defined in Amazonka.Amplify.Types.Step Methods (==) :: Step -> Step -> Bool # (/=) :: Step -> Step -> Bool #
Read Step Source #
Instance details Defined in Amazonka.Amplify.Types.Step Methods readsPrec :: Int -> ReadS Step # readList :: ReadS [Step] # readPrec :: ReadPrec Step # readListPrec :: ReadPrec [Step] #
Show Step Source #
Instance details Defined in Amazonka.Amplify.Types.Step Methods showsPrec :: Int -> Step -> ShowS # show :: Step -> String # showList :: [Step] -> ShowS #
Generic Step Source #
Instance details Defined in Amazonka.Amplify.Types.Step Associated Types type Rep Step :: Type -> Type # Methods from :: Step -> Rep Step x # to :: Rep Step x -> Step #
NFData Step Source #
Instance details Defined in Amazonka.Amplify.Types.Step Methods rnf :: Step -> () #
Hashable Step Source #
Instance details Defined in Amazonka.Amplify.Types.Step Methods hashWithSalt :: Int -> Step -> Int # hash :: Step -> Int #
FromJSON Step Source #
Instance details Defined in Amazonka.Amplify.Types.Step Methods parseJSON :: Value -> Parser Step # parseJSONList :: Value -> Parser [Step] #
type Rep Step Source #
Instance details Defined in Amazonka.Amplify.Types.Step type Rep Step = D1 ('MetaData "Step" "Amazonka.Amplify.Types.Step" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "Step'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "logUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "testArtifactsUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "artifactsUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "testConfigUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "screenshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stepName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobStatus) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newStep Source #

Arguments

:: Text	`$sel:stepName:Step'`
-> UTCTime	`$sel:startTime:Step'`
-> JobStatus	`$sel:status:Step'`
-> UTCTime	`$sel:endTime:Step'`
-> Step

Create a value of Step 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:logUrl:Step', step_logUrl - The URL to the logs for the execution step.

$sel:context:Step', step_context - The context for the current step. Includes a build image if the step is build.

$sel:testArtifactsUrl:Step', step_testArtifactsUrl - The URL to the test artifact for the execution step.

$sel:artifactsUrl:Step', step_artifactsUrl - The URL to the artifact for the execution step.

$sel:testConfigUrl:Step', step_testConfigUrl - The URL to the test configuration for the execution step.

$sel:screenshots:Step', step_screenshots - The list of screenshot URLs for the execution step, if relevant.

$sel:statusReason:Step', step_statusReason - The reason for the current step status.

$sel:stepName:Step', step_stepName - The name of the execution step.

$sel:startTime:Step', step_startTime - The start date and time of the execution step.

$sel:status:Step', step_status - The status of the execution step.

$sel:endTime:Step', step_endTime - The end date and time of the execution step.

step_logUrl :: Lens' Step (Maybe Text) Source #

The URL to the logs for the execution step.

step_context :: Lens' Step (Maybe Text) Source #

The context for the current step. Includes a build image if the step is build.

step_testArtifactsUrl :: Lens' Step (Maybe Text) Source #

The URL to the test artifact for the execution step.

step_artifactsUrl :: Lens' Step (Maybe Text) Source #

The URL to the artifact for the execution step.

step_testConfigUrl :: Lens' Step (Maybe Text) Source #

The URL to the test configuration for the execution step.

step_screenshots :: Lens' Step (Maybe (HashMap Text Text)) Source #

The list of screenshot URLs for the execution step, if relevant.

step_statusReason :: Lens' Step (Maybe Text) Source #

The reason for the current step status.

step_stepName :: Lens' Step Text Source #

The name of the execution step.

step_startTime :: Lens' Step UTCTime Source #

The start date and time of the execution step.

step_status :: Lens' Step JobStatus Source #

The status of the execution step.

step_endTime :: Lens' Step UTCTime Source #

The end date and time of the execution step.