Network.AWS.IoT

AWS IoT (Beta)

AWS IoT is in beta and is subject to change

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.

See: AWS API Reference

Service Configuration

ioT :: Service

API version '2015-05-28' of the Amazon IoT SDK 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.

SqlParseException

_SqlParseException :: AsError a => Getting (First ServiceError) a ServiceError

The Rule-SQL expression can't be parsed correctly.

InvalidRequestException

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError

The request is not valid.

TransferConflictException

_TransferConflictException :: AsError a => Getting (First ServiceError) a ServiceError

You can't transfer the the certificate because authorization policies are still attached.

CertificateStateException

_CertificateStateException :: AsError a => Getting (First ServiceError) a ServiceError

The certificate operation is not allowed.

MalformedPolicyException

_MalformedPolicyException :: AsError a => Getting (First ServiceError) a ServiceError

The policy documentation is not valid.

DeleteConflictException

_DeleteConflictException :: AsError a => Getting (First ServiceError) a ServiceError

You can't delete the resource because it is attached to one or more resources.

ResourceAlreadyExistsException

_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError

The resource already exists.

TransferAlreadyCompletedException

_TransferAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError

You can't revert the certificate transfer because it has already completed.

ThrottlingException

_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError

The rate exceeds the limit.

InternalFailureException

_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError

An unexpected error has occurred.

VersionsLimitExceededException

_VersionsLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

The number of policy versions exceeds the limit.

ServiceUnavailableException

_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError

The service is temporarily unavailable.

InternalException

_InternalException :: AsError a => Getting (First ServiceError) a ServiceError

An unexpected error has occurred.

UnauthorizedException

_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError

You are not authorized to perform this operation.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

The specified resource does not exist.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

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

ListThingPrincipals

module Network.AWS.IoT.ListThingPrincipals

ListPrincipalThings

module Network.AWS.IoT.ListPrincipalThings

GetLoggingOptions

module Network.AWS.IoT.GetLoggingOptions

CreateCertificateFromCsr

module Network.AWS.IoT.CreateCertificateFromCsr

DeleteThing

module Network.AWS.IoT.DeleteThing

UpdateThing

module Network.AWS.IoT.UpdateThing

CancelCertificateTransfer

module Network.AWS.IoT.CancelCertificateTransfer

DeletePolicyVersion

module Network.AWS.IoT.DeletePolicyVersion

CreateTopicRule

module Network.AWS.IoT.CreateTopicRule

CreatePolicyVersion

module Network.AWS.IoT.CreatePolicyVersion

DeleteTopicRule

module Network.AWS.IoT.DeleteTopicRule

ListPrincipalPolicies

module Network.AWS.IoT.ListPrincipalPolicies

ListTopicRules

module Network.AWS.IoT.ListTopicRules

TransferCertificate

module Network.AWS.IoT.TransferCertificate

GetTopicRule

module Network.AWS.IoT.GetTopicRule

DescribeThing

module Network.AWS.IoT.DescribeThing

DeletePolicy

module Network.AWS.IoT.DeletePolicy

ListCertificates

module Network.AWS.IoT.ListCertificates

GetPolicyVersion

module Network.AWS.IoT.GetPolicyVersion

DeleteCertificate

module Network.AWS.IoT.DeleteCertificate

UpdateCertificate

module Network.AWS.IoT.UpdateCertificate

AttachThingPrincipal

module Network.AWS.IoT.AttachThingPrincipal

ListThings

module Network.AWS.IoT.ListThings

DetachPrincipalPolicy

module Network.AWS.IoT.DetachPrincipalPolicy

CreateThing

module Network.AWS.IoT.CreateThing

DescribeCertificate

module Network.AWS.IoT.DescribeCertificate

ReplaceTopicRule

module Network.AWS.IoT.ReplaceTopicRule

SetDefaultPolicyVersion

module Network.AWS.IoT.SetDefaultPolicyVersion

ListPolicyVersions

module Network.AWS.IoT.ListPolicyVersions

CreateKeysAndCertificate

module Network.AWS.IoT.CreateKeysAndCertificate

AcceptCertificateTransfer

module Network.AWS.IoT.AcceptCertificateTransfer

GetPolicy

module Network.AWS.IoT.GetPolicy

DescribeEndpoint

module Network.AWS.IoT.DescribeEndpoint

SetLoggingOptions

module Network.AWS.IoT.SetLoggingOptions

AttachPrincipalPolicy

module Network.AWS.IoT.AttachPrincipalPolicy

RejectCertificateTransfer

module Network.AWS.IoT.RejectCertificateTransfer

DetachThingPrincipal

module Network.AWS.IoT.DetachThingPrincipal

Types

CertificateStatus

data CertificateStatus

Constructors

Active

Inactive

PendingTransfer

Revoked

Instances

Enum CertificateStatus

Eq CertificateStatus

Data CertificateStatus

Ord CertificateStatus

Read CertificateStatus

Show CertificateStatus

Generic CertificateStatus

ToJSON CertificateStatus

FromJSON CertificateStatus

Hashable CertificateStatus

ToHeader CertificateStatus

ToQuery CertificateStatus

ToByteString CertificateStatus

FromText CertificateStatus

ToText CertificateStatus

type Rep CertificateStatus

LogLevel

data LogLevel

Constructors

Debug

Disabled

Error'

Info

Warn

Instances

Enum LogLevel

Eq LogLevel

Data LogLevel

Ord LogLevel

Read LogLevel

Show LogLevel

Generic LogLevel

ToJSON LogLevel

FromJSON LogLevel

Hashable LogLevel

ToHeader LogLevel

ToQuery LogLevel

ToByteString LogLevel

FromText LogLevel

ToText LogLevel

type Rep LogLevel

Action

data Action

Describes the actions associated with a rule.

See: action smart constructor.

Instances

Eq Action

Data Action

Read Action

Show Action

Generic Action

ToJSON Action

FromJSON Action

type Rep Action

action :: Action

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:

• aSns
• aDynamoDB
• aFirehose
• aLambda
• aKinesis
• aS3
• aRepublish
• aSqs

aSns :: Lens' Action (Maybe SNSAction)

Publish to an SNS topic.

aDynamoDB :: Lens' Action (Maybe DynamoDBAction)

Write to a DynamoDB table.

aFirehose :: Lens' Action (Maybe FirehoseAction)

Undocumented member.

aLambda :: Lens' Action (Maybe LambdaAction)

Invoke a Lambda function.

aKinesis :: Lens' Action (Maybe KinesisAction)

Write data to a Kinesis stream.

aS3 :: Lens' Action (Maybe S3Action)

Write to an S3 bucket.

aRepublish :: Lens' Action (Maybe RepublishAction)

Publish to another MQTT topic.

aSqs :: Lens' Action (Maybe SqsAction)

Publish to an SQS queue.

AttributePayload

data AttributePayload

The attribute payload, a JSON string containing up to three key-value pairs.

For example: {\"attributes\":{\"string1\":\"string2\”}}

See: attributePayload smart constructor.

Instances

Eq AttributePayload

Data AttributePayload

Read AttributePayload

Show AttributePayload

Generic AttributePayload

ToJSON AttributePayload

type Rep AttributePayload

attributePayload :: AttributePayload

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

apAttributes :: Lens' AttributePayload (HashMap Text Text)

A JSON string containing up to three key-value pair in JSON format.

For example: {\"attributes\":{\"string1\":\"string2\”}}

Certificate

data Certificate

Information about a certificate.

See: certificate smart constructor.

Instances

Eq Certificate

Data Certificate

Read Certificate

Show Certificate

Generic Certificate

FromJSON Certificate

type Rep Certificate

certificate :: Certificate

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
• cCertificateARN
• cCertificateId
• cCreationDate

cStatus :: Lens' Certificate (Maybe CertificateStatus)

The status of the certificate.

cCertificateARN :: Lens' Certificate (Maybe Text)

The ARN of the certificate.

cCertificateId :: Lens' Certificate (Maybe Text)

The ID of the certificate.

cCreationDate :: Lens' Certificate (Maybe UTCTime)

The date and time the certificate was created.

CertificateDescription

data CertificateDescription

Describes a certificate.

See: certificateDescription smart constructor.

Instances

Eq CertificateDescription

Data CertificateDescription

Read CertificateDescription

Show CertificateDescription

Generic CertificateDescription

FromJSON CertificateDescription

type Rep CertificateDescription

certificateDescription :: CertificateDescription

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
• cdOwnedBy
• cdLastModifiedDate
• cdCertificatePem
• cdCertificateARN
• cdCertificateId
• cdCreationDate

cdStatus :: Lens' CertificateDescription (Maybe CertificateStatus)

The status of the certificate.

cdOwnedBy :: Lens' CertificateDescription (Maybe Text)

The ID of the AWS account that owns the certificate.

cdLastModifiedDate :: Lens' CertificateDescription (Maybe UTCTime)

The date and time the certificate was last modified.

cdCertificatePem :: Lens' CertificateDescription (Maybe Text)

The certificate data, in PEM format.

cdCertificateARN :: Lens' CertificateDescription (Maybe Text)

The ARN of the certificate.

cdCertificateId :: Lens' CertificateDescription (Maybe Text)

The ID of the certificate.

cdCreationDate :: Lens' CertificateDescription (Maybe UTCTime)

The date and time the certificate was created.

DynamoDBAction

data DynamoDBAction

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.

Instances

Eq DynamoDBAction

Data DynamoDBAction

Read DynamoDBAction

Show DynamoDBAction

Generic DynamoDBAction

ToJSON DynamoDBAction

FromJSON DynamoDBAction

type Rep DynamoDBAction

dynamoDBAction

Arguments

:: Text

ddaTableName

-> Text

ddaRoleARN

-> Text

ddaHashKeyField

-> Text

ddaHashKeyValue

-> Text

ddaRangeKeyField

-> Text

ddaRangeKeyValue

-> DynamoDBAction

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
• ddaTableName
• ddaRoleARN
• ddaHashKeyField
• ddaHashKeyValue
• ddaRangeKeyField
• ddaRangeKeyValue

ddaPayloadField :: Lens' DynamoDBAction (Maybe Text)

The action payload.

ddaTableName :: Lens' DynamoDBAction Text

The name of the DynamoDB table.

ddaRoleARN :: Lens' DynamoDBAction Text

The ARN of the IAM role that grants access.

ddaHashKeyField :: Lens' DynamoDBAction Text

The hash key name.

ddaHashKeyValue :: Lens' DynamoDBAction Text

The hash key value.

ddaRangeKeyField :: Lens' DynamoDBAction Text

The range key name.

ddaRangeKeyValue :: Lens' DynamoDBAction Text

The range key value.

FirehoseAction

data FirehoseAction

See: firehoseAction smart constructor.

Instances

Eq FirehoseAction

Data FirehoseAction

Read FirehoseAction

Show FirehoseAction

Generic FirehoseAction

ToJSON FirehoseAction

FromJSON FirehoseAction

type Rep FirehoseAction

firehoseAction

Arguments

:: Text

faRoleARN

-> Text

faDeliveryStreamName

-> FirehoseAction

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
• faDeliveryStreamName

faRoleARN :: Lens' FirehoseAction Text

Undocumented member.

faDeliveryStreamName :: Lens' FirehoseAction Text

Undocumented member.

KeyPair

data KeyPair

Describes a key pair.

See: keyPair smart constructor.

Instances

Eq KeyPair

Data KeyPair

Read KeyPair

Show KeyPair

Generic KeyPair

FromJSON KeyPair

type Rep KeyPair

keyPair :: KeyPair

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:

• kpPrivateKey
• kpPublicKey

kpPrivateKey :: Lens' KeyPair (Maybe Text)

The private key.

kpPublicKey :: Lens' KeyPair (Maybe Text)

The public key.

KinesisAction

data KinesisAction

Describes an action to write data to an Amazon Kinesis stream.

See: kinesisAction smart constructor.

Instances

Eq KinesisAction

Data KinesisAction

Read KinesisAction

Show KinesisAction

Generic KinesisAction

ToJSON KinesisAction

FromJSON KinesisAction

type Rep KinesisAction

kinesisAction

Arguments

:: Text

kaRoleARN

-> Text

kaStreamName

-> KinesisAction

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
• kaRoleARN
• kaStreamName

kaPartitionKey :: Lens' KinesisAction (Maybe Text)

The partition key.

kaRoleARN :: Lens' KinesisAction Text

The ARN of the IAM role that grants access.

kaStreamName :: Lens' KinesisAction Text

The name of the Kinesis stream.

LambdaAction

data LambdaAction

Describes an action to invoke a Lamdba function.

See: lambdaAction smart constructor.

Instances

Eq LambdaAction

Data LambdaAction

Read LambdaAction

Show LambdaAction

Generic LambdaAction

ToJSON LambdaAction

FromJSON LambdaAction

type Rep LambdaAction

lambdaAction

Arguments

:: Text

laFunctionARN

-> LambdaAction

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

laFunctionARN :: Lens' LambdaAction Text

The ARN of the Lambda function.

LoggingOptionsPayload

data LoggingOptionsPayload

Describes the logging options payload.

See: loggingOptionsPayload smart constructor.

Instances

Eq LoggingOptionsPayload

Data LoggingOptionsPayload

Read LoggingOptionsPayload

Show LoggingOptionsPayload

Generic LoggingOptionsPayload

ToJSON LoggingOptionsPayload

type Rep LoggingOptionsPayload

loggingOptionsPayload

Arguments

:: Text

lopRoleARN

-> LoggingOptionsPayload

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
• lopRoleARN

lopLogLevel :: Lens' LoggingOptionsPayload (Maybe LogLevel)

The logging level.

lopRoleARN :: Lens' LoggingOptionsPayload Text

The ARN of the IAM role that grants access.

Policy

data Policy

Describes an AWS IoT policy.

See: policy smart constructor.

Instances

Eq Policy

Data Policy

Read Policy

Show Policy

Generic Policy

FromJSON Policy

type Rep Policy

policy :: Policy

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:

• pPolicyName
• pPolicyARN

pPolicyName :: Lens' Policy (Maybe Text)

The policy name.

pPolicyARN :: Lens' Policy (Maybe Text)

The policy ARN.

PolicyVersion

data PolicyVersion

Describes a policy version.

See: policyVersion smart constructor.

Instances

Eq PolicyVersion

Data PolicyVersion

Read PolicyVersion

Show PolicyVersion

Generic PolicyVersion

FromJSON PolicyVersion

type Rep PolicyVersion

policyVersion :: PolicyVersion

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
• pvCreateDate
• pvIsDefaultVersion

pvVersionId :: Lens' PolicyVersion (Maybe Text)

The policy version ID.

pvCreateDate :: Lens' PolicyVersion (Maybe UTCTime)

The date and time the policy was created.

pvIsDefaultVersion :: Lens' PolicyVersion (Maybe Bool)

Specifies whether the policy version is the default.

RepublishAction

data RepublishAction

Describes an action to republish to another topic.

See: republishAction smart constructor.

Instances

Eq RepublishAction

Data RepublishAction

Read RepublishAction

Show RepublishAction

Generic RepublishAction

ToJSON RepublishAction

FromJSON RepublishAction

type Rep RepublishAction

republishAction

Arguments

:: Text

raRoleARN

-> Text

raTopic

-> RepublishAction

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
• raTopic

raRoleARN :: Lens' RepublishAction Text

The ARN of the IAM role that grants access.

raTopic :: Lens' RepublishAction Text

The name of the MQTT topic.

S3Action

data S3Action

Describes an action to write data to an Amazon S3 bucket.

See: s3Action smart constructor.

Instances

Eq S3Action

Data S3Action

Read S3Action

Show S3Action

Generic S3Action

ToJSON S3Action

FromJSON S3Action

type Rep S3Action

s3Action

Arguments

:: Text

sRoleARN

-> Text

sBucketName

-> Text

sKey

-> S3Action

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:

• sRoleARN
• sBucketName
• sKey

sRoleARN :: Lens' S3Action Text

The ARN of the IAM role that grants access.

sBucketName :: Lens' S3Action Text

The S3 bucket.

sKey :: Lens' S3Action Text

The object key.

SNSAction

data SNSAction

Describes an action to publish to an Amazon SNS topic.

See: snsAction smart constructor.

Instances

Eq SNSAction

Data SNSAction

Read SNSAction

Show SNSAction

Generic SNSAction

ToJSON SNSAction

FromJSON SNSAction

type Rep SNSAction

snsAction

Arguments

:: Text

snsaTargetARN

-> Text

snsaRoleARN

-> SNSAction

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
• snsaRoleARN

snsaTargetARN :: Lens' SNSAction Text

The ARN of the SNS topic.

snsaRoleARN :: Lens' SNSAction Text

The ARN of the IAM role that grants access.

SqsAction

data SqsAction

Describes an action to publish data to an SQS queue.

See: sqsAction smart constructor.

Instances

Eq SqsAction

Data SqsAction

Read SqsAction

Show SqsAction

Generic SqsAction

ToJSON SqsAction

FromJSON SqsAction

type Rep SqsAction

sqsAction

Arguments

:: Text

saRoleARN

-> Text

saQueueURL

-> SqsAction

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:

• saUseBase64
• saRoleARN
• saQueueURL

saUseBase64 :: Lens' SqsAction (Maybe Bool)

Specifies whether to use Base64 encoding.

saRoleARN :: Lens' SqsAction Text

The ARN of the IAM role that grants access.

saQueueURL :: Lens' SqsAction Text

The URL of the Amazon SQS queue.

ThingAttribute

data ThingAttribute

Describes a thing attribute.

See: thingAttribute smart constructor.

Instances

Eq ThingAttribute

Data ThingAttribute

Read ThingAttribute

Show ThingAttribute

Generic ThingAttribute

FromJSON ThingAttribute

type Rep ThingAttribute

thingAttribute :: ThingAttribute

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
• taThingName

taAttributes :: Lens' ThingAttribute (HashMap Text Text)

The attributes.

taThingName :: Lens' ThingAttribute (Maybe Text)

The name of the thing.

TopicRule

data TopicRule

Describes a rule.

See: topicRule smart constructor.

Instances

Eq TopicRule

Data TopicRule

Read TopicRule

Show TopicRule

Generic TopicRule

FromJSON TopicRule

type Rep TopicRule

topicRule :: TopicRule

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:

• trCreatedAt
• trActions
• trRuleDisabled
• trRuleName
• trSql
• trDescription

trCreatedAt :: Lens' TopicRule (Maybe UTCTime)

The date and time the rule was created.

trActions :: Lens' TopicRule [Action]

The actions associated with the rule.

trRuleDisabled :: Lens' TopicRule (Maybe Bool)

Specifies whether the rule is disabled.

trRuleName :: Lens' TopicRule (Maybe Text)

The name of the rule.

trSql :: Lens' TopicRule (Maybe Text)

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters properly.

trDescription :: Lens' TopicRule (Maybe Text)

The description of the rule.

TopicRuleListItem

data TopicRuleListItem

Describes a rule.

See: topicRuleListItem smart constructor.

Instances

Eq TopicRuleListItem

Data TopicRuleListItem

Read TopicRuleListItem

Show TopicRuleListItem

Generic TopicRuleListItem

FromJSON TopicRuleListItem

type Rep TopicRuleListItem

topicRuleListItem :: TopicRuleListItem

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
• trliRuleDisabled
• trliRuleName
• trliTopicPattern

trliCreatedAt :: Lens' TopicRuleListItem (Maybe UTCTime)

The date and time the rule was created.

trliRuleDisabled :: Lens' TopicRuleListItem (Maybe Bool)

Specifies whether the rule is disabled.

trliRuleName :: Lens' TopicRuleListItem (Maybe Text)

The name of the rule.

trliTopicPattern :: Lens' TopicRuleListItem (Maybe Text)

The pattern for the topic names that apply.

TopicRulePayload

data TopicRulePayload

Describes a rule.

See: topicRulePayload smart constructor.

Instances

Eq TopicRulePayload

Data TopicRulePayload

Read TopicRulePayload

Show TopicRulePayload

Generic TopicRulePayload

ToJSON TopicRulePayload

type Rep TopicRulePayload

topicRulePayload

Arguments

:: Text

trpSql

-> TopicRulePayload

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
• trpDescription
• trpSql
• trpActions

trpRuleDisabled :: Lens' TopicRulePayload (Maybe Bool)

Specifies whether the rule is disabled.

trpDescription :: Lens' TopicRulePayload (Maybe Text)

The description of the rule.

trpSql :: Lens' TopicRulePayload Text

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]

The actions associated with the rule.