IoT#
Client#
- class IoT.Client#
A low-level client representing AWS 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.
import boto3 client = boto3.client('iot')
These are the available methods:
- accept_certificate_transfer
- add_thing_to_billing_group
- add_thing_to_thing_group
- associate_sbom_with_package_version
- associate_targets_with_job
- attach_policy
- attach_principal_policy
- attach_security_profile
- attach_thing_principal
- can_paginate
- cancel_audit_mitigation_actions_task
- cancel_audit_task
- cancel_certificate_transfer
- cancel_detect_mitigation_actions_task
- cancel_job
- cancel_job_execution
- clear_default_authorizer
- close
- confirm_topic_rule_destination
- create_audit_suppression
- create_authorizer
- create_billing_group
- create_certificate_from_csr
- create_certificate_provider
- create_command
- create_custom_metric
- create_dimension
- create_domain_configuration
- create_dynamic_thing_group
- create_fleet_metric
- create_job
- create_job_template
- create_keys_and_certificate
- create_mitigation_action
- create_ota_update
- create_package
- create_package_version
- create_policy
- create_policy_version
- create_provisioning_claim
- create_provisioning_template
- create_provisioning_template_version
- create_role_alias
- create_scheduled_audit
- create_security_profile
- create_stream
- create_thing
- create_thing_group
- create_thing_type
- create_topic_rule
- create_topic_rule_destination
- delete_account_audit_configuration
- delete_audit_suppression
- delete_authorizer
- delete_billing_group
- delete_ca_certificate
- delete_certificate
- delete_certificate_provider
- delete_command
- delete_command_execution
- delete_custom_metric
- delete_dimension
- delete_domain_configuration
- delete_dynamic_thing_group
- delete_fleet_metric
- delete_job
- delete_job_execution
- delete_job_template
- delete_mitigation_action
- delete_ota_update
- delete_package
- delete_package_version
- delete_policy
- delete_policy_version
- delete_provisioning_template
- delete_provisioning_template_version
- delete_registration_code
- delete_role_alias
- delete_scheduled_audit
- delete_security_profile
- delete_stream
- delete_thing
- delete_thing_group
- delete_thing_type
- delete_topic_rule
- delete_topic_rule_destination
- delete_v2_logging_level
- deprecate_thing_type
- describe_account_audit_configuration
- describe_audit_finding
- describe_audit_mitigation_actions_task
- describe_audit_suppression
- describe_audit_task
- describe_authorizer
- describe_billing_group
- describe_ca_certificate
- describe_certificate
- describe_certificate_provider
- describe_custom_metric
- describe_default_authorizer
- describe_detect_mitigation_actions_task
- describe_dimension
- describe_domain_configuration
- describe_endpoint
- describe_event_configurations
- describe_fleet_metric
- describe_index
- describe_job
- describe_job_execution
- describe_job_template
- describe_managed_job_template
- describe_mitigation_action
- describe_provisioning_template
- describe_provisioning_template_version
- describe_role_alias
- describe_scheduled_audit
- describe_security_profile
- describe_stream
- describe_thing
- describe_thing_group
- describe_thing_registration_task
- describe_thing_type
- detach_policy
- detach_principal_policy
- detach_security_profile
- detach_thing_principal
- disable_topic_rule
- disassociate_sbom_from_package_version
- enable_topic_rule
- get_behavior_model_training_summaries
- get_buckets_aggregation
- get_cardinality
- get_command
- get_command_execution
- get_effective_policies
- get_indexing_configuration
- get_job_document
- get_logging_options
- get_ota_update
- get_package
- get_package_configuration
- get_package_version
- get_paginator
- get_percentiles
- get_policy
- get_policy_version
- get_registration_code
- get_statistics
- get_topic_rule
- get_topic_rule_destination
- get_v2_logging_options
- get_waiter
- list_active_violations
- list_attached_policies
- list_audit_findings
- list_audit_mitigation_actions_executions
- list_audit_mitigation_actions_tasks
- list_audit_suppressions
- list_audit_tasks
- list_authorizers
- list_billing_groups
- list_ca_certificates
- list_certificate_providers
- list_certificates
- list_certificates_by_ca
- list_command_executions
- list_commands
- list_custom_metrics
- list_detect_mitigation_actions_executions
- list_detect_mitigation_actions_tasks
- list_dimensions
- list_domain_configurations
- list_fleet_metrics
- list_indices
- list_job_executions_for_job
- list_job_executions_for_thing
- list_job_templates
- list_jobs
- list_managed_job_templates
- list_metric_values
- list_mitigation_actions
- list_ota_updates
- list_outgoing_certificates
- list_package_versions
- list_packages
- list_policies
- list_policy_principals
- list_policy_versions
- list_principal_policies
- list_principal_things
- list_principal_things_v2
- list_provisioning_template_versions
- list_provisioning_templates
- list_related_resources_for_audit_finding
- list_role_aliases
- list_sbom_validation_results
- list_scheduled_audits
- list_security_profiles
- list_security_profiles_for_target
- list_streams
- list_tags_for_resource
- list_targets_for_policy
- list_targets_for_security_profile
- list_thing_groups
- list_thing_groups_for_thing
- list_thing_principals
- list_thing_principals_v2
- list_thing_registration_task_reports
- list_thing_registration_tasks
- list_thing_types
- list_things
- list_things_in_billing_group
- list_things_in_thing_group
- list_topic_rule_destinations
- list_topic_rules
- list_v2_logging_levels
- list_violation_events
- put_verification_state_on_violation
- register_ca_certificate
- register_certificate
- register_certificate_without_ca
- register_thing
- reject_certificate_transfer
- remove_thing_from_billing_group
- remove_thing_from_thing_group
- replace_topic_rule
- search_index
- set_default_authorizer
- set_default_policy_version
- set_logging_options
- set_v2_logging_level
- set_v2_logging_options
- start_audit_mitigation_actions_task
- start_detect_mitigation_actions_task
- start_on_demand_audit_task
- start_thing_registration_task
- stop_thing_registration_task
- tag_resource
- test_authorization
- test_invoke_authorizer
- transfer_certificate
- untag_resource
- update_account_audit_configuration
- update_audit_suppression
- update_authorizer
- update_billing_group
- update_ca_certificate
- update_certificate
- update_certificate_provider
- update_command
- update_custom_metric
- update_dimension
- update_domain_configuration
- update_dynamic_thing_group
- update_event_configurations
- update_fleet_metric
- update_indexing_configuration
- update_job
- update_mitigation_action
- update_package
- update_package_configuration
- update_package_version
- update_provisioning_template
- update_role_alias
- update_scheduled_audit
- update_security_profile
- update_stream
- update_thing
- update_thing_group
- update_thing_groups_for_thing
- update_thing_type
- update_topic_rule_destination
- validate_security_profile_behaviors
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are:
- GetBehaviorModelTrainingSummaries
- ListActiveViolations
- ListAttachedPolicies
- ListAuditFindings
- ListAuditMitigationActionsExecutions
- ListAuditMitigationActionsTasks
- ListAuditSuppressions
- ListAuditTasks
- ListAuthorizers
- ListBillingGroups
- ListCACertificates
- ListCertificates
- ListCertificatesByCA
- ListCommandExecutions
- ListCommands
- ListCustomMetrics
- ListDetectMitigationActionsExecutions
- ListDetectMitigationActionsTasks
- ListDimensions
- ListDomainConfigurations
- ListFleetMetrics
- ListIndices
- ListJobExecutionsForJob
- ListJobExecutionsForThing
- ListJobTemplates
- ListJobs
- ListManagedJobTemplates
- ListMetricValues
- ListMitigationActions
- ListOTAUpdates
- ListOutgoingCertificates
- ListPackageVersions
- ListPackages
- ListPolicies
- ListPolicyPrincipals
- ListPrincipalPolicies
- ListPrincipalThings
- ListPrincipalThingsV2
- ListProvisioningTemplateVersions
- ListProvisioningTemplates
- ListRelatedResourcesForAuditFinding
- ListRoleAliases
- ListSbomValidationResults
- ListScheduledAudits
- ListSecurityProfiles
- ListSecurityProfilesForTarget
- ListStreams
- ListTagsForResource
- ListTargetsForPolicy
- ListTargetsForSecurityProfile
- ListThingGroups
- ListThingGroupsForThing
- ListThingPrincipals
- ListThingPrincipalsV2
- ListThingRegistrationTaskReports
- ListThingRegistrationTasks
- ListThingTypes
- ListThings
- ListThingsInBillingGroup
- ListThingsInThingGroup
- ListTopicRuleDestinations
- ListTopicRules
- ListV2LoggingLevels
- ListViolationEvents