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 |
Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
Synopsis
- data DescribeThingRegistrationTask = DescribeThingRegistrationTask' {}
- newDescribeThingRegistrationTask :: Text -> DescribeThingRegistrationTask
- describeThingRegistrationTask_taskId :: Lens' DescribeThingRegistrationTask Text
- data DescribeThingRegistrationTaskResponse = DescribeThingRegistrationTaskResponse' {
- status :: Maybe TaskStatus
- lastModifiedDate :: Maybe POSIX
- inputFileKey :: Maybe Text
- taskId :: Maybe Text
- creationDate :: Maybe POSIX
- percentageProgress :: Maybe Natural
- templateBody :: Maybe Text
- successCount :: Maybe Int
- message :: Maybe Text
- failureCount :: Maybe Int
- inputFileBucket :: Maybe Text
- roleArn :: Maybe Text
- httpStatus :: Int
- newDescribeThingRegistrationTaskResponse :: Int -> DescribeThingRegistrationTaskResponse
- describeThingRegistrationTaskResponse_status :: Lens' DescribeThingRegistrationTaskResponse (Maybe TaskStatus)
- describeThingRegistrationTaskResponse_lastModifiedDate :: Lens' DescribeThingRegistrationTaskResponse (Maybe UTCTime)
- describeThingRegistrationTaskResponse_inputFileKey :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)
- describeThingRegistrationTaskResponse_taskId :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)
- describeThingRegistrationTaskResponse_creationDate :: Lens' DescribeThingRegistrationTaskResponse (Maybe UTCTime)
- describeThingRegistrationTaskResponse_percentageProgress :: Lens' DescribeThingRegistrationTaskResponse (Maybe Natural)
- describeThingRegistrationTaskResponse_templateBody :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)
- describeThingRegistrationTaskResponse_successCount :: Lens' DescribeThingRegistrationTaskResponse (Maybe Int)
- describeThingRegistrationTaskResponse_message :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)
- describeThingRegistrationTaskResponse_failureCount :: Lens' DescribeThingRegistrationTaskResponse (Maybe Int)
- describeThingRegistrationTaskResponse_inputFileBucket :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)
- describeThingRegistrationTaskResponse_roleArn :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)
- describeThingRegistrationTaskResponse_httpStatus :: Lens' DescribeThingRegistrationTaskResponse Int
Creating a Request
data DescribeThingRegistrationTask Source #
See: newDescribeThingRegistrationTask
smart constructor.
Instances
newDescribeThingRegistrationTask Source #
Create a value of DescribeThingRegistrationTask
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:DescribeThingRegistrationTask'
, describeThingRegistrationTask_taskId
- The task ID.
Request Lenses
describeThingRegistrationTask_taskId :: Lens' DescribeThingRegistrationTask Text Source #
The task ID.
Destructuring the Response
data DescribeThingRegistrationTaskResponse Source #
See: newDescribeThingRegistrationTaskResponse
smart constructor.
DescribeThingRegistrationTaskResponse' | |
|
Instances
newDescribeThingRegistrationTaskResponse Source #
Create a value of DescribeThingRegistrationTaskResponse
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:status:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_status
- The status of the bulk thing provisioning task.
$sel:lastModifiedDate:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_lastModifiedDate
- The date when the task was last modified.
$sel:inputFileKey:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_inputFileKey
- The input file key.
$sel:taskId:DescribeThingRegistrationTask'
, describeThingRegistrationTaskResponse_taskId
- The task ID.
$sel:creationDate:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_creationDate
- The task creation date.
$sel:percentageProgress:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_percentageProgress
- The progress of the bulk provisioning task expressed as a percentage.
$sel:templateBody:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_templateBody
- The task's template.
$sel:successCount:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_successCount
- The number of things successfully provisioned.
$sel:message:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_message
- The message.
$sel:failureCount:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_failureCount
- The number of things that failed to be provisioned.
$sel:inputFileBucket:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_inputFileBucket
- The S3 bucket that contains the input file.
$sel:roleArn:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_roleArn
- The role ARN that grants access to the input file bucket.
$sel:httpStatus:DescribeThingRegistrationTaskResponse'
, describeThingRegistrationTaskResponse_httpStatus
- The response's http status code.
Response Lenses
describeThingRegistrationTaskResponse_status :: Lens' DescribeThingRegistrationTaskResponse (Maybe TaskStatus) Source #
The status of the bulk thing provisioning task.
describeThingRegistrationTaskResponse_lastModifiedDate :: Lens' DescribeThingRegistrationTaskResponse (Maybe UTCTime) Source #
The date when the task was last modified.
describeThingRegistrationTaskResponse_inputFileKey :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #
The input file key.
describeThingRegistrationTaskResponse_taskId :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #
The task ID.
describeThingRegistrationTaskResponse_creationDate :: Lens' DescribeThingRegistrationTaskResponse (Maybe UTCTime) Source #
The task creation date.
describeThingRegistrationTaskResponse_percentageProgress :: Lens' DescribeThingRegistrationTaskResponse (Maybe Natural) Source #
The progress of the bulk provisioning task expressed as a percentage.
describeThingRegistrationTaskResponse_templateBody :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #
The task's template.
describeThingRegistrationTaskResponse_successCount :: Lens' DescribeThingRegistrationTaskResponse (Maybe Int) Source #
The number of things successfully provisioned.
describeThingRegistrationTaskResponse_message :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #
The message.
describeThingRegistrationTaskResponse_failureCount :: Lens' DescribeThingRegistrationTaskResponse (Maybe Int) Source #
The number of things that failed to be provisioned.
describeThingRegistrationTaskResponse_inputFileBucket :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #
The S3 bucket that contains the input file.
describeThingRegistrationTaskResponse_roleArn :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #
The role ARN that grants access to the input file bucket.
describeThingRegistrationTaskResponse_httpStatus :: Lens' DescribeThingRegistrationTaskResponse Int Source #
The response's http status code.