AWS.Iot — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptCertificateTransfer(params = {}, callback) ⇒ AWS.Request

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.

addThingToBillingGroup(params = {}, callback) ⇒ AWS.Request

addThingToThingGroup(params = {}, callback) ⇒ AWS.Request

associateTargetsWithJob(params = {}, callback) ⇒ AWS.Request

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.

attachPolicy(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the AttachPolicy action.

attachPrincipalPolicy(params = {}, callback) ⇒ AWS.Request

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.

attachSecurityProfile(params = {}, callback) ⇒ AWS.Request

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.

attachThingPrincipal(params = {}, callback) ⇒ AWS.Request

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.

cancelAuditMitigationActionsTask(params = {}, callback) ⇒ AWS.Request

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.

cancelAuditTask(params = {}, callback) ⇒ AWS.Request

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.

cancelCertificateTransfer(params = {}, callback) ⇒ AWS.Request

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.

cancelDetectMitigationActionsTask(params = {}, callback) ⇒ AWS.Request

cancelJob(params = {}, callback) ⇒ AWS.Request

Cancels a job.

Requires permission to access the CancelJob action.

cancelJobExecution(params = {}, callback) ⇒ AWS.Request

Cancels the execution of a job for a given thing.

Requires permission to access the CancelJobExecution action.

confirmTopicRuleDestination(params = {}, callback) ⇒ AWS.Request

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.

createAuditSuppression(params = {}, callback) ⇒ AWS.Request

createAuthorizer(params = {}, callback) ⇒ AWS.Request

Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

createBillingGroup(params = {}, callback) ⇒ AWS.Request

createCertificateFromCsr(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the CreateCertificateFromCsr action.

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, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.

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

createCertificateProvider(params = {}, callback) ⇒ AWS.Request

createCustomMetric(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the CreateCustomMetric action.

createDimension(params = {}, callback) ⇒ AWS.Request

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.

createDomainConfiguration(params = {}, callback) ⇒ AWS.Request

createDynamicThingGroup(params = {}, callback) ⇒ AWS.Request

createFleetMetric(params = {}, callback) ⇒ AWS.Request

createJob(params = {}, callback) ⇒ AWS.Request

Creates a job.

Requires permission to access the CreateJob action.

createJobTemplate(params = {}, callback) ⇒ AWS.Request

createKeysAndCertificate(params = {}, callback) ⇒ AWS.Request

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.

createMitigationAction(params = {}, callback) ⇒ AWS.Request

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.

createOTAUpdate(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the CreateOTAUpdate action.

createPackage(params = {}, callback) ⇒ AWS.Request

createPackageVersion(params = {}, callback) ⇒ AWS.Request

createPolicy(params = {}, callback) ⇒ AWS.Request

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.

createPolicyVersion(params = {}, callback) ⇒ AWS.Request

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.

createProvisioningClaim(params = {}, callback) ⇒ AWS.Request

createProvisioningTemplate(params = {}, callback) ⇒ AWS.Request

createProvisioningTemplateVersion(params = {}, callback) ⇒ AWS.Request

createRoleAlias(params = {}, callback) ⇒ AWS.Request

Creates a role alias.

Requires permission to access the CreateRoleAlias action.

createScheduledAudit(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the CreateScheduledAudit action.

createSecurityProfile(params = {}, callback) ⇒ AWS.Request

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile action.

createStream(params = {}, callback) ⇒ AWS.Request

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.

createThing(params = {}, callback) ⇒ AWS.Request

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.

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

Requires permission to access the CreateThing action.

createThingGroup(params = {}, callback) ⇒ AWS.Request

Create a thing group.

Note: 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.

createThingType(params = {}, callback) ⇒ AWS.Request

Creates a new thing type.

Requires permission to access the CreateThingType action.

createTopicRule(params = {}, callback) ⇒ AWS.Request

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.

createTopicRuleDestination(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the CreateTopicRuleDestination action.

deleteAccountAuditConfiguration(params = {}, callback) ⇒ AWS.Request

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.

deleteAuditSuppression(params = {}, callback) ⇒ AWS.Request

deleteAuthorizer(params = {}, callback) ⇒ AWS.Request

Deletes an authorizer.

Requires permission to access the DeleteAuthorizer action.

deleteBillingGroup(params = {}, callback) ⇒ AWS.Request

deleteCACertificate(params = {}, callback) ⇒ AWS.Request

Deletes a registered CA certificate.

Requires permission to access the DeleteCACertificate action.

deleteCertificate(params = {}, callback) ⇒ AWS.Request

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.

deleteCertificateProvider(params = {}, callback) ⇒ AWS.Request

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

deleteCustomMetric(params = {}, callback) ⇒ AWS.Request

Deletes a Device Defender detect custom metric.

Requires permission to access the DeleteCustomMetric action.

Note: 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.

deleteDimension(params = {}, callback) ⇒ AWS.Request

Removes the specified dimension from your Amazon Web Services accounts.

Requires permission to access the DeleteDimension action.

deleteDomainConfiguration(params = {}, callback) ⇒ AWS.Request

deleteDynamicThingGroup(params = {}, callback) ⇒ AWS.Request

deleteFleetMetric(params = {}, callback) ⇒ AWS.Request

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.

deleteJob(params = {}, callback) ⇒ AWS.Request

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.

deleteJobExecution(params = {}, callback) ⇒ AWS.Request

deleteJobTemplate(params = {}, callback) ⇒ AWS.Request

Deletes the specified job template.

deleteMitigationAction(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the DeleteMitigationAction action.

deleteOTAUpdate(params = {}, callback) ⇒ AWS.Request

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

deletePackage(params = {}, callback) ⇒ AWS.Request

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.

deletePackageVersion(params = {}, callback) ⇒ AWS.Request

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.

deletePolicy(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

deletePolicyVersion(params = {}, callback) ⇒ AWS.Request

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.

deleteProvisioningTemplate(params = {}, callback) ⇒ AWS.Request

deleteProvisioningTemplateVersion(params = {}, callback) ⇒ AWS.Request

deleteRegistrationCode(params = {}, callback) ⇒ AWS.Request

deleteRoleAlias(params = {}, callback) ⇒ AWS.Request

Deletes a role alias

Requires permission to access the DeleteRoleAlias action.

deleteScheduledAudit(params = {}, callback) ⇒ AWS.Request

deleteSecurityProfile(params = {}, callback) ⇒ AWS.Request

Deletes a Device Defender security profile.

Requires permission to access the DeleteSecurityProfile action.

deleteStream(params = {}, callback) ⇒ AWS.Request

Deletes a stream.

Requires permission to access the DeleteStream action.

deleteThing(params = {}, callback) ⇒ AWS.Request

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.

deleteThingGroup(params = {}, callback) ⇒ AWS.Request

Deletes a thing group.

Requires permission to access the DeleteThingGroup action.

deleteThingType(params = {}, callback) ⇒ AWS.Request

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.

deleteTopicRule(params = {}, callback) ⇒ AWS.Request

Deletes the rule.

Requires permission to access the DeleteTopicRule action.

deleteTopicRuleDestination(params = {}, callback) ⇒ AWS.Request

deleteV2LoggingLevel(params = {}, callback) ⇒ AWS.Request

deprecateThingType(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the DeprecateThingType action.

describeAccountAuditConfiguration(params = {}, callback) ⇒ AWS.Request

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.

describeAuditFinding(params = {}, callback) ⇒ AWS.Request

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.

describeAuditMitigationActionsTask(params = {}, callback) ⇒ AWS.Request

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.

describeAuditSuppression(params = {}, callback) ⇒ AWS.Request

Gets information about a Device Defender audit suppression.

describeAuditTask(params = {}, callback) ⇒ AWS.Request

Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask action.

describeAuthorizer(params = {}, callback) ⇒ AWS.Request

describeBillingGroup(params = {}, callback) ⇒ AWS.Request

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

describeCACertificate(params = {}, callback) ⇒ AWS.Request

describeCertificate(params = {}, callback) ⇒ AWS.Request

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

describeCertificateProvider(params = {}, callback) ⇒ AWS.Request

describeCustomMetric(params = {}, callback) ⇒ AWS.Request

Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

describeDefaultAuthorizer(params = {}, callback) ⇒ AWS.Request

describeDetectMitigationActionsTask(params = {}, callback) ⇒ AWS.Request

describeDimension(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the DescribeDimension action.

describeDomainConfiguration(params = {}, callback) ⇒ AWS.Request

describeEndpoint(params = {}, callback) ⇒ AWS.Request

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

Note: 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.

describeEventConfigurations(params = {}, callback) ⇒ AWS.Request

describeFleetMetric(params = {}, callback) ⇒ AWS.Request

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

describeIndex(params = {}, callback) ⇒ AWS.Request

Describes a search index.

Requires permission to access the DescribeIndex action.

describeJob(params = {}, callback) ⇒ AWS.Request

Describes a job.

Requires permission to access the DescribeJob action.

describeJobExecution(params = {}, callback) ⇒ AWS.Request

describeJobTemplate(params = {}, callback) ⇒ AWS.Request

Returns information about a job template.

describeManagedJobTemplate(params = {}, callback) ⇒ AWS.Request

View details of a managed job template.

describeMitigationAction(params = {}, callback) ⇒ AWS.Request

describeProvisioningTemplate(params = {}, callback) ⇒ AWS.Request

describeProvisioningTemplateVersion(params = {}, callback) ⇒ AWS.Request

describeRoleAlias(params = {}, callback) ⇒ AWS.Request

describeScheduledAudit(params = {}, callback) ⇒ AWS.Request

describeSecurityProfile(params = {}, callback) ⇒ AWS.Request

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

describeStream(params = {}, callback) ⇒ AWS.Request

Gets information about a stream.

Requires permission to access the DescribeStream action.

describeThing(params = {}, callback) ⇒ AWS.Request

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

describeThingGroup(params = {}, callback) ⇒ AWS.Request

describeThingRegistrationTask(params = {}, callback) ⇒ AWS.Request

describeThingType(params = {}, callback) ⇒ AWS.Request

Gets information about the specified thing type.

Requires permission to access the DescribeThingType action.

detachPolicy(params = {}, callback) ⇒ AWS.Request

Detaches a policy from the specified target.

Note: 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.

detachPrincipalPolicy(params = {}, callback) ⇒ AWS.Request

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.

detachSecurityProfile(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the DetachSecurityProfile action.

detachThingPrincipal(params = {}, callback) ⇒ AWS.Request

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.

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

Requires permission to access the DetachThingPrincipal action.

disableTopicRule(params = {}, callback) ⇒ AWS.Request

enableTopicRule(params = {}, callback) ⇒ AWS.Request

Enables the rule.

Requires permission to access the EnableTopicRule action.

getBehaviorModelTrainingSummaries(params = {}, callback) ⇒ AWS.Request

getBucketsAggregation(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the GetBucketsAggregation action.

getCardinality(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the GetCardinality action.

getEffectivePolicies(params = {}, callback) ⇒ AWS.Request

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.

getIndexingConfiguration(params = {}, callback) ⇒ AWS.Request

getJobDocument(params = {}, callback) ⇒ AWS.Request

Gets a job document.

Requires permission to access the GetJobDocument action.

getLoggingOptions(params = {}, callback) ⇒ AWS.Request

Gets the logging options.

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

Requires permission to access the GetLoggingOptions action.

getOTAUpdate(params = {}, callback) ⇒ AWS.Request

Gets an OTA update.

Requires permission to access the GetOTAUpdate action.

getPackage(params = {}, callback) ⇒ AWS.Request

Gets information about the specified software package.

Requires permission to access the GetPackage action.

getPackageConfiguration(params = {}, callback) ⇒ AWS.Request

Gets information about the specified software package's configuration.

Requires permission to access the GetPackageConfiguration action.

getPackageVersion(params = {}, callback) ⇒ AWS.Request

Gets information about the specified package version.

Requires permission to access the GetPackageVersion action.

getPercentiles(params = {}, callback) ⇒ AWS.Request

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.

getPolicy(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the GetPolicy action.

getPolicyVersion(params = {}, callback) ⇒ AWS.Request

Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion action.

getRegistrationCode(params = {}, callback) ⇒ AWS.Request

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.

getStatistics(params = {}, callback) ⇒ AWS.Request

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.

getTopicRule(params = {}, callback) ⇒ AWS.Request

Gets information about the rule.

Requires permission to access the GetTopicRule action.

getTopicRuleDestination(params = {}, callback) ⇒ AWS.Request

getV2LoggingOptions(params = {}, callback) ⇒ AWS.Request

Gets the fine grained logging options.

Requires permission to access the GetV2LoggingOptions action.

listActiveViolations(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListActiveViolations action.

listAttachedPolicies(params = {}, callback) ⇒ AWS.Request

Lists the policies attached to the specified thing group.

Requires permission to access the ListAttachedPolicies action.

listAuditFindings(params = {}, callback) ⇒ AWS.Request

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.

listAuditMitigationActionsExecutions(params = {}, callback) ⇒ AWS.Request

listAuditMitigationActionsTasks(params = {}, callback) ⇒ AWS.Request

listAuditSuppressions(params = {}, callback) ⇒ AWS.Request

Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions action.

listAuditTasks(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListAuditTasks action.

listAuthorizers(params = {}, callback) ⇒ AWS.Request

Lists the authorizers registered in your account.

Requires permission to access the ListAuthorizers action.

listBillingGroups(params = {}, callback) ⇒ AWS.Request

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

listCACertificates(params = {}, callback) ⇒ AWS.Request

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.

listCertificateProviders(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListCertificateProviders action.

listCertificates(params = {}, callback) ⇒ AWS.Request

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.

listCertificatesByCA(params = {}, callback) ⇒ AWS.Request

List the device certificates signed by the specified CA certificate.

Requires permission to access the ListCertificatesByCA action.

listCustomMetrics(params = {}, callback) ⇒ AWS.Request

Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics action.

listDetectMitigationActionsExecutions(params = {}, callback) ⇒ AWS.Request

listDetectMitigationActionsTasks(params = {}, callback) ⇒ AWS.Request

listDimensions(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListDimensions action.

listDomainConfigurations(params = {}, callback) ⇒ AWS.Request

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.

listFleetMetrics(params = {}, callback) ⇒ AWS.Request

Lists all your fleet metrics.

Requires permission to access the ListFleetMetrics action.

listIndices(params = {}, callback) ⇒ AWS.Request

Lists the search indices.

Requires permission to access the ListIndices action.

listJobExecutionsForJob(params = {}, callback) ⇒ AWS.Request

listJobExecutionsForThing(params = {}, callback) ⇒ AWS.Request

listJobs(params = {}, callback) ⇒ AWS.Request

Lists jobs.

Requires permission to access the ListJobs action.

listJobTemplates(params = {}, callback) ⇒ AWS.Request

Returns a list of job templates.

Requires permission to access the ListJobTemplates action.

listManagedJobTemplates(params = {}, callback) ⇒ AWS.Request

Returns a list of managed job templates.

listMetricValues(params = {}, callback) ⇒ AWS.Request

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.

listMitigationActions(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListMitigationActions action.

listOTAUpdates(params = {}, callback) ⇒ AWS.Request

Lists OTA updates.

Requires permission to access the ListOTAUpdates action.

listOutgoingCertificates(params = {}, callback) ⇒ AWS.Request

Lists certificates that are being transferred but not yet accepted.

Requires permission to access the ListOutgoingCertificates action.

listPackages(params = {}, callback) ⇒ AWS.Request

Lists the software packages associated to the account.

Requires permission to access the ListPackages action.

listPackageVersions(params = {}, callback) ⇒ AWS.Request

Lists the software package versions associated to the account.

Requires permission to access the ListPackageVersions action.

listPolicies(params = {}, callback) ⇒ AWS.Request

Lists your policies.

Requires permission to access the ListPolicies action.

listPolicyPrincipals(params = {}, callback) ⇒ AWS.Request

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.

listPolicyVersions(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListPolicyVersions action.

listPrincipalPolicies(params = {}, callback) ⇒ AWS.Request

listPrincipalThings(params = {}, callback) ⇒ AWS.Request

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.

listProvisioningTemplates(params = {}, callback) ⇒ AWS.Request

Lists the provisioning templates in your Amazon Web Services account.

Requires permission to access the ListProvisioningTemplates action.

listProvisioningTemplateVersions(params = {}, callback) ⇒ AWS.Request

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

Note: 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.

listRoleAliases(params = {}, callback) ⇒ AWS.Request

Lists the role aliases registered in your account.

Requires permission to access the ListRoleAliases action.

listScheduledAudits(params = {}, callback) ⇒ AWS.Request

Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits action.

listSecurityProfiles(params = {}, callback) ⇒ AWS.Request

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.

Note: dimensionName and metricName cannot be used in the same request.

listSecurityProfilesForTarget(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListSecurityProfilesForTarget action.

listStreams(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListStreams action.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListTagsForResource action.

listTargetsForPolicy(params = {}, callback) ⇒ AWS.Request

List targets for the specified policy.

Requires permission to access the ListTargetsForPolicy action.

listTargetsForSecurityProfile(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListTargetsForSecurityProfile action.

listThingGroups(params = {}, callback) ⇒ AWS.Request

List the thing groups in your account.

Requires permission to access the ListThingGroups action.

listThingGroupsForThing(params = {}, callback) ⇒ AWS.Request

List the thing groups to which the specified thing belongs.

Requires permission to access the ListThingGroupsForThing action.

listThingPrincipals(params = {}, callback) ⇒ AWS.Request

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.

listThingRegistrationTaskReports(params = {}, callback) ⇒ AWS.Request

Information about the thing registration tasks.

listThingRegistrationTasks(params = {}, callback) ⇒ AWS.Request

listThings(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

listThingsInBillingGroup(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListThingsInBillingGroup action.

listThingsInThingGroup(params = {}, callback) ⇒ AWS.Request

listThingTypes(params = {}, callback) ⇒ AWS.Request

Lists the existing thing types.

Requires permission to access the ListThingTypes action.

listTopicRuleDestinations(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the ListTopicRuleDestinations action.

listTopicRules(params = {}, callback) ⇒ AWS.Request

Lists the rules for the specific topic.

Requires permission to access the ListTopicRules action.

listV2LoggingLevels(params = {}, callback) ⇒ AWS.Request

listViolationEvents(params = {}, callback) ⇒ AWS.Request

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.

putVerificationStateOnViolation(params = {}, callback) ⇒ AWS.Request

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

registerCACertificate(params = {}, callback) ⇒ AWS.Request

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.

registerCertificate(params = {}, callback) ⇒ AWS.Request

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.

registerCertificateWithoutCA(params = {}, callback) ⇒ AWS.Request

registerThing(params = {}, callback) ⇒ AWS.Request

rejectCertificateTransfer(params = {}, callback) ⇒ AWS.Request

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.

removeThingFromBillingGroup(params = {}, callback) ⇒ AWS.Request

Removes the given thing from the billing group.

Requires permission to access the RemoveThingFromBillingGroup action.

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

removeThingFromThingGroup(params = {}, callback) ⇒ AWS.Request

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.

replaceTopicRule(params = {}, callback) ⇒ AWS.Request

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.

searchIndex(params = {}, callback) ⇒ AWS.Request

The query search index.

Requires permission to access the SearchIndex action.

setDefaultAuthorizer(params = {}, callback) ⇒ AWS.Request

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.

setDefaultPolicyVersion(params = {}, callback) ⇒ AWS.Request

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.

setLoggingOptions(params = {}, callback) ⇒ AWS.Request

Sets the logging options.

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

Requires permission to access the SetLoggingOptions action.

setV2LoggingLevel(params = {}, callback) ⇒ AWS.Request

setV2LoggingOptions(params = {}, callback) ⇒ AWS.Request

Sets the logging options for the V2 logging service.

Requires permission to access the SetV2LoggingOptions action.

startAuditMitigationActionsTask(params = {}, callback) ⇒ AWS.Request

startDetectMitigationActionsTask(params = {}, callback) ⇒ AWS.Request

startOnDemandAuditTask(params = {}, callback) ⇒ AWS.Request

startThingRegistrationTask(params = {}, callback) ⇒ AWS.Request

stopThingRegistrationTask(params = {}, callback) ⇒ AWS.Request

tagResource(params = {}, callback) ⇒ AWS.Request

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.

testAuthorization(params = {}, callback) ⇒ AWS.Request

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.

testInvokeAuthorizer(params = {}, callback) ⇒ AWS.Request

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.

transferCertificate(params = {}, callback) ⇒ AWS.Request

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.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the given tags (metadata) from the resource.

Requires permission to access the UntagResource action.

updateAccountAuditConfiguration(params = {}, callback) ⇒ AWS.Request

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.

updateAuditSuppression(params = {}, callback) ⇒ AWS.Request

Updates a Device Defender audit suppression.

updateAuthorizer(params = {}, callback) ⇒ AWS.Request

Updates an authorizer.

Requires permission to access the UpdateAuthorizer action.

updateBillingGroup(params = {}, callback) ⇒ AWS.Request

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup action.

updateCACertificate(params = {}, callback) ⇒ AWS.Request

Updates a registered CA certificate.

Requires permission to access the UpdateCACertificate action.

updateCertificate(params = {}, callback) ⇒ AWS.Request

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.

updateCertificateProvider(params = {}, callback) ⇒ AWS.Request

updateCustomMetric(params = {}, callback) ⇒ AWS.Request

Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric action.

updateDimension(params = {}, callback) ⇒ AWS.Request

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.

updateDomainConfiguration(params = {}, callback) ⇒ AWS.Request

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.

Requires permission to access the UpdateDomainConfiguration action.

updateDynamicThingGroup(params = {}, callback) ⇒ AWS.Request

updateEventConfigurations(params = {}, callback) ⇒ AWS.Request

updateFleetMetric(params = {}, callback) ⇒ AWS.Request

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

updateIndexingConfiguration(params = {}, callback) ⇒ AWS.Request

updateJob(params = {}, callback) ⇒ AWS.Request

Updates supported fields of the specified job.

Requires permission to access the UpdateJob action.

updateMitigationAction(params = {}, callback) ⇒ AWS.Request

Updates the definition for the specified mitigation action.

Requires permission to access the UpdateMitigationAction action.

updatePackage(params = {}, callback) ⇒ AWS.Request

updatePackageConfiguration(params = {}, callback) ⇒ AWS.Request

updatePackageVersion(params = {}, callback) ⇒ AWS.Request

updateProvisioningTemplate(params = {}, callback) ⇒ AWS.Request

updateRoleAlias(params = {}, callback) ⇒ AWS.Request

Updates a role alias.

Requires permission to access the UpdateRoleAlias action.

updateScheduledAudit(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the UpdateScheduledAudit action.

updateSecurityProfile(params = {}, callback) ⇒ AWS.Request

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

updateStream(params = {}, callback) ⇒ AWS.Request

Updates an existing stream. The stream version will be incremented by one.

Requires permission to access the UpdateStream action.

updateThing(params = {}, callback) ⇒ AWS.Request

Updates the data for a thing.

Requires permission to access the UpdateThing action.

updateThingGroup(params = {}, callback) ⇒ AWS.Request

Update a thing group.

Requires permission to access the UpdateThingGroup action.

updateThingGroupsForThing(params = {}, callback) ⇒ AWS.Request

updateTopicRuleDestination(params = {}, callback) ⇒ AWS.Request

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.

validateSecurityProfileBehaviors(params = {}, callback) ⇒ AWS.Request