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.SnowDeviceManagement.DescribeExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Checks the status of a remote task running on one or more target devices.

Synopsis

data DescribeExecution = DescribeExecution' {
- managedDeviceId :: Text
- taskId :: Text
}
newDescribeExecution :: Text -> Text -> DescribeExecution
describeExecution_managedDeviceId :: Lens' DescribeExecution Text
describeExecution_taskId :: Lens' DescribeExecution Text
data DescribeExecutionResponse = DescribeExecutionResponse' {
- executionId :: Maybe Text
- lastUpdatedAt :: Maybe POSIX
- managedDeviceId :: Maybe Text
- startedAt :: Maybe POSIX
- state :: Maybe ExecutionState
- taskId :: Maybe Text
- httpStatus :: Int
}
newDescribeExecutionResponse :: Int -> DescribeExecutionResponse
describeExecutionResponse_executionId :: Lens' DescribeExecutionResponse (Maybe Text)
describeExecutionResponse_lastUpdatedAt :: Lens' DescribeExecutionResponse (Maybe UTCTime)
describeExecutionResponse_managedDeviceId :: Lens' DescribeExecutionResponse (Maybe Text)
describeExecutionResponse_startedAt :: Lens' DescribeExecutionResponse (Maybe UTCTime)
describeExecutionResponse_state :: Lens' DescribeExecutionResponse (Maybe ExecutionState)
describeExecutionResponse_taskId :: Lens' DescribeExecutionResponse (Maybe Text)
describeExecutionResponse_httpStatus :: Lens' DescribeExecutionResponse Int

Creating a Request

data DescribeExecution Source #

See: newDescribeExecution smart constructor.

Constructors

DescribeExecution'
Fields managedDeviceId :: Text The ID of the managed device. taskId :: Text The ID of the task that the action is describing.

Instances

Instances details

ToJSON DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods toJSON :: DescribeExecution -> Value # toEncoding :: DescribeExecution -> Encoding # toJSONList :: [DescribeExecution] -> Value # toEncodingList :: [DescribeExecution] -> Encoding #
ToHeaders DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods toHeaders :: DescribeExecution -> [Header] #
ToPath DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods toPath :: DescribeExecution -> ByteString #
ToQuery DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods toQuery :: DescribeExecution -> QueryString #
AWSRequest DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Associated Types type AWSResponse DescribeExecution # Methods request :: (Service -> Service) -> DescribeExecution -> Request DescribeExecution # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeExecution))) #
Generic DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Associated Types type Rep DescribeExecution :: Type -> Type # Methods from :: DescribeExecution -> Rep DescribeExecution x # to :: Rep DescribeExecution x -> DescribeExecution #
Read DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods readsPrec :: Int -> ReadS DescribeExecution # readList :: ReadS [DescribeExecution] # readPrec :: ReadPrec DescribeExecution # readListPrec :: ReadPrec [DescribeExecution] #
Show DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods showsPrec :: Int -> DescribeExecution -> ShowS # show :: DescribeExecution -> String # showList :: [DescribeExecution] -> ShowS #
NFData DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods rnf :: DescribeExecution -> () #
Eq DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods (==) :: DescribeExecution -> DescribeExecution -> Bool # (/=) :: DescribeExecution -> DescribeExecution -> Bool #
Hashable DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods hashWithSalt :: Int -> DescribeExecution -> Int # hash :: DescribeExecution -> Int #
type AWSResponse DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution type AWSResponse DescribeExecution = DescribeExecutionResponse
type Rep DescribeExecution Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution type Rep DescribeExecution = D1 ('MetaData "DescribeExecution" "Amazonka.SnowDeviceManagement.DescribeExecution" "amazonka-snow-device-management-2.0-BSOYMJEGkqv86alAaVucXA" 'False) (C1 ('MetaCons "DescribeExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "managedDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeExecution Source #

Arguments

:: Text	`DescribeExecution`
-> Text	`DescribeExecution`
-> DescribeExecution

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

DescribeExecution, describeExecution_managedDeviceId - The ID of the managed device.

DescribeExecution, describeExecution_taskId - The ID of the task that the action is describing.

Request Lenses

describeExecution_managedDeviceId :: Lens' DescribeExecution Text Source #

The ID of the managed device.

describeExecution_taskId :: Lens' DescribeExecution Text Source #

The ID of the task that the action is describing.

Destructuring the Response

data DescribeExecutionResponse Source #

See: newDescribeExecutionResponse smart constructor.

Constructors

DescribeExecutionResponse'

Fields

executionId :: Maybe Text
The ID of the execution.
lastUpdatedAt :: Maybe POSIX
When the status of the execution was last updated.
managedDeviceId :: Maybe Text
The ID of the managed device that the task is being executed on.
startedAt :: Maybe POSIX
When the execution began.
state :: Maybe ExecutionState
The current state of the execution.
taskId :: Maybe Text
The ID of the task being executed on the device.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeExecutionResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Associated Types type Rep DescribeExecutionResponse :: Type -> Type # Methods from :: DescribeExecutionResponse -> Rep DescribeExecutionResponse x # to :: Rep DescribeExecutionResponse x -> DescribeExecutionResponse #
Read DescribeExecutionResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods readsPrec :: Int -> ReadS DescribeExecutionResponse # readList :: ReadS [DescribeExecutionResponse] # readPrec :: ReadPrec DescribeExecutionResponse # readListPrec :: ReadPrec [DescribeExecutionResponse] #
Show DescribeExecutionResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods showsPrec :: Int -> DescribeExecutionResponse -> ShowS # show :: DescribeExecutionResponse -> String # showList :: [DescribeExecutionResponse] -> ShowS #
NFData DescribeExecutionResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods rnf :: DescribeExecutionResponse -> () #
Eq DescribeExecutionResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution Methods (==) :: DescribeExecutionResponse -> DescribeExecutionResponse -> Bool # (/=) :: DescribeExecutionResponse -> DescribeExecutionResponse -> Bool #
type Rep DescribeExecutionResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeExecution type Rep DescribeExecutionResponse = D1 ('MetaData "DescribeExecutionResponse" "Amazonka.SnowDeviceManagement.DescribeExecution" "amazonka-snow-device-management-2.0-BSOYMJEGkqv86alAaVucXA" 'False) (C1 ('MetaCons "DescribeExecutionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "managedDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionState))) :: (S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeExecutionResponse Source #

Arguments

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

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

DescribeExecutionResponse, describeExecutionResponse_executionId - The ID of the execution.

DescribeExecutionResponse, describeExecutionResponse_lastUpdatedAt - When the status of the execution was last updated.

DescribeExecution, describeExecutionResponse_managedDeviceId - The ID of the managed device that the task is being executed on.

$sel:startedAt:DescribeExecutionResponse', describeExecutionResponse_startedAt - When the execution began.

DescribeExecutionResponse, describeExecutionResponse_state - The current state of the execution.

DescribeExecution, describeExecutionResponse_taskId - The ID of the task being executed on the device.

$sel:httpStatus:DescribeExecutionResponse', describeExecutionResponse_httpStatus - The response's http status code.

Response Lenses

describeExecutionResponse_executionId :: Lens' DescribeExecutionResponse (Maybe Text) Source #

The ID of the execution.

describeExecutionResponse_lastUpdatedAt :: Lens' DescribeExecutionResponse (Maybe UTCTime) Source #

When the status of the execution was last updated.

describeExecutionResponse_managedDeviceId :: Lens' DescribeExecutionResponse (Maybe Text) Source #

The ID of the managed device that the task is being executed on.

describeExecutionResponse_startedAt :: Lens' DescribeExecutionResponse (Maybe UTCTime) Source #

When the execution began.

describeExecutionResponse_state :: Lens' DescribeExecutionResponse (Maybe ExecutionState) Source #

The current state of the execution.

describeExecutionResponse_taskId :: Lens' DescribeExecutionResponse (Maybe Text) Source #

The ID of the task being executed on the device.

describeExecutionResponse_httpStatus :: Lens' DescribeExecutionResponse Int Source #

The response's http status code.