Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- CertificateConflictException
- SqlParseException
- InvalidRequestException
- TransferConflictException
- CertificateStateException
- RegistrationCodeValidationException
- MalformedPolicyException
- DeleteConflictException
- ResourceAlreadyExistsException
- CertificateValidationException
- TransferAlreadyCompletedException
- ThrottlingException
- InternalFailureException
- VersionsLimitExceededException
- ServiceUnavailableException
- InternalException
- UnauthorizedException
- ResourceNotFoundException
- LimitExceededException
- Waiters
- Operations
- ListPolicies
- CreatePolicy
- RegisterCertificate
- ListThingPrincipals
- ListPrincipalThings
- GetLoggingOptions
- CreateCertificateFromCsr
- DeleteThing
- UpdateThing
- CancelCertificateTransfer
- DeletePolicyVersion
- DisableTopicRule
- CreateTopicRule
- CreatePolicyVersion
- ListCACertificates
- DeleteTopicRule
- ListPrincipalPolicies
- DeleteCACertificate
- UpdateCACertificate
- ListTopicRules
- TransferCertificate
- GetTopicRule
- DescribeThing
- DeletePolicy
- ListCertificates
- GetPolicyVersion
- DeleteCertificate
- UpdateCertificate
- DescribeCACertificate
- GetRegistrationCode
- ListCertificatesByCA
- AttachThingPrincipal
- ListThings
- DetachPrincipalPolicy
- DeleteRegistrationCode
- CreateThing
- DescribeCertificate
- ReplaceTopicRule
- SetDefaultPolicyVersion
- ListPolicyVersions
- CreateKeysAndCertificate
- EnableTopicRule
- AcceptCertificateTransfer
- GetPolicy
- DescribeEndpoint
- RegisterCACertificate
- SetLoggingOptions
- AttachPrincipalPolicy
- RejectCertificateTransfer
- DetachThingPrincipal
- Types
- CACertificateStatus
- CertificateStatus
- LogLevel
- MessageFormat
- Action
- AttributePayload
- CACertificate
- CACertificateDescription
- Certificate
- CertificateDescription
- CloudwatchAlarmAction
- CloudwatchMetricAction
- DynamoDBAction
- ElasticsearchAction
- FirehoseAction
- KeyPair
- KinesisAction
- LambdaAction
- LoggingOptionsPayload
- Policy
- PolicyVersion
- RepublishAction
- S3Action
- SNSAction
- SqsAction
- ThingAttribute
- TopicRule
- TopicRuleListItem
- TopicRulePayload
- TransferData
AWS IoT
AWS IoT provides secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each thing (Thing Registry), configure logging, and create and manage policies and credentials to authenticate things.
For more information about how AWS IoT works, see the Developer Guide.
- ioT :: Service
- _CertificateConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _SqlParseException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _TransferConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _CertificateStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _RegistrationCodeValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _MalformedPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _DeleteConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _CertificateValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _TransferAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _VersionsLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.IoT.ListPolicies
- module Network.AWS.IoT.CreatePolicy
- module Network.AWS.IoT.RegisterCertificate
- module Network.AWS.IoT.ListThingPrincipals
- module Network.AWS.IoT.ListPrincipalThings
- module Network.AWS.IoT.GetLoggingOptions
- module Network.AWS.IoT.CreateCertificateFromCsr
- module Network.AWS.IoT.DeleteThing
- module Network.AWS.IoT.UpdateThing
- module Network.AWS.IoT.CancelCertificateTransfer
- module Network.AWS.IoT.DeletePolicyVersion
- module Network.AWS.IoT.DisableTopicRule
- module Network.AWS.IoT.CreateTopicRule
- module Network.AWS.IoT.CreatePolicyVersion
- module Network.AWS.IoT.ListCACertificates
- module Network.AWS.IoT.DeleteTopicRule
- module Network.AWS.IoT.ListPrincipalPolicies
- module Network.AWS.IoT.DeleteCACertificate
- module Network.AWS.IoT.UpdateCACertificate
- module Network.AWS.IoT.ListTopicRules
- module Network.AWS.IoT.TransferCertificate
- module Network.AWS.IoT.GetTopicRule
- module Network.AWS.IoT.DescribeThing
- module Network.AWS.IoT.DeletePolicy
- module Network.AWS.IoT.ListCertificates
- module Network.AWS.IoT.GetPolicyVersion
- module Network.AWS.IoT.DeleteCertificate
- module Network.AWS.IoT.UpdateCertificate
- module Network.AWS.IoT.DescribeCACertificate
- module Network.AWS.IoT.GetRegistrationCode
- module Network.AWS.IoT.ListCertificatesByCA
- module Network.AWS.IoT.AttachThingPrincipal
- module Network.AWS.IoT.ListThings
- module Network.AWS.IoT.DetachPrincipalPolicy
- module Network.AWS.IoT.DeleteRegistrationCode
- module Network.AWS.IoT.CreateThing
- module Network.AWS.IoT.DescribeCertificate
- module Network.AWS.IoT.ReplaceTopicRule
- module Network.AWS.IoT.SetDefaultPolicyVersion
- module Network.AWS.IoT.ListPolicyVersions
- module Network.AWS.IoT.CreateKeysAndCertificate
- module Network.AWS.IoT.EnableTopicRule
- module Network.AWS.IoT.AcceptCertificateTransfer
- module Network.AWS.IoT.GetPolicy
- module Network.AWS.IoT.DescribeEndpoint
- module Network.AWS.IoT.RegisterCACertificate
- module Network.AWS.IoT.SetLoggingOptions
- module Network.AWS.IoT.AttachPrincipalPolicy
- module Network.AWS.IoT.RejectCertificateTransfer
- module Network.AWS.IoT.DetachThingPrincipal
- data CACertificateStatus
- data CertificateStatus
- data LogLevel
- data MessageFormat
- data Action
- action :: Action
- aCloudwatchMetric :: Lens' Action (Maybe CloudwatchMetricAction)
- aCloudwatchAlarm :: Lens' Action (Maybe CloudwatchAlarmAction)
- aSns :: Lens' Action (Maybe SNSAction)
- aDynamoDB :: Lens' Action (Maybe DynamoDBAction)
- aFirehose :: Lens' Action (Maybe FirehoseAction)
- aLambda :: Lens' Action (Maybe LambdaAction)
- aKinesis :: Lens' Action (Maybe KinesisAction)
- aS3 :: Lens' Action (Maybe S3Action)
- aElasticsearch :: Lens' Action (Maybe ElasticsearchAction)
- aRepublish :: Lens' Action (Maybe RepublishAction)
- aSqs :: Lens' Action (Maybe SqsAction)
- data AttributePayload
- attributePayload :: AttributePayload
- apAttributes :: Lens' AttributePayload (HashMap Text Text)
- data CACertificate
- cACertificate :: CACertificate
- cacStatus :: Lens' CACertificate (Maybe CACertificateStatus)
- cacCertificateARN :: Lens' CACertificate (Maybe Text)
- cacCertificateId :: Lens' CACertificate (Maybe Text)
- cacCreationDate :: Lens' CACertificate (Maybe UTCTime)
- data CACertificateDescription
- cACertificateDescription :: CACertificateDescription
- cacdStatus :: Lens' CACertificateDescription (Maybe CACertificateStatus)
- cacdOwnedBy :: Lens' CACertificateDescription (Maybe Text)
- cacdCertificatePem :: Lens' CACertificateDescription (Maybe Text)
- cacdCertificateARN :: Lens' CACertificateDescription (Maybe Text)
- cacdCertificateId :: Lens' CACertificateDescription (Maybe Text)
- cacdCreationDate :: Lens' CACertificateDescription (Maybe UTCTime)
- data Certificate
- certificate :: Certificate
- cStatus :: Lens' Certificate (Maybe CertificateStatus)
- cCertificateARN :: Lens' Certificate (Maybe Text)
- cCertificateId :: Lens' Certificate (Maybe Text)
- cCreationDate :: Lens' Certificate (Maybe UTCTime)
- data CertificateDescription
- certificateDescription :: CertificateDescription
- cdStatus :: Lens' CertificateDescription (Maybe CertificateStatus)
- cdOwnedBy :: Lens' CertificateDescription (Maybe Text)
- cdLastModifiedDate :: Lens' CertificateDescription (Maybe UTCTime)
- cdCaCertificateId :: Lens' CertificateDescription (Maybe Text)
- cdPreviousOwnedBy :: Lens' CertificateDescription (Maybe Text)
- cdCertificatePem :: Lens' CertificateDescription (Maybe Text)
- cdCertificateARN :: Lens' CertificateDescription (Maybe Text)
- cdCertificateId :: Lens' CertificateDescription (Maybe Text)
- cdCreationDate :: Lens' CertificateDescription (Maybe UTCTime)
- cdTransferData :: Lens' CertificateDescription (Maybe TransferData)
- data CloudwatchAlarmAction
- cloudwatchAlarmAction :: Text -> Text -> Text -> Text -> CloudwatchAlarmAction
- caaRoleARN :: Lens' CloudwatchAlarmAction Text
- caaAlarmName :: Lens' CloudwatchAlarmAction Text
- caaStateReason :: Lens' CloudwatchAlarmAction Text
- caaStateValue :: Lens' CloudwatchAlarmAction Text
- data CloudwatchMetricAction
- cloudwatchMetricAction :: Text -> Text -> Text -> Text -> Text -> CloudwatchMetricAction
- cmaMetricTimestamp :: Lens' CloudwatchMetricAction (Maybe Text)
- cmaRoleARN :: Lens' CloudwatchMetricAction Text
- cmaMetricNamespace :: Lens' CloudwatchMetricAction Text
- cmaMetricName :: Lens' CloudwatchMetricAction Text
- cmaMetricValue :: Lens' CloudwatchMetricAction Text
- cmaMetricUnit :: Lens' CloudwatchMetricAction Text
- data DynamoDBAction
- dynamoDBAction :: Text -> Text -> Text -> Text -> Text -> Text -> DynamoDBAction
- ddaPayloadField :: Lens' DynamoDBAction (Maybe Text)
- ddaTableName :: Lens' DynamoDBAction Text
- ddaRoleARN :: Lens' DynamoDBAction Text
- ddaHashKeyField :: Lens' DynamoDBAction Text
- ddaHashKeyValue :: Lens' DynamoDBAction Text
- ddaRangeKeyField :: Lens' DynamoDBAction Text
- ddaRangeKeyValue :: Lens' DynamoDBAction Text
- data ElasticsearchAction
- elasticsearchAction :: Text -> Text -> Text -> Text -> Text -> ElasticsearchAction
- eaRoleARN :: Lens' ElasticsearchAction Text
- eaEndpoint :: Lens' ElasticsearchAction Text
- eaIndex :: Lens' ElasticsearchAction Text
- eaType :: Lens' ElasticsearchAction Text
- eaId :: Lens' ElasticsearchAction Text
- data FirehoseAction
- firehoseAction :: Text -> Text -> FirehoseAction
- faRoleARN :: Lens' FirehoseAction Text
- faDeliveryStreamName :: Lens' FirehoseAction Text
- data KeyPair
- keyPair :: KeyPair
- kpPrivateKey :: Lens' KeyPair (Maybe Text)
- kpPublicKey :: Lens' KeyPair (Maybe Text)
- data KinesisAction
- kinesisAction :: Text -> Text -> KinesisAction
- kaPartitionKey :: Lens' KinesisAction (Maybe Text)
- kaRoleARN :: Lens' KinesisAction Text
- kaStreamName :: Lens' KinesisAction Text
- data LambdaAction
- lambdaAction :: Text -> LambdaAction
- laFunctionARN :: Lens' LambdaAction Text
- data LoggingOptionsPayload
- loggingOptionsPayload :: Text -> LoggingOptionsPayload
- lopLogLevel :: Lens' LoggingOptionsPayload (Maybe LogLevel)
- lopRoleARN :: Lens' LoggingOptionsPayload Text
- data Policy
- policy :: Policy
- pPolicyName :: Lens' Policy (Maybe Text)
- pPolicyARN :: Lens' Policy (Maybe Text)
- data PolicyVersion
- policyVersion :: PolicyVersion
- pvVersionId :: Lens' PolicyVersion (Maybe Text)
- pvCreateDate :: Lens' PolicyVersion (Maybe UTCTime)
- pvIsDefaultVersion :: Lens' PolicyVersion (Maybe Bool)
- data RepublishAction
- republishAction :: Text -> Text -> RepublishAction
- raRoleARN :: Lens' RepublishAction Text
- raTopic :: Lens' RepublishAction Text
- data S3Action
- s3Action :: Text -> Text -> Text -> S3Action
- sRoleARN :: Lens' S3Action Text
- sBucketName :: Lens' S3Action Text
- sKey :: Lens' S3Action Text
- data SNSAction
- snsAction :: Text -> Text -> SNSAction
- snsaMessageFormat :: Lens' SNSAction (Maybe MessageFormat)
- snsaTargetARN :: Lens' SNSAction Text
- snsaRoleARN :: Lens' SNSAction Text
- data SqsAction
- sqsAction :: Text -> Text -> SqsAction
- saUseBase64 :: Lens' SqsAction (Maybe Bool)
- saRoleARN :: Lens' SqsAction Text
- saQueueURL :: Lens' SqsAction Text
- data ThingAttribute
- thingAttribute :: ThingAttribute
- taAttributes :: Lens' ThingAttribute (HashMap Text Text)
- taThingName :: Lens' ThingAttribute (Maybe Text)
- data TopicRule
- topicRule :: TopicRule
- trCreatedAt :: Lens' TopicRule (Maybe UTCTime)
- trActions :: Lens' TopicRule [Action]
- trAwsIotSqlVersion :: Lens' TopicRule (Maybe Text)
- trRuleDisabled :: Lens' TopicRule (Maybe Bool)
- trRuleName :: Lens' TopicRule (Maybe Text)
- trSql :: Lens' TopicRule (Maybe Text)
- trDescription :: Lens' TopicRule (Maybe Text)
- data TopicRuleListItem
- topicRuleListItem :: TopicRuleListItem
- trliCreatedAt :: Lens' TopicRuleListItem (Maybe UTCTime)
- trliRuleDisabled :: Lens' TopicRuleListItem (Maybe Bool)
- trliRuleName :: Lens' TopicRuleListItem (Maybe Text)
- trliRuleARN :: Lens' TopicRuleListItem (Maybe Text)
- trliTopicPattern :: Lens' TopicRuleListItem (Maybe Text)
- data TopicRulePayload
- topicRulePayload :: Text -> TopicRulePayload
- trpAwsIotSqlVersion :: Lens' TopicRulePayload (Maybe Text)
- trpRuleDisabled :: Lens' TopicRulePayload (Maybe Bool)
- trpDescription :: Lens' TopicRulePayload (Maybe Text)
- trpSql :: Lens' TopicRulePayload Text
- trpActions :: Lens' TopicRulePayload [Action]
- data TransferData
- transferData :: TransferData
- tdTransferDate :: Lens' TransferData (Maybe UTCTime)
- tdAcceptDate :: Lens' TransferData (Maybe UTCTime)
- tdTransferMessage :: Lens' TransferData (Maybe Text)
- tdRejectDate :: Lens' TransferData (Maybe UTCTime)
- tdRejectReason :: Lens' TransferData (Maybe Text)
Service Configuration
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoT
.
CertificateConflictException
_CertificateConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Unable to verify the CA certificate used to sign the device certificate you are attempting to register. This is happens when you have registered more than one CA certificate that has the same subject field and public key.
SqlParseException
_SqlParseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Rule-SQL expression can't be parsed correctly.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request is not valid.
TransferConflictException
_TransferConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't transfer the certificate because authorization policies are still attached.
CertificateStateException
_CertificateStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The certificate operation is not allowed.
RegistrationCodeValidationException
_RegistrationCodeValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The registration code is invalid.
MalformedPolicyException
_MalformedPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The policy documentation is not valid.
DeleteConflictException
_DeleteConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't delete the resource because it is attached to one or more resources.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource already exists.
CertificateValidationException
_CertificateValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The certificate is invalid.
TransferAlreadyCompletedException
_TransferAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't revert the certificate transfer because the transfer is already complete.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The rate exceeds the limit.
InternalFailureException
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An unexpected error has occurred.
VersionsLimitExceededException
_VersionsLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of policy versions exceeds the limit.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service is temporarily unavailable.
InternalException
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An unexpected error has occurred.
UnauthorizedException
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are not authorized to perform this operation.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource does not exist.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of attached entities exceeds the limit.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListPolicies
module Network.AWS.IoT.ListPolicies
CreatePolicy
module Network.AWS.IoT.CreatePolicy
RegisterCertificate
ListThingPrincipals
ListPrincipalThings
GetLoggingOptions
CreateCertificateFromCsr
DeleteThing
module Network.AWS.IoT.DeleteThing
UpdateThing
module Network.AWS.IoT.UpdateThing
CancelCertificateTransfer
DeletePolicyVersion
DisableTopicRule
CreateTopicRule
CreatePolicyVersion
ListCACertificates
DeleteTopicRule
ListPrincipalPolicies
DeleteCACertificate
UpdateCACertificate
ListTopicRules
TransferCertificate
GetTopicRule
module Network.AWS.IoT.GetTopicRule
DescribeThing
DeletePolicy
module Network.AWS.IoT.DeletePolicy
ListCertificates
GetPolicyVersion
DeleteCertificate
UpdateCertificate
DescribeCACertificate
GetRegistrationCode
ListCertificatesByCA
AttachThingPrincipal
ListThings
module Network.AWS.IoT.ListThings
DetachPrincipalPolicy
DeleteRegistrationCode
CreateThing
module Network.AWS.IoT.CreateThing
DescribeCertificate
ReplaceTopicRule
SetDefaultPolicyVersion
ListPolicyVersions
CreateKeysAndCertificate
EnableTopicRule
AcceptCertificateTransfer
GetPolicy
module Network.AWS.IoT.GetPolicy
DescribeEndpoint
RegisterCACertificate
SetLoggingOptions
AttachPrincipalPolicy
RejectCertificateTransfer
DetachThingPrincipal
Types
CACertificateStatus
data CACertificateStatus Source #
CertificateStatus
data CertificateStatus Source #
LogLevel
MessageFormat
data MessageFormat Source #
Action
Describes the actions associated with a rule.
See: action
smart constructor.
Creates a value of Action
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aCloudwatchMetric :: Lens' Action (Maybe CloudwatchMetricAction) Source #
Capture a CloudWatch metric.
aCloudwatchAlarm :: Lens' Action (Maybe CloudwatchAlarmAction) Source #
Change the state of a CloudWatch alarm.
aFirehose :: Lens' Action (Maybe FirehoseAction) Source #
Write to an Amazon Kinesis Firehose stream.
aElasticsearch :: Lens' Action (Maybe ElasticsearchAction) Source #
Write data to an Amazon Elasticsearch Service; domain.
aRepublish :: Lens' Action (Maybe RepublishAction) Source #
Publish to another MQTT topic.
AttributePayload
data AttributePayload Source #
The attribute payload, a JSON string containing up to three key-value pairs (for example, {\"attributes\":{\"string1\":\"string2\"}}).
See: attributePayload
smart constructor.
attributePayload :: AttributePayload Source #
Creates a value of AttributePayload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apAttributes :: Lens' AttributePayload (HashMap Text Text) Source #
A JSON string containing up to three key-value pair in JSON format (for example, {\"attributes\":{\"string1\":\"string2\"}}).
CACertificate
data CACertificate Source #
A CA certificate.
See: cACertificate
smart constructor.
cACertificate :: CACertificate Source #
Creates a value of CACertificate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cacStatus :: Lens' CACertificate (Maybe CACertificateStatus) Source #
The status of the CA certificate.
cacCertificateARN :: Lens' CACertificate (Maybe Text) Source #
The ARN of the CA certificate.
cacCertificateId :: Lens' CACertificate (Maybe Text) Source #
The ID of the CA certificate.
cacCreationDate :: Lens' CACertificate (Maybe UTCTime) Source #
The date the CA certificate was created.
CACertificateDescription
data CACertificateDescription Source #
Describes a CA certificate.
See: cACertificateDescription
smart constructor.
cACertificateDescription :: CACertificateDescription Source #
Creates a value of CACertificateDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cacdStatus :: Lens' CACertificateDescription (Maybe CACertificateStatus) Source #
The status of a CA certificate.
cacdOwnedBy :: Lens' CACertificateDescription (Maybe Text) Source #
The owner of the CA certificate.
cacdCertificatePem :: Lens' CACertificateDescription (Maybe Text) Source #
The CA certificate data, in PEM format.
cacdCertificateARN :: Lens' CACertificateDescription (Maybe Text) Source #
The CA certificate ARN.
cacdCertificateId :: Lens' CACertificateDescription (Maybe Text) Source #
The CA certificate ID.
cacdCreationDate :: Lens' CACertificateDescription (Maybe UTCTime) Source #
The date the CA certificate was created.
Certificate
data Certificate Source #
Information about a certificate.
See: certificate
smart constructor.
certificate :: Certificate Source #
Creates a value of Certificate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cStatus :: Lens' Certificate (Maybe CertificateStatus) Source #
The status of the certificate.
cCertificateARN :: Lens' Certificate (Maybe Text) Source #
The ARN of the certificate.
cCertificateId :: Lens' Certificate (Maybe Text) Source #
The ID of the certificate.
cCreationDate :: Lens' Certificate (Maybe UTCTime) Source #
The date and time the certificate was created.
CertificateDescription
data CertificateDescription Source #
Describes a certificate.
See: certificateDescription
smart constructor.
certificateDescription :: CertificateDescription Source #
Creates a value of CertificateDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdStatus :: Lens' CertificateDescription (Maybe CertificateStatus) Source #
The status of the certificate.
cdOwnedBy :: Lens' CertificateDescription (Maybe Text) Source #
The ID of the AWS account that owns the certificate.
cdLastModifiedDate :: Lens' CertificateDescription (Maybe UTCTime) Source #
The date and time the certificate was last modified.
cdCaCertificateId :: Lens' CertificateDescription (Maybe Text) Source #
The certificate ID of the CA certificate used to sign this certificate.
cdPreviousOwnedBy :: Lens' CertificateDescription (Maybe Text) Source #
The ID of the AWS account of the previous owner of the certificate.
cdCertificatePem :: Lens' CertificateDescription (Maybe Text) Source #
The certificate data, in PEM format.
cdCertificateARN :: Lens' CertificateDescription (Maybe Text) Source #
The ARN of the certificate.
cdCertificateId :: Lens' CertificateDescription (Maybe Text) Source #
The ID of the certificate.
cdCreationDate :: Lens' CertificateDescription (Maybe UTCTime) Source #
The date and time the certificate was created.
cdTransferData :: Lens' CertificateDescription (Maybe TransferData) Source #
The transfer data.
CloudwatchAlarmAction
data CloudwatchAlarmAction Source #
Describes an action that updates a CloudWatch alarm.
See: cloudwatchAlarmAction
smart constructor.
cloudwatchAlarmAction Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> CloudwatchAlarmAction |
Creates a value of CloudwatchAlarmAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
caaRoleARN :: Lens' CloudwatchAlarmAction Text Source #
The IAM role that allows access to the CloudWatch alarm.
caaAlarmName :: Lens' CloudwatchAlarmAction Text Source #
The CloudWatch alarm name.
caaStateReason :: Lens' CloudwatchAlarmAction Text Source #
The reason for the alarm change.
caaStateValue :: Lens' CloudwatchAlarmAction Text Source #
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
CloudwatchMetricAction
data CloudwatchMetricAction Source #
Describes an action that captures a CloudWatch metric.
See: cloudwatchMetricAction
smart constructor.
cloudwatchMetricAction Source #
Creates a value of CloudwatchMetricAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmaMetricTimestamp :: Lens' CloudwatchMetricAction (Maybe Text) Source #
An optional Unix timestamp.
cmaRoleARN :: Lens' CloudwatchMetricAction Text Source #
The IAM role that allows access to the CloudWatch metric.
cmaMetricNamespace :: Lens' CloudwatchMetricAction Text Source #
The CloudWatch metric namespace name.
cmaMetricName :: Lens' CloudwatchMetricAction Text Source #
The CloudWatch metric name.
cmaMetricValue :: Lens' CloudwatchMetricAction Text Source #
The CloudWatch metric value.
cmaMetricUnit :: Lens' CloudwatchMetricAction Text Source #
The metric unit supported by CloudWatch.
DynamoDBAction
data DynamoDBAction Source #
Describes an action to write to a DynamoDB table.
The tableName
, hashKeyField
, and rangeKeyField
values must match the values used when you created the table.
The hashKeyValue
and rangeKeyvalue
fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: >{sql-expression}.
You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:
'"hashKeyValue": ">{topic(3)}"'
The following field uses the timestamp:
'"rangeKeyValue": ">{timestamp()}"'
See: dynamoDBAction
smart constructor.
Creates a value of DynamoDBAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddaPayloadField :: Lens' DynamoDBAction (Maybe Text) Source #
The action payload. This name can be customized.
ddaTableName :: Lens' DynamoDBAction Text Source #
The name of the DynamoDB table.
ddaRoleARN :: Lens' DynamoDBAction Text Source #
The ARN of the IAM role that grants access to the DynamoDB table.
ddaHashKeyField :: Lens' DynamoDBAction Text Source #
The hash key name.
ddaHashKeyValue :: Lens' DynamoDBAction Text Source #
The hash key value.
ddaRangeKeyField :: Lens' DynamoDBAction Text Source #
The range key name.
ddaRangeKeyValue :: Lens' DynamoDBAction Text Source #
The range key value.
ElasticsearchAction
data ElasticsearchAction Source #
Describes an action that writes data to an Amazon Elasticsearch Service; domain.
See: elasticsearchAction
smart constructor.
Creates a value of ElasticsearchAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eaRoleARN :: Lens' ElasticsearchAction Text Source #
The IAM role ARN that has access to Elasticsearch.
eaEndpoint :: Lens' ElasticsearchAction Text Source #
The endpoint of your Elasticsearch domain.
eaIndex :: Lens' ElasticsearchAction Text Source #
The Elasticsearch index where you want to store your data.
eaId :: Lens' ElasticsearchAction Text Source #
The unique identifier for the document you are storing.
FirehoseAction
data FirehoseAction Source #
Describes an action that writes data to an Amazon Kinesis Firehose stream.
See: firehoseAction
smart constructor.
Creates a value of FirehoseAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
faRoleARN :: Lens' FirehoseAction Text Source #
The IAM role that grants access to the Amazon Kinesis Firehost stream.
faDeliveryStreamName :: Lens' FirehoseAction Text Source #
The delivery stream name.
KeyPair
Describes a key pair.
See: keyPair
smart constructor.
Creates a value of KeyPair
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
KinesisAction
data KinesisAction Source #
Describes an action to write data to an Amazon Kinesis stream.
See: kinesisAction
smart constructor.
Creates a value of KinesisAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kaPartitionKey :: Lens' KinesisAction (Maybe Text) Source #
The partition key.
kaRoleARN :: Lens' KinesisAction Text Source #
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
kaStreamName :: Lens' KinesisAction Text Source #
The name of the Amazon Kinesis stream.
LambdaAction
data LambdaAction Source #
Describes an action to invoke a Lambda function.
See: lambdaAction
smart constructor.
Creates a value of LambdaAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
laFunctionARN :: Lens' LambdaAction Text Source #
The ARN of the Lambda function.
LoggingOptionsPayload
data LoggingOptionsPayload Source #
Describes the logging options payload.
See: loggingOptionsPayload
smart constructor.
loggingOptionsPayload Source #
Creates a value of LoggingOptionsPayload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lopLogLevel :: Lens' LoggingOptionsPayload (Maybe LogLevel) Source #
The logging level.
lopRoleARN :: Lens' LoggingOptionsPayload Text Source #
The ARN of the IAM role that grants access.
Policy
Describes an AWS IoT policy.
See: policy
smart constructor.
Creates a value of Policy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
PolicyVersion
data PolicyVersion Source #
Describes a policy version.
See: policyVersion
smart constructor.
policyVersion :: PolicyVersion Source #
Creates a value of PolicyVersion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pvVersionId :: Lens' PolicyVersion (Maybe Text) Source #
The policy version ID.
pvCreateDate :: Lens' PolicyVersion (Maybe UTCTime) Source #
The date and time the policy was created.
pvIsDefaultVersion :: Lens' PolicyVersion (Maybe Bool) Source #
Specifies whether the policy version is the default.
RepublishAction
data RepublishAction Source #
Describes an action to republish to another topic.
See: republishAction
smart constructor.
Creates a value of RepublishAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
S3Action
Describes an action to write data to an Amazon S3 bucket.
See: s3Action
smart constructor.
Creates a value of S3Action
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SNSAction
Describes an action to publish to an Amazon SNS topic.
See: snsAction
smart constructor.
Creates a value of SNSAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
snsaMessageFormat :: Lens' SNSAction (Maybe MessageFormat) Source #
The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
SqsAction
Describes an action to publish data to an Amazon SQS queue.
See: sqsAction
smart constructor.
Creates a value of SqsAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ThingAttribute
data ThingAttribute Source #
Describes a thing attribute.
See: thingAttribute
smart constructor.
thingAttribute :: ThingAttribute Source #
Creates a value of ThingAttribute
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
taAttributes :: Lens' ThingAttribute (HashMap Text Text) Source #
The attributes.
taThingName :: Lens' ThingAttribute (Maybe Text) Source #
The name of the thing.
TopicRule
Describes a rule.
See: topicRule
smart constructor.
topicRule :: TopicRule Source #
Creates a value of TopicRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trAwsIotSqlVersion :: Lens' TopicRule (Maybe Text) Source #
The version of the SQL rules engine to use when evaluating the rule.
trSql :: Lens' TopicRule (Maybe Text) Source #
The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
TopicRuleListItem
data TopicRuleListItem Source #
Describes a rule.
See: topicRuleListItem
smart constructor.
topicRuleListItem :: TopicRuleListItem Source #
Creates a value of TopicRuleListItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trliCreatedAt :: Lens' TopicRuleListItem (Maybe UTCTime) Source #
The date and time the rule was created.
trliRuleDisabled :: Lens' TopicRuleListItem (Maybe Bool) Source #
Specifies whether the rule is disabled.
trliRuleName :: Lens' TopicRuleListItem (Maybe Text) Source #
The name of the rule.
trliRuleARN :: Lens' TopicRuleListItem (Maybe Text) Source #
The rule ARN.
trliTopicPattern :: Lens' TopicRuleListItem (Maybe Text) Source #
The pattern for the topic names that apply.
TopicRulePayload
data TopicRulePayload Source #
Describes a rule.
See: topicRulePayload
smart constructor.
Creates a value of TopicRulePayload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trpAwsIotSqlVersion :: Lens' TopicRulePayload (Maybe Text) Source #
The version of the SQL rules engine to use when evaluating the rule.
trpRuleDisabled :: Lens' TopicRulePayload (Maybe Bool) Source #
Specifies whether the rule is disabled.
trpDescription :: Lens' TopicRulePayload (Maybe Text) Source #
The description of the rule.
trpSql :: Lens' TopicRulePayload Text Source #
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
trpActions :: Lens' TopicRulePayload [Action] Source #
The actions associated with the rule.
TransferData
data TransferData Source #
Data used to transfer a certificate to an AWS account.
See: transferData
smart constructor.
transferData :: TransferData Source #
Creates a value of TransferData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdTransferDate :: Lens' TransferData (Maybe UTCTime) Source #
The date the transfer took place.
tdAcceptDate :: Lens' TransferData (Maybe UTCTime) Source #
The date the transfer was accepted.
tdTransferMessage :: Lens' TransferData (Maybe Text) Source #
The transfer message.
tdRejectDate :: Lens' TransferData (Maybe UTCTime) Source #
The date the transfer was rejected.
tdRejectReason :: Lens' TransferData (Maybe Text) Source #
The reason why the transfer was rejected.