Package-level declarations

IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

Adds a thing to a billing group.

Adds a thing to a thing group.

Associates the selected software bill of materials (SBOM) with a specific software package version.

Associates a group with a continuous job. The following criteria must be met:

Attaches the specified policy to the specified principal (certificate or other credential).

Attaches the specified policy to the specified principal (certificate or other credential).

Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities.

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.

Cancels a pending transfer for the specified certificate.

Cancels a Device Defender ML Detect mitigation action.

Cancels a job.

Cancels the execution of a job for a given thing.

Clears the default authorizer.

Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

Creates a Device Defender audit suppression.

Creates an authorizer.

Creates a billing group. If this call is made multiple times using the same billing group name and configuration, the call will succeed. If this call is made with the same billing group name but different configuration a ResourceAlreadyExistsException is thrown.

Creates an X.509 certificate using the specified certificate signing request.

Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.

Creates a command. A command contains reusable configurations that can be applied before they are sent to the devices.

Use this API to define a Custom Metric published by your devices to Device Defender.

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

Creates a domain configuration.

Creates a dynamic thing group.

Creates a fleet metric.

Creates a job.

Creates a job template.

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

Creates an IoT OTA update on a target group of things or groups.

Creates an IoT software package that can be deployed to your fleet.

Creates a new version for an existing IoT software package.

Creates an IoT policy.

Creates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Creates a provisioning claim.

Creates a provisioning template.

Creates a new version of a provisioning template.

Creates a role alias.

Creates a scheduled audit that is run at a specified time interval.

Creates a Device Defender security profile.

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.

Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.

Create a thing group.

Creates a new thing type. If this call is made multiple times using the same thing type name and configuration, the call will succeed. If this call is made with the same thing type name but different configuration a ResourceAlreadyExistsException is thrown.

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Creates a topic rule destination. The destination must be confirmed prior to use.

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.

Deletes a Device Defender audit suppression.

Deletes an authorizer.

Deletes the billing group.

Deletes a registered CA certificate.

Deletes the specified certificate.

Deletes a certificate provider.

Delete a command resource.

Delete a command execution.

Deletes a Device Defender detect custom metric.

Removes the specified dimension from your Amazon Web Services accounts.

Deletes the specified domain configuration.

Deletes a dynamic thing group.

Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.

Deletes a job and its related job executions.

Deletes a job execution.

Deletes the specified job template.

Deletes a defined mitigation action from your Amazon Web Services accounts.

Delete an OTA update.

Deletes a specific version from a software package.

Deletes a specific version from a software package.

Deletes the specified policy.

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

Deletes a provisioning template.

Deletes a provisioning template version.

Deletes a CA certificate registration code.

Deletes a role alias

Deletes a scheduled audit.

Deletes a Device Defender security profile.

Deletes a stream.

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

Deletes a thing group.

Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

Deletes the rule.

Deletes a topic rule destination.

Deletes a logging level.

Deprecates a thing type. You can not associate new things with deprecated thing type.

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

Gets information about a Device Defender audit suppression.

Gets information about a Device Defender audit.

Describes an authorizer.

Returns information about a billing group.

Describes a registered CA certificate.

Gets information about the specified certificate.

Describes a certificate provider.

Gets information about a Device Defender detect custom metric.

Describes the default authorizer.

Gets information about a Device Defender ML Detect mitigation action.

Provides details about a dimension that is defined in your Amazon Web Services accounts.

Gets summary information about a domain configuration.

Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.

Describes event configurations.

Gets information about the specified fleet metric.

Describes a search index.

Describes a job.

Describes a job execution.

Returns information about a job template.

View details of a managed job template.

Gets information about a mitigation action.

Returns information about a provisioning template.

Returns information about a provisioning template version.

Describes a role alias.

Gets information about a scheduled audit.

Gets information about a Device Defender security profile.

Gets information about a stream.

Gets information about the specified thing.

Describe a thing group.

Describes a bulk thing provisioning task.

Gets information about the specified thing type.

Detaches a policy from the specified target.

Removes the specified policy from the specified certificate.

Disassociates a Device Defender security profile from a thing group or from this account.

Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Disables the rule.

Disassociates the selected software bill of materials (SBOM) from a specific software package version.

Enables the rule.

Returns a Device Defender's ML Detect Security Profile training model's status.

Aggregates on indexed data with search queries pertaining to particular fields.

Returns the approximate count of unique values that match the query.

Gets information about the specified command.

Gets information about the specific command execution on a single device.

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway.

Gets the indexing configuration.

Gets a job document.

Gets the logging options.

Gets an OTA update.

Gets information about the specified software package.

Gets information about the specified software package's configuration.

Gets information about the specified package version.

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

Gets information about the specified policy with the policy document of the default version.

Gets information about the specified policy version.

Gets a registration code used to register a CA certificate with IoT.

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

Retrieves the live connectivity status per device.

Gets information about the rule.

Gets information about a topic rule destination.

Gets the fine grained logging options.

Lists the active violations for a given Device Defender security profile.

Lists the policies attached to the specified thing group.

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)

Gets the status of audit mitigation action tasks that were executed.

Gets a list of audit mitigation action tasks that match the specified filters.

Lists your Device Defender audit listings.

Lists the Device Defender audits that have been performed during a given time period.

Lists the authorizers registered in your account.

Lists the billing groups you have created.

Lists the CA certificates registered for your Amazon Web Services account.

Lists all your certificate providers in your Amazon Web Services account.

Lists the certificates registered in your Amazon Web Services account.

List the device certificates signed by the specified CA certificate.

List all command executions.

List all commands in your account.

Lists your Device Defender detect custom metrics.

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

List of Device Defender ML Detect mitigation actions tasks.

List the set of dimensions that are defined for your Amazon Web Services accounts.

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

Lists all your fleet metrics.

Lists the search indices.

Lists the job executions for a job.

Lists the job executions for the specified thing.

Lists jobs.