Amazonka.IoT.DescribeThingRegistrationTask

Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

Creating a Request

data DescribeThingRegistrationTask

See: newDescribeThingRegistrationTask smart constructor.

Constructors

DescribeThingRegistrationTask'

Fields

• taskId :: Text

  The task ID.

Instances

ToHeaders DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

toHeaders :: DescribeThingRegistrationTask -> [Header]

ToPath DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

toPath :: DescribeThingRegistrationTask -> ByteString

ToQuery DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

toQuery :: DescribeThingRegistrationTask -> QueryString

AWSRequest DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Associated Types

type AWSResponse DescribeThingRegistrationTask

Methods

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

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

Generic DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Associated Types

type Rep DescribeThingRegistrationTask :: Type -> Type

Methods

from :: DescribeThingRegistrationTask -> Rep DescribeThingRegistrationTask x

to :: Rep DescribeThingRegistrationTask x -> DescribeThingRegistrationTask

Read DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

readsPrec :: Int -> ReadS DescribeThingRegistrationTask

readList :: ReadS [DescribeThingRegistrationTask]

readPrec :: ReadPrec DescribeThingRegistrationTask

readListPrec :: ReadPrec [DescribeThingRegistrationTask]

Show DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

showsPrec :: Int -> DescribeThingRegistrationTask -> ShowS

show :: DescribeThingRegistrationTask -> String

showList :: [DescribeThingRegistrationTask] -> ShowS

NFData DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

rnf :: DescribeThingRegistrationTask -> ()

Eq DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

(==) :: DescribeThingRegistrationTask -> DescribeThingRegistrationTask -> Bool

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

Hashable DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

hashWithSalt :: Int -> DescribeThingRegistrationTask -> Int

hash :: DescribeThingRegistrationTask -> Int

type AWSResponse DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

type AWSResponse DescribeThingRegistrationTask = DescribeThingRegistrationTaskResponse

type Rep DescribeThingRegistrationTask

Defined in Amazonka.IoT.DescribeThingRegistrationTask

type Rep DescribeThingRegistrationTask = D1 ('MetaData "DescribeThingRegistrationTask" "Amazonka.IoT.DescribeThingRegistrationTask" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeThingRegistrationTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeThingRegistrationTask

Arguments

:: Text

DescribeThingRegistrationTask

-> DescribeThingRegistrationTask

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:

DescribeThingRegistrationTask, describeThingRegistrationTask_taskId - The task ID.

Request Lenses

describeThingRegistrationTask_taskId :: Lens' DescribeThingRegistrationTask Text

The task ID.

Destructuring the Response

data DescribeThingRegistrationTaskResponse

See: newDescribeThingRegistrationTaskResponse smart constructor.

Constructors

DescribeThingRegistrationTaskResponse'

Fields

• creationDate :: Maybe POSIX

  The task creation date.

• failureCount :: Maybe Int

  The number of things that failed to be provisioned.

• inputFileBucket :: Maybe Text

  The S3 bucket that contains the input file.

• inputFileKey :: Maybe Text

  The input file key.

• lastModifiedDate :: Maybe POSIX

  The date when the task was last modified.

• message :: Maybe Text

  The message.

• percentageProgress :: Maybe Natural

  The progress of the bulk provisioning task expressed as a percentage.

• roleArn :: Maybe Text

  The role ARN that grants access to the input file bucket.

• status :: Maybe TaskStatus

  The status of the bulk thing provisioning task.

• successCount :: Maybe Int

  The number of things successfully provisioned.

• taskId :: Maybe Text

  The task ID.

• templateBody :: Maybe Text

  The task's template.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeThingRegistrationTaskResponse

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Associated Types

type Rep DescribeThingRegistrationTaskResponse :: Type -> Type

Methods

from :: DescribeThingRegistrationTaskResponse -> Rep DescribeThingRegistrationTaskResponse x

to :: Rep DescribeThingRegistrationTaskResponse x -> DescribeThingRegistrationTaskResponse

Read DescribeThingRegistrationTaskResponse

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

readsPrec :: Int -> ReadS DescribeThingRegistrationTaskResponse

readList :: ReadS [DescribeThingRegistrationTaskResponse]

readPrec :: ReadPrec DescribeThingRegistrationTaskResponse

readListPrec :: ReadPrec [DescribeThingRegistrationTaskResponse]

Show DescribeThingRegistrationTaskResponse

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

showsPrec :: Int -> DescribeThingRegistrationTaskResponse -> ShowS

show :: DescribeThingRegistrationTaskResponse -> String

showList :: [DescribeThingRegistrationTaskResponse] -> ShowS

NFData DescribeThingRegistrationTaskResponse

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

rnf :: DescribeThingRegistrationTaskResponse -> ()

Eq DescribeThingRegistrationTaskResponse

Defined in Amazonka.IoT.DescribeThingRegistrationTask

Methods

(==) :: DescribeThingRegistrationTaskResponse -> DescribeThingRegistrationTaskResponse -> Bool

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

type Rep DescribeThingRegistrationTaskResponse

Defined in Amazonka.IoT.DescribeThingRegistrationTask

type Rep DescribeThingRegistrationTaskResponse = D1 ('MetaData "DescribeThingRegistrationTaskResponse" "Amazonka.IoT.DescribeThingRegistrationTask" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeThingRegistrationTaskResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "failureCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "inputFileBucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "inputFileKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "percentageProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskStatus)))) :*: ((S1 ('MetaSel ('Just "successCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeThingRegistrationTaskResponse

Arguments

:: Int

$sel:httpStatus:DescribeThingRegistrationTaskResponse'

-> DescribeThingRegistrationTaskResponse

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:

DescribeThingRegistrationTaskResponse, describeThingRegistrationTaskResponse_creationDate - The task creation date.

$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:inputFileKey:DescribeThingRegistrationTaskResponse', describeThingRegistrationTaskResponse_inputFileKey - The input file key.

DescribeThingRegistrationTaskResponse, describeThingRegistrationTaskResponse_lastModifiedDate - The date when the task was last modified.

DescribeThingRegistrationTaskResponse, describeThingRegistrationTaskResponse_message - The message.

$sel:percentageProgress:DescribeThingRegistrationTaskResponse', describeThingRegistrationTaskResponse_percentageProgress - The progress of the bulk provisioning task expressed as a percentage.

DescribeThingRegistrationTaskResponse, describeThingRegistrationTaskResponse_roleArn - The role ARN that grants access to the input file bucket.

DescribeThingRegistrationTaskResponse, describeThingRegistrationTaskResponse_status - The status of the bulk thing provisioning task.

$sel:successCount:DescribeThingRegistrationTaskResponse', describeThingRegistrationTaskResponse_successCount - The number of things successfully provisioned.

DescribeThingRegistrationTask, describeThingRegistrationTaskResponse_taskId - The task ID.

DescribeThingRegistrationTaskResponse, describeThingRegistrationTaskResponse_templateBody - The task's template.

$sel:httpStatus:DescribeThingRegistrationTaskResponse', describeThingRegistrationTaskResponse_httpStatus - The response's http status code.

Response Lenses

describeThingRegistrationTaskResponse_creationDate :: Lens' DescribeThingRegistrationTaskResponse (Maybe UTCTime)

The task creation date.

describeThingRegistrationTaskResponse_failureCount :: Lens' DescribeThingRegistrationTaskResponse (Maybe Int)

The number of things that failed to be provisioned.

describeThingRegistrationTaskResponse_inputFileBucket :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)

The S3 bucket that contains the input file.

describeThingRegistrationTaskResponse_inputFileKey :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)

The input file key.

describeThingRegistrationTaskResponse_lastModifiedDate :: Lens' DescribeThingRegistrationTaskResponse (Maybe UTCTime)

The date when the task was last modified.

describeThingRegistrationTaskResponse_message :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)

The message.

describeThingRegistrationTaskResponse_percentageProgress :: Lens' DescribeThingRegistrationTaskResponse (Maybe Natural)

The progress of the bulk provisioning task expressed as a percentage.

describeThingRegistrationTaskResponse_roleArn :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)

The role ARN that grants access to the input file bucket.

describeThingRegistrationTaskResponse_status :: Lens' DescribeThingRegistrationTaskResponse (Maybe TaskStatus)

The status of the bulk thing provisioning task.

describeThingRegistrationTaskResponse_successCount :: Lens' DescribeThingRegistrationTaskResponse (Maybe Int)

The number of things successfully provisioned.

describeThingRegistrationTaskResponse_taskId :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)

The task ID.

describeThingRegistrationTaskResponse_templateBody :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text)

The task's template.

describeThingRegistrationTaskResponse_httpStatus :: Lens' DescribeThingRegistrationTaskResponse Int

The response's http status code.