String failureType
The type of job execution failure to define a rule to initiate a job abort.
String action
The type of abort action to initiate a job abort.
Double thresholdPercentage
The threshold as a percentage of the total number of executed things that will initiate a job abort.
AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
Integer minNumberOfExecutedThings
Minimum number of executed things before evaluating an abort rule.
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.
IotEventsAction iotEvents
Sends an input to an AWS IoT Events detector.
StepFunctionsAction stepFunctions
Starts execution of a Step Functions state machine.
String violationId
The ID of the active violation.
String thingName
The name of the thing responsible for the active violation.
String securityProfileName
The security profile whose behavior is in violation.
Behavior behavior
The behavior which is being violated.
MetricValue lastViolationValue
The value of the metric (the measurement) which caused the most recent violation.
Date lastViolationTime
The time the most recent violation occurred.
Date violationStartTime
The time the violation started.
String billingGroupName
The name of the billing group.
String billingGroupArn
The ARN of the billing group.
String thingName
The name of the thing to be added to the billing group.
String thingArn
The ARN of the thing to be added to the billing group.
String thingGroupName
The name of the group to which you are adding a thing.
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.
String thingArn
The ARN of the thing to add to a group.
Boolean overrideDynamicGroups
Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
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
.
Boolean enabled
True if this audit check is enabled for this account.
String checkRunStatus
The completion status of this check, one of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".
Boolean checkCompliant
True if the check completed and found all resources compliant.
Long totalResourcesCount
The number of resources on which the check was performed.
Long nonCompliantResourcesCount
The number of resources that the check found non-compliant.
String errorCode
The code of any error encountered when performing this check during this audit. One of "INSUFFICIENT_PERMISSIONS", or "AUDIT_CHECK_DISABLED".
String message
The message associated with any error encountered when performing this check during this audit.
String taskId
The ID of the audit that generated this result (finding)
String checkName
The audit check that generated this result.
Date taskStartTime
The time the audit started.
Date findingTime
The time the result (finding) was discovered.
String severity
The severity of the result (finding).
NonCompliantResource nonCompliantResource
The resource that was found to be non-compliant with the audit check.
List<E> relatedResources
The list of related resources.
String reasonForNonCompliance
The reason the resource was non-compliant.
String reasonForNonComplianceCode
A code which indicates the reason that the resource was non-compliant.
String authorizerName
The authorizer name.
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.
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.
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.
List<E> missingContextValues
Contains any missing context values found while evaluating policy.
Integer maximumPerMinute
The maximum number of OTA update job executions started per minute.
String name
The name you have given to the behavior.
String metric
What is measured by the behavior.
BehaviorCriteria criteria
The criteria that determine if a device is behaving normally in regard to the metric
.
String comparisonOperator
The operator that relates the thing measured (metric
) to the criteria (containing a
value
or statisticalThreshold
).
MetricValue value
The value to be compared with the metric
.
Integer durationSeconds
Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time
dimension (for example, NUM_MESSAGES_SENT
). For a statisticalThreshhold
metric
comparison, measurements from all devices are accumulated over this time duration before being used to calculate
percentiles, and later, measurements from an individual device are also accumulated over this time duration
before being given a percentile rank.
Integer consecutiveDatapointsToAlarm
If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
Integer consecutiveDatapointsToClear
If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
StatisticalThreshold statisticalThreshold
A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
Date creationDate
The date the billing group was created.
String billingGroupDescription
The description of the billing group.
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"
Date lastModifiedDate
The date the CA certificate was last modified.
Integer customerVersion
The customer version of the CA certificate.
String generationId
The generation ID of the CA certificate.
CertificateValidity validity
When the CA certificate is valid.
String taskId
The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".
String certificateId
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
String jobId
The ID of the job to be canceled.
String thingName
The name of the thing whose execution of the job will be canceled.
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.
String reasonCode
(Optional)A reason code string that explains why the job was canceled.
String comment
An optional comment string describing why the job was canceled.
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.)
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.
Integer customerVersion
The customer version of the certificate.
TransferData transferData
The transfer data.
String generationId
The generation ID of the certificate.
CertificateValidity validity
When the certificate is valid.
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.
StartSigningJobParameter startSigningJobParameter
Describes the code-signing job.
CustomCodeSigning customCodeSigning
A custom method for code signing a file.
ByteBuffer inlineDocument
A base64 encoded binary representation of the code signing signature.
Boolean enabled
True to enable the configuration.
String authorizerName
The authorizer name.
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.
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.
String billingGroupName
The name you wish to give to the billing group.
BillingGroupProperties billingGroupProperties
The properties of the billing group.
List<E> tags
Metadata which can be used to manage the billing group.
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.
String thingGroupName
The dynamic thing group name to create.
ThingGroupProperties thingGroupProperties
The dynamic thing group properties.
String indexName
The dynamic thing group index name.
Currently one index is supported: "AWS_Things".
String queryString
The dynamic thing group search query string.
See Query Syntax for information about query string syntax.
String queryVersion
The dynamic thing group query version.
Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
List<E> tags
Metadata which can be used to manage the dynamic thing group.
String thingGroupName
The dynamic thing group name.
String thingGroupArn
The dynamic thing group ARN.
String thingGroupId
The dynamic thing group ID.
String indexName
The dynamic thing group index name.
String queryString
The dynamic thing group search query string.
String queryVersion
The dynamic thing group query version.
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.
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.
String document
The job document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
String description
A short text description of the job.
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.
JobExecutionsRolloutConfig jobExecutionsRolloutConfig
Allows you to create a staged rollout of the job.
AbortConfig abortConfig
Allows you to create criteria to abort a job.
TimeoutConfig timeoutConfig
Specifies the amount of time each device has to finish its execution of the job. The timer is started when the
job execution status is set to IN_PROGRESS
. If the job execution status is not set to another
terminal state before the time expires, it will be automatically set to TIMED_OUT
.
List<E> tags
Metadata which can be used to manage the job.
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 otaUpdateId
The ID of the OTA update to be created.
String description
The description of the OTA update.
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.
AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig
Configuration for the rollout of OTA updates.
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.
Map<K,V> additionalParameters
A list of additional OTA update parameters which are name-value pairs.
List<E> tags
Metadata which can be used to manage updates.
String otaUpdateId
The OTA update ID.
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.
String policyName
The policy name.
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 frequency
How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system.
String dayOfMonth
The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
String dayOfWeek
The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
List<E> targetCheckNames
Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
DescribeAccountAuditConfiguration
to see the list of all checks including those that are enabled or
UpdateAccountAuditConfiguration
to select which checks are enabled.)
List<E> tags
Metadata which can be used to manage the scheduled audit.
String scheduledAuditName
The name you want to give to the scheduled audit. (Max. 128 chars)
String scheduledAuditArn
The ARN of the scheduled audit.
String securityProfileName
The name you are giving to the security profile.
String securityProfileDescription
A description of the security profile.
List<E> behaviors
Specifies the behaviors that, when violated by a device (thing), cause an alert.
Map<K,V> alertTargets
Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
List<E> additionalMetricsToRetain
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the
profile's behaviors
but it is also retained for any metric specified here.
List<E> tags
Metadata which can be used to manage the security profile.
String streamId
The stream ID.
String description
A description of the stream.
List<E> files
The files to stream.
String roleArn
An IAM role that allows the IoT service principal assumes to access your S3 files.
List<E> tags
Metadata which can be used to manage streams.
String thingGroupName
The thing group name to create.
String parentGroupName
The name of the parent thing group.
ThingGroupProperties thingGroupProperties
The thing group properties.
List<E> tags
Metadata which can be used to manage the thing group.
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 billingGroupName
The name of the billing group the thing will be added to.
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.
List<E> tags
Metadata which can be used to manage the thing type.
String ruleName
The name of the rule.
TopicRulePayload topicRulePayload
The rule payload.
String tags
Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
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.
Boolean deleteScheduledAudits
If true, all scheduled audits are deleted.
String authorizerName
The name of the authorizer to delete.
String billingGroupName
The name of the billing group.
Long expectedVersion
The expected version of the billing group. If the version of the billing group does not match the expected
version specified in the request, the DeleteBillingGroup
request is rejected with a
VersionConflictException
.
String certificateId
The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)
String jobId
The ID of the job whose execution on a particular device will be deleted.
String thingName
The name of the thing whose job execution will be deleted.
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.
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.
Boolean deleteStream
Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.
Boolean forceDeleteAWSJob
Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted.
String policyName
The name of the policy to delete.
String roleAlias
The role alias to delete.
String scheduledAuditName
The name of the scheduled audit you want to delete.
String securityProfileName
The name of the security profile to be deleted.
Long expectedVersion
The expected version of the security profile. A new version is generated whenever the security profile is
updated. If you specify a value that is different than the actual version, a
VersionConflictException
is thrown.
String streamId
The stream ID.
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.
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 roleArn
The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.
On the first call to UpdateAccountAuditConfiguration
this parameter is required.
Map<K,V> auditNotificationTargetConfigurations
Information about the targets to which audit notifications are sent for this account.
Map<K,V> auditCheckConfigurations
Which audit checks are enabled and disabled for this account.
String taskId
The ID of the audit whose information you want to get.
String taskStatus
The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
String taskType
The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
Date taskStartTime
The time the audit started.
TaskStatistics taskStatistics
Statistical information about the audit.
String scheduledAuditName
The name of the scheduled audit (only if the audit was a scheduled audit).
Map<K,V> auditDetails
Detailed information about each check performed during this audit.
String authorizerName
The name of the authorizer to describe.
AuthorizerDescription authorizerDescription
The authorizer description.
String billingGroupName
The name of the billing group.
String billingGroupName
The name of the billing group.
String billingGroupId
The ID of the billing group.
String billingGroupArn
The ARN of the billing group.
Long version
The version of the billing group.
BillingGroupProperties billingGroupProperties
The properties of the billing group.
BillingGroupMetadata billingGroupMetadata
Additional information about the billing group.
String certificateId
The CA certificate identifier.
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.)
CertificateDescription certificateDescription
The description of the certificate.
AuthorizerDescription authorizerDescription
The default authorizer's description.
String endpointType
The endpoint type. Valid endpoint types include:
iot:Data
- Returns a VeriSign signed data endpoint.
iot:Data-ATS
- Returns an ATS signed data endpoint.
iot:CredentialProvider
- Returns an AWS IoT credentials provider API endpoint.
iot:Jobs
- Returns an AWS IoT device management Jobs API endpoint.
String endpointAddress
The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
String indexName
The index name.
String indexName
The index name.
String indexStatus
The index status.
String schema
Contains a value that specifies the type of indexing performed. Valid values are:
REGISTRY – Your thing index contains only registry data.
REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.
REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.
String jobId
The unique identifier you assigned to this job when it was created.
String thingName
The name of the thing on which the job execution is running.
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.
String roleAlias
The role alias to describe.
RoleAliasDescription roleAliasDescription
The role alias description.
String scheduledAuditName
The name of the scheduled audit whose information you want to get.
String frequency
How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system.
String dayOfMonth
The day of the month on which the scheduled audit takes place. Will be "1" through "31" or "LAST". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
String dayOfWeek
The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT".
List<E> targetCheckNames
Which checks are performed during the scheduled audit. (Note that checks must be enabled for your account. (Use
DescribeAccountAuditConfiguration
to see the list of all checks including those that are enabled or
UpdateAccountAuditConfiguration
to select which checks are enabled.)
String scheduledAuditName
The name of the scheduled audit.
String scheduledAuditArn
The ARN of the scheduled audit.
String securityProfileName
The name of the security profile whose information you want to get.
String securityProfileName
The name of the security profile.
String securityProfileArn
The ARN of the security profile.
String securityProfileDescription
A description of the security profile (associated with the security profile when it was created or updated).
List<E> behaviors
Specifies the behaviors that, when violated by a device (thing), cause an alert.
Map<K,V> alertTargets
Where the alerts are sent. (Alerts are always sent to the console.)
List<E> additionalMetricsToRetain
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the
profile's behaviors
but it is also retained for any metric specified here.
Long version
The version of the security profile. A new version is generated whenever the security profile is updated.
Date creationDate
The time the security profile was created.
Date lastModifiedDate
The time the security profile was last modified.
String streamId
The stream ID.
StreamInfo streamInfo
Information about the stream.
String thingGroupName
The name of the thing group.
String thingGroupName
The name of the thing group.
String thingGroupId
The thing group ID.
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 indexName
The dynamic thing group index name.
String queryString
The dynamic thing group search query string.
String queryVersion
The dynamic thing group query version.
String status
The dynamic thing group status.
String taskId
The task ID.
String taskId
The task ID.
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.
String inputFileKey
The input file key.
String roleArn
The role ARN that grants access to the input file bucket.
String status
The status of the bulk thing provisioning task.
String message
The message.
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.
String thingName
The name of the thing.
String defaultClientId
The default client ID.
String thingName
The name of the thing.
String thingId
The ID of the thing to describe.
String thingArn
The ARN of the thing to describe.
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 billingGroupName
The name of the billing group the thing belongs to.
String thingTypeName
The name of the thing type.
String thingTypeName
The name of the thing type.
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.
S3Destination s3Destination
Describes the location in S3 of the updated firmware.
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.
Integer baseRatePerMinute
The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
Double incrementFactor
The exponential factor to increase the rate of rollout for a job.
RateIncreaseCriteria rateIncreaseCriteria
The criteria to initiate the increase in rate of rollout for a job.
AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).
Stream stream
The stream that contains the OTA update.
S3Location s3Location
The location of the updated firmware in S3.
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).
ThingIndexingConfiguration thingIndexingConfiguration
Thing indexing configuration.
ThingGroupIndexingConfiguration thingGroupIndexingConfiguration
The index configuration.
String jobId
The unique identifier you assigned to this job when it was created.
String document
The job document content.
String otaUpdateId
The OTA update ID.
OTAUpdateInfo otaUpdateInfo
The OTA update info.
String policyName
The name of the policy.
String policyName
The policy name.
String policyArn
The policy ARN.
String policyDocument
The JSON document that describes the policy.
String defaultVersionId
The default policy version ID.
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.
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.
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.
String indexName
The name of the index to search. The default value is AWS_Things
.
String queryString
The query used to search. You can specify "*" for the query string to get the count of all indexed things in your AWS account.
String aggregationField
The aggregation field name. Currently not supported.
String queryVersion
The version of the query used to search.
Statistics statistics
The statistics returned by the Fleet Indexing service based on the query and aggregation field.
String ruleName
The name of the rule.
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 inputName
The name of the AWS IoT Events input.
String messageId
[Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.
String roleArn
The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents: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.
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.
String status
The status of the job, one of IN_PROGRESS
, CANCELED
, DELETION_IN_PROGRESS
or COMPLETED
.
Boolean forceCanceled
Will be true
if the job was canceled with the optional force
parameter set to
true
.
String reasonCode
If the job was updated, provides the reason code for the update.
String comment
If the job was updated, describes the reason for the update.
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.
PresignedUrlConfig presignedUrlConfig
Configuration for pre-signed S3 URLs.
JobExecutionsRolloutConfig jobExecutionsRolloutConfig
Allows you to create a staged rollout of a job.
AbortConfig abortConfig
Configuration for criteria to abort the job.
Date createdAt
The time, in seconds since the epoch, when the job was created.
Date lastUpdatedAt
The time, in seconds since the epoch, when the job was last updated.
Date completedAt
The time, in seconds since the epoch, when the job was completed.
JobProcessDetails jobProcessDetails
Details about the job process.
TimeoutConfig timeoutConfig
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job
execution status is set to IN_PROGRESS
. If the job execution status is not set to another terminal
state before the timer expires, it will be automatically set to TIMED_OUT
.
String jobId
The unique identifier you assigned to the job when it was created.
String status
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
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 seconds since the epoch, when the job execution was queued.
Date startedAt
The time, in seconds since the epoch, when the job execution started.
Date lastUpdatedAt
The time, in seconds 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.
Long approximateSecondsBeforeTimedOut
The estimated number of seconds that remain before the job execution status will be changed to
TIMED_OUT
. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes).
The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will
not be included if the job execution has reached a terminal status.
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.
ExponentialRolloutRate exponentialRate
The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
String status
The status of the job execution.
Date queuedAt
The time, in seconds since the epoch, when the job execution was queued.
Date startedAt
The time, in seconds since the epoch, when the job execution started.
Date lastUpdatedAt
The time, in seconds 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.
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.
Integer numberOfTimedOutThings
The number of things whose job execution status is TIMED_OUT
.
String jobArn
The job ARN.
String jobId
The unique identifier you assigned to this job when it was created.
String thingGroupId
The ID of the thing group.
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.
String status
The job summary status.
Date createdAt
The time, in seconds since the epoch, when the job was created.
Date lastUpdatedAt
The time, in seconds since the epoch, when the job was last updated.
Date completedAt
The time, in seconds since the epoch, when the job completed.
String functionArn
The ARN of the Lambda function.
String thingName
The name of the thing whose active violations are listed.
String securityProfileName
The name of the Device Defender security profile for which violations are listed.
String nextToken
The token for the next set of results.
Integer maxResults
The maximum number of results to return at one time.
String taskId
A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.
String checkName
A filter to limit results to the findings for the specified audit check.
ResourceIdentifier resourceIdentifier
Information identifying the non-compliant resource.
Integer maxResults
The maximum number of results to return at one time. The default is 25.
String nextToken
The token for the next set of results.
Date startTime
A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
Date endTime
A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.
Date startTime
The beginning of the time period. Note that audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".
Date endTime
The end of the time period.
String taskType
A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
String taskStatus
A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED" or "CANCELED".
String nextToken
The token for the next set of results.
Integer maxResults
The maximum number of results to return at one time. The default is 25.
Integer pageSize
The maximum number of results to return at one time.
String marker
A marker used to get the next set of results.
Boolean ascendingOrder
Return the list of authorizers in ascending alphabetical order.
String status
The status of the list authorizers request.
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 thingName
The thing name.
String status
An optional filter that lets you search for jobs that have the specified status.
Integer maxResults
The maximum number of results to be returned per request.
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.
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.
Integer maxResults
The maximum number of results to return per request.
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.
String thingGroupId
A filter that limits the returned jobs to those for the specified group.
String policyName
The policy name.
String nextToken
The token for the next set of results.
Integer maxResults
The maximum number of results to return at one time.
Boolean recursive
If true, return child groups as well.
String securityProfileTargetArn
The ARN of the target (thing group) whose attached security profiles you want to get.
String nextToken
The token to retrieve the next set of results.
Integer maxResults
The maximum number of results to return at one time.
String parentGroup
A filter that limits the results to those with the specified parent group.
String namePrefixFilter
A filter that limits the results to those with the specified name prefix.
Boolean recursive
If true, return child groups as well.
String thingName
The name of the thing.
String thingGroupName
The thing group name.
Boolean recursive
When true, list things in this thing group and in all child groups as well.
String nextToken
The token to retrieve the next set of results.
Integer maxResults
The maximum number of results to return at one time.
String nextToken
The token to retrieve the next set of 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 targetType
The type of resource for which you are configuring logging. Must be 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.
Date startTime
The start time for the alerts to be listed.
Date endTime
The end time for the alerts to be listed.
String thingName
A filter to limit results to those alerts caused by the specified thing.
String securityProfileName
A filter to limit results to those alerts generated by the specified security profile.
String nextToken
The token for the next set of results.
Integer maxResults
The maximum number of results to return at one time.
List<E> violationEvents
The security profile violation alerts issued for this account during the given time frame, potentially filtered by security profile, behavior violated, or thing (device) violating.
String nextToken
A token that can be used to retrieve the next set of results, or null
if there are no additional
results.
Long count
If the comparisonOperator
calls for a numeric value, use this to specify that numeric value to be
compared with the metric
.
List<E> cidrs
If the comparisonOperator
calls for a set of CIDRs, use this to specify that set to be compared with
the metric
.
List<E> ports
If the comparisonOperator
calls for a set of ports, use this to specify that set to be compared with
the metric
.
String resourceType
The type of the non-compliant resource.
ResourceIdentifier resourceIdentifier
Information identifying the non-compliant resource.
Map<K,V> additionalInfo
Additional information about the non-compliant resource.
String fileName
The name of the file.
String fileVersion
The file version.
FileLocation fileLocation
The location of the updated firmware.
CodeSigning codeSigning
The code signing method of the file.
Map<K,V> attributes
A list of name/attribute pairs.
String otaUpdateId
The OTA update ID.
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.
List<E> targets
The targets of the OTA update.
AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig
Configuration for the rollout of OTA updates.
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.
List<E> otaUpdateFiles
A list of files associated with the OTA update.
String otaUpdateStatus
The status of the OTA update.
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.
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 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.
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.
String tableName
The table where the message data will be written
Integer numberOfNotifiedThings
The threshold for number of notified things that will initiate the increase in rate of rollout.
Integer numberOfSucceededThings
The threshold for number of succeeded things that will initiate the increase in rate of rollout.
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.
RegistrationConfig registrationConfig
Information about the registration configuration.
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 certificate is set to active.
String status
The status of the register certificate request.
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 resourceType
The type of resource.
ResourceIdentifier resourceIdentifier
Information identifying the resource.
Map<K,V> additionalInfo
Additional information about the resource.
String billingGroupName
The name of the billing group.
String billingGroupArn
The ARN of the billing group.
String thingName
The name of the thing to be removed from the billing group.
String thingArn
The ARN of the thing to be removed from the billing group.
String ruleName
The name of the rule.
TopicRulePayload topicRulePayload
The rule payload.
String deviceCertificateId
The ID of the certificate attached to the resource.
String caCertificateId
The ID of the CA certificate used to authorize the certificate.
String cognitoIdentityPoolId
The ID of the Cognito Identity Pool.
String clientId
The client ID.
PolicyVersionIdentifier policyVersionIdentifier
The version of the policy associated with the resource.
String account
The account with which the resource is associated.
String roleAlias
The role alias.
String roleAliasArn
The ARN of the role alias.
String roleArn
The role ARN.
String owner
The role alias owner.
Integer credentialDurationSeconds
The number of seconds for which the credential is valid.
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.
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.
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.
String scheduledAuditName
The name of the scheduled audit.
String scheduledAuditArn
The ARN of the scheduled audit.
String frequency
How often the scheduled audit takes place.
String dayOfMonth
The day of the month on which the scheduled audit is run (if the frequency
is "MONTHLY"). If days
29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the
month.
String dayOfWeek
The day of the week on which the scheduled audit is run (if the frequency
is "WEEKLY" or
"BIWEEKLY").
String indexName
The search index name.
String queryString
The search query string.
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.
String queryVersion
The query version.
String arn
The ARN of the security profile.
SecurityProfileIdentifier securityProfileIdentifier
Information that identifies the security profile.
SecurityProfileTarget target
Information about the target (thing group) associated with the security profile.
String authorizerName
The authorizer name.
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
(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 https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
List<E> targetCheckNames
Which checks are performed during the audit. The checks you specify must be enabled for your account or an
exception occurs. Use DescribeAccountAuditConfiguration
to see the list of all checks including
those that are enabled or UpdateAccountAuditConfiguration
to select which checks are enabled.
String taskId
The ID of the on-demand audit you started.
SigningProfileParameter signingProfileParameter
Describes the code-signing profile.
String signingProfileName
The code-signing profile name.
Destination destination
The location to write the code-signed file.
String templateBody
The provisioning template.
String inputFileBucket
The S3 bucket that contains the input file.
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).
String roleArn
The IAM role ARN that grants permission the input file.
String taskId
The bulk thing provisioning task ID.
String statistic
The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are
collected over the specified period (durationSeconds
) from all reporting devices in your account and
statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the
accumulated measurements from the device fall above or below (comparisonOperator
) the value
associated with the percentile specified, then the device is considered to be in compliance with the behavior,
otherwise a violation occurs.
Integer count
The count of things that match the query.
String executionNamePrefix
(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
String stateMachineName
The name of the Step Functions state machine whose execution will be started.
String roleArn
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
String taskId
The bulk thing provisioning task ID.
Integer fileId
The file ID.
S3Location s3Location
The location of the file in S3.
String streamId
The stream ID.
String streamArn
The stream ARN.
Integer streamVersion
The stream version.
String description
The description of the stream.
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.
Integer totalChecks
The number of checks in this audit.
Integer inProgressChecks
The number of checks in progress.
Integer waitingForDataCollectionChecks
The number of checks waiting for data collection.
Integer compliantChecks
The number of checks that found compliant resources.
Integer nonCompliantChecks
The number of checks that found non-compliant resources.
Integer failedChecks
The number of checks
Integer canceledChecks
The number of checks that did not run because the audit was canceled.
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.
Boolean isAuthenticated
True if the token is authenticated, otherwise false.
String principalId
The principal ID.
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.
String thingTypeName
The name of the thing type, if the thing has been associated with a type.
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.
Boolean connected
True if the thing is connected to the AWS IoT service; false if it is not connected.
Long timestamp
The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for more than a few weeks, the time value might be missing.
String thingName
The thing name.
String thingId
The thing ID.
String thingTypeName
The thing type name.
List<E> thingGroupNames
Thing group names.
Map<K,V> attributes
The attributes.
String shadow
The shadow.
ThingConnectivity connectivity
Indicates whether the thing is connected to the AWS IoT service.
String thingGroupName
The thing group name.
String thingGroupId
The thing group ID.
String thingGroupDescription
The thing group description.
Map<K,V> attributes
The thing group attributes.
List<E> parentGroupNames
Parent group names.
String thingGroupIndexingMode
Thing group indexing mode.
String thingGroupDescription
The thing group description.
AttributePayload attributePayload
The thing group attributes in JSON format.
String thingIndexingMode
Thing indexing mode. Valid values are:
REGISTRY – Your thing index contains registry data only.
REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
OFF - Thing indexing is disabled.
String thingConnectivityIndexingMode
Thing connectivity indexing mode. Valid values are:
STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.
OFF - Thing connectivity status indexing is disabled.
String thingTypeName
The name of the thing type.
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.
Long inProgressTimeoutInMinutes
Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval
can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will
apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer
than this interval, the job execution will fail and switch to the terminal TIMED_OUT
status.
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.
Action errorAction
The action to perform when an error occurs.
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 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 roleArn
The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.
Map<K,V> auditNotificationTargetConfigurations
Information about the targets to which audit notifications are sent.
Map<K,V> auditCheckConfigurations
Specifies which audit checks are enabled and disabled for this account. Use
DescribeAccountAuditConfiguration
to see the list of all checks including those that are currently
enabled.
Note that some data collection may begin immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.
You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.
On the first call to UpdateAccountAuditConfiguration
this parameter is required and must specify at
least one enabled check.
String authorizerName
The authorizer name.
String authorizerFunctionArn
The ARN of the authorizer's Lambda function.
String tokenKeyName
The key used to extract the token from the HTTP headers.
Map<K,V> tokenSigningPublicKeys
The public keys used to verify the token signature.
String status
The status of the update authorizer request.
String billingGroupName
The name of the billing group.
BillingGroupProperties billingGroupProperties
The properties of the billing group.
Long expectedVersion
The expected version of the billing group. If the version of the billing group does not match the expected
version specified in the request, the UpdateBillingGroup
request is rejected with a
VersionConflictException
.
Long version
The latest version of the billing group.
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".
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.)
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 thingGroupName
The name of the dynamic thing group to update.
ThingGroupProperties thingGroupProperties
The dynamic thing group properties to update.
Long expectedVersion
The expected version of the dynamic thing group to update.
String indexName
The dynamic thing group index to update.
Currently one index is supported: 'AWS_Things'.
String queryString
The dynamic thing group search query string to update.
String queryVersion
The dynamic thing group query version to update.
Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
Long version
The dynamic thing group version.
ThingIndexingConfiguration thingIndexingConfiguration
Thing indexing configuration.
ThingGroupIndexingConfiguration thingGroupIndexingConfiguration
Thing group indexing configuration.
String jobId
The ID of the job to be updated.
String description
A short text description of the job.
PresignedUrlConfig presignedUrlConfig
Configuration information for pre-signed S3 URLs.
JobExecutionsRolloutConfig jobExecutionsRolloutConfig
Allows you to create a staged rollout of the job.
AbortConfig abortConfig
Allows you to create criteria to abort a job.
TimeoutConfig timeoutConfig
Specifies the amount of time each device has to finish its execution of the job. The timer is started when the
job execution status is set to IN_PROGRESS
. If the job execution status is not set to another
terminal state before the time expires, it will be automatically set to TIMED_OUT
.
String frequency
How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system.
String dayOfMonth
The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
String dayOfWeek
The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
List<E> targetCheckNames
Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
DescribeAccountAuditConfiguration
to see the list of all checks including those that are enabled or
UpdateAccountAuditConfiguration
to select which checks are enabled.)
String scheduledAuditName
The name of the scheduled audit. (Max. 128 chars)
String scheduledAuditArn
The ARN of the scheduled audit.
String securityProfileName
The name of the security profile you want to update.
String securityProfileDescription
A description of the security profile.
List<E> behaviors
Specifies the behaviors that, when violated by a device (thing), cause an alert.
Map<K,V> alertTargets
Where the alerts are sent. (Alerts are always sent to the console.)
List<E> additionalMetricsToRetain
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the
profile's behaviors
but it is also retained for any metric specified here.
Boolean deleteBehaviors
If true, delete all behaviors
defined for this security profile. If any behaviors
are
defined in the current invocation an exception occurs.
Boolean deleteAlertTargets
If true, delete all alertTargets
defined for this security profile. If any alertTargets
are defined in the current invocation an exception occurs.
Boolean deleteAdditionalMetricsToRetain
If true, delete all additionalMetricsToRetain
defined for this security profile. If any
additionalMetricsToRetain
are defined in the current invocation an exception occurs.
Long expectedVersion
The expected version of the security profile. A new version is generated whenever the security profile is
updated. If you specify a value that is different than the actual version, a
VersionConflictException
is thrown.
String securityProfileName
The name of the security profile that was updated.
String securityProfileArn
The ARN of the security profile that was updated.
String securityProfileDescription
The description of the security profile.
List<E> behaviors
Specifies the behaviors that, when violated by a device (thing), cause an alert.
Map<K,V> alertTargets
Where the alerts are sent. (Alerts are always sent to the console.)
List<E> additionalMetricsToRetain
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the
security profile's behaviors
but it is also retained for any metric specified here.
Long version
The updated version of the security profile.
Date creationDate
The time the security profile was created.
Date lastModifiedDate
The time the security profile was last modified.
String thingGroupName
The thing group to update.
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.
List<E> thingGroupsToAdd
The groups to which the thing will be added.
List<E> thingGroupsToRemove
The groups from which the thing will be removed.
Boolean overrideDynamicGroups
Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
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 association is removed.
String errorMessage
The description of an error found in the behaviors.
String violationId
The ID of the violation event.
String thingName
The name of the thing responsible for the violation event.
String securityProfileName
The name of the security profile whose behavior was violated.
Behavior behavior
The behavior which was violated.
MetricValue metricValue
The value of the metric (the measurement).
String violationEventType
The type of violation event.
Date violationEventTime
The time the violation event occurred.
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 © 2019. All rights reserved.