Amazonka.SnowDeviceManagement.DescribeTask

Checks the metadata for a given task on a device.

Creating a Request

data DescribeTask

See: newDescribeTask smart constructor.

Constructors

DescribeTask'

Fields

• taskId :: Text

  The ID of the task to be described.

Instances

ToJSON DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

toJSON :: DescribeTask -> Value

toEncoding :: DescribeTask -> Encoding

toJSONList :: [DescribeTask] -> Value

toEncodingList :: [DescribeTask] -> Encoding

ToHeaders DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

toHeaders :: DescribeTask -> [Header]

ToPath DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

toPath :: DescribeTask -> ByteString

ToQuery DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

toQuery :: DescribeTask -> QueryString

AWSRequest DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Associated Types

type AWSResponse DescribeTask

Methods

request :: (Service -> Service) -> DescribeTask -> Request DescribeTask

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTask)))

Generic DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Associated Types

type Rep DescribeTask :: Type -> Type

Methods

from :: DescribeTask -> Rep DescribeTask x

to :: Rep DescribeTask x -> DescribeTask

Read DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

readsPrec :: Int -> ReadS DescribeTask

readList :: ReadS [DescribeTask]

readPrec :: ReadPrec DescribeTask

readListPrec :: ReadPrec [DescribeTask]

Show DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

showsPrec :: Int -> DescribeTask -> ShowS

show :: DescribeTask -> String

showList :: [DescribeTask] -> ShowS

NFData DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

rnf :: DescribeTask -> ()

Eq DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

(==) :: DescribeTask -> DescribeTask -> Bool

(/=) :: DescribeTask -> DescribeTask -> Bool

Hashable DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

hashWithSalt :: Int -> DescribeTask -> Int

hash :: DescribeTask -> Int

type AWSResponse DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

type AWSResponse DescribeTask = DescribeTaskResponse

type Rep DescribeTask

Defined in Amazonka.SnowDeviceManagement.DescribeTask

type Rep DescribeTask = D1 ('MetaData "DescribeTask" "Amazonka.SnowDeviceManagement.DescribeTask" "amazonka-snow-device-management-2.0-BSOYMJEGkqv86alAaVucXA" 'False) (C1 ('MetaCons "DescribeTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeTask

Arguments

:: Text

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:

DescribeTask, describeTask_taskId - The ID of the task to be described.

Request Lenses

describeTask_taskId :: Lens' DescribeTask Text

The ID of the task to be described.

Destructuring the Response

data DescribeTaskResponse

See: newDescribeTaskResponse smart constructor.

Constructors

DescribeTaskResponse'

Fields

• completedAt :: Maybe POSIX

  When the task was completed.

• createdAt :: Maybe POSIX

  When the CreateTask operation was called.

• description :: Maybe Text

  The description provided of the task and managed devices.

• lastUpdatedAt :: Maybe POSIX

  When the state of the task was last updated.

• state :: Maybe TaskState

  The current state of the task.

• 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.

• targets :: Maybe (NonEmpty Text)

  The managed devices that the task was sent to.

• taskArn :: Maybe Text

  The Amazon Resource Name (ARN) of the task.

• taskId :: Maybe Text

  The ID of the task.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeTaskResponse

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Associated Types

type Rep DescribeTaskResponse :: Type -> Type

Methods

from :: DescribeTaskResponse -> Rep DescribeTaskResponse x

to :: Rep DescribeTaskResponse x -> DescribeTaskResponse

Read DescribeTaskResponse

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

readsPrec :: Int -> ReadS DescribeTaskResponse

readList :: ReadS [DescribeTaskResponse]

readPrec :: ReadPrec DescribeTaskResponse

readListPrec :: ReadPrec [DescribeTaskResponse]

Show DescribeTaskResponse

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

showsPrec :: Int -> DescribeTaskResponse -> ShowS

show :: DescribeTaskResponse -> String

showList :: [DescribeTaskResponse] -> ShowS

NFData DescribeTaskResponse

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

rnf :: DescribeTaskResponse -> ()

Eq DescribeTaskResponse

Defined in Amazonka.SnowDeviceManagement.DescribeTask

Methods

(==) :: DescribeTaskResponse -> DescribeTaskResponse -> Bool

(/=) :: DescribeTaskResponse -> DescribeTaskResponse -> Bool

type Rep DescribeTaskResponse

Defined in Amazonka.SnowDeviceManagement.DescribeTask

type Rep DescribeTaskResponse = D1 ('MetaData "DescribeTaskResponse" "Amazonka.SnowDeviceManagement.DescribeTask" "amazonka-snow-device-management-2.0-BSOYMJEGkqv86alAaVucXA" 'False) (C1 ('MetaCons "DescribeTaskResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "completedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskState))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeTaskResponse

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:completedAt:DescribeTaskResponse', describeTaskResponse_completedAt - When the task was completed.

DescribeTaskResponse, describeTaskResponse_createdAt - When the CreateTask operation was called.

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

DescribeTaskResponse, describeTaskResponse_lastUpdatedAt - When the state of the task was last updated.

DescribeTaskResponse, describeTaskResponse_state - The current state of the task.

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:targets:DescribeTaskResponse', describeTaskResponse_targets - The managed devices that the task was sent to.

DescribeTaskResponse, describeTaskResponse_taskArn - The Amazon Resource Name (ARN) of the task.

DescribeTask, describeTaskResponse_taskId - The ID of the task.

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

Response Lenses

describeTaskResponse_completedAt :: Lens' DescribeTaskResponse (Maybe UTCTime)

When the task was completed.

describeTaskResponse_createdAt :: Lens' DescribeTaskResponse (Maybe UTCTime)

When the CreateTask operation was called.

describeTaskResponse_description :: Lens' DescribeTaskResponse (Maybe Text)

The description provided of the task and managed devices.

describeTaskResponse_lastUpdatedAt :: Lens' DescribeTaskResponse (Maybe UTCTime)

When the state of the task was last updated.

describeTaskResponse_state :: Lens' DescribeTaskResponse (Maybe TaskState)

The current state of the task.

describeTaskResponse_tags :: Lens' DescribeTaskResponse (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.

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

The managed devices that the task was sent to.

describeTaskResponse_taskArn :: Lens' DescribeTaskResponse (Maybe Text)

The Amazon Resource Name (ARN) of the task.

describeTaskResponse_taskId :: Lens' DescribeTaskResponse (Maybe Text)

The ID of the task.

describeTaskResponse_httpStatus :: Lens' DescribeTaskResponse Int

The response's http status code.