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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Checks the metadata for a given task on a device.

Synopsis

data DescribeTask = DescribeTask' {
- taskId :: Text
}
newDescribeTask :: Text -> DescribeTask
describeTask_taskId :: Lens' DescribeTask Text
data DescribeTaskResponse = DescribeTaskResponse' {
- state :: Maybe TaskState
- lastUpdatedAt :: Maybe POSIX
- createdAt :: Maybe POSIX
- taskId :: Maybe Text
- taskArn :: Maybe Text
- targets :: Maybe (NonEmpty Text)
- completedAt :: Maybe POSIX
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newDescribeTaskResponse :: Int -> DescribeTaskResponse
describeTaskResponse_state :: Lens' DescribeTaskResponse (Maybe TaskState)
describeTaskResponse_lastUpdatedAt :: Lens' DescribeTaskResponse (Maybe UTCTime)
describeTaskResponse_createdAt :: Lens' DescribeTaskResponse (Maybe UTCTime)
describeTaskResponse_taskId :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_taskArn :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_targets :: Lens' DescribeTaskResponse (Maybe (NonEmpty Text))
describeTaskResponse_completedAt :: Lens' DescribeTaskResponse (Maybe UTCTime)
describeTaskResponse_description :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_tags :: Lens' DescribeTaskResponse (Maybe (HashMap Text Text))
describeTaskResponse_httpStatus :: Lens' DescribeTaskResponse Int

Creating a Request

data DescribeTask Source #

See: newDescribeTask smart constructor.

Constructors

DescribeTask'
Fields taskId :: Text The ID of the task to be described.

Instances

Instances details

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

newDescribeTask Source #

Arguments

:: Text	`$sel:taskId:DescribeTask'`
-> DescribeTask

Create a value of DescribeTask 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:taskId:DescribeTask', describeTask_taskId - The ID of the task to be described.

Request Lenses

describeTask_taskId :: Lens' DescribeTask Text Source #

The ID of the task to be described.

Destructuring the Response

data DescribeTaskResponse Source #

See: newDescribeTaskResponse smart constructor.

Constructors

DescribeTaskResponse'

Fields

state :: Maybe TaskState
The current state of the task.
lastUpdatedAt :: Maybe POSIX
When the state of the task was last updated.
createdAt :: Maybe POSIX
When the CreateTask operation was called.
taskId :: Maybe Text
The ID of the task.
taskArn :: Maybe Text
The Amazon Resource Name (ARN) of the task.
targets :: Maybe (NonEmpty Text)
The managed devices that the task was sent to.
completedAt :: Maybe POSIX
When the task was completed.
description :: Maybe Text
The description provided of the task and managed devices.
tags :: Maybe (HashMap Text Text)
Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeTask Methods (==) :: DescribeTaskResponse -> DescribeTaskResponse -> Bool # (/=) :: DescribeTaskResponse -> DescribeTaskResponse -> Bool #
Read DescribeTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeTask Methods readsPrec :: Int -> ReadS DescribeTaskResponse # readList :: ReadS [DescribeTaskResponse] # readPrec :: ReadPrec DescribeTaskResponse # readListPrec :: ReadPrec [DescribeTaskResponse] #
Show DescribeTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeTask Methods showsPrec :: Int -> DescribeTaskResponse -> ShowS # show :: DescribeTaskResponse -> String # showList :: [DescribeTaskResponse] -> ShowS #
Generic DescribeTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeTask Associated Types type Rep DescribeTaskResponse :: Type -> Type # Methods from :: DescribeTaskResponse -> Rep DescribeTaskResponse x # to :: Rep DescribeTaskResponse x -> DescribeTaskResponse #
NFData DescribeTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeTask Methods rnf :: DescribeTaskResponse -> () #
type Rep DescribeTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeTask type Rep DescribeTaskResponse = D1 ('MetaData "DescribeTaskResponse" "Amazonka.SnowDeviceManagement.DescribeTask" "libZSservicesZSamazonka-snow-device-managementZSamazonka-snow-device-management" 'False) (C1 ('MetaCons "DescribeTaskResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskState)) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "completedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeTaskResponse Source #

Arguments

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

Create a value of DescribeTaskResponse 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:state:DescribeTaskResponse', describeTaskResponse_state - The current state of the task.

$sel:lastUpdatedAt:DescribeTaskResponse', describeTaskResponse_lastUpdatedAt - When the state of the task was last updated.

$sel:createdAt:DescribeTaskResponse', describeTaskResponse_createdAt - When the CreateTask operation was called.

$sel:taskId:DescribeTask', describeTaskResponse_taskId - The ID of the task.

$sel:taskArn:DescribeTaskResponse', describeTaskResponse_taskArn - The Amazon Resource Name (ARN) of the task.

$sel:targets:DescribeTaskResponse', describeTaskResponse_targets - The managed devices that the task was sent to.

$sel:completedAt:DescribeTaskResponse', describeTaskResponse_completedAt - When the task was completed.

$sel:description:DescribeTaskResponse', describeTaskResponse_description - The description provided of the task and managed devices.

$sel:tags:DescribeTaskResponse', describeTaskResponse_tags - Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

$sel:httpStatus:DescribeTaskResponse', describeTaskResponse_httpStatus - The response's http status code.

Response Lenses

describeTaskResponse_state :: Lens' DescribeTaskResponse (Maybe TaskState) Source #

The current state of the task.

describeTaskResponse_lastUpdatedAt :: Lens' DescribeTaskResponse (Maybe UTCTime) Source #

When the state of the task was last updated.

describeTaskResponse_createdAt :: Lens' DescribeTaskResponse (Maybe UTCTime) Source #

When the CreateTask operation was called.

describeTaskResponse_taskId :: Lens' DescribeTaskResponse (Maybe Text) Source #

The ID of the task.

describeTaskResponse_taskArn :: Lens' DescribeTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task.

describeTaskResponse_targets :: Lens' DescribeTaskResponse (Maybe (NonEmpty Text)) Source #

The managed devices that the task was sent to.

describeTaskResponse_completedAt :: Lens' DescribeTaskResponse (Maybe UTCTime) Source #

When the task was completed.

describeTaskResponse_description :: Lens' DescribeTaskResponse (Maybe Text) Source #

The description provided of the task and managed devices.

describeTaskResponse_tags :: Lens' DescribeTaskResponse (Maybe (HashMap Text Text)) Source #

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

describeTaskResponse_httpStatus :: Lens' DescribeTaskResponse Int Source #

The response's http status code.