View Source aws_iot (aws v0.3.1)
AWS IoT
AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS 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 AWS 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 AWS Signature Version 4 to sign the request is: execute-api.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.Link to this section Summary
Functions
Accepts a pending certificate transfer.
Associates a group with a continuous job.
Attaches the specified policy to the specified principal (certificate or other credential).
Associates a Device Defender security profile with a thing group or this account.
Attaches the specified principal to the specified thing.
Cancels a mitigation action task that is in progress.
Cancels an audit that is in progress.
Cancels a pending transfer for the specified certificate.
Confirms a topic rule destination.
Creates an X.509 certificate using the specified certificate signing request.
Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender.
Creates a domain configuration.
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.
Creates an AWS IoT policy.
Creates a new version of the specified AWS IoT policy.
Creates a stream for delivering one or more large files in chunks over MQTT.
Creates a thing record in the registry.
Create a thing group.
Creates a rule.
Creates a topic rule destination.
Restores the default settings for Device Defender audits for this account.
Deletes the specified certificate.
Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of.
Deletes the specified domain configuration.
Deletes a job and its related job executions.
Deletes the specified policy.
Deletes the specified version of the specified policy.
Deletes the specified thing.
Deletes the specified thing type.
Deprecates a thing type.
Gets information about the Device Defender audit settings for this account.
Gets information about a single audit finding.
Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings.
Gets summary information about a domain configuration.
Removes the specified policy from the specified certificate.
Detaches the specified principal from the specified thing.
Gets the logging options.
Groups the aggregated values that match the query into percentile groupings.
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.
Lists the CA certificates registered for your AWS account.
Lists the certificates registered in your AWS account.
Gets a list of domain configurations for the user.
Lists the principals associated with the specified policy.
Lists the policies attached to the specified principal.
Lists the things associated with the specified principal.
Lists the Device Defender security profiles you've created.
Lists the principals associated with the specified thing.
Lists your things.
Lists the Device Defender security profile violations discovered during the given time period.
Registers a CA certificate with AWS IoT.
Registers a device certificate with AWS IoT.
Provisions a thing in the device registry.
Rejects a pending certificate transfer.
Remove the specified thing from the specified group.
Replaces the rule.
Sets the default authorizer.
Sets the specified version of the specified policy as the policy's default (operative) version.
Sets the logging options.
Adds to or modifies the tags of the given resource.
Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource.
Tests a custom authorization behavior by invoking a specified custom authorizer.
Transfers the specified certificate to the specified AWS account.
Configures or reconfigures the Device Defender audit settings for this account.
Updates the status of the specified certificate.
Updates the definition for a dimension.
Updates values stored in the domain configuration.
Updates an existing stream.
Updates a topic rule destination.
Link to this section Functions
Accepts a pending certificate transfer.
The default state of the certificate is INACTIVE.
To check for pending certificate transfers, callListCertificates
to enumerate your certificates.
accept_certificate_transfer(Client, CertificateId, Input0, Options0)
View SourceAssociates 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.
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This API is deprecated. Please useAttachPolicy
instead.
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.attach_security_profile(Client, SecurityProfileName, Input0, Options0)
View SourceAttaches the specified principal to the specified thing.
A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.Cancels a mitigation action task that is in progress.
If the task is not in progress, an InvalidRequestException occurs.cancel_audit_mitigation_actions_task(Client, TaskId, Input0, Options0)
View SourceCancels an audit that is in progress.
The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.Cancels a pending transfer for the specified certificate.
Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer
instead.) After transfer, AWS 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.
cancel_certificate_transfer(Client, CertificateId, Input0, Options0)
View Sourcecancel_detect_mitigation_actions_task(Client, TaskId, Input0, Options0)
View SourceConfirms a topic rule destination.
When you create a rule requiring a destination, AWS IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when callingConfirmTopicRuleDestination
to confirm that you own or have access to the endpoint.
confirm_topic_rule_destination(Client, ConfirmationToken, QueryMap, HeadersMap)
View Sourceconfirm_topic_rule_destination(Client, ConfirmationToken, QueryMap, HeadersMap, Options0)
View SourceCreates an X.509 certificate using the specified certificate signing request.
Note: 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 or NIST P-384 curves.
Note: 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.
Assuming 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 AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run 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 a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender.
For example, using aTOPIC_FILTER
dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
create_domain_configuration(Client, DomainConfigurationName, Input)
View SourceCreates a domain configuration.
The domain configuration feature is in public preview and is subject to change.create_domain_configuration(Client, DomainConfigurationName, Input0, Options0)
View Sourcecreate_dynamic_thing_group(Client, ThingGroupName, Input0, Options0)
View SourceCreates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
You can also call CreateKeysAndCertificate
over MQTT from a device, for more information, see Provisioning MQTT API.
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.
Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.Creates an AWS 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.Creates a new version of the specified AWS 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.
create_provisioning_template_version(Client, TemplateName, Input0, Options0)
View Sourcecreate_scheduled_audit(Client, ScheduledAuditName, Input0, Options0)
View Sourcecreate_security_profile(Client, SecurityProfileName, Input0, Options0)
View SourceCreates a stream for delivering one or more large files in chunks over MQTT.
A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.Creates a thing record in the registry.
If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException
is thrown.
Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.Creates a rule.
Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.Creates a topic rule destination.
The destination must be confirmed prior to use.Restores the default settings for Device Defender audits for this account.
Any configuration data you entered is deleted and all audit checks are reset to disabled.Deletes 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 theDetachPrincipalPolicy
API to detach all policies. Next, use the UpdateCertificate
API to set the certificate to the INACTIVE status.
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_domain_configuration(Client, DomainConfigurationName, Input)
View SourceDeletes the specified domain configuration.
The domain configuration feature is in public preview and is subject to change.delete_domain_configuration(Client, DomainConfigurationName, Input0, Options0)
View Sourcedelete_dynamic_thing_group(Client, ThingGroupName, Input0, Options0)
View SourceDeletes 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.delete_job_execution(Client, ExecutionNumber, JobId, ThingName, Input)
View Sourcedelete_job_execution(Client, ExecutionNumber, JobId, ThingName, Input0, Options0)
View SourceDeletes 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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.Deletes the specified version of the specified policy.
You cannot delete the default version of a policy using this API. To delete the default version of a policy, useDeletePolicy
. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
delete_policy_version(Client, PolicyName, PolicyVersionId, Input0, Options0)
View Sourcedelete_provisioning_template(Client, TemplateName, Input0, Options0)
View Sourcedelete_provisioning_template_version(Client, TemplateName, VersionId, Input)
View Sourcedelete_provisioning_template_version(Client, TemplateName, VersionId, Input0, Options0)
View Sourcedelete_scheduled_audit(Client, ScheduledAuditName, Input0, Options0)
View Sourcedelete_security_profile(Client, SecurityProfileName, Input0, Options0)
View SourceDeletes the specified thing.
Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.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 callingDeprecateThingType
, 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.
Deprecates a thing type.
You can not associate new things with deprecated thing type.Gets information about the Device Defender audit settings for this account.
Settings include how audit notifications are sent and which audit checks are enabled or disabled.describe_account_audit_configuration(Client, QueryMap, HeadersMap)
View Sourcedescribe_account_audit_configuration(Client, QueryMap, HeadersMap, Options0)
View SourceGets 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.describe_audit_finding(Client, FindingId, QueryMap, HeadersMap, Options0)
View SourceGets 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_mitigation_actions_task(Client, TaskId, QueryMap, HeadersMap)
View Sourcedescribe_audit_mitigation_actions_task(Client, TaskId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_audit_task(Client, TaskId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_authorizer(Client, AuthorizerName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_billing_group(Client, BillingGroupName, QueryMap, HeadersMap)
View Sourcedescribe_billing_group(Client, BillingGroupName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_ca_certificate(Client, CertificateId, QueryMap, HeadersMap)
View Sourcedescribe_ca_certificate(Client, CertificateId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_certificate(Client, CertificateId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_custom_metric(Client, MetricName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_default_authorizer(Client, QueryMap, HeadersMap, Options0)
View Sourcedescribe_detect_mitigation_actions_task(Client, TaskId, QueryMap, HeadersMap)
View Sourcedescribe_detect_mitigation_actions_task(Client, TaskId, QueryMap, HeadersMap, Options0)
View SourceGets summary information about a domain configuration.
The domain configuration feature is in public preview and is subject to change.describe_domain_configuration(Client, DomainConfigurationName, QueryMap, HeadersMap)
View Sourcedescribe_domain_configuration(Client, DomainConfigurationName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_event_configurations(Client, QueryMap, HeadersMap, Options0)
View Sourcedescribe_job_execution(Client, JobId, ThingName, QueryMap, HeadersMap)
View Sourcedescribe_job_execution(Client, JobId, ThingName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_mitigation_action(Client, ActionName, QueryMap, HeadersMap)
View Sourcedescribe_mitigation_action(Client, ActionName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_provisioning_template(Client, TemplateName, QueryMap, HeadersMap)
View Sourcedescribe_provisioning_template(Client, TemplateName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_provisioning_template_version(Client, TemplateName, VersionId)
View Sourcedescribe_provisioning_template_version(Client, TemplateName, VersionId, QueryMap, HeadersMap)
View Sourcedescribe_provisioning_template_version(Client, TemplateName, VersionId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_role_alias(Client, RoleAlias, QueryMap, HeadersMap, Options0)
View Sourcedescribe_scheduled_audit(Client, ScheduledAuditName, QueryMap, HeadersMap)
View Sourcedescribe_scheduled_audit(Client, ScheduledAuditName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_security_profile(Client, SecurityProfileName, QueryMap, HeadersMap)
View Sourcedescribe_security_profile(Client, SecurityProfileName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_thing_group(Client, ThingGroupName, QueryMap, HeadersMap)
View Sourcedescribe_thing_group(Client, ThingGroupName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_thing_registration_task(Client, TaskId, QueryMap, HeadersMap)
View Sourcedescribe_thing_registration_task(Client, TaskId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_thing_type(Client, ThingTypeName, QueryMap, HeadersMap, Options0)
View SourceRemoves the specified policy from the specified certificate.
Note: This API is deprecated. Please useDetachPolicy
instead.
detach_security_profile(Client, SecurityProfileName, Input0, Options0)
View SourceDetaches 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.get_behavior_model_training_summaries(Client, QueryMap, HeadersMap)
View Sourceget_behavior_model_training_summaries(Client, QueryMap, HeadersMap, Options0)
View Sourceget_indexing_configuration(Client, QueryMap, HeadersMap, Options0)
View SourceGets the logging options.
NOTE: use of this command is not recommended. UseGetV2LoggingOptions
instead.
get_ota_update(Client, OtaUpdateId, QueryMap, HeadersMap, Options0)
View SourceGroups 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 callGetPercentiles
. 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.
get_policy_version(Client, PolicyName, PolicyVersionId, QueryMap, HeadersMap)
View Sourceget_policy_version(Client, PolicyName, PolicyVersionId, QueryMap, HeadersMap, Options0)
View SourceReturns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.
If the aggregation field is of typeString
, only the count statistic is returned.
get_topic_rule_destination(Client, Arn, QueryMap, HeadersMap, Options0)
View SourceLists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.
(Findings are retained for 90 days.)list_audit_mitigation_actions_executions(Client, FindingId, TaskId)
View Sourcelist_audit_mitigation_actions_executions(Client, FindingId, TaskId, QueryMap, HeadersMap)
View Sourcelist_audit_mitigation_actions_executions(Client, FindingId, TaskId, QueryMap, HeadersMap, Options0)
View Sourcelist_audit_mitigation_actions_tasks(Client, EndTime, StartTime, QueryMap, HeadersMap)
View Sourcelist_audit_mitigation_actions_tasks(Client, EndTime, StartTime, QueryMap, HeadersMap, Options0)
View Sourcelist_audit_tasks(Client, EndTime, StartTime, QueryMap, HeadersMap)
View Sourcelist_audit_tasks(Client, EndTime, StartTime, QueryMap, HeadersMap, Options0)
View SourceLists the CA certificates registered for your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.Lists the certificates registered in your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.list_certificates_by_ca(Client, CaCertificateId, QueryMap, HeadersMap)
View Sourcelist_certificates_by_ca(Client, CaCertificateId, QueryMap, HeadersMap, Options0)
View Sourcelist_detect_mitigation_actions_executions(Client, QueryMap, HeadersMap)
View Sourcelist_detect_mitigation_actions_executions(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_detect_mitigation_actions_tasks(Client, EndTime, StartTime, QueryMap, HeadersMap)
View Sourcelist_detect_mitigation_actions_tasks(Client, EndTime, StartTime, QueryMap, HeadersMap, Options0)
View SourceGets a list of domain configurations for the user.
This list is sorted alphabetically by domain configuration name.
The domain configuration feature is in public preview and is subject to change.list_domain_configurations(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_job_executions_for_job(Client, JobId, QueryMap, HeadersMap, Options0)
View Sourcelist_job_executions_for_thing(Client, ThingName, QueryMap, HeadersMap)
View Sourcelist_job_executions_for_thing(Client, ThingName, QueryMap, HeadersMap, Options0)
View Sourcelist_outgoing_certificates(Client, QueryMap, HeadersMap, Options0)
View SourceLists the principals associated with the specified policy.
Note: This API is deprecated. Please useListTargetsForPolicy
instead.
list_policy_principals(Client, PolicyName, QueryMap, HeadersMap, Options0)
View Sourcelist_policy_versions(Client, PolicyName, QueryMap, HeadersMap, Options0)
View SourceLists the policies attached to the specified principal.
If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
Note: This API is deprecated. Please useListAttachedPolicies
instead.
list_principal_policies(Client, Principal, QueryMap, HeadersMap, Options0)
View SourceLists 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.list_principal_things(Client, Principal, QueryMap, HeadersMap, Options0)
View Sourcelist_provisioning_template_versions(Client, TemplateName, QueryMap, HeadersMap)
View Sourcelist_provisioning_template_versions(Client, TemplateName, QueryMap, HeadersMap, Options0)
View Sourcelist_provisioning_templates(Client, QueryMap, HeadersMap, Options0)
View SourceLists the Device Defender security profiles you've created.
You can filter security profiles by dimension or custom metric.
dimensionName
and metricName
cannot be used in the same request.
list_security_profiles_for_target(Client, SecurityProfileTargetArn)
View Sourcelist_security_profiles_for_target(Client, SecurityProfileTargetArn, QueryMap, HeadersMap)
View Sourcelist_security_profiles_for_target(Client, SecurityProfileTargetArn, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourcelist_targets_for_security_profile(Client, SecurityProfileName, QueryMap, HeadersMap)
View Sourcelist_targets_for_security_profile(Client, SecurityProfileName, QueryMap, HeadersMap, Options0)
View Sourcelist_thing_groups_for_thing(Client, ThingName, QueryMap, HeadersMap)
View Sourcelist_thing_groups_for_thing(Client, ThingName, QueryMap, HeadersMap, Options0)
View SourceLists 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.list_thing_principals(Client, ThingName, QueryMap, HeadersMap, Options0)
View Sourcelist_thing_registration_task_reports(Client, TaskId, ReportType, QueryMap, HeadersMap)
View Sourcelist_thing_registration_task_reports(Client, TaskId, ReportType, QueryMap, HeadersMap, Options0)
View Sourcelist_thing_registration_tasks(Client, QueryMap, HeadersMap, Options0)
View SourceLists 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.
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, BillingGroupName, QueryMap, HeadersMap)
View Sourcelist_things_in_billing_group(Client, BillingGroupName, QueryMap, HeadersMap, Options0)
View Sourcelist_things_in_thing_group(Client, ThingGroupName, QueryMap, HeadersMap)
View Sourcelist_things_in_thing_group(Client, ThingGroupName, QueryMap, HeadersMap, Options0)
View Sourcelist_topic_rule_destinations(Client, QueryMap, HeadersMap, Options0)
View SourceLists 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).list_violation_events(Client, EndTime, StartTime, QueryMap, HeadersMap)
View Sourcelist_violation_events(Client, EndTime, StartTime, QueryMap, HeadersMap, Options0)
View SourceRegisters a CA certificate with AWS IoT.
This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.Registers a device certificate with AWS IoT.
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.Provisions a thing in the device registry.
RegisterThing calls other AWS IoT control plane APIs. These calls might exceed your account level AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise your throttling limits if necessary.Rejects a pending certificate transfer.
After AWS 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.
reject_certificate_transfer(Client, CertificateId, Input0, Options0)
View SourceRemove the specified thing from the specified group.
You must specify either athingGroupArn
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.
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.Sets the default authorizer.
This will be used if a websocket connection is made without specifying an authorizer.set_default_policy_version(Client, PolicyName, PolicyVersionId, Input)
View SourceSets 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 ListPrincipalPolicy API.set_default_policy_version(Client, PolicyName, PolicyVersionId, Input0, Options0)
View SourceSets the logging options.
NOTE: use of this command is not recommended. UseSetV2LoggingOptions
instead.
start_audit_mitigation_actions_task(Client, TaskId, Input0, Options0)
View Sourcestart_detect_mitigation_actions_task(Client, TaskId, Input0, Options0)
View SourceAdds to or modifies the tags of the given resource.
Tags are metadata which can be used to manage a resource.Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource.
Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.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 AWS IoT device gateway.Transfers the specified certificate to the specified AWS account.
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 API to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.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.Updates the status of the specified certificate.
This operation is idempotent.
Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to AWS IoT.
Within a few minutes of updating a certificate from the ACTIVE state to any other state, AWS IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.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).update_domain_configuration(Client, DomainConfigurationName, Input)
View SourceUpdates values stored in the domain configuration.
Domain configurations for default endpoints can't be updated.
The domain configuration feature is in public preview and is subject to change.update_domain_configuration(Client, DomainConfigurationName, Input0, Options0)
View Sourceupdate_dynamic_thing_group(Client, ThingGroupName, Input0, Options0)
View Sourceupdate_provisioning_template(Client, TemplateName, Input0, Options0)
View Sourceupdate_scheduled_audit(Client, ScheduledAuditName, Input0, Options0)
View Sourceupdate_security_profile(Client, SecurityProfileName, Input0, Options0)
View SourceUpdates an existing stream.
The stream version will be incremented by one.Updates a topic rule destination.
You use this to change the status, endpoint URL, or confirmation URL of the destination.