View Source AWS.IoT (aws-elixir v1.0.4)

IoT

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.

The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.

The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.

For more information about how IoT works, see the Developer Guide.

For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.

Link to this section Summary

Functions

accept_certificate_transfer(client, certificate_id, input, options \\ [])

Accepts a pending certificate transfer.

add_thing_to_billing_group(client, input, options \\ [])

Adds a thing to a billing group.

add_thing_to_thing_group(client, input, options \\ [])

Adds a thing to a thing group.

associate_sbom_with_package_version(client, package_name, version_name, input, options \\ [])

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

associate_targets_with_job(client, job_id, input, options \\ [])

Associates a group with a continuous job.

attach_policy(client, policy_name, input, options \\ [])

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

attach_principal_policy(client, policy_name, input, options \\ [])

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

attach_security_profile(client, security_profile_name, input, options \\ [])

Associates a Device Defender security profile with a thing group or this account.

attach_thing_principal(client, thing_name, input, options \\ [])

Attaches the specified principal to the specified thing.

cancel_audit_mitigation_actions_task(client, task_id, input, options \\ [])

Cancels a mitigation action task that is in progress.

cancel_audit_task(client, task_id, input, options \\ [])

Cancels an audit that is in progress.

cancel_certificate_transfer(client, certificate_id, input, options \\ [])

Cancels a pending transfer for the specified certificate.

cancel_detect_mitigation_actions_task(client, task_id, input, options \\ [])

Cancels a Device Defender ML Detect mitigation action.

cancel_job(client, job_id, input, options \\ [])

Cancels a job.

cancel_job_execution(client, job_id, thing_name, input, options \\ [])

Cancels the execution of a job for a given thing.

clear_default_authorizer(client, input, options \\ [])

Clears the default authorizer.

confirm_topic_rule_destination(client, confirmation_token, options \\ [])

Confirms a topic rule destination.

create_audit_suppression(client, input, options \\ [])

Creates a Device Defender audit suppression.

create_authorizer(client, authorizer_name, input, options \\ [])

Creates an authorizer.

create_billing_group(client, billing_group_name, input, options \\ [])

Creates a billing group.

create_certificate_from_csr(client, input, options \\ [])

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

create_certificate_provider(client, certificate_provider_name, input, options \\ [])

Creates an Amazon Web Services IoT Core certificate provider.

create_command(client, command_id, input, options \\ [])

Creates a command.

create_custom_metric(client, metric_name, input, options \\ [])

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

create_dimension(client, name, input, options \\ [])

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender.

create_domain_configuration(client, domain_configuration_name, input, options \\ [])

Creates a domain configuration.

create_dynamic_thing_group(client, thing_group_name, input, options \\ [])

Creates a dynamic thing group.

create_fleet_metric(client, metric_name, input, options \\ [])

Creates a fleet metric.

create_job(client, job_id, input, options \\ [])

Creates a job.

create_job_template(client, job_template_id, input, options \\ [])

Creates a job template.

create_keys_and_certificate(client, input, options \\ [])

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.

create_mitigation_action(client, action_name, input, options \\ [])

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.

create_ota_update(client, ota_update_id, input, options \\ [])

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

create_package(client, package_name, input, options \\ [])

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

create_package_version(client, package_name, version_name, input, options \\ [])

Creates a new version for an existing IoT software package.

create_policy(client, policy_name, input, options \\ [])

Creates an IoT policy.

create_policy_version(client, policy_name, input, options \\ [])

Creates a new version of the specified IoT policy.

create_provisioning_claim(client, template_name, input, options \\ [])

Creates a provisioning claim.

create_provisioning_template(client, input, options \\ [])

Creates a provisioning template.

create_provisioning_template_version(client, template_name, input, options \\ [])

Creates a new version of a provisioning template.

create_role_alias(client, role_alias, input, options \\ [])

Creates a role alias.

create_scheduled_audit(client, scheduled_audit_name, input, options \\ [])

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

create_security_profile(client, security_profile_name, input, options \\ [])

Creates a Device Defender security profile.

create_stream(client, stream_id, input, options \\ [])

Creates a stream for delivering one or more large files in chunks over MQTT.

create_thing(client, thing_name, input, options \\ [])

Creates a thing record in the registry.

create_thing_group(client, thing_group_name, input, options \\ [])

Create a thing group.

create_thing_type(client, thing_type_name, input, options \\ [])

Creates a new thing type.

create_topic_rule(client, rule_name, input, options \\ [])

Creates a rule.

create_topic_rule_destination(client, input, options \\ [])

Creates a topic rule destination.

delete_account_audit_configuration(client, input, options \\ [])

Restores the default settings for Device Defender audits for this account.

delete_audit_suppression(client, input, options \\ [])

Deletes a Device Defender audit suppression.

delete_authorizer(client, authorizer_name, input, options \\ [])

Deletes an authorizer.

delete_billing_group(client, billing_group_name, input, options \\ [])

Deletes the billing group.

delete_ca_certificate(client, certificate_id, input, options \\ [])

Deletes a registered CA certificate.

delete_certificate(client, certificate_id, input, options \\ [])

Deletes the specified certificate.

delete_certificate_provider(client, certificate_provider_name, input, options \\ [])

Deletes a certificate provider.

delete_command(client, command_id, input, options \\ [])

Delete a command resource.

delete_command_execution(client, execution_id, input, options \\ [])

Delete a command execution.

delete_custom_metric(client, metric_name, input, options \\ [])

Deletes a Device Defender detect custom metric.

delete_dimension(client, name, input, options \\ [])

Removes the specified dimension from your Amazon Web Services accounts.

delete_domain_configuration(client, domain_configuration_name, input, options \\ [])

Deletes the specified domain configuration.

delete_dynamic_thing_group(client, thing_group_name, input, options \\ [])

Deletes a dynamic thing group.

delete_fleet_metric(client, metric_name, input, options \\ [])

Deletes the specified fleet metric.

delete_job(client, job_id, input, options \\ [])

Deletes a job and its related job executions.

delete_job_execution(client, execution_number, job_id, thing_name, input, options \\ [])

Deletes a job execution.

delete_job_template(client, job_template_id, input, options \\ [])

Deletes the specified job template.

delete_mitigation_action(client, action_name, input, options \\ [])

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

delete_ota_update(client, ota_update_id, input, options \\ [])

Delete an OTA update.

delete_package(client, package_name, input, options \\ [])

Deletes a specific version from a software package.

delete_package_version(client, package_name, version_name, input, options \\ [])

Deletes a specific version from a software package.

delete_policy(client, policy_name, input, options \\ [])

Deletes the specified policy.

delete_policy_version(client, policy_name, policy_version_id, input, options \\ [])

Deletes the specified version of the specified policy.

delete_provisioning_template(client, template_name, input, options \\ [])

Deletes a provisioning template.

delete_provisioning_template_version(client, template_name, version_id, input, options \\ [])

Deletes a provisioning template version.

delete_registration_code(client, input, options \\ [])

Deletes a CA certificate registration code.

delete_role_alias(client, role_alias, input, options \\ [])

Deletes a role alias

delete_scheduled_audit(client, scheduled_audit_name, input, options \\ [])

Deletes a scheduled audit.

delete_security_profile(client, security_profile_name, input, options \\ [])

Deletes a Device Defender security profile.

delete_stream(client, stream_id, input, options \\ [])

Deletes a stream.

delete_thing(client, thing_name, input, options \\ [])

Deletes the specified thing.

delete_thing_group(client, thing_group_name, input, options \\ [])

Deletes a thing group.

delete_thing_type(client, thing_type_name, input, options \\ [])

Deletes the specified thing type.

delete_topic_rule(client, rule_name, input, options \\ [])

Deletes the rule.

delete_topic_rule_destination(client, arn, input, options \\ [])

Deletes a topic rule destination.

delete_v2_logging_level(client, input, options \\ [])

Deletes a logging level.

deprecate_thing_type(client, thing_type_name, input, options \\ [])

Deprecates a thing type.

describe_account_audit_configuration(client, options \\ [])

Gets information about the Device Defender audit settings for this account.

describe_audit_finding(client, finding_id, options \\ [])

Gets information about a single audit finding.

describe_audit_mitigation_actions_task(client, task_id, options \\ [])

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings.

describe_audit_suppression(client, input, options \\ [])

Gets information about a Device Defender audit suppression.

describe_audit_task(client, task_id, options \\ [])

Gets information about a Device Defender audit.

describe_authorizer(client, authorizer_name, options \\ [])

Describes an authorizer.

describe_billing_group(client, billing_group_name, options \\ [])

Returns information about a billing group.

describe_ca_certificate(client, certificate_id, options \\ [])

Describes a registered CA certificate.

describe_certificate(client, certificate_id, options \\ [])

Gets information about the specified certificate.

describe_certificate_provider(client, certificate_provider_name, options \\ [])

Describes a certificate provider.

describe_custom_metric(client, metric_name, options \\ [])

Gets information about a Device Defender detect custom metric.

describe_default_authorizer(client, options \\ [])

Describes the default authorizer.

describe_detect_mitigation_actions_task(client, task_id, options \\ [])

Gets information about a Device Defender ML Detect mitigation action.

describe_dimension(client, name, options \\ [])

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

describe_domain_configuration(client, domain_configuration_name, options \\ [])

Gets summary information about a domain configuration.

describe_endpoint(client, endpoint_type \\ nil, options \\ [])

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

describe_event_configurations(client, options \\ [])

Describes event configurations.

describe_fleet_metric(client, metric_name, options \\ [])

Gets information about the specified fleet metric.

describe_index(client, index_name, options \\ [])

Describes a search index.

describe_job(client, job_id, before_substitution \\ nil, options \\ [])

Describes a job.

describe_job_execution(client, job_id, thing_name, execution_number \\ nil, options \\ [])

Describes a job execution.

describe_job_template(client, job_template_id, options \\ [])

Returns information about a job template.

describe_managed_job_template(client, template_name, template_version \\ nil, options \\ [])

View details of a managed job template.

describe_mitigation_action(client, action_name, options \\ [])

Gets information about a mitigation action.

describe_provisioning_template(client, template_name, options \\ [])

Returns information about a provisioning template.

describe_provisioning_template_version(client, template_name, version_id, options \\ [])

Returns information about a provisioning template version.

describe_role_alias(client, role_alias, options \\ [])

Describes a role alias.

describe_scheduled_audit(client, scheduled_audit_name, options \\ [])

Gets information about a scheduled audit.

describe_security_profile(client, security_profile_name, options \\ [])

Gets information about a Device Defender security profile.

describe_stream(client, stream_id, options \\ [])

Gets information about a stream.

describe_thing(client, thing_name, options \\ [])

Gets information about the specified thing.

describe_thing_group(client, thing_group_name, options \\ [])

Describe a thing group.

describe_thing_registration_task(client, task_id, options \\ [])

Describes a bulk thing provisioning task.

describe_thing_type(client, thing_type_name, options \\ [])

Gets information about the specified thing type.

detach_policy(client, policy_name, input, options \\ [])

Detaches a policy from the specified target.

detach_principal_policy(client, policy_name, input, options \\ [])

Removes the specified policy from the specified certificate.

detach_security_profile(client, security_profile_name, input, options \\ [])

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

detach_thing_principal(client, thing_name, input, options \\ [])

Detaches the specified principal from the specified thing.

disable_topic_rule(client, rule_name, input, options \\ [])

Disables the rule.

disassociate_sbom_from_package_version(client, package_name, version_name, input, options \\ [])

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

enable_topic_rule(client, rule_name, input, options \\ [])

Enables the rule.

get_behavior_model_training_summaries(client, max_results \\ nil, next_token \\ nil, security_profile_name \\ nil, options \\ [])

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

get_buckets_aggregation(client, input, options \\ [])

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

get_cardinality(client, input, options \\ [])

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

get_command(client, command_id, options \\ [])

Gets information about the specified command.

get_command_execution(client, execution_id, include_result \\ nil, target_arn, options \\ [])

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

get_effective_policies(client, input, options \\ [])

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.

get_indexing_configuration(client, options \\ [])

Gets the indexing configuration.

get_job_document(client, job_id, before_substitution \\ nil, options \\ [])

Gets a job document.

get_logging_options(client, options \\ [])

Gets the logging options.

get_ota_update(client, ota_update_id, options \\ [])

Gets an OTA update.

get_package(client, package_name, options \\ [])

Gets information about the specified software package.

get_package_configuration(client, options \\ [])

Gets information about the specified software package's configuration.

get_package_version(client, package_name, version_name, options \\ [])

Gets information about the specified package version.

get_percentiles(client, input, options \\ [])

Groups the aggregated values that match the query into percentile groupings.

get_policy(client, policy_name, options \\ [])

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

get_policy_version(client, policy_name, policy_version_id, options \\ [])

Gets information about the specified policy version.

get_registration_code(client, options \\ [])

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

get_statistics(client, input, options \\ [])

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.

get_topic_rule(client, rule_name, options \\ [])

Gets information about the rule.

get_topic_rule_destination(client, arn, options \\ [])

Gets information about a topic rule destination.

get_v2_logging_options(client, options \\ [])

Gets the fine grained logging options.

list_active_violations(client, behavior_criteria_type \\ nil, list_suppressed_alerts \\ nil, max_results \\ nil, next_token \\ nil, security_profile_name \\ nil, thing_name \\ nil, verification_state \\ nil, options \\ [])

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

list_attached_policies(client, target, input, options \\ [])

Lists the policies attached to the specified thing group.

list_audit_findings(client, input, options \\ [])

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.

list_audit_mitigation_actions_executions(client, action_status \\ nil, finding_id, max_results \\ nil, next_token \\ nil, task_id, options \\ [])

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

list_audit_mitigation_actions_tasks(client, audit_task_id \\ nil, end_time, finding_id \\ nil, max_results \\ nil, next_token \\ nil, start_time, task_status \\ nil, options \\ [])

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

list_audit_suppressions(client, input, options \\ [])

Lists your Device Defender audit listings.

list_audit_tasks(client, end_time, max_results \\ nil, next_token \\ nil, start_time, task_status \\ nil, task_type \\ nil, options \\ [])

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

list_authorizers(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, status \\ nil, options \\ [])

Lists the authorizers registered in your account.

list_billing_groups(client, max_results \\ nil, name_prefix_filter \\ nil, next_token \\ nil, options \\ [])

Lists the billing groups you have created.

list_ca_certificates(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, template_name \\ nil, options \\ [])

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

list_certificate_providers(client, ascending_order \\ nil, next_token \\ nil, options \\ [])

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

list_certificates(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

Lists the certificates registered in your Amazon Web Services account.

list_certificates_by_ca(client, ca_certificate_id, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

List the device certificates signed by the specified CA certificate.

list_command_executions(client, input, options \\ [])

List all command executions.

list_commands(client, command_parameter_name \\ nil, max_results \\ nil, namespace \\ nil, next_token \\ nil, sort_order \\ nil, options \\ [])

List all commands in your account.

list_custom_metrics(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists your Device Defender detect custom metrics.

list_detect_mitigation_actions_executions(client, end_time \\ nil, max_results \\ nil, next_token \\ nil, start_time \\ nil, task_id \\ nil, thing_name \\ nil, violation_id \\ nil, options \\ [])

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

list_detect_mitigation_actions_tasks(client, end_time, max_results \\ nil, next_token \\ nil, start_time, options \\ [])

List of Device Defender ML Detect mitigation actions tasks.

list_dimensions(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_domain_configurations(client, marker \\ nil, page_size \\ nil, service_type \\ nil, options \\ [])

Gets a list of domain configurations for the user.

list_fleet_metrics(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all your fleet metrics.

list_indices(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the search indices.

list_job_executions_for_job(client, job_id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists the job executions for a job.

list_job_executions_for_thing(client, thing_name, job_id \\ nil, max_results \\ nil, namespace_id \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists the job executions for the specified thing.

list_job_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of job templates.

list_jobs(client, max_results \\ nil, namespace_id \\ nil, next_token \\ nil, status \\ nil, target_selection \\ nil, thing_group_id \\ nil, thing_group_name \\ nil, options \\ [])

Lists jobs.

list_managed_job_templates(client, max_results \\ nil, next_token \\ nil, template_name \\ nil, options \\ [])

Returns a list of managed job templates.

list_metric_values(client, dimension_name \\ nil, dimension_value_operator \\ nil, end_time, max_results \\ nil, metric_name, next_token \\ nil, start_time, thing_name, options \\ [])

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

list_mitigation_actions(client, action_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Gets a list of all mitigation actions that match the specified filter criteria.

list_ota_updates(client, max_results \\ nil, next_token \\ nil, ota_update_status \\ nil, options \\ [])

Lists OTA updates.

list_outgoing_certificates(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

Lists certificates that are being transferred but not yet accepted.

list_package_versions(client, package_name, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists the software package versions associated to the account.

list_packages(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the software packages associated to the account.

list_policies(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

Lists your policies.

list_policy_principals(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, policy_name, options \\ [])

Lists the principals associated with the specified policy.

list_policy_versions(client, policy_name, options \\ [])

Lists the versions of the specified policy and identifies the default version.

list_principal_policies(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, principal, options \\ [])

Lists the policies attached to the specified principal.

list_principal_things(client, max_results \\ nil, next_token \\ nil, principal, options \\ [])

Lists the things associated with the specified principal.

list_principal_things_v2(client, max_results \\ nil, next_token \\ nil, thing_principal_type \\ nil, principal, options \\ [])

Lists the things associated with the specified principal.

list_provisioning_template_versions(client, template_name, max_results \\ nil, next_token \\ nil, options \\ [])

A list of provisioning template versions.

list_provisioning_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the provisioning templates in your Amazon Web Services account.

The related resources of an Audit finding.

list_role_aliases(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

Lists the role aliases registered in your account.

list_sbom_validation_results(client, package_name, version_name, max_results \\ nil, next_token \\ nil, validation_result \\ nil, options \\ [])

The validation results for all software bill of materials (SBOM) attached to a specific software package version.

list_scheduled_audits(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all of your scheduled audits.

list_security_profiles(client, dimension_name \\ nil, max_results \\ nil, metric_name \\ nil, next_token \\ nil, options \\ [])

Lists the Device Defender security profiles you've created.

list_security_profiles_for_target(client, max_results \\ nil, next_token \\ nil, recursive \\ nil, security_profile_target_arn, options \\ [])

Lists the Device Defender security profiles attached to a target (thing group).

list_streams(client, ascending_order \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all of the streams in your Amazon Web Services account.

list_tags_for_resource(client, next_token \\ nil, resource_arn, options \\ [])

Lists the tags (metadata) you have assigned to the resource.

list_targets_for_policy(client, policy_name, input, options \\ [])

List targets for the specified policy.

list_targets_for_security_profile(client, security_profile_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the targets (thing groups) associated with a given Device Defender security profile.

list_thing_groups(client, max_results \\ nil, name_prefix_filter \\ nil, next_token \\ nil, parent_group \\ nil, recursive \\ nil, options \\ [])

List the thing groups in your account.

list_thing_groups_for_thing(client, thing_name, max_results \\ nil, next_token \\ nil, options \\ [])

List the thing groups to which the specified thing belongs.

list_thing_principals(client, thing_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the principals associated with the specified thing.

list_thing_principals_v2(client, thing_name, max_results \\ nil, next_token \\ nil, thing_principal_type \\ nil, options \\ [])

Lists the principals associated with the specified thing.

list_thing_registration_task_reports(client, task_id, max_results \\ nil, next_token \\ nil, report_type, options \\ [])

Information about the thing registration tasks.

list_thing_registration_tasks(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

List bulk thing provisioning tasks.

list_thing_types(client, max_results \\ nil, next_token \\ nil, thing_type_name \\ nil, options \\ [])

Lists the existing thing types.

list_things(client, attribute_name \\ nil, attribute_value \\ nil, max_results \\ nil, next_token \\ nil, thing_type_name \\ nil, use_prefix_attribute_value \\ nil, options \\ [])

Lists your things.

list_things_in_billing_group(client, billing_group_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the things you have added to the given billing group.

list_things_in_thing_group(client, thing_group_name, max_results \\ nil, next_token \\ nil, recursive \\ nil, options \\ [])

Lists the things in the specified group.

list_topic_rule_destinations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all the topic rule destinations in your Amazon Web Services account.

list_topic_rules(client, max_results \\ nil, next_token \\ nil, rule_disabled \\ nil, topic \\ nil, options \\ [])

Lists the rules for the specific topic.

list_v2_logging_levels(client, max_results \\ nil, next_token \\ nil, target_type \\ nil, options \\ [])

Lists logging levels.

list_violation_events(client, behavior_criteria_type \\ nil, end_time, list_suppressed_alerts \\ nil, max_results \\ nil, next_token \\ nil, security_profile_name \\ nil, start_time, thing_name \\ nil, verification_state \\ nil, options \\ [])

Lists the Device Defender security profile violations discovered during the given time period.

metadata()

put_verification_state_on_violation(client, violation_id, input, options \\ [])

Set a verification state and provide a description of that verification state on a violation (detect alarm).

register_ca_certificate(client, input, options \\ [])

Registers a CA certificate with Amazon Web Services IoT Core.

register_certificate(client, input, options \\ [])

Registers a device certificate with IoT in the same certificate mode as the signing CA.

register_certificate_without_ca(client, input, options \\ [])

register_thing(client, input, options \\ [])

Provisions a thing in the device registry.

reject_certificate_transfer(client, certificate_id, input, options \\ [])

Rejects a pending certificate transfer.

remove_thing_from_billing_group(client, input, options \\ [])

Removes the given thing from the billing group.

remove_thing_from_thing_group(client, input, options \\ [])

Remove the specified thing from the specified group.

replace_topic_rule(client, rule_name, input, options \\ [])

Replaces the rule.

search_index(client, input, options \\ [])

The query search index.

set_default_authorizer(client, input, options \\ [])

Sets the default authorizer.

set_default_policy_version(client, policy_name, policy_version_id, input, options \\ [])

Sets the specified version of the specified policy as the policy's default (operative) version.

set_logging_options(client, input, options \\ [])

Sets the logging options.

set_v2_logging_level(client, input, options \\ [])

Sets the logging level.

set_v2_logging_options(client, input, options \\ [])

Sets the logging options for the V2 logging service.

start_audit_mitigation_actions_task(client, task_id, input, options \\ [])

Starts a task that applies a set of mitigation actions to the specified target.

start_detect_mitigation_actions_task(client, task_id, input, options \\ [])

Starts a Device Defender ML Detect mitigation actions task.

start_on_demand_audit_task(client, input, options \\ [])

Starts an on-demand Device Defender audit.

start_thing_registration_task(client, input, options \\ [])

Creates a bulk thing provisioning task.

stop_thing_registration_task(client, task_id, input, options \\ [])

Cancels a bulk thing provisioning task.

tag_resource(client, input, options \\ [])

Adds to or modifies the tags of the given resource.

test_authorization(client, input, options \\ [])

Tests if a specified principal is authorized to perform an IoT action on a specified resource.

test_invoke_authorizer(client, authorizer_name, input, options \\ [])

Tests a custom authorization behavior by invoking a specified custom authorizer.

transfer_certificate(client, certificate_id, input, options \\ [])

Transfers the specified certificate to the specified Amazon Web Services account.

untag_resource(client, input, options \\ [])

Removes the given tags (metadata) from the resource.

update_account_audit_configuration(client, input, options \\ [])

Configures or reconfigures the Device Defender audit settings for this account.

update_audit_suppression(client, input, options \\ [])

Updates a Device Defender audit suppression.

update_authorizer(client, authorizer_name, input, options \\ [])

Updates an authorizer.

update_billing_group(client, billing_group_name, input, options \\ [])

Updates information about the billing group.

update_ca_certificate(client, certificate_id, input, options \\ [])

Updates a registered CA certificate.

update_certificate(client, certificate_id, input, options \\ [])

Updates the status of the specified certificate.

update_certificate_provider(client, certificate_provider_name, input, options \\ [])

Updates a certificate provider.

update_command(client, command_id, input, options \\ [])

Update information about a command or mark a command for deprecation.

update_custom_metric(client, metric_name, input, options \\ [])

Updates a Device Defender detect custom metric.

update_dimension(client, name, input, options \\ [])

Updates the definition for a dimension.

update_domain_configuration(client, domain_configuration_name, input, options \\ [])

Updates values stored in the domain configuration.

update_dynamic_thing_group(client, thing_group_name, input, options \\ [])

Updates a dynamic thing group.

update_event_configurations(client, input, options \\ [])

Updates the event configurations.

update_fleet_metric(client, metric_name, input, options \\ [])

Updates the data for a fleet metric.

update_indexing_configuration(client, input, options \\ [])

Updates the search configuration.

update_job(client, job_id, input, options \\ [])

Updates supported fields of the specified job.

update_mitigation_action(client, action_name, input, options \\ [])

Updates the definition for the specified mitigation action.

update_package(client, package_name, input, options \\ [])

Updates the supported fields for a specific software package.

update_package_configuration(client, input, options \\ [])

Updates the software package configuration.

update_package_version(client, package_name, version_name, input, options \\ [])

Updates the supported fields for a specific package version.

update_provisioning_template(client, template_name, input, options \\ [])

Updates a provisioning template.

update_role_alias(client, role_alias, input, options \\ [])

Updates a role alias.

update_scheduled_audit(client, scheduled_audit_name, input, options \\ [])

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

update_security_profile(client, security_profile_name, input, options \\ [])

Updates a Device Defender security profile.

update_stream(client, stream_id, input, options \\ [])

Updates an existing stream.

update_thing(client, thing_name, input, options \\ [])

Updates the data for a thing.

update_thing_group(client, thing_group_name, input, options \\ [])

Update a thing group.

update_thing_groups_for_thing(client, input, options \\ [])

Updates the groups to which the thing belongs.

update_thing_type(client, thing_type_name, input, options \\ [])

Updates a thing type.

update_topic_rule_destination(client, input, options \\ [])

Updates a topic rule destination.

validate_security_profile_behaviors(client, input, options \\ [])

Validates a Device Defender security profile behaviors specification.

Link to this section Functions

accept_certificate_transfer(client, certificate_id, input, options \\ [])

Accepts a pending certificate transfer.

The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

Requires permission to access the AcceptCertificateTransfer action.

add_thing_to_billing_group(client, input, options \\ [])

Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup action.

add_thing_to_thing_group(client, input, options \\ [])

Adds a thing to a thing group.

Requires permission to access the AddThingToThingGroup action.

associate_sbom_with_package_version(client, package_name, version_name, input, options \\ [])

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

Requires permission to access the AssociateSbomWithPackageVersion action.

associate_targets_with_job(client, job_id, input, options \\ [])

Associates a group with a continuous job.

The following criteria must be met:

* The job must have been created with the targetSelection field set to "CONTINUOUS".

* The job status must currently be "IN_PROGRESS".

* The total number of targets associated with a job must not exceed 100.

Requires permission to access the AssociateTargetsWithJob action.

attach_policy(client, policy_name, input, options \\ [])

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

Requires permission to access the AttachPolicy action.

attach_principal_policy(client, policy_name, input, options \\ [])

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

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.

Requires permission to access the AttachPrincipalPolicy action.

attach_security_profile(client, security_profile_name, input, options \\ [])

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.

Requires permission to access the AttachSecurityProfile action.

attach_thing_principal(client, thing_name, input, options \\ [])

Attaches the specified principal to the specified thing.

A principal can be X.509 certificates, Amazon Cognito identities or federated identities.

Requires permission to access the AttachThingPrincipal action.

cancel_audit_mitigation_actions_task(client, task_id, input, options \\ [])

Cancels a mitigation action task that is in progress.

If the task is not in progress, an InvalidRequestException occurs.

Requires permission to access the CancelAuditMitigationActionsTask action.

cancel_audit_task(client, task_id, input, options \\ [])

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.

Requires permission to access the CancelAuditTask action.

cancel_certificate_transfer(client, certificate_id, input, options \\ [])

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

Requires permission to access the CancelCertificateTransfer action.

cancel_detect_mitigation_actions_task(client, task_id, input, options \\ [])

Cancels a Device Defender ML Detect mitigation action.

Requires permission to access the CancelDetectMitigationActionsTask action.

cancel_job(client, job_id, input, options \\ [])

Cancels a job.

Requires permission to access the CancelJob action.

cancel_job_execution(client, job_id, thing_name, input, options \\ [])

Cancels the execution of a job for a given thing.

Requires permission to access the CancelJobExecution action.

clear_default_authorizer(client, input, options \\ [])

Clears the default authorizer.

Requires permission to access the ClearDefaultAuthorizer action.

confirm_topic_rule_destination(client, confirmation_token, options \\ [])

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.

Requires permission to access the ConfirmTopicRuleDestination action.

create_audit_suppression(client, input, options \\ [])

Creates a Device Defender audit suppression.

Requires permission to access the CreateAuditSuppression action.

create_authorizer(client, authorizer_name, input, options \\ [])

Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

create_billing_group(client, billing_group_name, input, options \\ [])

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.

Requires permission to access the CreateBillingGroup action.

create_certificate_from_csr(client, input, options \\ [])

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

Requires permission to access the CreateCertificateFromCsr action.

The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.

Reusing the same certificate signing request (CSR) results in a distinct certificate.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr
--certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the corresponding CSR.

You can also run the aws iot create-certificate-from-csr part of the command in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr
--certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr
--certificate-signing-request file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:

> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr
--certificate-signing-request file://@path"

create_certificate_provider(client, certificate_provider_name, input, options \\ [])

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.

Requires permission to access the CreateCertificateProvider action.

After you create a certificate provider, the behavior of CreateCertificateFromCsr API for fleet provisioning will change and all API calls to CreateCertificateFromCsr will invoke the certificate provider to create the certificates. It can take up to a few minutes for this behavior to change after a certificate provider is created.

create_command(client, command_id, input, options \\ [])

Creates a command.

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

create_custom_metric(client, metric_name, input, options \\ [])

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

Requires permission to access the CreateCustomMetric action.

create_dimension(client, name, input, options \\ [])

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.

Requires permission to access the CreateDimension action.

create_domain_configuration(client, domain_configuration_name, input, options \\ [])

Creates a domain configuration.

Requires permission to access the CreateDomainConfiguration action.

create_dynamic_thing_group(client, thing_group_name, input, options \\ [])

Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup action.

create_fleet_metric(client, metric_name, input, options \\ [])

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

create_job(client, job_id, input, options \\ [])

Creates a job.

Requires permission to access the CreateJob action.

create_job_template(client, job_template_id, input, options \\ [])

Creates a job template.

Requires permission to access the CreateJobTemplate action.

create_keys_and_certificate(client, input, options \\ [])

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.

Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.

Requires permission to access the CreateKeysAndCertificate action.

create_mitigation_action(client, action_name, input, options \\ [])

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.

Requires permission to access the CreateMitigationAction action.

create_ota_update(client, ota_update_id, input, options \\ [])

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

Requires permission to access the CreateOTAUpdate action.

create_package(client, package_name, input, options \\ [])

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

Requires permission to access the CreatePackage and GetIndexingConfiguration actions.

create_package_version(client, package_name, version_name, input, options \\ [])

Creates a new version for an existing IoT software package.

Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.

create_policy(client, policy_name, input, options \\ [])

Creates an IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

Requires permission to access the CreatePolicy action.

create_policy_version(client, policy_name, input, options \\ [])

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.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

create_provisioning_claim(client, template_name, input, options \\ [])

Creates a provisioning claim.

Requires permission to access the CreateProvisioningClaim action.

create_provisioning_template(client, input, options \\ [])

Creates a provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

create_provisioning_template_version(client, template_name, input, options \\ [])

Creates a new version of a provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion action.

create_role_alias(client, role_alias, input, options \\ [])

Creates a role alias.

Requires permission to access the CreateRoleAlias action.

The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.

create_scheduled_audit(client, scheduled_audit_name, input, options \\ [])

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

Requires permission to access the CreateScheduledAudit action.

create_security_profile(client, security_profile_name, input, options \\ [])

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile action.

create_stream(client, stream_id, input, options \\ [])

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.

Requires permission to access the CreateStream action.

create_thing(client, thing_name, input, options \\ [])

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.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

Requires permission to access the CreateThing action.

create_thing_group(client, thing_group_name, input, options \\ [])

Create a thing group.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

If the ThingGroup that you create has the exact same attributes as an existing ThingGroup, you will get a 200 success response.

Requires permission to access the CreateThingGroup action.

create_thing_type(client, thing_type_name, input, options \\ [])

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.

Requires permission to access the CreateThingType action.

create_topic_rule(client, rule_name, input, options \\ [])

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.

Requires permission to access the CreateTopicRule action.

create_topic_rule_destination(client, input, options \\ [])

Creates a topic rule destination.

The destination must be confirmed prior to use.

Requires permission to access the CreateTopicRuleDestination action.

delete_account_audit_configuration(client, input, options \\ [])

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.

Requires permission to access the DeleteAccountAuditConfiguration action.

delete_audit_suppression(client, input, options \\ [])

Deletes a Device Defender audit suppression.

Requires permission to access the DeleteAuditSuppression action.

delete_authorizer(client, authorizer_name, input, options \\ [])

Deletes an authorizer.

Requires permission to access the DeleteAuthorizer action.

delete_billing_group(client, billing_group_name, input, options \\ [])

Deletes the billing group.

Requires permission to access the DeleteBillingGroup action.

delete_ca_certificate(client, certificate_id, input, options \\ [])

Deletes a registered CA certificate.

Requires permission to access the DeleteCACertificate action.

delete_certificate(client, certificate_id, input, options \\ [])

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.

Requires permission to access the DeleteCertificate action.

delete_certificate_provider(client, certificate_provider_name, input, options \\ [])

Deletes a certificate provider.

Requires permission to access the DeleteCertificateProvider action.

If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).

delete_command(client, command_id, input, options \\ [])

Delete a command resource.

delete_command_execution(client, execution_id, input, options \\ [])

Delete a command execution.

Only command executions that enter a terminal state can be deleted from your account.

delete_custom_metric(client, metric_name, input, options \\ [])

Deletes a Device Defender detect custom metric.

Requires permission to access the DeleteCustomMetric action.

Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.

delete_dimension(client, name, input, options \\ [])

Removes the specified dimension from your Amazon Web Services accounts.

Requires permission to access the DeleteDimension action.

delete_domain_configuration(client, domain_configuration_name, input, options \\ [])

Deletes the specified domain configuration.

Requires permission to access the DeleteDomainConfiguration action.

delete_dynamic_thing_group(client, thing_group_name, input, options \\ [])

Deletes a dynamic thing group.

Requires permission to access the DeleteDynamicThingGroup action.

delete_fleet_metric(client, metric_name, input, options \\ [])

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.

Requires permission to access the DeleteFleetMetric action.

delete_job(client, job_id, input, options \\ [])

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

Requires permission to access the DeleteJob action.

delete_job_execution(client, execution_number, job_id, thing_name, input, options \\ [])

Deletes a job execution.

Requires permission to access the DeleteJobExecution action.

delete_job_template(client, job_template_id, input, options \\ [])

Deletes the specified job template.

delete_mitigation_action(client, action_name, input, options \\ [])

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

Requires permission to access the DeleteMitigationAction action.

delete_ota_update(client, ota_update_id, input, options \\ [])

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

delete_package(client, package_name, input, options \\ [])

Deletes a specific version from a software package.

Note: All package versions must be deleted before deleting the software package.

Requires permission to access the DeletePackageVersion action.

delete_package_version(client, package_name, version_name, input, options \\ [])

Deletes a specific version from a software package.

Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.

delete_policy(client, policy_name, input, options \\ [])

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.

Requires permission to access the DeletePolicy action.

delete_policy_version(client, policy_name, policy_version_id, input, options \\ [])

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.

Requires permission to access the DeletePolicyVersion action.

delete_provisioning_template(client, template_name, input, options \\ [])

Deletes a provisioning template.

Requires permission to access the DeleteProvisioningTemplate action.

delete_provisioning_template_version(client, template_name, version_id, input, options \\ [])

Deletes a provisioning template version.

Requires permission to access the DeleteProvisioningTemplateVersion action.

delete_registration_code(client, input, options \\ [])

Deletes a CA certificate registration code.

Requires permission to access the DeleteRegistrationCode action.

delete_role_alias(client, role_alias, input, options \\ [])

Deletes a role alias

Requires permission to access the DeleteRoleAlias action.

delete_scheduled_audit(client, scheduled_audit_name, input, options \\ [])

Deletes a scheduled audit.

Requires permission to access the DeleteScheduledAudit action.

delete_security_profile(client, security_profile_name, input, options \\ [])

Deletes a Device Defender security profile.

Requires permission to access the DeleteSecurityProfile action.

delete_stream(client, stream_id, input, options \\ [])

Deletes a stream.

Requires permission to access the DeleteStream action.

delete_thing(client, thing_name, input, options \\ [])

Deletes the specified thing.

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

Requires permission to access the DeleteThing action.

delete_thing_group(client, thing_group_name, input, options \\ [])

Deletes a thing group.

Requires permission to access the DeleteThingGroup action.

delete_thing_type(client, thing_type_name, input, options \\ [])

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.

Requires permission to access the DeleteThingType action.

delete_topic_rule(client, rule_name, input, options \\ [])

Deletes the rule.

Requires permission to access the DeleteTopicRule action.

delete_topic_rule_destination(client, arn, input, options \\ [])

Deletes a topic rule destination.

Requires permission to access the DeleteTopicRuleDestination action.

delete_v2_logging_level(client, input, options \\ [])

Deletes a logging level.

Requires permission to access the DeleteV2LoggingLevel action.

deprecate_thing_type(client, thing_type_name, input, options \\ [])

Deprecates a thing type.

You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

describe_account_audit_configuration(client, options \\ [])

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.

Requires permission to access the DescribeAccountAuditConfiguration action.

describe_audit_finding(client, finding_id, options \\ [])

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.

Requires permission to access the DescribeAuditFinding action.

describe_audit_mitigation_actions_task(client, task_id, options \\ [])

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.

describe_audit_suppression(client, input, options \\ [])

Gets information about a Device Defender audit suppression.

describe_audit_task(client, task_id, options \\ [])

Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask action.

describe_authorizer(client, authorizer_name, options \\ [])

Describes an authorizer.

Requires permission to access the DescribeAuthorizer action.

describe_billing_group(client, billing_group_name, options \\ [])

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

describe_ca_certificate(client, certificate_id, options \\ [])

Describes a registered CA certificate.

Requires permission to access the DescribeCACertificate action.

describe_certificate(client, certificate_id, options \\ [])

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

describe_certificate_provider(client, certificate_provider_name, options \\ [])

Describes a certificate provider.

Requires permission to access the DescribeCertificateProvider action.

describe_custom_metric(client, metric_name, options \\ [])

Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

describe_default_authorizer(client, options \\ [])

Describes the default authorizer.

Requires permission to access the DescribeDefaultAuthorizer action.

describe_detect_mitigation_actions_task(client, task_id, options \\ [])

Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask action.

describe_dimension(client, name, options \\ [])

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

Requires permission to access the DescribeDimension action.

describe_domain_configuration(client, domain_configuration_name, options \\ [])

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration action.

describe_endpoint(client, endpoint_type \\ nil, options \\ [])

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

The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint.

Requires permission to access the DescribeEndpoint action.

describe_event_configurations(client, options \\ [])

Describes event configurations.

Requires permission to access the DescribeEventConfigurations action.

describe_fleet_metric(client, metric_name, options \\ [])

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

describe_index(client, index_name, options \\ [])

Describes a search index.

Requires permission to access the DescribeIndex action.

describe_job(client, job_id, before_substitution \\ nil, options \\ [])

Describes a job.

Requires permission to access the DescribeJob action.

describe_job_execution(client, job_id, thing_name, execution_number \\ nil, options \\ [])

Describes a job execution.

Requires permission to access the DescribeJobExecution action.

describe_job_template(client, job_template_id, options \\ [])

Returns information about a job template.

describe_managed_job_template(client, template_name, template_version \\ nil, options \\ [])

View details of a managed job template.

describe_mitigation_action(client, action_name, options \\ [])

Gets information about a mitigation action.

Requires permission to access the DescribeMitigationAction action.

describe_provisioning_template(client, template_name, options \\ [])

Returns information about a provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

describe_provisioning_template_version(client, template_name, version_id, options \\ [])

Returns information about a provisioning template version.

Requires permission to access the DescribeProvisioningTemplateVersion action.

describe_role_alias(client, role_alias, options \\ [])

Describes a role alias.

Requires permission to access the DescribeRoleAlias action.

describe_scheduled_audit(client, scheduled_audit_name, options \\ [])

Gets information about a scheduled audit.

Requires permission to access the DescribeScheduledAudit action.

describe_security_profile(client, security_profile_name, options \\ [])

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

describe_stream(client, stream_id, options \\ [])

Gets information about a stream.

Requires permission to access the DescribeStream action.

describe_thing(client, thing_name, options \\ [])

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

describe_thing_group(client, thing_group_name, options \\ [])

Describe a thing group.

Requires permission to access the DescribeThingGroup action.

describe_thing_registration_task(client, task_id, options \\ [])

Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

describe_thing_type(client, thing_type_name, options \\ [])

Gets information about the specified thing type.

Requires permission to access the DescribeThingType action.

detach_policy(client, policy_name, input, options \\ [])

Detaches a policy from the specified target.

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.

Requires permission to access the DetachPolicy action.

detach_principal_policy(client, policy_name, input, options \\ [])

Removes the specified policy from the specified certificate.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.

Requires permission to access the DetachPrincipalPolicy action.

detach_security_profile(client, security_profile_name, input, options \\ [])

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

Requires permission to access the DetachSecurityProfile action.

detach_thing_principal(client, thing_name, input, options \\ [])

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.

This call is asynchronous. It might take several seconds for the detachment to propagate.

Requires permission to access the DetachThingPrincipal action.

disable_topic_rule(client, rule_name, input, options \\ [])

Disables the rule.

Requires permission to access the DisableTopicRule action.

disassociate_sbom_from_package_version(client, package_name, version_name, input, options \\ [])

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

Requires permission to access the DisassociateSbomWithPackageVersion action.

enable_topic_rule(client, rule_name, input, options \\ [])

Enables the rule.

Requires permission to access the EnableTopicRule action.

get_behavior_model_training_summaries(client, max_results \\ nil, next_token \\ nil, security_profile_name \\ nil, options \\ [])

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

Requires permission to access the GetBehaviorModelTrainingSummaries action.

get_buckets_aggregation(client, input, options \\ [])

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

Requires permission to access the GetBucketsAggregation action.

get_cardinality(client, input, options \\ [])

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

Requires permission to access the GetCardinality action.

get_command(client, command_id, options \\ [])

Gets information about the specified command.

get_command_execution(client, execution_id, include_result \\ nil, target_arn, options \\ [])

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

get_effective_policies(client, input, options \\ [])

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.

Requires permission to access the GetEffectivePolicies action.

get_indexing_configuration(client, options \\ [])

Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration action.

get_job_document(client, job_id, before_substitution \\ nil, options \\ [])

Gets a job document.

Requires permission to access the GetJobDocument action.

get_logging_options(client, options \\ [])

Gets the logging options.

NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

Requires permission to access the GetLoggingOptions action.

get_ota_update(client, ota_update_id, options \\ [])

Gets an OTA update.

Requires permission to access the GetOTAUpdate action.

get_package(client, package_name, options \\ [])

Gets information about the specified software package.

Requires permission to access the GetPackage action.

get_package_configuration(client, options \\ [])

Gets information about the specified software package's configuration.

Requires permission to access the GetPackageConfiguration action.

get_package_version(client, package_name, version_name, options \\ [])

Gets information about the specified package version.

Requires permission to access the GetPackageVersion action.

get_percentiles(client, input, options \\ [])

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.

Requires permission to access the GetPercentiles action.

get_policy(client, policy_name, options \\ [])

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

Requires permission to access the GetPolicy action.

get_policy_version(client, policy_name, policy_version_id, options \\ [])

Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion action.

get_registration_code(client, options \\ [])

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

IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code.

Requires permission to access the GetRegistrationCode action.

get_statistics(client, input, options \\ [])

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.

Requires permission to access the GetStatistics action.

get_topic_rule(client, rule_name, options \\ [])

Gets information about the rule.

Requires permission to access the GetTopicRule action.

get_topic_rule_destination(client, arn, options \\ [])

Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination action.

get_v2_logging_options(client, options \\ [])

Gets the fine grained logging options.

Requires permission to access the GetV2LoggingOptions action.

list_active_violations(client, behavior_criteria_type \\ nil, list_suppressed_alerts \\ nil, max_results \\ nil, next_token \\ nil, security_profile_name \\ nil, thing_name \\ nil, verification_state \\ nil, options \\ [])

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

Requires permission to access the ListActiveViolations action.

list_attached_policies(client, target, input, options \\ [])

Lists the policies attached to the specified thing group.

Requires permission to access the ListAttachedPolicies action.

list_audit_findings(client, input, options \\ [])

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.)

Requires permission to access the ListAuditFindings action.

list_audit_mitigation_actions_executions(client, action_status \\ nil, finding_id, max_results \\ nil, next_token \\ nil, task_id, options \\ [])

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

Requires permission to access the ListAuditMitigationActionsExecutions action.

list_audit_mitigation_actions_tasks(client, audit_task_id \\ nil, end_time, finding_id \\ nil, max_results \\ nil, next_token \\ nil, start_time, task_status \\ nil, options \\ [])

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

Requires permission to access the ListAuditMitigationActionsTasks action.

list_audit_suppressions(client, input, options \\ [])

Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions action.

list_audit_tasks(client, end_time, max_results \\ nil, next_token \\ nil, start_time, task_status \\ nil, task_type \\ nil, options \\ [])

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

Requires permission to access the ListAuditTasks action.

list_authorizers(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, status \\ nil, options \\ [])

Lists the authorizers registered in your account.

Requires permission to access the ListAuthorizers action.

list_billing_groups(client, max_results \\ nil, name_prefix_filter \\ nil, next_token \\ nil, options \\ [])

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

list_ca_certificates(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, template_name \\ nil, options \\ [])

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

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Requires permission to access the ListCACertificates action.

list_certificate_providers(client, ascending_order \\ nil, next_token \\ nil, options \\ [])

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

Requires permission to access the ListCertificateProviders action.

list_certificates(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

Lists the certificates registered in your Amazon Web Services account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Requires permission to access the ListCertificates action.

list_certificates_by_ca(client, ca_certificate_id, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

List the device certificates signed by the specified CA certificate.

Requires permission to access the ListCertificatesByCA action.

list_command_executions(client, input, options \\ [])

List all command executions.

You must provide only the startedTimeFilter or the completedTimeFilter information. If you provide both time filters, the API will generate an error. You can use this information to find command executions that started within a specific timeframe.

list_commands(client, command_parameter_name \\ nil, max_results \\ nil, namespace \\ nil, next_token \\ nil, sort_order \\ nil, options \\ [])

List all commands in your account.

list_custom_metrics(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics action.

list_detect_mitigation_actions_executions(client, end_time \\ nil, max_results \\ nil, next_token \\ nil, start_time \\ nil, task_id \\ nil, thing_name \\ nil, violation_id \\ nil, options \\ [])

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

Requires permission to access the ListDetectMitigationActionsExecutions action.

list_detect_mitigation_actions_tasks(client, end_time, max_results \\ nil, next_token \\ nil, start_time, options \\ [])

List of Device Defender ML Detect mitigation actions tasks.

Requires permission to access the ListDetectMitigationActionsTasks action.

list_dimensions(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

Requires permission to access the ListDimensions action.

list_domain_configurations(client, marker \\ nil, page_size \\ nil, service_type \\ nil, options \\ [])

Gets a list of domain configurations for the user.

This list is sorted alphabetically by domain configuration name.

Requires permission to access the ListDomainConfigurations action.

list_fleet_metrics(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all your fleet metrics.

Requires permission to access the ListFleetMetrics action.

list_indices(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the search indices.

Requires permission to access the ListIndices action.

list_job_executions_for_job(client, job_id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists the job executions for a job.

Requires permission to access the ListJobExecutionsForJob action.

list_job_executions_for_thing(client, thing_name, job_id \\ nil, max_results \\ nil, namespace_id \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists the job executions for the specified thing.

Requires permission to access the ListJobExecutionsForThing action.

list_job_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of job templates.

Requires permission to access the ListJobTemplates action.

list_jobs(client, max_results \\ nil, namespace_id \\ nil, next_token \\ nil, status \\ nil, target_selection \\ nil, thing_group_id \\ nil, thing_group_name \\ nil, options \\ [])

Lists jobs.

Requires permission to access the ListJobs action.

list_managed_job_templates(client, max_results \\ nil, next_token \\ nil, template_name \\ nil, options \\ [])

Returns a list of managed job templates.

list_metric_values(client, dimension_name \\ nil, dimension_value_operator \\ nil, end_time, max_results \\ nil, metric_name, next_token \\ nil, start_time, thing_name, options \\ [])

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

list_mitigation_actions(client, action_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Gets a list of all mitigation actions that match the specified filter criteria.

Requires permission to access the ListMitigationActions action.

list_ota_updates(client, max_results \\ nil, next_token \\ nil, ota_update_status \\ nil, options \\ [])

Lists OTA updates.

Requires permission to access the ListOTAUpdates action.

list_outgoing_certificates(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

Lists certificates that are being transferred but not yet accepted.

Requires permission to access the ListOutgoingCertificates action.

list_package_versions(client, package_name, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists the software package versions associated to the account.

Requires permission to access the ListPackageVersions action.

list_packages(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the software packages associated to the account.

Requires permission to access the ListPackages action.

list_policies(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

Lists your policies.

Requires permission to access the ListPolicies action.

list_policy_principals(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, policy_name, options \\ [])

Lists the principals associated with the specified policy.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.

Requires permission to access the ListPolicyPrincipals action.

list_policy_versions(client, policy_name, options \\ [])

Lists the versions of the specified policy and identifies the default version.

Requires permission to access the ListPolicyVersions action.

list_principal_policies(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, principal, options \\ [])

Lists the policies attached to the specified principal.

If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.

Requires permission to access the ListPrincipalPolicies action.

list_principal_things(client, max_results \\ nil, next_token \\ nil, principal, options \\ [])

Lists the things associated with the specified principal.

A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListPrincipalThings action.

list_principal_things_v2(client, max_results \\ nil, next_token \\ nil, thing_principal_type \\ nil, principal, options \\ [])

Lists the things associated with the specified principal.

A principal can be an X.509 certificate or an Amazon Cognito ID.

Requires permission to access the ListPrincipalThings action.

list_provisioning_template_versions(client, template_name, max_results \\ nil, next_token \\ nil, options \\ [])

A list of provisioning template versions.

Requires permission to access the ListProvisioningTemplateVersions action.

list_provisioning_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the provisioning templates in your Amazon Web Services account.

Requires permission to access the ListProvisioningTemplates action.

list_related_resources_for_audit_finding(client, finding_id, max_results \\ nil, next_token \\ nil, options \\ [])

The related resources of an Audit finding.

The following resources can be returned from calling this API:

* DEVICE_CERTIFICATE

* CA_CERTIFICATE

* IOT_POLICY

* COGNITO_IDENTITY_POOL

* CLIENT_ID

* ACCOUNT_SETTINGS

* ROLE_ALIAS

* IAM_ROLE

* ISSUER_CERTIFICATE

This API is similar to DescribeAuditFinding's RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

list_role_aliases(client, ascending_order \\ nil, marker \\ nil, page_size \\ nil, options \\ [])

Lists the role aliases registered in your account.

Requires permission to access the ListRoleAliases action.

list_sbom_validation_results(client, package_name, version_name, max_results \\ nil, next_token \\ nil, validation_result \\ nil, options \\ [])

The validation results for all software bill of materials (SBOM) attached to a specific software package version.

Requires permission to access the ListSbomValidationResults action.

list_scheduled_audits(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits action.

list_security_profiles(client, dimension_name \\ nil, max_results \\ nil, metric_name \\ nil, next_token \\ nil, options \\ [])

Lists the Device Defender security profiles you've created.

You can filter security profiles by dimension or custom metric.

Requires permission to access the ListSecurityProfiles action.

dimensionName and metricName cannot be used in the same request.

list_security_profiles_for_target(client, max_results \\ nil, next_token \\ nil, recursive \\ nil, security_profile_target_arn, options \\ [])

Lists the Device Defender security profiles attached to a target (thing group).

Requires permission to access the ListSecurityProfilesForTarget action.

list_streams(client, ascending_order \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all of the streams in your Amazon Web Services account.

Requires permission to access the ListStreams action.

list_tags_for_resource(client, next_token \\ nil, resource_arn, options \\ [])

Lists the tags (metadata) you have assigned to the resource.

Requires permission to access the ListTagsForResource action.

list_targets_for_policy(client, policy_name, input, options \\ [])

List targets for the specified policy.

Requires permission to access the ListTargetsForPolicy action.

list_targets_for_security_profile(client, security_profile_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the targets (thing groups) associated with a given Device Defender security profile.

Requires permission to access the ListTargetsForSecurityProfile action.

list_thing_groups(client, max_results \\ nil, name_prefix_filter \\ nil, next_token \\ nil, parent_group \\ nil, recursive \\ nil, options \\ [])

List the thing groups in your account.

Requires permission to access the ListThingGroups action.

list_thing_groups_for_thing(client, thing_name, max_results \\ nil, next_token \\ nil, options \\ [])

List the thing groups to which the specified thing belongs.

Requires permission to access the ListThingGroupsForThing action.

list_thing_principals(client, thing_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the principals associated with the specified thing.

A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListThingPrincipals action.

list_thing_principals_v2(client, thing_name, max_results \\ nil, next_token \\ nil, thing_principal_type \\ nil, options \\ [])

Lists the principals associated with the specified thing.

A principal can be an X.509 certificate or an Amazon Cognito ID.

Requires permission to access the ListThingPrincipals action.

list_thing_registration_task_reports(client, task_id, max_results \\ nil, next_token \\ nil, report_type, options \\ [])

Information about the thing registration tasks.

list_thing_registration_tasks(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

List bulk thing provisioning tasks.

Requires permission to access the ListThingRegistrationTasks action.

list_thing_types(client, max_results \\ nil, next_token \\ nil, thing_type_name \\ nil, options \\ [])

Lists the existing thing types.

Requires permission to access the ListThingTypes action.

list_things(client, attribute_name \\ nil, attribute_value \\ nil, max_results \\ nil, next_token \\ nil, thing_type_name \\ nil, use_prefix_attribute_value \\ nil, options \\ [])

Lists your things.

Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. For more information, see List Things from the Amazon Web Services IoT Core Developer Guide.

Requires permission to access the ListThings action.

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

list_things_in_billing_group(client, billing_group_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the things you have added to the given billing group.

Requires permission to access the ListThingsInBillingGroup action.

list_things_in_thing_group(client, thing_group_name, max_results \\ nil, next_token \\ nil, recursive \\ nil, options \\ [])

Lists the things in the specified group.

Requires permission to access the ListThingsInThingGroup action.

list_topic_rule_destinations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all the topic rule destinations in your Amazon Web Services account.

Requires permission to access the ListTopicRuleDestinations action.

list_topic_rules(client, max_results \\ nil, next_token \\ nil, rule_disabled \\ nil, topic \\ nil, options \\ [])

Lists the rules for the specific topic.

Requires permission to access the ListTopicRules action.

list_v2_logging_levels(client, max_results \\ nil, next_token \\ nil, target_type \\ nil, options \\ [])

Lists logging levels.

Requires permission to access the ListV2LoggingLevels action.

list_violation_events(client, behavior_criteria_type \\ nil, end_time, list_suppressed_alerts \\ nil, max_results \\ nil, next_token \\ nil, security_profile_name \\ nil, start_time, thing_name \\ nil, verification_state \\ nil, options \\ [])

Lists the Device Defender security profile violations discovered during the given time period.

You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).

Requires permission to access the ListViolationEvents action.

metadata()

put_verification_state_on_violation(client, violation_id, input, options \\ [])

Set a verification state and provide a description of that verification state on a violation (detect alarm).

register_ca_certificate(client, input, options \\ [])

Registers a CA certificate with Amazon Web Services IoT Core.

There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

Requires permission to access the RegisterCACertificate action.

register_certificate(client, input, options \\ [])

Registers a device certificate with IoT in the same certificate mode as the signing CA.

If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

Requires permission to access the RegisterCertificate action.

register_certificate_without_ca(client, input, options \\ [])

For supported certificates, consult Certificate signing algorithms supported by IoT.

register_thing(client, input, options \\ [])

Provisions a thing in the device registry.

RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.

Requires permission to access the RegisterThing action.

reject_certificate_transfer(client, certificate_id, input, options \\ [])

Rejects a pending certificate transfer.

After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

Requires permission to access the RejectCertificateTransfer action.

remove_thing_from_billing_group(client, input, options \\ [])

Removes the given thing from the billing group.

Requires permission to access the RemoveThingFromBillingGroup action.

This call is asynchronous. It might take several seconds for the detachment to propagate.

remove_thing_from_thing_group(client, input, options \\ [])

Remove the specified thing from the specified group.

You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.

Requires permission to access the RemoveThingFromThingGroup action.

replace_topic_rule(client, rule_name, input, options \\ [])

Replaces the rule.

You must specify all parameters for the new 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.

Requires permission to access the ReplaceTopicRule action.

search_index(client, input, options \\ [])

The query search index.

Requires permission to access the SearchIndex action.

set_default_authorizer(client, input, options \\ [])

Sets the default authorizer.

This will be used if a websocket connection is made without specifying an authorizer.

Requires permission to access the SetDefaultAuthorizer action.

set_default_policy_version(client, policy_name, policy_version_id, input, options \\ [])

Sets the specified version of the specified policy as the policy's default (operative) version.

This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action.

Requires permission to access the SetDefaultPolicyVersion action.

set_logging_options(client, input, options \\ [])

Sets the logging options.

NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.

Requires permission to access the SetLoggingOptions action.

set_v2_logging_level(client, input, options \\ [])

Sets the logging level.

Requires permission to access the SetV2LoggingLevel action.

set_v2_logging_options(client, input, options \\ [])

Sets the logging options for the V2 logging service.

Requires permission to access the SetV2LoggingOptions action.

start_audit_mitigation_actions_task(client, task_id, input, options \\ [])

Starts a task that applies a set of mitigation actions to the specified target.

Requires permission to access the StartAuditMitigationActionsTask action.

start_detect_mitigation_actions_task(client, task_id, input, options \\ [])

Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask action.

start_on_demand_audit_task(client, input, options \\ [])

Starts an on-demand Device Defender audit.

Requires permission to access the StartOnDemandAuditTask action.

start_thing_registration_task(client, input, options \\ [])

Creates a bulk thing provisioning task.

Requires permission to access the StartThingRegistrationTask action.

stop_thing_registration_task(client, task_id, input, options \\ [])

Cancels a bulk thing provisioning task.

Requires permission to access the StopThingRegistrationTask action.

tag_resource(client, input, options \\ [])

Adds to or modifies the tags of the given resource.

Tags are metadata which can be used to manage a resource.

Requires permission to access the TagResource action.

test_authorization(client, input, options \\ [])

Tests if a specified principal is authorized to perform an IoT action on a specified resource.

Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.

Requires permission to access the TestAuthorization action.

test_invoke_authorizer(client, authorizer_name, input, options \\ [])

Tests a custom authorization behavior by invoking a specified custom authorizer.

Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.

Requires permission to access the TestInvokeAuthorizer action.

transfer_certificate(client, certificate_id, input, options \\ [])

Transfers the specified certificate to the specified Amazon Web Services account.

Requires permission to access the TransferCertificate action.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.

untag_resource(client, input, options \\ [])

Removes the given tags (metadata) from the resource.

Requires permission to access the UntagResource action.

update_account_audit_configuration(client, input, options \\ [])

Configures or reconfigures the Device Defender audit settings for this account.

Settings include how audit notifications are sent and which audit checks are enabled or disabled.

Requires permission to access the UpdateAccountAuditConfiguration action.

update_audit_suppression(client, input, options \\ [])

Updates a Device Defender audit suppression.

update_authorizer(client, authorizer_name, input, options \\ [])

Updates an authorizer.

Requires permission to access the UpdateAuthorizer action.

update_billing_group(client, billing_group_name, input, options \\ [])

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup action.

update_ca_certificate(client, certificate_id, input, options \\ [])

Updates a registered CA certificate.

Requires permission to access the UpdateCACertificate action.

update_certificate(client, certificate_id, input, options \\ [])

Updates the status of the specified certificate.

This operation is idempotent.

Requires permission to access the UpdateCertificate action.

Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

update_certificate_provider(client, certificate_provider_name, input, options \\ [])

Updates a certificate provider.

Requires permission to access the UpdateCertificateProvider action.

update_command(client, command_id, input, options \\ [])

Update information about a command or mark a command for deprecation.

update_custom_metric(client, metric_name, input, options \\ [])

Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric action.

update_dimension(client, name, input, options \\ [])

Updates the definition for a dimension.

You cannot change the type of a dimension after it is created (you can delete it and recreate it).

Requires permission to access the UpdateDimension action.

update_domain_configuration(client, domain_configuration_name, input, options \\ [])

Updates values stored in the domain configuration.

Domain configurations for default endpoints can't be updated.

Requires permission to access the UpdateDomainConfiguration action.

update_dynamic_thing_group(client, thing_group_name, input, options \\ [])

Updates a dynamic thing group.

Requires permission to access the UpdateDynamicThingGroup action.

update_event_configurations(client, input, options \\ [])

Updates the event configurations.

Requires permission to access the UpdateEventConfigurations action.

update_fleet_metric(client, metric_name, input, options \\ [])

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

update_indexing_configuration(client, input, options \\ [])

Updates the search configuration.

Requires permission to access the UpdateIndexingConfiguration action.

update_job(client, job_id, input, options \\ [])

Updates supported fields of the specified job.

Requires permission to access the UpdateJob action.

update_mitigation_action(client, action_name, input, options \\ [])

Updates the definition for the specified mitigation action.

Requires permission to access the UpdateMitigationAction action.

update_package(client, package_name, input, options \\ [])

Updates the supported fields for a specific software package.

Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.

update_package_configuration(client, input, options \\ [])

Updates the software package configuration.

Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.

update_package_version(client, package_name, version_name, input, options \\ [])

Updates the supported fields for a specific package version.

Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.

update_provisioning_template(client, template_name, input, options \\ [])

Updates a provisioning template.

Requires permission to access the UpdateProvisioningTemplate action.

update_role_alias(client, role_alias, input, options \\ [])

Updates a role alias.

Requires permission to access the UpdateRoleAlias action.

update_scheduled_audit(client, scheduled_audit_name, input, options \\ [])

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

Requires permission to access the UpdateScheduledAudit action.

update_security_profile(client, security_profile_name, input, options \\ [])

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

update_stream(client, stream_id, input, options \\ [])

Updates an existing stream.

The stream version will be incremented by one.

Requires permission to access the UpdateStream action.

update_thing(client, thing_name, input, options \\ [])

Updates the data for a thing.

Requires permission to access the UpdateThing action.

update_thing_group(client, thing_group_name, input, options \\ [])

Update a thing group.

Requires permission to access the UpdateThingGroup action.

update_thing_groups_for_thing(client, input, options \\ [])

Updates the groups to which the thing belongs.

Requires permission to access the UpdateThingGroupsForThing action.

update_thing_type(client, thing_type_name, input, options \\ [])

Updates a thing type.

update_topic_rule_destination(client, input, options \\ [])

Updates a topic rule destination.

You use this to change the status, endpoint URL, or confirmation URL of the destination.

Requires permission to access the UpdateTopicRuleDestination action.

validate_security_profile_behaviors(client, input, options \\ [])

Validates a Device Defender security profile behaviors specification.

Requires permission to access the ValidateSecurityProfileBehaviors action.

Settings View Source AWS.IoT (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

accept_certificate_transfer(client, certificate_id, input, options \\ [])

add_thing_to_billing_group(client, input, options \\ [])

add_thing_to_thing_group(client, input, options \\ [])

associate_sbom_with_package_version(client, package_name, version_name, input, options \\ [])

associate_targets_with_job(client, job_id, input, options \\ [])

attach_policy(client, policy_name, input, options \\ [])

attach_principal_policy(client, policy_name, input, options \\ [])

attach_security_profile(client, security_profile_name, input, options \\ [])

attach_thing_principal(client, thing_name, input, options \\ [])

cancel_audit_mitigation_actions_task(client, task_id, input, options \\ [])

cancel_audit_task(client, task_id, input, options \\ [])

cancel_certificate_transfer(client, certificate_id, input, options \\ [])

cancel_detect_mitigation_actions_task(client, task_id, input, options \\ [])

cancel_job(client, job_id, input, options \\ [])

cancel_job_execution(client, job_id, thing_name, input, options \\ [])

clear_default_authorizer(client, input, options \\ [])

confirm_topic_rule_destination(client, confirmation_token, options \\ [])

create_audit_suppression(client, input, options \\ [])

create_authorizer(client, authorizer_name, input, options \\ [])

create_billing_group(client, billing_group_name, input, options \\ [])

create_certificate_from_csr(client, input, options \\ [])

create_certificate_provider(client, certificate_provider_name, input, options \\ [])

create_command(client, command_id, input, options \\ [])

create_custom_metric(client, metric_name, input, options \\ [])

create_dimension(client, name, input, options \\ [])

create_domain_configuration(client, domain_configuration_name, input, options \\ [])

create_dynamic_thing_group(client, thing_group_name, input, options \\ [])

create_fleet_metric(client, metric_name, input, options \\ [])

create_job(client, job_id, input, options \\ [])

create_job_template(client, job_template_id, input, options \\ [])

create_keys_and_certificate(client, input, options \\ [])

create_mitigation_action(client, action_name, input, options \\ [])

create_ota_update(client, ota_update_id, input, options \\ [])

create_package(client, package_name, input, options \\ [])

create_package_version(client, package_name, version_name, input, options \\ [])

create_policy(client, policy_name, input, options \\ [])

create_policy_version(client, policy_name, input, options \\ [])

create_provisioning_claim(client, template_name, input, options \\ [])

create_provisioning_template(client, input, options \\ [])

create_provisioning_template_version(client, template_name, input, options \\ [])

create_role_alias(client, role_alias, input, options \\ [])

create_scheduled_audit(client, scheduled_audit_name, input, options \\ [])

create_security_profile(client, security_profile_name, input, options \\ [])

create_stream(client, stream_id, input, options \\ [])

create_thing(client, thing_name, input, options \\ [])

create_thing_group(client, thing_group_name, input, options \\ [])

create_thing_type(client, thing_type_name, input, options \\ [])

create_topic_rule(client, rule_name, input, options \\ [])

create_topic_rule_destination(client, input, options \\ [])

delete_account_audit_configuration(client, input, options \\ [])

delete_audit_suppression(client, input, options \\ [])

delete_authorizer(client, authorizer_name, input, options \\ [])

delete_billing_group(client, billing_group_name, input, options \\ [])

delete_ca_certificate(client, certificate_id, input, options \\ [])

delete_certificate(client, certificate_id, input, options \\ [])

delete_certificate_provider(client, certificate_provider_name, input, options \\ [])

delete_command(client, command_id, input, options \\ [])

delete_command_execution(client, execution_id, input, options \\ [])

delete_custom_metric(client, metric_name, input, options \\ [])

delete_dimension(client, name, input, options \\ [])

delete_domain_configuration(client, domain_configuration_name, input, options \\ [])

delete_dynamic_thing_group(client, thing_group_name, input, options \\ [])

delete_fleet_metric(client, metric_name, input, options \\ [])

delete_job(client, job_id, input, options \\ [])

delete_job_execution(client, execution_number, job_id, thing_name, input, options \\ [])

delete_job_template(client, job_template_id, input, options \\ [])

delete_mitigation_action(client, action_name, input, options \\ [])

delete_ota_update(client, ota_update_id, input, options \\ [])

delete_package(client, package_name, input, options \\ [])

delete_package_version(client, package_name, version_name, input, options \\ [])

delete_policy(client, policy_name, input, options \\ [])

delete_policy_version(client, policy_name, policy_version_id, input, options \\ [])

delete_provisioning_template(client, template_name, input, options \\ [])

delete_provisioning_template_version(client, template_name, version_id, input, options \\ [])

delete_registration_code(client, input, options \\ [])

delete_role_alias(client, role_alias, input, options \\ [])

View Source AWS.IoT (aws-elixir v1.0.4)