String failureType
The type of job execution failure to define a rule to initiate a job abort.
Constraints:
Allowed Values: FAILED, REJECTED, TIMED_OUT, ALL
String action
The type of abort action to initiate a job abort.
Constraints:
Allowed Values: CANCEL
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).
Constraints:
Range: - 100
Integer minNumberOfExecutedThings
Minimum number of executed things before evaluating an abort rule.
Constraints:
Range: 1 -
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.
IotSiteWiseAction iotSiteWise
Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
StepFunctionsAction stepFunctions
Starts execution of a Step Functions state machine.
HttpAction http
Send data to an HTTPS endpoint.
String violationId
The ID of the active violation.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+
String thingName
The name of the thing responsible for the active violation.
Constraints:
Length: 1 - 128
String securityProfileName
The security profile whose behavior is in violation.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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.
List<E> thingGroupNames
The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.
Boolean overrideDynamicGroups
Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.
String billingGroupName
The name of the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String billingGroupArn
The ARN of the billing group.
String thingName
The name of the thing to be added to the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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.
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.
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.
AssetPropertyVariant value
The value of the asset property.
AssetPropertyTimestamp timestamp
The asset property value timestamp.
String quality
Optional. A string that describes the quality of the value. Accepts
substitution templates. Must be GOOD, BAD, or
UNCERTAIN.
String stringValue
Optional. The string value of the value entry. Accepts substitution templates.
Constraints:
Length: 1 - 1024
String integerValue
Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
String doubleValue
Optional. A string that contains the double value of the value entry. Accepts substitution templates.
String booleanValue
Optional. A string that contains the boolean value (true or
false) of the value entry. Accepts substitution templates.
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 or UpdateThingGroup.
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".
Constraints:
Allowed Values: IN_PROGRESS, WAITING_FOR_DATA_COLLECTION,
CANCELED, COMPLETED_COMPLIANT, COMPLETED_NON_COMPLIANT, FAILED
Boolean checkCompliant
True if the check is complete and found all resources compliant.
Long totalResourcesCount
The number of resources on which the check was performed.
Long nonCompliantResourcesCount
The number of resources that were found noncompliant during the check.
String errorCode
The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".
String message
The message associated with any error encountered when this check is performed during this audit.
Constraints:
Length: - 2048
String findingId
A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String taskId
The ID of the audit that generated this result (finding).
Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+
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).
Constraints:
Allowed Values: CRITICAL, HIGH, MEDIUM, LOW
NonCompliantResource nonCompliantResource
The resource that was found to be noncompliant with the audit check.
List<E> relatedResources
The list of related resources.
String reasonForNonCompliance
The reason the resource was noncompliant.
String reasonForNonComplianceCode
A code that indicates the reason that the resource was noncompliant.
String taskId
The unique identifier for the task that applies the mitigation action.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String findingId
The unique identifier for the findings to which the task and associated mitigation action are applied.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String actionName
The friendly name of the mitigation action being applied by the task.
Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+
String actionId
The unique identifier for the mitigation action being applied by the task.
String status
The current status of the task being executed.
Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED, SKIPPED,
PENDING
Date startTime
The date and time when the task was started.
Date endTime
The date and time when the task was completed or canceled. Blank if the task is still running.
String errorCode
If an error occurred, the code that indicates which type of error occurred.
String message
If an error occurred, a message that describes the error.
Constraints:
Length: - 2048
String taskId
The unique identifier for the task.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
Date startTime
The time at which the audit mitigation actions task was started.
String taskStatus
The current state of the audit mitigation actions task.
Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED
String auditTaskId
If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.
Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+
List<E> findingIds
If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.
Map<K,V> auditCheckToReasonCodeFilter
Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.
String targetArn
The ARN of the target (SNS topic) to which audit notifications are sent.
String roleArn
The ARN of the role that grants permission to send notifications to the target.
Constraints:
Length: 20 - 2048
Boolean enabled
True if notifications to the target are enabled.
String taskId
The ID of this audit.
Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+
String taskStatus
The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED
String taskType
The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
Constraints:
Allowed Values: ON_DEMAND_AUDIT_TASK, SCHEDULED_AUDIT_TASK
String defaultAuthorizerName
The name of the authorization service for a domain configuration.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
Boolean allowAuthorizerOverride
A Boolean that specifies whether the domain configuration's authorization service can be overridden.
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.
Boolean signingDisabled
Specifies whether AWS IoT validates the token signature in an authorization request.
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.
Integer maximumPerMinute
The maximum number of OTA update job executions started per minute.
Constraints:
Range: 1 - 1000
Long expiresInSec
How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.
String name
The name you have given to the behavior.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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).
Constraints:
Allowed Values: less-than, less-than-equals, greater-than,
greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set,
not-in-port-set
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.
Constraints:
Range: 1 - 10
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.
Constraints:
Range: 1 - 10
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.
Constraints:
Length: - 2028
Pattern: [\p{Graph}\x20]*
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:
Length: 12 - 12
Pattern: [0-9]+
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.
CertificateValidity validity
When the CA certificate is valid.
String taskId
The unique identifier for the task that you want to cancel.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String taskId
The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".
Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+
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 reasonCode
(Optional)A reason code string that explains why the job was canceled.
Constraints:
Length: - 128
Pattern: [\p{Upper}\p{Digit}_]+
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:
Length: 12 - 12
Pattern: [0-9]+
String previousOwnedBy
The ID of the AWS account of the previous owner of the certificate.
Constraints:
Length: 12 - 12
Pattern: [0-9]+
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.
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 confirmationToken
The token used to confirm ownership or access to the topic rule confirmation URL.
Constraints:
Length: 1 - 2048
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
Boolean signingDisabled
Specifies whether AWS IoT validates the token signature in an authorization request.
String billingGroupName
The name you wish to give to the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
BillingGroupProperties billingGroupProperties
The properties of the billing group.
List<E> tags
Metadata which can be used to manage the billing group.
String billingGroupName
The name you gave to the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String billingGroupArn
The ARN of the billing group.
String billingGroupId
The ID of the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+
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 domainConfigurationName
The name of the domain configuration. This value must be unique to a region.
Constraints:
Length: 1 - 128
Pattern: [\w.-]+
String domainName
The name of the domain.
Constraints:
Length: 1 - 253
List<E> serverCertificateArns
The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for AWS-managed domains.
String validationCertificateArn
The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for AWS-managed domains.
Constraints:
Length: 1 - 2048
Pattern:
arn:aws:acm:[a-z]{2}-(gov-)?[a-z]{4,9}-\d{1}:\d{12}:certificate
/?[a-zA-Z0-9/-]+
AuthorizerConfig authorizerConfig
An object that specifies the authorization service for a domain.
String serviceType
The type of service delivered by the endpoint.
Constraints:
Allowed Values: DATA, CREDENTIAL_PROVIDER, JOBS
String thingGroupName
The dynamic thing group name to create.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
ThingGroupProperties thingGroupProperties
The dynamic thing group properties.
String indexName
The dynamic thing group index name.
Currently one index is supported: "AWS_Things".
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String queryString
The dynamic thing group search query string.
See Query Syntax for information about query string syntax.
Constraints:
Length: 1 -
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.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingGroupArn
The dynamic thing group ARN.
String thingGroupId
The dynamic thing group ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+
String indexName
The dynamic thing group index name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String queryString
The dynamic thing group search query string.
Constraints:
Length: 1 -
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.
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.
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.
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.
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).
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 actionName
A friendly name for the action. Choose a friendly name that accurately
describes the action (for example, EnableLoggingAction).
Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+
String roleArn
The ARN of the IAM role that is used to apply the mitigation action.
Constraints:
Length: 20 - 2048
MitigationActionParams actionParams
Defines the type of action and the parameters for that action.
List<E> tags
Metadata that can be used to manage the mitigation action.
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.
List<E> protocols
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
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
AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig
Configuration for the rollout of OTA updates.
AwsJobPresignedUrlConfig awsJobPresignedUrlConfig
Configuration information for pre-signed URLs.
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.
List<E> tags
Metadata which can be used to manage updates.
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 templateName
The name of the provisioning template to use.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
String certificateId
The ID of the certificate.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String certificatePem
The provisioning claim certificate.
Constraints:
Length: 1 - 65536
KeyPair keyPair
The provisioning claim key pair.
Date expiration
The provisioning claim expiration time.
String templateName
The name of the fleet provisioning template.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
String description
The description of the fleet provisioning template.
Constraints:
Length: 0 - 500
Pattern: [^\p{C}]*
String templateBody
The JSON formatted contents of the fleet provisioning template.
Boolean enabled
True to enable the fleet provisioning template, otherwise false.
String provisioningRoleArn
The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
Constraints:
Length: 20 - 2048
List<E> tags
Metadata which can be used to manage the fleet provisioning template.
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..."
String templateArn
The ARN that identifies the provisioning template.
String templateName
The name of the fleet provisioning template.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
Integer defaultVersionId
The default version of the fleet provisioning template.
String templateName
The name of the fleet provisioning template.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
String templateBody
The JSON formatted contents of the fleet provisioning template.
Boolean setAsDefault
Sets a fleet provision template version as the default version.
String templateArn
The ARN that identifies the provisioning template.
String templateName
The name of the fleet provisioning template.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
Integer versionId
The version of the fleet provisioning template.
Boolean isDefaultVersion
True if the fleet provisioning template version is the default version, otherwise false.
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 frequency
How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the system.
Constraints:
Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
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.
Constraints:
Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
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".
Constraints:
Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
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 use
UpdateAccountAuditConfiguration to select which checks are
enabled.)
String scheduledAuditName
The name you want to give to the scheduled audit. (Max. 128 chars)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
List<E> tags
Metadata that can be used to manage the scheduled audit.
String scheduledAuditArn
The ARN of the scheduled audit.
String securityProfileName
The name you are giving to the security profile.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String securityProfileDescription
A description of the security profile.
Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*
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 that can be used to manage the security profile.
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
List<E> tags
Metadata which can be used to manage streams.
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.
List<E> tags
Metadata which can be used to manage the thing group.
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 billingGroupName
The name of the billing group the thing will be added to.
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:_-]+
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.
TopicRuleDestinationConfiguration destinationConfiguration
The topic rule destination configuration.
TopicRuleDestination topicRuleDestination
The topic rule destination.
String ruleName
The name of the rule.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
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.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String billingGroupName
The name of the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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.)
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
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]+
Boolean forceDelete
Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.
String domainConfigurationName
The name of the domain configuration to be deleted.
Constraints:
Length: 1 - 128
Pattern: [\w.-]+
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 actionName
The name of the mitigation action that you want to delete.
Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+
String otaUpdateId
The OTA update ID to delete.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
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.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String templateName
The name of the fleet provision template to delete.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
String roleAlias
The role alias to delete.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String scheduledAuditName
The name of the scheduled audit you want to delete.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String securityProfileName
The name of the security profile to be deleted.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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 from the actual version, a
VersionConflictException is thrown.
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 arn
The ARN of the topic rule destination to delete.
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 roleArn
The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
On the first call to UpdateAccountAuditConfiguration, this
parameter is required.
Constraints:
Length: 20 - 2048
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 findingId
A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
AuditFinding finding
The findings (results) of the audit.
String taskId
The unique identifier for the audit mitigation task.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String taskStatus
The current status of the task.
Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED
Date startTime
The date and time when the task was started.
Date endTime
The date and time when the task was completed or canceled.
Map<K,V> taskStatistics
Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.
AuditMitigationActionsTaskTarget target
Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.
Map<K,V> auditCheckToActionsMapping
Specifies the mitigation actions that should be applied to specific audit checks.
List<E> actionsDefinition
Specifies the mitigation actions and their parameters that are applied as part of this task.
String taskId
The ID of the audit whose information you want to get.
Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+
String taskStatus
The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED
String taskType
The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
Constraints:
Allowed Values: ON_DEMAND_AUDIT_TASK, 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).
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
Map<K,V> auditDetails
Detailed information about each check performed during this audit.
String authorizerName
The name of the authorizer to describe.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
AuthorizerDescription authorizerDescription
The authorizer description.
String billingGroupName
The name of the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String billingGroupName
The name of the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String billingGroupId
The ID of the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+
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.
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 domainConfigurationName
The name of the domain configuration.
Constraints:
Length: 1 - 128
Pattern: [\w.:-]+
String domainConfigurationName
The name of the domain configuration.
Constraints:
Length: 1 - 128
Pattern: [\w.:-]+
String domainConfigurationArn
The ARN of the domain configuration.
String domainName
The name of the domain.
Constraints:
Length: 1 - 253
List<E> serverCertificates
A list containing summary information about the server certificate included in the domain configuration.
AuthorizerConfig authorizerConfig
An object that specifies the authorization service for a domain.
String domainConfigurationStatus
A Boolean value that specifies the current state of the domain configuration.
Constraints:
Allowed Values: ENABLED, DISABLED
String serviceType
The type of service delivered by the endpoint.
Constraints:
Allowed Values: DATA, CREDENTIAL_PROVIDER, JOBS
String domainType
The type of the domain.
Constraints:
Allowed Values: ENDPOINT, AWS_MANAGED, CUSTOMER_MANAGED
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.
Constraints:
Length: - 128
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 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.
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 actionName
The friendly name that uniquely identifies the mitigation action.
Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+
String actionName
The friendly name that uniquely identifies the mitigation action.
Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+
String actionType
The type of mitigation action.
Constraints:
Allowed Values: UPDATE_DEVICE_CERTIFICATE, UPDATE_CA_CERTIFICATE,
ADD_THINGS_TO_THING_GROUP, REPLACE_DEFAULT_POLICY_VERSION,
ENABLE_IOT_LOGGING, PUBLISH_FINDING_TO_SNS
String actionArn
The ARN that identifies this migration action.
String actionId
A unique identifier for this action.
String roleArn
The ARN of the IAM role used to apply this action.
Constraints:
Length: 20 - 2048
MitigationActionParams actionParams
Parameters that control how the mitigation action is applied, specific to the type of mitigation action.
Date creationDate
The date and time when the mitigation action was added to your AWS account.
Date lastModifiedDate
The date and time when the mitigation action was last changed.
String templateName
The name of the fleet provisioning template.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
String templateArn
The ARN of the fleet provisioning template.
String templateName
The name of the fleet provisioning template.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
String description
The description of the fleet provisioning template.
Constraints:
Length: 0 - 500
Pattern: [^\p{C}]*
Date creationDate
The date when the fleet provisioning template was created.
Date lastModifiedDate
The date when the fleet provisioning template was last modified.
Integer defaultVersionId
The default fleet template version ID.
String templateBody
The JSON formatted contents of the fleet provisioning template.
Boolean enabled
True if the fleet provisioning template is enabled, otherwise false.
String provisioningRoleArn
The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
Constraints:
Length: 20 - 2048
Integer versionId
The fleet provisioning template version ID.
Date creationDate
The date when the fleet provisioning template version was created.
String templateBody
The JSON formatted contents of the fleet provisioning template version.
Boolean isDefaultVersion
True if the fleet provisioning template version is the default version.
String roleAlias
The role alias to describe.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
RoleAliasDescription roleAliasDescription
The role alias description.
String scheduledAuditName
The name of the scheduled audit whose information you want to get.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String frequency
How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.
Constraints:
Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
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.
Constraints:
Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
String dayOfWeek
The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT".
Constraints:
Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
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 use
UpdateAccountAuditConfiguration to select which checks are
enabled.)
String scheduledAuditName
The name of the scheduled audit.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String scheduledAuditArn
The ARN of the scheduled audit.
String securityProfileName
The name of the security profile whose information you want to get.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String securityProfileName
The name of the security profile.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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).
Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*
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.
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 indexName
The dynamic thing group index name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String queryString
The dynamic thing group search query string.
Constraints:
Length: 1 -
String queryVersion
The dynamic thing group query version.
String status
The dynamic thing group status.
Constraints:
Allowed Values: ACTIVE, BUILDING, REBUILDING
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 billingGroupName
The name of the billing group the thing belongs to.
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 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.
S3Destination s3Destination
Describes the location in S3 of the updated firmware.
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 domainConfigurationName
The name of the domain configuration. This value must be unique to a region.
Constraints:
Length: 1 - 128
Pattern: [\w.:-]+
String domainConfigurationArn
The ARN of the domain configuration.
String serviceType
The type of service delivered by the endpoint.
Constraints:
Allowed Values: DATA, CREDENTIAL_PROVIDER, JOBS
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_]+$
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.
Constraints:
Range: 1 - 1000
Double incrementFactor
The exponential factor to increase the rate of rollout for a job.
Constraints:
Range: 1 - 5
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).
Constraints:
Pattern: ([\n\t])|(\r\n)|(,)
String indexName
The name of the index to search.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String queryString
The search query.
Constraints:
Length: 1 -
String aggregationField
The field to aggregate.
Constraints:
Length: 1 -
String queryVersion
The query version.
Integer cardinality
The approximate count of unique values that match the query.
ThingIndexingConfiguration thingIndexingConfiguration
Thing indexing configuration.
ThingGroupIndexingConfiguration thingGroupIndexingConfiguration
The index 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 indexName
The name of the index to search.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String queryString
The query string.
Constraints:
Length: 1 -
String aggregationField
The field to aggregate.
Constraints:
Length: 1 -
String queryVersion
The query version.
List<E> percents
The percentile groups returned.
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 was created.
Date lastModifiedDate
The date the policy 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 indexName
The name of the index to search. The default value is
AWS_Things.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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.
Constraints:
Length: 1 -
String aggregationField
The aggregation field name.
Constraints:
Length: 1 -
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 arn
The ARN of the topic rule destination.
TopicRuleDestination topicRuleDestination
The topic rule destination.
String ruleName
The name of the rule.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
String url
The endpoint URL. If substitution templates are used in the URL, you must
also specify a confirmationUrl. If this is a new
destination, a new TopicRuleDestination is created if
possible.
Constraints:
Length: - 2000
String confirmationUrl
The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substituion template before traffic is allowed to your endpoint URL.
Constraints:
Length: - 2000
List<E> headers
The HTTP headers to send with the message data.
HttpAuthorization auth
The authentication method to use when sending data to an HTTPS endpoint.
SigV4Authorization sigv4
Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process.
String confirmationUrl
The URL AWS IoT uses to confirm ownership of or access to the topic rule destination URL.
Constraints:
Length: - 2000
String confirmationUrl
The URL used to confirm the HTTP topic rule destination URL.
Constraints:
Length: - 2000
String confirmationUrl
The URL used to confirm ownership of or access to the HTTP topic rule destination URL.
Constraints:
Length: - 2000
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.
Constraints:
Length: 1 - 128
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.
Constraints:
Length: - 128
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").
List<E> putAssetPropertyValueEntries
A list of asset property value entries.
String roleArn
The ARN of the role that grants AWS IoT permission to send an asset
property value to AWS IoTSiteWise. (
"Action": "iotsitewise:BatchPutAssetPropertyValue"). The
trust policy can restrict access to specific asset hierarchy paths.
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, DELETION_IN_PROGRESS 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 reasonCode
If the job was updated, provides the reason code for the update.
Constraints:
Length: - 128
Pattern: [\p{Upper}\p{Digit}_]+
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.
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.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String status
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT,
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 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.
Constraints:
Range: 1 -
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.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT,
REJECTED, REMOVED, CANCELED
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.
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.
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.
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 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.
Constraints:
Length: 1 - 128
String securityProfileName
The name of the Device Defender security profile for which violations are listed.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String nextToken
The token for the next set of results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String target
The group or principal 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
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.
Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+
String checkName
A filter to limit results to the findings for the specified audit check.
ResourceIdentifier resourceIdentifier
Information identifying the noncompliant resource.
Integer maxResults
The maximum number of results to return at one time. The default is 25.
Constraints:
Range: 1 - 250
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.
String taskId
Specify this filter to limit results to actions for a specific audit mitigation actions task.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String actionStatus
Specify this filter to limit results to those with a specific status.
Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED, SKIPPED,
PENDING
String findingId
Specify this filter to limit results to those that were applied to a specific audit finding.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
Integer maxResults
The maximum number of results to return at one time. The default is 25.
Constraints:
Range: 1 - 250
String nextToken
The token for the next set of results.
String auditTaskId
Specify this filter to limit results to tasks that were applied to results for a specific audit.
Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+
String findingId
Specify this filter to limit results to tasks that were applied to a specific audit finding.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String taskStatus
Specify this filter to limit results to tasks that are in a specific state.
Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED
Integer maxResults
The maximum number of results to return at one time. The default is 25.
Constraints:
Range: 1 - 250
String nextToken
The token for the next set of results.
Date startTime
Specify this filter to limit results to tasks that began on or after a specific date and time.
Date endTime
Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.
Date startTime
The beginning of the time period. 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".
Constraints:
Allowed Values: ON_DEMAND_AUDIT_TASK, 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".
Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, 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.
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 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 namePrefixFilter
Limit the results to billing groups whose names have the given prefix.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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 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
String serviceType
The type of service delivered by the endpoint.
Constraints:
Allowed Values: DATA, CREDENTIAL_PROVIDER, JOBS
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, TIMED_OUT,
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, TIMED_OUT,
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\-]+
String actionType
Specify a value to limit the result to mitigation actions with a specific action type.
Constraints:
Allowed Values: UPDATE_DEVICE_CERTIFICATE, UPDATE_CA_CERTIFICATE,
ADD_THINGS_TO_THING_GROUP, REPLACE_DEFAULT_POLICY_VERSION,
ENABLE_IOT_LOGGING, PUBLISH_FINDING_TO_SNS
Integer maxResults
The maximum number of results to return at one time. The default is 25.
Constraints:
Range: 1 - 250
String nextToken
The token for the next set of results.
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.
String templateName
The name of the fleet provisioning template.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String nextToken
A token to retrieve the next set of results.
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 nextToken
The token for the next set of results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
Boolean recursive
If true, return child groups too.
String securityProfileTargetArn
The ARN of the target (thing group) whose attached security profiles you want to get.
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 nextToken
The token to retrieve the next set of 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 to retrieve the next set of 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 billingGroupName
The name of the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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 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 to retrieve the next set of results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
String nextToken
The token to retrieve the next set of 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 to retrieve the next set of 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
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.
Constraints:
Length: 1 - 128
String securityProfileName
A filter to limit results to those alerts generated by the specified security profile.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String nextToken
The token for the next set of results.
Integer maxResults
The maximum number of results to return at one time.
Constraints:
Range: 1 - 250
List<E> violationEvents
The security profile violation alerts issued for this account during the given time period, 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.
Constraints:
Range: 0 -
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 name
A user-friendly name for the mitigation action.
Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+
String id
A unique identifier for the mitigation action.
String roleArn
The IAM role ARN used to apply this mitigation action.
Constraints:
Length: 20 - 2048
MitigationActionParams actionParams
The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
UpdateDeviceCertificateParams updateDeviceCertificateParams
Parameters to define a mitigation action that changes the state of the device certificate to inactive.
UpdateCACertificateParams updateCACertificateParams
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
AddThingsToThingGroupParams addThingsToThingGroupParams
Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.
ReplaceDefaultPolicyVersionParams replaceDefaultPolicyVersionParams
Parameters to define a mitigation action that adds a blank policy to restrict permissions.
EnableIoTLoggingParams enableIoTLoggingParams
Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.
PublishFindingToSnsParams publishFindingToSnsParams
Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.
String username
The value of the username key in an MQTT authorization
request.
Constraints:
Length: 1 - 65535
ByteBuffer password
The value of the password key in an MQTT authorization
request.
Constraints:
Length: 1 - 65535
String clientId
The value of the clientId key in an MQTT authorization
request.
Constraints:
Length: 1 - 65535
String resourceType
The type of the noncompliant resource.
Constraints:
Allowed Values: DEVICE_CERTIFICATE, CA_CERTIFICATE, IOT_POLICY,
COGNITO_IDENTITY_POOL, CLIENT_ID, ACCOUNT_SETTINGS, ROLE_ALIAS, IAM_ROLE
ResourceIdentifier resourceIdentifier
Information that identifies the noncompliant resource.
Map<K,V> additionalInfo
Other information about the noncompliant 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.
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.
List<E> protocols
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig
Configuration for the rollout of OTA updates.
AwsJobPresignedUrlConfig awsJobPresignedUrlConfig
Configuration information for pre-signed URLs. Valid when
protocols contains HTTP.
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:
Length: 12 - 12
Pattern: [0-9]+
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 templateArn
The ARN of the fleet provisioning template.
String templateName
The name of the fleet provisioning template.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
String description
The description of the fleet provisioning template.
Constraints:
Length: 0 - 500
Pattern: [^\p{C}]*
Date creationDate
The date when the fleet provisioning template summary was created.
Date lastModifiedDate
The date when the fleet provisioning template summary was last modified.
Boolean enabled
True if the fleet provision template is enabled, otherwise false.
Integer versionId
The ID of the fleet privisioning template version.
Date creationDate
The date when the fleet provisioning template version was created
Boolean isDefaultVersion
True if the fleet provisioning template version is the default version, otherwise false.
String topicArn
The ARN of the topic to which you want to publish the findings.
Constraints:
Length: - 350
String entryId
Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
String assetId
The ID of the AWS IoT SiteWise asset. You must specify either a
propertyAlias or both an aliasId and a
propertyId. Accepts substitution templates.
String propertyId
The ID of the asset's property. You must specify either a
propertyAlias or both an aliasId and a
propertyId. Accepts substitution templates.
String propertyAlias
The name of the property alias associated with your asset property. You
must specify either a propertyAlias or both an
aliasId and a propertyId. Accepts substitution
templates.
Constraints:
Length: 1 - 2048
List<E> propertyValues
A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
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.
Constraints:
Range: 1 -
Integer numberOfSucceededThings
The threshold for number of succeeded things that will initiate the increase in rate of rollout.
Constraints:
Range: 1 -
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 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 resourceType
The type of resource.
Constraints:
Allowed Values: DEVICE_CERTIFICATE, CA_CERTIFICATE, IOT_POLICY,
COGNITO_IDENTITY_POOL, CLIENT_ID, ACCOUNT_SETTINGS, ROLE_ALIAS, IAM_ROLE
ResourceIdentifier resourceIdentifier
Information that identifies the resource.
Map<K,V> additionalInfo
Other information about the resource.
String billingGroupName
The name of the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String billingGroupArn
The ARN of the billing group.
String thingName
The name of the thing to be removed from the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String thingArn
The ARN of the thing to be removed from the billing group.
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 templateName
The name of the template to be applied. The only supported value is
BLANK_POLICY.
Constraints:
Allowed Values: BLANK_POLICY
String ruleName
The name of the rule.
Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$
TopicRulePayload topicRulePayload
The rule payload.
String deviceCertificateId
The ID of the certificate attached to the resource.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String caCertificateId
The ID of the CA certificate used to authorize the certificate.
Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+
String cognitoIdentityPoolId
The ID of the Amazon 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.
Constraints:
Length: 12 - 12
Pattern: [0-9]+
String iamRoleArn
The ARN of the IAM role that has overly permissive actions.
Constraints:
Length: 20 - 2048
String roleAliasArn
The ARN of the role alias that has overly permissive actions.
Constraints:
Length: 1 - 2048
String roleAlias
The role alias.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
String roleAliasArn
The ARN of the role alias.
Constraints:
Length: 1 - 2048
String roleArn
The role ARN.
Constraints:
Length: 20 - 2048
String owner
The role alias owner.
Constraints:
Length: 12 - 12
Pattern: [0-9]+
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 scheduledAuditName
The name of the scheduled audit.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String scheduledAuditArn
The ARN of the scheduled audit.
String frequency
How often the scheduled audit occurs.
Constraints:
Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
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.
Constraints:
Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
String dayOfWeek
The day of the week on which the scheduled audit is run (if the
frequency is "WEEKLY" or "BIWEEKLY").
Constraints:
Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
String indexName
The search index name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String queryString
The search query string.
Constraints:
Length: 1 -
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 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 serverCertificateArn
The ARN of the server certificate.
Constraints:
Length: 1 - 2048
Pattern:
arn:aws:acm:[a-z]{2}-(gov-)?[a-z]{4,9}-\d{1}:\d{12}:certificate
/?[a-zA-Z0-9/-]+
String serverCertificateStatus
The status of the server certificate.
Constraints:
Allowed Values: INVALID, VALID
String serverCertificateStatusDetail
Details that explain the status of the server certificate.
String authorizerName
The authorizer name.
Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+
LoggingOptionsPayload loggingOptionsPayload
The logging options payload.
String roleArn
The ARN of the role that allows IoT to write to Cloudwatch logs.
String defaultLogLevel
The default logging level.
Constraints:
Allowed Values: DEBUG, INFO, ERROR, WARN, DISABLED
Boolean disableAllLogs
If true all logs are disabled. The default is 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 https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
Constraints:
Allowed Values: RAW, JSON
String taskId
A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
AuditMitigationActionsTaskTarget target
Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.
Map<K,V> auditCheckToActionsMapping
For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.
String clientRequestToken
Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.
Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$
String taskId
The unique identifier for the audit mitigation task. This matches the
taskId that you specified in the request.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
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.
Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+
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.
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 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.
Constraints:
Pattern: (p0|p0\.1|p0\.01|p1|p10|p50|p90|p99|p99\.9|p99\.99|p100)
Integer count
The count of things that match the query.
Double average
The average of the aggregated field values.
Double sum
The sum of the aggregated field values.
Double minimum
The minimum aggregated field value.
Double maximum
The maximum aggregated field value.
Double sumOfSquares
The sum of the squares of the aggregated field values.
Double variance
The variance of the aggregated field values.
Double stdDeviation
The standard deviation of the aggregated field values.
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.
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}]+
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 noncompliant resources.
Integer failedChecks
The number of checks.
Integer canceledChecks
The number of checks that did not run because the audit was canceled.
Long totalFindingsCount
The total number of findings to which a task is being applied.
Long failedFindingsCount
The number of findings for which at least one of the actions failed when applied.
Long succeededFindingsCount
The number of findings for which all mitigation actions succeeded when applied.
Long skippedFindingsCount
The number of findings skipped because of filter conditions provided in the parameters to the command.
Long canceledFindingsCount
The number of findings to which the mitigation action task was canceled when applied.
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 - 6144
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}
HttpContext httpContext
Specifies a test HTTP authorization request.
MqttContext mqttContext
Specifies a test MQTT authorization request.
TlsContext tlsContext
Specifies a test TLS authorization request.
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.
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.
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.
ThingConnectivity connectivity
Indicates whether the thing is connected to the AWS IoT service.
String thingGroupName
The thing group name.
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 thingGroupDescription
The thing group description.
Constraints:
Length: - 2028
Pattern: [\p{Graph}\x20]*
Map<K,V> attributes
The thing group attributes.
List<E> parentGroupNames
Parent group names.
String thingGroupIndexingMode
Thing group indexing mode.
Constraints:
Allowed Values: OFF, ON
List<E> managedFields
Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
List<E> customFields
A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
Contains custom field names and their data type.
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 contains registry data only.
REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
OFF - Thing indexing is disabled.
Constraints:
Allowed Values: OFF, REGISTRY, REGISTRY_AND_SHADOW
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.
Constraints:
Allowed Values: OFF, STATUS
List<E> managedFields
Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
List<E> customFields
Contains custom field names and their data type.
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.
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 serverName
The value of the serverName key in a TLS authorization
request.
Constraints:
Length: 1 - 253
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 arn
The topic rule destination URL.
String status
The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You can
set status to IN_PROGRESS by calling
UpdateTopicRuleDestination. Calling
UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed.
You can set status to DISABLED by calling
UpdateTopicRuleDestination.
Confirmation was completed, and traffic to this destination is not
allowed. You can set status to ENABLED by
calling UpdateTopicRuleDestination.
Confirmation could not be completed, for example if the confirmation
timed out. You can call GetTopicRuleDestination for details
about the error. You can set status to
IN_PROGRESS by calling
UpdateTopicRuleDestination. Calling
UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR
String statusReason
Additional details or reason why the topic rule destination is in the current status.
HttpUrlDestinationProperties httpUrlProperties
Properties of the HTTP URL.
HttpUrlDestinationConfiguration httpUrlConfiguration
Configuration of the HTTP URL.
String arn
The topic rule destination ARN.
String status
The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You can
set status to IN_PROGRESS by calling
UpdateTopicRuleDestination. Calling
UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed.
You can set status to DISABLED by calling
UpdateTopicRuleDestination.
Confirmation was completed, and traffic to this destination is not
allowed. You can set status to ENABLED by
calling UpdateTopicRuleDestination.
Confirmation could not be completed, for example if the confirmation
timed out. You can call GetTopicRuleDestination for details
about the error. You can set status to
IN_PROGRESS by calling
UpdateTopicRuleDestination. Calling
UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR
String statusReason
The reason the topic rule destination is in the current status.
HttpUrlDestinationSummary httpUrlSummary
Information about the HTTP URL.
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:
Length: 12 - 12
Pattern: [0-9]+
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 roleArn
The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.
Constraints:
Length: 20 - 2048
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.
Some data collection might start 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.
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 billingGroupName
The name of the billing group.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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 action
The action that you want to apply to the CA cerrtificate. The only
supported value is DEACTIVATE.
Constraints:
Allowed Values: DEACTIVATE
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, removes 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
String action
The action that you want to apply to the device cerrtificate. The only
supported value is DEACTIVATE.
Constraints:
Allowed Values: DEACTIVATE
String domainConfigurationName
The name of the domain configuration to be updated.
Constraints:
Length: 1 - 128
Pattern: [\w.:-]+
AuthorizerConfig authorizerConfig
An object that specifies the authorization service for a domain.
String domainConfigurationStatus
The status to which the domain configuration should be updated.
Constraints:
Allowed Values: ENABLED, DISABLED
Boolean removeAuthorizerConfig
Removes the authorization configuration from a domain.
String thingGroupName
The name of the dynamic thing group to update.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
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'.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String queryString
The dynamic thing group search query string to update.
Constraints:
Length: 1 -
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.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
String description
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
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 actionName
The friendly name for the mitigation action. You can't change the name by
using UpdateMitigationAction. Instead, you must delete and
re-create the mitigation action with the new name.
Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+
String roleArn
The ARN of the IAM role that is used to apply the mitigation action.
Constraints:
Length: 20 - 2048
MitigationActionParams actionParams
Defines the type of action and the parameters for that action.
String templateName
The name of the fleet provisioning template.
Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$
String description
The description of the fleet provisioning template.
Constraints:
Length: 0 - 500
Pattern: [^\p{C}]*
Boolean enabled
True to enable the fleet provisioning template, otherwise false.
Integer defaultVersionId
The ID of the default provisioning template version.
String provisioningRoleArn
The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
Constraints:
Length: 20 - 2048
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 frequency
How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.
Constraints:
Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
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.
Constraints:
Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
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".
Constraints:
Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
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 use
UpdateAccountAuditConfiguration to select which checks are
enabled.)
String scheduledAuditName
The name of the scheduled audit. (Max. 128 chars)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
String scheduledAuditArn
The ARN of the scheduled audit.
String securityProfileName
The name of the security profile you want to update.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String securityProfileDescription
A description of the security profile.
Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*
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 from the actual version, a
VersionConflictException is thrown.
String securityProfileName
The name of the security profile that was updated.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
String securityProfileArn
The ARN of the security profile that was updated.
String securityProfileDescription
The description of the security profile.
Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*
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 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.
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.
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 arn
The ARN of the topic rule destination.
String status
The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You can
set status to IN_PROGRESS by calling
UpdateTopicRuleDestination. Calling
UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed.
You can set status to DISABLED by calling
UpdateTopicRuleDestination.
Confirmation was completed, and traffic to this destination is not
allowed. You can set status to ENABLED by
calling UpdateTopicRuleDestination.
Confirmation could not be completed, for example if the confirmation
timed out. You can call GetTopicRuleDestination for details
about the error. You can set status to
IN_PROGRESS by calling
UpdateTopicRuleDestination. Calling
UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR
String errorMessage
The description of an error found in the behaviors.
Constraints:
Length: - 2048
String violationId
The ID of the violation event.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+
String thingName
The name of the thing responsible for the violation event.
Constraints:
Length: 1 - 128
String securityProfileName
The name of the security profile whose behavior was violated.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
Behavior behavior
The behavior which was violated.
MetricValue metricValue
The value of the metric (the measurement).
String violationEventType
The type of violation event.
Constraints:
Allowed Values: in-alarm, alarm-cleared, alarm-invalidated
Date violationEventTime
The time the violation event occurred.
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.
private void readObject(ObjectInputStream arg0) throws IOException, ClassNotFoundException
IOExceptionClassNotFoundExceptionprivate void writeObject(ObjectOutputStream arg0) throws IOException
IOExceptionBigInteger publicExponent
BigInteger modulus
Copyright © 2020. All rights reserved.