DynamoDBAction dynamoDB
Write to a DynamoDB table.
DynamoDBv2Action dynamoDBv2
Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
LambdaAction lambda
Invoke a Lambda function.
SnsAction sns
Publish to an Amazon SNS topic.
SqsAction sqs
Publish to an Amazon SQS queue.
KinesisAction kinesis
Write data to an Amazon Kinesis stream.
RepublishAction republish
Publish to another MQTT topic.
S3Action s3
Write to an Amazon S3 bucket.
FirehoseAction firehose
Write to an Amazon Kinesis Firehose stream.
CloudwatchMetricAction cloudwatchMetric
Capture a CloudWatch metric.
CloudwatchAlarmAction cloudwatchAlarm
Change the state of a CloudWatch alarm.
ElasticsearchAction elasticsearch
Write data to an Amazon Elasticsearch Service domain.
Map<K,V> attributes
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}})
Boolean merge
Specifies whether the list of attributes provided in the AttributePayload
is merged with the
attributes stored in the registry, instead of overwriting them.
To remove an attribute, call UpdateThing
with an empty attribute value.
The merge
attribute is only valid when calling UpdateThing
.
String certificateArn
The ARN of the CA certificate.
String certificateId
The ID of the CA certificate.
String status
The status of the CA certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
Date creationDate
The date the CA certificate was created.
String certificateArn
The CA certificate ARN.
String certificateId
The CA certificate ID.
String status
The status of a CA certificate.
String certificatePem
The CA certificate data, in PEM format.
String ownedBy
The owner of the CA certificate.
Date creationDate
The date the CA certificate was created.
String autoRegistrationStatus
Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"
String certificateId
The ID of the certificate.
String certificateArn
The ARN of the certificate.
String certificateId
The ID of the certificate.
String status
The status of the certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
Date creationDate
The date and time the certificate was created.
String certificateArn
The ARN of the certificate.
String certificateId
The ID of the certificate.
String caCertificateId
The certificate ID of the CA certificate used to sign this certificate.
String status
The status of the certificate.
String certificatePem
The certificate data, in PEM format.
String ownedBy
The ID of the AWS account that owns the certificate.
String previousOwnedBy
The ID of the AWS account of the previous owner of the certificate.
Date creationDate
The date and time the certificate was created.
Date lastModifiedDate
The date and time the certificate was last modified.
TransferData transferData
The transfer data.
String roleArn
The IAM role that allows access to the CloudWatch alarm.
String alarmName
The CloudWatch alarm name.
String stateReason
The reason for the alarm change.
String stateValue
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
String roleArn
The IAM role that allows access to the CloudWatch metric.
String metricNamespace
The CloudWatch metric namespace name.
String metricName
The CloudWatch metric name.
String metricValue
The CloudWatch metric value.
String metricUnit
The metric unit supported by CloudWatch.
String metricTimestamp
An optional Unix timestamp.
String certificateArn
The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.
String certificateId
The ID of the certificate. Certificate management operations only take a certificateId.
String certificatePem
The certificate data, in PEM format.
Boolean setAsActive
Specifies whether the certificate is active.
String certificateArn
The ARN of the certificate.
String certificateId
The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).
String certificatePem
The certificate data, in PEM format.
KeyPair keyPair
The generated key pair.
String policyName
The policy name.
String policyDocument
The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespaces
Boolean setAsDefault
Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
String thingName
The name of the thing to create.
String thingTypeName
The name of the thing type associated with the new thing.
AttributePayload attributePayload
The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:
{\"attributes\":{\"string1\":\"string2\"}})
String thingTypeName
The name of the thing type.
ThingTypeProperties thingTypeProperties
The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.
String ruleName
The name of the rule.
TopicRulePayload topicRulePayload
The rule payload.
String certificateId
The ID of the certificate to delete.
String certificateId
The ID of the certificate.
String policyName
The name of the policy to delete.
String thingName
The name of the thing to delete.
Long expectedVersion
The expected version of the thing record in the registry. If the version of the record in the registry does not
match the expected version specified in the request, the DeleteThing
request is rejected with a
VersionConflictException
.
String thingTypeName
The name of the thing type.
String ruleName
The name of the rule.
String certificateId
The CA certificate identifier.
CACertificateDescription certificateDescription
The CA certificate description.
String certificateId
The ID of the certificate.
CertificateDescription certificateDescription
The description of the certificate.
String endpointAddress
The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
String thingName
The name of the thing.
String defaultClientId
The default client ID.
String thingName
The name of the thing.
String thingTypeName
The thing type name.
Map<K,V> attributes
The thing attributes.
Long version
The current version of the thing record in the registry.
To avoid unintentional changes to the information in the registry, you can pass the version information in the
expectedVersion
parameter of the UpdateThing
and DeleteThing
calls.
String thingTypeName
The name of the thing type.
String thingTypeName
The name of the thing type.
ThingTypeProperties thingTypeProperties
The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.
ThingTypeMetadata thingTypeMetadata
String ruleName
The name of the rule to disable.
String tableName
The name of the DynamoDB table.
String roleArn
The ARN of the IAM role that grants access to the DynamoDB table.
String operation
The type of operation to be performed. This follows the substitution template, so it can be
${operation}
, but the substitution must result in one of the following: INSERT
,
UPDATE
, or DELETE
.
String hashKeyField
The hash key name.
String hashKeyValue
The hash key value.
String hashKeyType
The hash key type. Valid values are "STRING" or "NUMBER"
String rangeKeyField
The range key name.
String rangeKeyValue
The range key value.
String rangeKeyType
The range key type. Valid values are "STRING" or "NUMBER"
String payloadField
The action payload. This name can be customized.
String roleArn
The ARN of the IAM role that grants access to the DynamoDB table.
PutItemInput putItem
Specifies the DynamoDB table to which the message data will be written. For example:
{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
String roleArn
The IAM role ARN that has access to Elasticsearch.
String endpoint
The endpoint of your Elasticsearch domain.
String index
The Elasticsearch index where you want to store your data.
String type
The type of document you are storing.
String id
The unique identifier for the document you are storing.
String ruleName
The name of the topic rule to enable.
String roleArn
The IAM role that grants access to the Amazon Kinesis Firehost stream.
String deliveryStreamName
The delivery stream name.
String separator
A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
String policyName
The name of the policy.
String policyArn
The policy ARN.
String policyName
The policy name.
String policyDocument
The JSON document that describes the policy.
String policyVersionId
The policy version ID.
Boolean isDefaultVersion
Specifies whether the policy version is the default.
String registrationCode
The CA certificate registration code.
String ruleName
The name of the rule.
String functionArn
The ARN of the Lambda function.
String caCertificateId
The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.
Integer pageSize
The result page size.
String marker
The marker for the next set of results.
Boolean ascendingOrder
Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
String policyName
The policy name.
String thingName
The name of the thing.
String nextToken
The token for the next set of results, or null if there are no additional results.
Integer maxResults
The maximum number of results to return in this operation.
String attributeName
The attribute name used to search for things.
String attributeValue
The attribute value used to search for things.
String thingTypeName
The name of the thing type used to search for things.
String certificateArn
The certificate ARN.
String certificateId
The certificate ID.
String transferredTo
The AWS account to which the transfer was made.
Date transferDate
The date the transfer was initiated.
String transferMessage
The transfer message.
Date creationDate
The certificate creation date.
String tableName
The table where the message data will be written
String caCertificate
The CA certificate.
String verificationCertificate
The private key verification certificate.
Boolean setAsActive
A boolean value that specifies if the CA certificate is set to active.
Boolean allowAutoRegistration
Allows this CA certificate to be used for auto registration of device certificates.
String certificatePem
The certificate data, in PEM format.
String caCertificatePem
The CA certificate used to sign the device certificate being registered.
Boolean setAsActive
A boolean value that specifies if the CA certificate is set to active.
String status
String ruleName
The name of the rule.
TopicRulePayload topicRulePayload
The rule payload.
String roleArn
The ARN of the IAM role that grants access.
String bucketName
The Amazon S3 bucket.
String key
The object key.
String cannedAcl
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.
LoggingOptionsPayload loggingOptionsPayload
The logging options payload.
String targetArn
The ARN of the SNS topic.
String roleArn
The ARN of the IAM role that grants access.
String messageFormat
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 refer to their official documentation.
String thingName
The name of the thing.
String thingTypeName
The name of the thing type, if the thing has been associated with a type.
Map<K,V> attributes
A list of thing attributes which are name-value pairs.
Long version
The version of the thing record in the registry.
String thingTypeName
The name of the thing type.
ThingTypeProperties thingTypeProperties
The ThingTypeProperties for the thing type.
ThingTypeMetadata thingTypeMetadata
String ruleName
The name of the rule.
String sql
The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
String description
The description of the rule.
Date createdAt
The date and time the rule was created.
List<E> actions
The actions associated with the rule.
Boolean ruleDisabled
Specifies whether the rule is disabled.
String awsIotSqlVersion
The version of the SQL rules engine to use when evaluating the rule.
String sql
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
String description
The description of the rule.
List<E> actions
The actions associated with the rule.
Boolean ruleDisabled
Specifies whether the rule is disabled.
String awsIotSqlVersion
The version of the SQL rules engine to use when evaluating the rule.
String transferredCertificateArn
The ARN of the certificate.
String transferMessage
The transfer message.
String rejectReason
The reason why the transfer was rejected.
Date transferDate
The date the transfer took place.
Date acceptDate
The date the transfer was accepted.
Date rejectDate
The date the transfer was rejected.
String certificateId
The CA certificate identifier.
String newStatus
The updated status of the CA certificate.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
String newAutoRegistrationStatus
The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".
String certificateId
The ID of the certificate.
String newStatus
The new status.
Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
String thingName
The name of the thing to update.
String thingTypeName
The name of the thing type.
AttributePayload attributePayload
A list of thing attributes, a JSON string containing name-value pairs. For example:
{\"attributes\":{\"name1\":\"value2\"}})
This data is used to add new attributes or update existing attributes.
Long expectedVersion
The expected version of the thing record in the registry. If the version of the record in the registry does not
match the expected version specified in the request, the UpdateThing
request is rejected with a
VersionConflictException
.
Boolean removeThingType
Remove a thing type association. If true, the assocation is removed.
String thingName
The name of the thing.
ByteBuffer payload
The state information, in JSON format.
String thingName
The name of the thing.
ByteBuffer payload
The state information, in JSON format.
String topic
The name of the MQTT topic.
Integer qos
The Quality of Service (QoS) level.
ByteBuffer payload
The state information, in JSON format.
String thingName
The name of the thing.
ByteBuffer payload
The state information, in JSON format.
ByteBuffer payload
The state information, in JSON format.
Copyright © 2017. All rights reserved.