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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Instructs one or more devices to start a task, such as unlocking or rebooting.

Synopsis

data CreateTask = CreateTask' {
- clientToken :: Maybe Text
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- command :: Command
- targets :: NonEmpty Text
}
newCreateTask :: Command -> NonEmpty Text -> CreateTask
createTask_clientToken :: Lens' CreateTask (Maybe Text)
createTask_description :: Lens' CreateTask (Maybe Text)
createTask_tags :: Lens' CreateTask (Maybe (HashMap Text Text))
createTask_command :: Lens' CreateTask Command
createTask_targets :: Lens' CreateTask (NonEmpty Text)
data CreateTaskResponse = CreateTaskResponse' {
- taskArn :: Maybe Text
- taskId :: Maybe Text
- httpStatus :: Int
}
newCreateTaskResponse :: Int -> CreateTaskResponse
createTaskResponse_taskArn :: Lens' CreateTaskResponse (Maybe Text)
createTaskResponse_taskId :: Lens' CreateTaskResponse (Maybe Text)
createTaskResponse_httpStatus :: Lens' CreateTaskResponse Int

Creating a Request

data CreateTask Source #

See: newCreateTask smart constructor.

Constructors

CreateTask'

Fields

clientToken :: Maybe Text
A token ensuring that the action is called only once with the specified details.
description :: Maybe Text
A description of the task and its targets.
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.
command :: Command
The task to be performed. Only one task is executed on a device at a time.
targets :: NonEmpty Text
A list of managed device IDs.

Instances

Instances details

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

newCreateTask Source #

Arguments

:: Command	`$sel:command:CreateTask'`
-> NonEmpty Text	`$sel:targets:CreateTask'`
-> CreateTask

Create a value of CreateTask 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:clientToken:CreateTask', createTask_clientToken - A token ensuring that the action is called only once with the specified details.

$sel:description:CreateTask', createTask_description - A description of the task and its targets.

CreateTask, createTask_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:command:CreateTask', createTask_command - The task to be performed. Only one task is executed on a device at a time.

$sel:targets:CreateTask', createTask_targets - A list of managed device IDs.

Request Lenses

createTask_clientToken :: Lens' CreateTask (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

createTask_description :: Lens' CreateTask (Maybe Text) Source #

A description of the task and its targets.

createTask_tags :: Lens' CreateTask (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.

createTask_command :: Lens' CreateTask Command Source #

The task to be performed. Only one task is executed on a device at a time.

createTask_targets :: Lens' CreateTask (NonEmpty Text) Source #

A list of managed device IDs.

Destructuring the Response

data CreateTaskResponse Source #

See: newCreateTaskResponse smart constructor.

Constructors

CreateTaskResponse'
Fields taskArn :: Maybe Text The Amazon Resource Name (ARN) of the task that you created. taskId :: Maybe Text The ID of the task that you created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.CreateTask Associated Types type Rep CreateTaskResponse :: Type -> Type # Methods from :: CreateTaskResponse -> Rep CreateTaskResponse x # to :: Rep CreateTaskResponse x -> CreateTaskResponse #
Read CreateTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.CreateTask Methods readsPrec :: Int -> ReadS CreateTaskResponse # readList :: ReadS [CreateTaskResponse] # readPrec :: ReadPrec CreateTaskResponse # readListPrec :: ReadPrec [CreateTaskResponse] #
Show CreateTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.CreateTask Methods showsPrec :: Int -> CreateTaskResponse -> ShowS # show :: CreateTaskResponse -> String # showList :: [CreateTaskResponse] -> ShowS #
NFData CreateTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.CreateTask Methods rnf :: CreateTaskResponse -> () #
Eq CreateTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.CreateTask Methods (==) :: CreateTaskResponse -> CreateTaskResponse -> Bool # (/=) :: CreateTaskResponse -> CreateTaskResponse -> Bool #
type Rep CreateTaskResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.CreateTask type Rep CreateTaskResponse = D1 ('MetaData "CreateTaskResponse" "Amazonka.SnowDeviceManagement.CreateTask" "amazonka-snow-device-management-2.0-BSOYMJEGkqv86alAaVucXA" 'False) (C1 ('MetaCons "CreateTaskResponse'" 'PrefixI 'True) (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))))

newCreateTaskResponse Source #

Arguments

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

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

CreateTaskResponse, createTaskResponse_taskArn - The Amazon Resource Name (ARN) of the task that you created.

CreateTaskResponse, createTaskResponse_taskId - The ID of the task that you created.

$sel:httpStatus:CreateTaskResponse', createTaskResponse_httpStatus - The response's http status code.

Response Lenses

createTaskResponse_taskArn :: Lens' CreateTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task that you created.

createTaskResponse_taskId :: Lens' CreateTaskResponse (Maybe Text) Source #

The ID of the task that you created.

createTaskResponse_httpStatus :: Lens' CreateTaskResponse Int Source #

The response's http status code.