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.ECS.SubmitTaskStateChange

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

Synopsis

data SubmitTaskStateChange = SubmitTaskStateChange' {
- attachments :: Maybe [AttachmentStateChange]
- cluster :: Maybe Text
- containers :: Maybe [ContainerStateChange]
- executionStoppedAt :: Maybe POSIX
- managedAgents :: Maybe [ManagedAgentStateChange]
- pullStartedAt :: Maybe POSIX
- pullStoppedAt :: Maybe POSIX
- reason :: Maybe Text
- status :: Maybe Text
- task :: Maybe Text
}
newSubmitTaskStateChange :: SubmitTaskStateChange
submitTaskStateChange_attachments :: Lens' SubmitTaskStateChange (Maybe [AttachmentStateChange])
submitTaskStateChange_cluster :: Lens' SubmitTaskStateChange (Maybe Text)
submitTaskStateChange_containers :: Lens' SubmitTaskStateChange (Maybe [ContainerStateChange])
submitTaskStateChange_executionStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime)
submitTaskStateChange_managedAgents :: Lens' SubmitTaskStateChange (Maybe [ManagedAgentStateChange])
submitTaskStateChange_pullStartedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime)
submitTaskStateChange_pullStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime)
submitTaskStateChange_reason :: Lens' SubmitTaskStateChange (Maybe Text)
submitTaskStateChange_status :: Lens' SubmitTaskStateChange (Maybe Text)
submitTaskStateChange_task :: Lens' SubmitTaskStateChange (Maybe Text)
data SubmitTaskStateChangeResponse = SubmitTaskStateChangeResponse' {
- acknowledgment :: Maybe Text
- httpStatus :: Int
}
newSubmitTaskStateChangeResponse :: Int -> SubmitTaskStateChangeResponse
submitTaskStateChangeResponse_acknowledgment :: Lens' SubmitTaskStateChangeResponse (Maybe Text)
submitTaskStateChangeResponse_httpStatus :: Lens' SubmitTaskStateChangeResponse Int

Creating a Request

data SubmitTaskStateChange Source #

See: newSubmitTaskStateChange smart constructor.

Constructors

SubmitTaskStateChange'

Fields

attachments :: Maybe [AttachmentStateChange]
Any attachments associated with the state change request.
cluster :: Maybe Text
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
containers :: Maybe [ContainerStateChange]
Any containers that's associated with the state change request.
executionStoppedAt :: Maybe POSIX
The Unix timestamp for the time when the task execution stopped.
managedAgents :: Maybe [ManagedAgentStateChange]
The details for the managed agent that's associated with the task.
pullStartedAt :: Maybe POSIX
The Unix timestamp for the time when the container image pull started.
pullStoppedAt :: Maybe POSIX
The Unix timestamp for the time when the container image pull completed.
reason :: Maybe Text
The reason for the state change request.
status :: Maybe Text
The status of the state change request.
task :: Maybe Text
The task ID or full ARN of the task in the state change request.

Instances

Instances details

ToJSON SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods toJSON :: SubmitTaskStateChange -> Value # toEncoding :: SubmitTaskStateChange -> Encoding # toJSONList :: [SubmitTaskStateChange] -> Value # toEncodingList :: [SubmitTaskStateChange] -> Encoding #
ToHeaders SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods toHeaders :: SubmitTaskStateChange -> [Header] #
ToPath SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods toPath :: SubmitTaskStateChange -> ByteString #
ToQuery SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods toQuery :: SubmitTaskStateChange -> QueryString #
AWSRequest SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Associated Types type AWSResponse SubmitTaskStateChange # Methods request :: (Service -> Service) -> SubmitTaskStateChange -> Request SubmitTaskStateChange # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SubmitTaskStateChange -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SubmitTaskStateChange))) #
Generic SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Associated Types type Rep SubmitTaskStateChange :: Type -> Type # Methods from :: SubmitTaskStateChange -> Rep SubmitTaskStateChange x # to :: Rep SubmitTaskStateChange x -> SubmitTaskStateChange #
Read SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods readsPrec :: Int -> ReadS SubmitTaskStateChange # readList :: ReadS [SubmitTaskStateChange] # readPrec :: ReadPrec SubmitTaskStateChange # readListPrec :: ReadPrec [SubmitTaskStateChange] #
Show SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods showsPrec :: Int -> SubmitTaskStateChange -> ShowS # show :: SubmitTaskStateChange -> String # showList :: [SubmitTaskStateChange] -> ShowS #
NFData SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods rnf :: SubmitTaskStateChange -> () #
Eq SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods (==) :: SubmitTaskStateChange -> SubmitTaskStateChange -> Bool # (/=) :: SubmitTaskStateChange -> SubmitTaskStateChange -> Bool #
Hashable SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods hashWithSalt :: Int -> SubmitTaskStateChange -> Int # hash :: SubmitTaskStateChange -> Int #
type AWSResponse SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange type AWSResponse SubmitTaskStateChange = SubmitTaskStateChangeResponse
type Rep SubmitTaskStateChange Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange type Rep SubmitTaskStateChange = D1 ('MetaData "SubmitTaskStateChange" "Amazonka.ECS.SubmitTaskStateChange" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "SubmitTaskStateChange'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttachmentStateChange])) :: S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "containers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContainerStateChange])) :: (S1 ('MetaSel ('Just "executionStoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "managedAgents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ManagedAgentStateChange]))))) :: ((S1 ('MetaSel ('Just "pullStartedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "pullStoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newSubmitTaskStateChange :: SubmitTaskStateChange Source #

Create a value of SubmitTaskStateChange 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:

SubmitTaskStateChange, submitTaskStateChange_attachments - Any attachments associated with the state change request.

$sel:cluster:SubmitTaskStateChange', submitTaskStateChange_cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

SubmitTaskStateChange, submitTaskStateChange_containers - Any containers that's associated with the state change request.

SubmitTaskStateChange, submitTaskStateChange_executionStoppedAt - The Unix timestamp for the time when the task execution stopped.

SubmitTaskStateChange, submitTaskStateChange_managedAgents - The details for the managed agent that's associated with the task.

SubmitTaskStateChange, submitTaskStateChange_pullStartedAt - The Unix timestamp for the time when the container image pull started.

SubmitTaskStateChange, submitTaskStateChange_pullStoppedAt - The Unix timestamp for the time when the container image pull completed.

SubmitTaskStateChange, submitTaskStateChange_reason - The reason for the state change request.

SubmitTaskStateChange, submitTaskStateChange_status - The status of the state change request.

$sel:task:SubmitTaskStateChange', submitTaskStateChange_task - The task ID or full ARN of the task in the state change request.

Request Lenses

submitTaskStateChange_attachments :: Lens' SubmitTaskStateChange (Maybe [AttachmentStateChange]) Source #

Any attachments associated with the state change request.

submitTaskStateChange_cluster :: Lens' SubmitTaskStateChange (Maybe Text) Source #

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

submitTaskStateChange_containers :: Lens' SubmitTaskStateChange (Maybe [ContainerStateChange]) Source #

Any containers that's associated with the state change request.

submitTaskStateChange_executionStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime) Source #

The Unix timestamp for the time when the task execution stopped.

submitTaskStateChange_managedAgents :: Lens' SubmitTaskStateChange (Maybe [ManagedAgentStateChange]) Source #

The details for the managed agent that's associated with the task.

submitTaskStateChange_pullStartedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime) Source #

The Unix timestamp for the time when the container image pull started.

submitTaskStateChange_pullStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime) Source #

The Unix timestamp for the time when the container image pull completed.

submitTaskStateChange_reason :: Lens' SubmitTaskStateChange (Maybe Text) Source #

The reason for the state change request.

submitTaskStateChange_status :: Lens' SubmitTaskStateChange (Maybe Text) Source #

The status of the state change request.

submitTaskStateChange_task :: Lens' SubmitTaskStateChange (Maybe Text) Source #

The task ID or full ARN of the task in the state change request.

Destructuring the Response

data SubmitTaskStateChangeResponse Source #

See: newSubmitTaskStateChangeResponse smart constructor.

Constructors

SubmitTaskStateChangeResponse'
Fields acknowledgment :: Maybe Text Acknowledgement of the state change. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SubmitTaskStateChangeResponse Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Associated Types type Rep SubmitTaskStateChangeResponse :: Type -> Type # Methods from :: SubmitTaskStateChangeResponse -> Rep SubmitTaskStateChangeResponse x # to :: Rep SubmitTaskStateChangeResponse x -> SubmitTaskStateChangeResponse #
Read SubmitTaskStateChangeResponse Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods readsPrec :: Int -> ReadS SubmitTaskStateChangeResponse # readList :: ReadS [SubmitTaskStateChangeResponse] # readPrec :: ReadPrec SubmitTaskStateChangeResponse # readListPrec :: ReadPrec [SubmitTaskStateChangeResponse] #
Show SubmitTaskStateChangeResponse Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods showsPrec :: Int -> SubmitTaskStateChangeResponse -> ShowS # show :: SubmitTaskStateChangeResponse -> String # showList :: [SubmitTaskStateChangeResponse] -> ShowS #
NFData SubmitTaskStateChangeResponse Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods rnf :: SubmitTaskStateChangeResponse -> () #
Eq SubmitTaskStateChangeResponse Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange Methods (==) :: SubmitTaskStateChangeResponse -> SubmitTaskStateChangeResponse -> Bool # (/=) :: SubmitTaskStateChangeResponse -> SubmitTaskStateChangeResponse -> Bool #
type Rep SubmitTaskStateChangeResponse Source #
Instance details Defined in Amazonka.ECS.SubmitTaskStateChange type Rep SubmitTaskStateChangeResponse = D1 ('MetaData "SubmitTaskStateChangeResponse" "Amazonka.ECS.SubmitTaskStateChange" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "SubmitTaskStateChangeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "acknowledgment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSubmitTaskStateChangeResponse Source #

Arguments

:: Int	`$sel:httpStatus:SubmitTaskStateChangeResponse'`
-> SubmitTaskStateChangeResponse

Create a value of SubmitTaskStateChangeResponse 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:acknowledgment:SubmitTaskStateChangeResponse', submitTaskStateChangeResponse_acknowledgment - Acknowledgement of the state change.

$sel:httpStatus:SubmitTaskStateChangeResponse', submitTaskStateChangeResponse_httpStatus - The response's http status code.

Response Lenses

submitTaskStateChangeResponse_acknowledgment :: Lens' SubmitTaskStateChangeResponse (Maybe Text) Source #

Acknowledgement of the state change.

submitTaskStateChangeResponse_httpStatus :: Lens' SubmitTaskStateChangeResponse Int Source #

The response's http status code.