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.IoT.StartThingRegistrationTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a bulk thing provisioning task.

Requires permission to access the StartThingRegistrationTask action.

Synopsis

Creating a Request

data StartThingRegistrationTask Source #

See: newStartThingRegistrationTask smart constructor.

Constructors

StartThingRegistrationTask'
Fields templateBody :: Text The provisioning template. inputFileBucket :: Text The S3 bucket that contains the input file. inputFileKey :: Text The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing). roleArn :: Text The IAM role ARN that grants permission the input file.

Instances

Instances details

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

newStartThingRegistrationTask Source #

Arguments

:: Text	`StartThingRegistrationTask`
-> Text	`$sel:inputFileBucket:StartThingRegistrationTask'`
-> Text	`$sel:inputFileKey:StartThingRegistrationTask'`
-> Text	`StartThingRegistrationTask`
-> StartThingRegistrationTask

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

StartThingRegistrationTask, startThingRegistrationTask_templateBody - The provisioning template.

$sel:inputFileBucket:StartThingRegistrationTask', startThingRegistrationTask_inputFileBucket - The S3 bucket that contains the input file.

$sel:inputFileKey:StartThingRegistrationTask', startThingRegistrationTask_inputFileKey - The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).

StartThingRegistrationTask, startThingRegistrationTask_roleArn - The IAM role ARN that grants permission the input file.

Request Lenses

startThingRegistrationTask_templateBody :: Lens' StartThingRegistrationTask Text Source #

The provisioning template.

startThingRegistrationTask_inputFileBucket :: Lens' StartThingRegistrationTask Text Source #

The S3 bucket that contains the input file.

startThingRegistrationTask_inputFileKey :: Lens' StartThingRegistrationTask Text Source #

The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).

startThingRegistrationTask_roleArn :: Lens' StartThingRegistrationTask Text Source #

The IAM role ARN that grants permission the input file.

Destructuring the Response

data StartThingRegistrationTaskResponse Source #

See: newStartThingRegistrationTaskResponse smart constructor.

Constructors

StartThingRegistrationTaskResponse'
Fields taskId :: Maybe Text The bulk thing provisioning task ID. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartThingRegistrationTaskResponse Source #

Arguments

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

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

StartThingRegistrationTaskResponse, startThingRegistrationTaskResponse_taskId - The bulk thing provisioning task ID.

$sel:httpStatus:StartThingRegistrationTaskResponse', startThingRegistrationTaskResponse_httpStatus - The response's http status code.

Response Lenses

startThingRegistrationTaskResponse_taskId :: Lens' StartThingRegistrationTaskResponse (Maybe Text) Source #

The bulk thing provisioning task ID.

startThingRegistrationTaskResponse_httpStatus :: Lens' StartThingRegistrationTaskResponse Int Source #

The response's http status code.