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.
SalesforceAction salesforce
Send a message to a Salesforce IoT Cloud Input Stream.
IotAnalyticsAction iotAnalytics
Sends message data to an AWS IoT Analytics channel.
String thingGroupName
The name of the group to which you are adding a thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingGroupArn
The ARN of the group to which you are adding a thing.
String thingName
The name of the thing to add to a group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingArn
The ARN of the thing to add to a group.
List<E> targets
A list of thing group ARNs that define the targets of the job.
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String comment
An optional comment string describing why the job was associated with the targets.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
String jobArn
An ARN identifying the job.
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String description
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
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 authorizerName
The authorizer name.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String authorizerArn
The authorizer ARN.
String authorizerFunctionArn
The authorizer's Lambda function ARN.
String tokenKeyName
The key used to extract the token from the HTTP headers.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
Map<K,V> tokenSigningPublicKeys
The public keys used to validate the token signature returned by your custom authentication service.
String status
The status of the authorizer.
Constraints:
Allowed Values: ACTIVE, INACTIVE
Date creationDate
The UNIX timestamp of when the authorizer was created.
Date lastModifiedDate
The UNIX timestamp of when the authorizer was last updated.
AuthInfo authInfo
Authorization information.
Allowed allowed
The policies and statements that allowed the specified action.
Denied denied
The policies and statements that denied the specified action.
String authDecision
The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.
Constraints:
Allowed Values: ALLOWED, EXPLICIT_DENY, IMPLICIT_DENY
List<E> missingContextValues
Contains any missing context values found while evaluating policy.
String certificateArn
The ARN of the CA certificate.
String certificateId
The ID of the CA certificate.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String status
The status of the CA certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
Constraints:
Allowed Values: ACTIVE, INACTIVE
Date creationDate
The date the CA certificate was created.
String certificateArn
The CA certificate ARN.
String certificateId
The CA certificate ID.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String status
The status of a CA certificate.
Constraints:
Allowed Values: ACTIVE, INACTIVE
String certificatePem
The CA certificate data, in PEM format.
Constraints:
Length: 1 - 65536
String ownedBy
The owner of the CA certificate.
Constraints:
Pattern: [0-9]{12}
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"
Constraints:
Allowed Values: ENABLE, DISABLE
Date lastModifiedDate
The date the CA certificate was last modified.
Integer customerVersion
The customer version of the CA certificate.
Constraints:
Range: 1 -
String generationId
The generation ID of the CA certificate.
String certificateId
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String jobId
The ID of the job to be canceled.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String thingName
The name of the thing whose execution of the job will be canceled.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
Boolean force
(Optional) If true the job execution will be canceled if it
has status IN_PROGRESS or QUEUED, otherwise the job execution will be
canceled only if it has status QUEUED. If you attempt to cancel a job
execution that is IN_PROGRESS, and you do not set force to
true, then an InvalidStateTransitionException
will be thrown. The default is false.
Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
Long expectedVersion
(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
Map<K,V> statusDetails
A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String comment
An optional comment string describing why the job was canceled.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
Boolean force
(Optional) If true job executions with status "IN_PROGRESS"
and "QUEUED" are canceled, otherwise only job executions with status
"QUEUED" are canceled. The default is false.
Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.
String certificateArn
The ARN of the certificate.
String certificateId
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String status
The status of the certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER,
REGISTER_INACTIVE, PENDING_ACTIVATION
Date creationDate
The date and time the certificate was created.
String certificateArn
The ARN of the certificate.
String certificateId
The ID of the certificate.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String caCertificateId
The certificate ID of the CA certificate used to sign this certificate.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String status
The status of the certificate.
Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER,
REGISTER_INACTIVE, PENDING_ACTIVATION
String certificatePem
The certificate data, in PEM format.
Constraints:
Length: 1 - 65536
String ownedBy
The ID of the AWS account that owns the certificate.
Constraints:
Pattern: [0-9]{12}
String previousOwnedBy
The ID of the AWS account of the previous owner of the certificate.
Constraints:
Pattern: [0-9]{12}
Date creationDate
The date and time the certificate was created.
Date lastModifiedDate
The date and time the certificate was last modified.
Integer customerVersion
The customer version of the certificate.
Constraints:
Range: 1 -
TransferData transferData
The transfer data.
String generationId
The generation ID of the certificate.
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 awsSignerJobId
The ID of the AWSSignerJob which was created to sign the file.
CustomCodeSigning customCodeSigning
A custom method for code signing a file.
Stream stream
A stream of the code signing signature.
ByteBuffer inlineDocument
A base64 encoded binary representation of the code signing signature.
Boolean enabled
True to enable the configuration.
String authorizerName
The authorizer name.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String authorizerFunctionArn
The ARN of the authorizer's Lambda function.
String tokenKeyName
The name of the token key used to extract the token from the HTTP headers.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
Map<K,V> tokenSigningPublicKeys
The public keys used to verify the digital signature returned by your custom authentication service.
String status
The status of the create authorizer request.
Constraints:
Allowed Values: ACTIVE, INACTIVE
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.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String certificatePem
The certificate data, in PEM format.
Constraints:
Length: 1 - 65536
String jobId
A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
List<E> targets
A list of things and thing groups to which the job should be sent.
String documentSource
An S3 link to the job document.
Constraints:
Length: 1 - 1350
String document
The job document.
Constraints:
Length: - 32768
String description
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
PresignedUrlConfig presignedUrlConfig
Configuration information for pre-signed S3 URLs.
String targetSelection
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
JobExecutionsRolloutConfig jobExecutionsRolloutConfig
Allows you to create a staged rollout of the job.
Map<K,V> documentParameters
Parameters for the job document.
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).
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String certificatePem
The certificate data, in PEM format.
Constraints:
Length: 1 - 65536
KeyPair keyPair
The generated key pair.
String otaUpdateId
The ID of the OTA update to be created.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String description
The description of the OTA update.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
List<E> targets
The targeted devices to receive OTA updates.
String targetSelection
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
List<E> files
The files to be streamed by the OTA update.
String roleArn
The IAM role that allows access to the AWS IoT Jobs service.
Constraints:
Length: 20 - 2048
Map<K,V> additionalParameters
A list of additional OTA update parameters which are name-value pairs.
String otaUpdateId
The OTA update ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String awsIotJobId
The AWS IoT job ID associated with the OTA update.
String otaUpdateArn
The OTA update ARN.
String awsIotJobArn
The AWS IoT job ARN associated with the OTA update.
String otaUpdateStatus
The OTA update status.
Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS,
CREATE_COMPLETE, CREATE_FAILED
String policyName
The policy name.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyArn
The policy ARN.
String policyDocument
The JSON document that describes the policy.
String policyVersionId
The policy version ID.
Constraints:
Pattern: [0-9]+
String policyName
The policy name.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyDocument
The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.
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 policyArn
The policy ARN.
String policyDocument
The JSON document that describes the policy.
String policyVersionId
The policy version ID.
Constraints:
Pattern: [0-9]+
Boolean isDefaultVersion
Specifies whether the policy version is the default.
String roleAlias
The role alias that points to a role ARN. This allows you to change the role without having to update the device.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String roleArn
The role ARN.
Constraints:
Length: 20 - 2048
Integer credentialDurationSeconds
How long (in seconds) the credentials will be valid.
Constraints:
Range: 900 - 3600
String streamId
The stream ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String description
A description of the stream.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
List<E> files
The files to stream.
String roleArn
An IAM role that allows the IoT service principal assumes to access your S3 files.
Constraints:
Length: 20 - 2048
String streamId
The stream ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String streamArn
The stream ARN.
String description
A description of the stream.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
Integer streamVersion
The version of the stream.
Constraints:
Range: 0 - 65535
String thingGroupName
The thing group name to create.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String parentGroupName
The name of the parent thing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
ThingGroupProperties thingGroupProperties
The thing group properties.
String thingName
The name of the thing to create.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingTypeName
The name of the thing type associated with the new thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
TopicRulePayload topicRulePayload
The rule payload.
CodeSigningSignature signature
The signature for the file.
CodeSigningCertificateChain certificateChain
The certificate chain.
String hashAlgorithm
The hash algorithm used to code sign the file.
String signatureAlgorithm
The signature algorithm used to code sign the file.
String authorizerName
The name of the authorizer to delete.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String certificateId
The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String jobId
The ID of the job whose execution on a particular device will be deleted.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String thingName
The name of the thing whose job execution will be deleted.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
Long executionNumber
The ID of the job execution to be deleted. The
executionNumber refers to the execution of a particular job
on a particular device.
Note that once a job execution is deleted, the
executionNumber may be reused by IoT, so be sure you get and
use the correct value here.
Boolean force
(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.
Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
String jobId
The ID of the job to be deleted.
After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
Boolean force
(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.
Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.
String otaUpdateId
The OTA update ID to delete.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String policyName
The name of the policy to delete.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String roleAlias
The role alias to delete.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String streamId
The stream ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String thingName
The name of the thing to delete.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String ruleName
The name of the rule.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
ImplicitDeny implicitDeny
Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.
ExplicitDeny explicitDeny
Information that explicitly denies the authorization.
String thingTypeName
The name of the thing type to deprecate.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
Boolean undoDeprecate
Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.
String authorizerName
The name of the authorizer to describe.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
AuthorizerDescription authorizerDescription
The authorizer description.
String certificateId
The CA certificate identifier.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
CACertificateDescription certificateDescription
The CA certificate description.
RegistrationConfig registrationConfig
Information about the registration configuration.
String certificateId
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
CertificateDescription certificateDescription
The description of the certificate.
AuthorizerDescription authorizerDescription
The default authorizer's description.
String endpointType
The endpoint type.
String endpointAddress
The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
String indexName
The index name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String indexName
The index name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String indexStatus
The index status.
Constraints:
Allowed Values: ACTIVE, BUILDING, REBUILDING
String schema
Contains a value that specifies the type of indexing performed. Valid values are:
REGISTRY – Your thing index will contain only registry data.
REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String thingName
The name of the thing on which the job execution is running.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
Long executionNumber
A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.
JobExecution execution
Information about the job execution.
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String roleAlias
The role alias to describe.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
RoleAliasDescription roleAliasDescription
The role alias description.
String streamId
The stream ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
StreamInfo streamInfo
Information about the stream.
String thingGroupName
The name of the thing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingGroupName
The name of the thing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingGroupId
The thing group ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+
String thingGroupArn
The thing group ARN.
Long version
The version of the thing group.
ThingGroupProperties thingGroupProperties
The thing group properties.
ThingGroupMetadata thingGroupMetadata
Thing group metadata.
String taskId
The task ID.
Constraints:
Length: - 40
String taskId
The task ID.
Constraints:
Length: - 40
Date creationDate
The task creation date.
Date lastModifiedDate
The date when the task was last modified.
String templateBody
The task's template.
String inputFileBucket
The S3 bucket that contains the input file.
Constraints:
Length: 3 - 256
Pattern: [a-zA-Z0-9._-]+
String inputFileKey
The input file key.
Constraints:
Length: 1 - 1024
Pattern: [a-zA-Z0-9!_.*'()-\/]+
String roleArn
The role ARN that grants access to the input file bucket.
Constraints:
Length: 20 - 2048
String status
The status of the bulk thing provisioning task.
Constraints:
Allowed Values: InProgress, Completed, Failed, Cancelled,
Cancelling
String message
The message.
Constraints:
Length: - 2048
Integer successCount
The number of things successfully provisioned.
Integer failureCount
The number of things that failed to be provisioned.
Integer percentageProgress
The progress of the bulk provisioning task expressed as a percentage.
Constraints:
Range: 0 - 100
String thingName
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String defaultClientId
The default client ID.
String thingName
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingId
The ID of the thing to describe.
String thingArn
The ARN of the thing to describe.
String thingTypeName
The thing type name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingTypeName
The name of the thing type.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingTypeId
The thing type ID.
String thingTypeArn
The thing type ARN.
ThingTypeProperties thingTypeProperties
The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.
ThingTypeMetadata thingTypeMetadata
The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
String thingName
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String principal
If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.
String ruleName
The name of the rule to disable.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
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"
Constraints:
Allowed Values: STRING, 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"
Constraints:
Allowed Values: STRING, 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.
Constraints:
Pattern: https?://.*
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.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
String roleArn
The IAM role that grants access to the Amazon Kinesis Firehose 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).
Constraints:
Pattern: ([\n\t])|(\r\n)|(,)
ThingIndexingConfiguration thingIndexingConfiguration
Thing indexing configuration.
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String document
The job document content.
Constraints:
Length: - 32768
String otaUpdateId
The OTA update ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
OTAUpdateInfo otaUpdateInfo
The OTA update info.
String policyName
The name of the policy.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyName
The policy name.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyArn
The policy ARN.
String policyDocument
The JSON document that describes the policy.
String defaultVersionId
The default policy version ID.
Constraints:
Pattern: [0-9]+
Date creationDate
The date the policy was created.
Date lastModifiedDate
The date the policy was last modified.
String generationId
The generation ID of the policy.
String policyArn
The policy ARN.
String policyName
The policy name.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyDocument
The JSON document that describes the policy.
String policyVersionId
The policy version ID.
Constraints:
Pattern: [0-9]+
Boolean isDefaultVersion
Specifies whether the policy version is the default.
Date creationDate
The date the policy version was created.
Date lastModifiedDate
The date the policy version was last modified.
String generationId
The generation ID of the policy version.
String registrationCode
The CA certificate registration code.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String ruleName
The name of the rule.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
String channelArn
(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
String channelName
The name of the IoT Analytics channel to which message data will be sent.
String roleArn
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
String jobArn
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String targetSelection
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
String status
The status of the job, one of IN_PROGRESS,
CANCELED, or COMPLETED.
Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED,
DELETION_IN_PROGRESS
Boolean forceCanceled
Will be true if the job was canceled with the optional
force parameter set to true.
String comment
If the job was updated, describes the reason for the update.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
List<E> targets
A list of IoT things and thing groups to which the job should be sent.
String description
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
PresignedUrlConfig presignedUrlConfig
Configuration for pre-signed S3 URLs.
JobExecutionsRolloutConfig jobExecutionsRolloutConfig
Allows you to create a staged rollout of a job.
Date createdAt
The time, in milliseconds since the epoch, when the job was created.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the job was last updated.
Date completedAt
The time, in milliseconds since the epoch, when the job was completed.
JobProcessDetails jobProcessDetails
Details about the job process.
Map<K,V> documentParameters
The parameters specified for the job document.
String jobId
The unique identifier you assigned to the job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String status
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED,
REMOVED, CANCELED
Boolean forceCanceled
Will be true if the job execution was canceled with the
optional force parameter set to true.
JobExecutionStatusDetails statusDetails
A collection of name/value pairs that describe the status of the job execution.
String thingArn
The ARN of the thing on which the job execution is running.
Date queuedAt
The time, in milliseconds since the epoch, when the job execution was queued.
Date startedAt
The time, in milliseconds since the epoch, when the job execution started.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the job execution was last updated.
Long executionNumber
A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
Long versionNumber
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
Integer maximumPerMinute
The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
Constraints:
Range: 1 - 1000
String status
The status of the job execution.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED,
REMOVED, CANCELED
Date queuedAt
The time, in milliseconds since the epoch, when the job execution was queued.
Date startedAt
The time, in milliseconds since the epoch, when the job execution started.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the job execution was last updated.
Long executionNumber
A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information.
String thingArn
The ARN of the thing on which the job execution is running.
JobExecutionSummary jobExecutionSummary
Contains a subset of information about a job execution.
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
JobExecutionSummary jobExecutionSummary
Contains a subset of information about a job execution.
List<E> processingTargets
The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.
Integer numberOfCanceledThings
The number of things that cancelled the job.
Integer numberOfSucceededThings
The number of things which successfully completed the job.
Integer numberOfFailedThings
The number of things that failed executing the job.
Integer numberOfRejectedThings
The number of things that rejected the job.
Integer numberOfQueuedThings
The number of things that are awaiting execution of the job.
Integer numberOfInProgressThings
The number of things currently executing the job.
Integer numberOfRemovedThings
The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.
String jobArn
The job ARN.
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String thingGroupId
The ID of the thing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+
String targetSelection
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
String status
The job summary status.
Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED,
DELETION_IN_PROGRESS
Date createdAt
The time, in milliseconds since the epoch, when the job was created.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the job was last updated.
Date completedAt
The time, in milliseconds since the epoch, when the job completed.
String functionArn
The ARN of the Lambda function.
String target
The group for which the policies will be listed.
Boolean recursive
When true, recursively list attached policies.
String marker
The token to retrieve the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Integer pageSize
The maximum number of results to be returned per request.
Constraints:
Range: 1 - 250
Integer pageSize
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String marker
A marker used to get the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Boolean ascendingOrder
Return the list of authorizers in ascending alphabetical order.
String status
The status of the list authorizers request.
Constraints:
Allowed Values: ACTIVE, INACTIVE
String caCertificateId
The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
Integer pageSize
The result page size.
Constraints:
Range: 1 - 250
String marker
The marker for the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Boolean ascendingOrder
Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
Integer pageSize
The result page size.
Constraints:
Range: 1 - 250
String marker
The marker for the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Boolean ascendingOrder
Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
String jobId
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String status
The status of the job.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED,
REMOVED, CANCELED
Integer maxResults
The maximum number of results to be returned per request.
Constraints:
Range: 1 - 250
String nextToken
The token to retrieve the next set of results.
String thingName
The thing name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String status
An optional filter that lets you search for jobs that have the specified status.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED,
REMOVED, CANCELED
Integer maxResults
The maximum number of results to be returned per request.
Constraints:
Range: 1 - 250
String nextToken
The token to retrieve the next set of results.
String status
An optional filter that lets you search for jobs that have the specified status.
Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED,
DELETION_IN_PROGRESS
String targetSelection
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
Integer maxResults
The maximum number of results to return per request.
Constraints:
Range: 1 - 250
String nextToken
The token to retrieve the next set of results.
String thingGroupName
A filter that limits the returned jobs to those for the specified group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingGroupId
A filter that limits the returned jobs to those for the specified group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String nextToken
A token used to retrieve the next set of results.
String otaUpdateStatus
The OTA update job status.
Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS,
CREATE_COMPLETE, CREATE_FAILED
Integer pageSize
The result page size.
Constraints:
Range: 1 - 250
String marker
The marker for the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Boolean ascendingOrder
Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
String marker
The marker for the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Integer pageSize
The result page size.
Constraints:
Range: 1 - 250
Boolean ascendingOrder
Specifies the order for results. If true, the results are returned in ascending creation order.
String policyName
The policy name.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String marker
The marker for the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Integer pageSize
The result page size.
Constraints:
Range: 1 - 250
Boolean ascendingOrder
Specifies the order for results. If true, the results are returned in ascending creation order.
String policyName
The policy name.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String principal
The principal.
String marker
The marker for the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Integer pageSize
The result page size.
Constraints:
Range: 1 - 250
Boolean ascendingOrder
Specifies the order for results. If true, results are returned in ascending creation order.
Integer pageSize
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String marker
A marker used to get the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Boolean ascendingOrder
Return the list of role aliases in ascending alphabetical order.
String policyName
The policy name.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String marker
A marker used to get the next set of results.
Constraints:
Pattern: [A-Za-z0-9+/]+={0,2}
Integer pageSize
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String thingName
The thing name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String nextToken
The token used to get the next set of results, or null if there are no additional results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String nextToken
The token used to get the next set of results, or null if there are no additional results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String parentGroup
A filter that limits the results to those with the specified parent group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String namePrefixFilter
A filter that limits the results to those with the specified name prefix.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
Boolean recursive
If true, return child groups as well.
String thingName
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String taskId
The id of the task.
Constraints:
Length: - 40
String reportType
The type of task report.
Constraints:
Allowed Values: ERRORS, RESULTS
String nextToken
The token to retrieve the next set of results.
Integer maxResults
The maximum number of results to return per request.
Constraints:
Range: 1 - 250
String nextToken
The token used to get the next set of results, or null if there are no additional results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String status
The status of the bulk thing provisioning task.
Constraints:
Allowed Values: InProgress, Completed, Failed, Cancelled,
Cancelling
String thingGroupName
The thing group name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
Boolean recursive
When true, list things in this thing group and in all child groups as well.
String nextToken
The token used to get the next set of results, or null if there are no additional results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String nextToken
The token used to get 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.
Constraints:
Range: 1 - 250
String attributeName
The attribute name used to search for things.
Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_.,@/:#-]+
String attributeValue
The attribute value used to search for things.
Constraints:
Length: - 800
Pattern: [a-zA-Z0-9_.,@/:#-]*
String thingTypeName
The name of the thing type used to search for things.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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.
Constraints:
Range: 1 - 250
String thingTypeName
The name of the thing type.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String targetType
The type of resource for which you are configuring logging. Must be
THING_Group.
Constraints:
Allowed Values: DEFAULT, THING_GROUP
String nextToken
The token used to get the next set of results, or null if there are no additional results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String otaUpdateId
The OTA update ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String otaUpdateArn
The OTA update ARN.
Date creationDate
The date when the OTA update was created.
Date lastModifiedDate
The date when the OTA update was last updated.
String description
A description of the OTA update.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
List<E> targets
The targets of the OTA update.
String targetSelection
Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
List<E> otaUpdateFiles
A list of files associated with the OTA update.
String otaUpdateStatus
The status of the OTA update.
Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS,
CREATE_COMPLETE, CREATE_FAILED
String awsIotJobId
The AWS IoT job ID associated with the OTA update.
String awsIotJobArn
The AWS IoT job ARN associated with the OTA update.
ErrorInfo errorInfo
Error information associated with the OTA update.
Map<K,V> additionalParameters
A collection of name/value pairs
String certificateArn
The certificate ARN.
String certificateId
The certificate ID.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String transferredTo
The AWS account to which the transfer was made.
Constraints:
Pattern: [0-9]{12}
Date transferDate
The date the transfer was initiated.
String transferMessage
The transfer message.
Constraints:
Length: - 128
Date creationDate
The certificate creation date.
String roleArn
The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
Constraints:
Length: 20 - 2048
Long expiresInSec
How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
Constraints:
Range: 60 - 3600
String tableName
The table where the message data will be written
String caCertificate
The CA certificate.
Constraints:
Length: 1 - 65536
String verificationCertificate
The private key verification certificate.
Constraints:
Length: 1 - 65536
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.
RegistrationConfig registrationConfig
Information about the registration configuration.
String certificatePem
The certificate data, in PEM format.
Constraints:
Length: 1 - 65536
String caCertificatePem
The CA certificate used to sign the device certificate being registered.
Constraints:
Length: 1 - 65536
Boolean setAsActive
A boolean value that specifies if the CA certificate is set to active.
String status
The status of the register certificate request.
Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER,
REGISTER_INACTIVE, PENDING_ACTIVATION
String templateBody
The provisioning template. See Programmatic Provisioning for more information.
Map<K,V> parameters
The parameters for provisioning a thing. See Programmatic Provisioning for more information.
String thingGroupName
The group name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingGroupArn
The group ARN.
String thingName
The name of the thing to remove from the group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingArn
The ARN of the thing to remove from the group.
String ruleName
The name of the rule.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
TopicRulePayload topicRulePayload
The rule payload.
String roleAlias
The role alias.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String roleAliasArn
The ARN of the role alias.
String roleArn
The role ARN.
Constraints:
Length: 20 - 2048
String owner
The role alias owner.
Constraints:
Pattern: [0-9]{12}
Integer credentialDurationSeconds
The number of seconds for which the credential is valid.
Constraints:
Range: 900 - 3600
Date creationDate
The UNIX timestamp of when the role alias was created.
Date lastModifiedDate
The UNIX timestamp of when the role alias was last modified.
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.
Constraints:
Allowed Values: private, public-read, public-read-write,
aws-exec-read, authenticated-read, bucket-owner-read,
bucket-owner-full-control, log-delivery-write
String token
The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
Constraints:
Length: 40 -
String url
The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
Constraints:
Length: - 2000
Pattern:
https://ingestion-[a-zA-Z0-9]{1,12}\.[a-zA-Z0-9]+\.((sfdc-
matrix\.net)|(sfdcnow\.com))/streams/\w{1,20}/\w{1,20}/event
String indexName
The search index name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String queryString
The search query string.
Constraints:
Length: 1 - 1000
String nextToken
The token used to get the next set of results, or null if there are no additional results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 500
String queryVersion
The query version.
String authorizerName
The authorizer name.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
LoggingOptionsPayload loggingOptionsPayload
The logging options payload.
String roleArn
The role ARN that allows IoT to write to Cloudwatch logs.
String defaultLogLevel
The default logging level.
Constraints:
Allowed Values: DEBUG, INFO, ERROR, WARN, DISABLED
Boolean disableAllLogs
Set to true to disable all logs, otherwise set to false.
String targetArn
The ARN of the SNS topic.
String roleArn
The ARN of the IAM role that grants access.
String messageFormat
(Optional) The message format of the message to publish. 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.
Constraints:
Allowed Values: RAW, JSON
String templateBody
The provisioning template.
String inputFileBucket
The S3 bucket that contains the input file.
Constraints:
Length: 3 - 256
Pattern: [a-zA-Z0-9._-]+
String inputFileKey
The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).
Constraints:
Length: 1 - 1024
Pattern: [a-zA-Z0-9!_.*'()-\/]+
String roleArn
The IAM role ARN that grants permission the input file.
Constraints:
Length: 20 - 2048
String taskId
The bulk thing provisioning task ID.
Constraints:
Length: - 40
String taskId
The bulk thing provisioning task ID.
Constraints:
Length: - 40
Integer fileId
The file ID.
Constraints:
Range: 0 - 255
S3Location s3Location
The location of the file in S3.
String streamId
The stream ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String streamArn
The stream ARN.
Integer streamVersion
The stream version.
Constraints:
Range: 0 - 65535
String description
The description of the stream.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
List<E> files
The files to stream.
Date createdAt
The date when the stream was created.
Date lastUpdatedAt
The date when the stream was last updated.
String roleArn
An IAM role AWS IoT assumes to access your S3 files.
Constraints:
Length: 20 - 2048
String streamId
The stream ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String streamArn
The stream ARN.
Integer streamVersion
The stream version.
Constraints:
Range: 0 - 65535
String description
A description of the stream.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
String principal
The principal.
String cognitoIdentityPoolId
The Cognito identity pool ID.
List<E> authInfos
A list of authorization info objects. Simulating authorization will
create a response for each authInfo object in the list.
String clientId
The MQTT client ID.
List<E> policyNamesToAdd
When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
List<E> policyNamesToSkip
When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
String authorizerName
The custom authorizer name.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String token
The token returned by your custom authentication service.
Constraints:
Length: 1 - 1024
String tokenSignature
The signature made with the token and your custom authentication service's private key.
Constraints:
Length: 1 - 2560
Pattern: [A-Za-z0-9+/]+={0,2}
Boolean isAuthenticated
True if the token is authenticated, otherwise false.
String principalId
The principal ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9]+
List<E> policyDocuments
IAM policy documents.
Integer refreshAfterInSeconds
The number of seconds after which the temporary credentials are refreshed.
Integer disconnectAfterInSeconds
The number of seconds after which the connection is terminated.
String thingName
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingTypeName
The name of the thing type, if the thing has been associated with a type.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingArn
The thing ARN.
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 thingName
The thing name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingId
The thing ID.
String thingTypeName
The thing type name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
List<E> thingGroupNames
Thing group names.
Map<K,V> attributes
The attributes.
String shadow
The shadow.
String thingGroupDescription
The thing group description.
Constraints:
Length: - 2028
Pattern: [\p{Graph}\x20]*
AttributePayload attributePayload
The thing group attributes in JSON format.
String thingIndexingMode
Thing indexing mode. Valid values are:
REGISTRY – Your thing index will contain only registry data.
REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.
OFF - Thing indexing is disabled.
Constraints:
Allowed Values: OFF, REGISTRY, REGISTRY_AND_SHADOW
String thingTypeName
The name of the thing type.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingTypeArn
The thing type ARN.
ThingTypeProperties thingTypeProperties
The ThingTypeProperties for the thing type.
ThingTypeMetadata thingTypeMetadata
The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
String ruleName
The name of the rule.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
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.
Action errorAction
The action to perform when an error occurs.
String ruleArn
The rule ARN.
String ruleName
The name of the rule.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
String topicPattern
The pattern for the topic names that apply.
Date createdAt
The date and time the rule was created.
Boolean ruleDisabled
Specifies whether the rule is disabled.
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.
Action errorAction
The action to take when an error occurs.
String certificateId
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String targetAwsAccount
The AWS account.
Constraints:
Pattern: [0-9]{12}
String transferMessage
The transfer message.
Constraints:
Length: - 128
String transferredCertificateArn
The ARN of the certificate.
String transferMessage
The transfer message.
Constraints:
Length: - 128
String rejectReason
The reason why the transfer was rejected.
Constraints:
Length: - 128
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 authorizerName
The authorizer name.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String authorizerFunctionArn
The ARN of the authorizer's Lambda function.
String tokenKeyName
The key used to extract the token from the HTTP headers.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
Map<K,V> tokenSigningPublicKeys
The public keys used to verify the token signature.
String status
The status of the update authorizer request.
Constraints:
Allowed Values: ACTIVE, INACTIVE
String certificateId
The CA certificate identifier.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String newStatus
The updated status of the CA certificate.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
Constraints:
Allowed Values: ACTIVE, INACTIVE
String newAutoRegistrationStatus
The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".
Constraints:
Allowed Values: ENABLE, DISABLE
RegistrationConfig registrationConfig
Information about the registration configuration.
Boolean removeAutoRegistration
If true, remove auto registration.
String certificateId
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
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.
Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER,
REGISTER_INACTIVE, PENDING_ACTIVATION
ThingIndexingConfiguration thingIndexingConfiguration
Thing indexing configuration.
String roleAlias
The role alias to update.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String roleArn
The role ARN.
Constraints:
Length: 20 - 2048
Integer credentialDurationSeconds
The number of seconds the credential will be valid.
Constraints:
Range: 900 - 3600
String streamId
The stream ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String description
The description of the stream.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
List<E> files
The files associated with the stream.
String roleArn
An IAM role that allows the IoT service principal assumes to access your S3 files.
Constraints:
Length: 20 - 2048
String streamId
The stream ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String streamArn
The stream ARN.
String description
A description of the stream.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
Integer streamVersion
The stream version.
Constraints:
Range: 0 - 65535
String thingGroupName
The thing group to update.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
ThingGroupProperties thingGroupProperties
The thing group properties.
Long expectedVersion
The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.
Long version
The version of the updated thing group.
String thingName
The thing whose group memberships will be updated.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
List<E> thingGroupsToAdd
The groups to which the thing will be added.
List<E> thingGroupsToRemove
The groups from which the thing will be removed.
String thingName
The name of the thing to update.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingTypeName
The name of the thing type.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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 association is removed.
String thingName
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
ByteBuffer payload
The state information, in JSON format.
String thingName
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
ByteBuffer payload
The state information, in JSON format.
String topic
The name of the MQTT topic.
Integer qos
The Quality of Service (QoS) level.
Constraints:
Range: 0 - 1
ByteBuffer payload
The state information, in JSON format.
String thingName
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
ByteBuffer payload
The state information, in JSON format.
ByteBuffer payload
The state information, in JSON format.
Copyright © 2018. All rights reserved.