Copyright | (c) 2013-2015 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
- CertificateStatus
- LogLevel
- Action
- AttributePayload
- Certificate
- CertificateDescription
- DynamoDBAction
- FirehoseAction
- KeyPair
- KinesisAction
- LambdaAction
- LoggingOptionsPayload
- Policy
- PolicyVersion
- RepublishAction
- S3Action
- SNSAction
- SqsAction
- ThingAttribute
- TopicRule
- TopicRuleListItem
- TopicRulePayload
- ioT :: Service
- _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
- _MalformedPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _DeleteConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: 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
- data CertificateStatus
- data LogLevel
- data Action
- action :: Action
- 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)
- aRepublish :: Lens' Action (Maybe RepublishAction)
- aSqs :: Lens' Action (Maybe SqsAction)
- data AttributePayload
- attributePayload :: AttributePayload
- apAttributes :: Lens' AttributePayload (HashMap Text Text)
- 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)
- cdCertificatePem :: Lens' CertificateDescription (Maybe Text)
- cdCertificateARN :: Lens' CertificateDescription (Maybe Text)
- cdCertificateId :: Lens' CertificateDescription (Maybe Text)
- cdCreationDate :: Lens' CertificateDescription (Maybe UTCTime)
- 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 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
- 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]
- 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)
- trliTopicPattern :: Lens' TopicRuleListItem (Maybe Text)
- data TopicRulePayload
- topicRulePayload :: Text -> TopicRulePayload
- trpRuleDisabled :: Lens' TopicRulePayload (Maybe Bool)
- trpDescription :: Lens' TopicRulePayload (Maybe Text)
- trpSql :: Lens' TopicRulePayload Text
- trpActions :: Lens' TopicRulePayload [Action]
Service Configuration
Errors
_SqlParseException :: AsError a => Getting (First ServiceError) a ServiceError Source
The Rule-SQL expression can't be parsed correctly.
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source
The request is not valid.
_TransferConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source
You can't transfer the the certificate because authorization policies are still attached.
_CertificateStateException :: AsError a => Getting (First ServiceError) a ServiceError Source
The certificate operation is not allowed.
_MalformedPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source
The policy documentation is not valid.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source
The resource already exists.
_TransferAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError Source
You can't revert the certificate transfer because it has already completed.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source
The rate exceeds the limit.
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source
An unexpected error has occurred.
_VersionsLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source
The number of policy versions exceeds the limit.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source
The service is temporarily unavailable.
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError Source
An unexpected error has occurred.
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source
You are not authorized to perform this operation.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified resource does not exist.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source
The number of attached entities exceeds the limit.
CertificateStatus
data CertificateStatus Source
LogLevel
Action
Describes the actions associated with a rule.
See: action
smart constructor.
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\"}}
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.
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.
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 expression that's valid 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.
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.
FirehoseAction
data FirehoseAction Source
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
Undocumented member.
faDeliveryStreamName :: Lens' FirehoseAction Text Source
Undocumented member.
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.
kaStreamName :: Lens' KinesisAction Text Source
The name of the Kinesis stream.
LambdaAction
data LambdaAction Source
Describes an action to invoke a Lamdba 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.
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:
raRoleARN :: Lens' RepublishAction Text Source
The ARN of the IAM role that grants access.
raTopic :: Lens' RepublishAction Text Source
The name of the MQTT topic.
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:
sBucketName :: Lens' S3Action Text Source
The S3 bucket.
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:
snsaTargetARN :: Lens' SNSAction Text Source
The ARN of the SNS topic.
snsaRoleARN :: Lens' SNSAction Text Source
The ARN of the IAM role that grants access.
SqsAction
Describes an action to publish data to an 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:
saQueueURL :: Lens' SqsAction Text Source
The URL of the Amazon SQS queue.
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.
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:
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 properly.
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.
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:
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.