AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AbortConfig

The criteria that determine when and how a job abort takes place.

Class AbortCriteria

The criteria that determine when and how a job abort takes place.

Class AcceptCertificateTransferRequest

Container for the parameters to the AcceptCertificateTransfer operation. 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.

Class AcceptCertificateTransferResponse

This is the response object from the AcceptCertificateTransfer operation.

Class Action

Describes the actions associated with a rule.

Class ActiveViolation

Information about an active Device Defender security profile behavior violation.

Class AddThingsToThingGroupParams

Parameters used when defining a mitigation action that move a set of things to a thing group.

Class AddThingToBillingGroupRequest

Container for the parameters to the AddThingToBillingGroup operation. Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup action.

Class AddThingToBillingGroupResponse

This is the response object from the AddThingToBillingGroup operation.

Class AddThingToThingGroupRequest

Container for the parameters to the AddThingToThingGroup operation. Adds a thing to a thing group.

Requires permission to access the AddThingToThingGroup action.

Class AddThingToThingGroupResponse

This is the response object from the AddThingToThingGroup operation.

Class AggregationType

The type of aggregation queries.

Class AlertTarget

A structure containing the alert target ARN and the role ARN.

Class Allowed

Contains information that allowed the authorization.

Class AssetPropertyTimestamp

An asset property timestamp entry containing the following information.

Class AssetPropertyValue

An asset property value entry containing the following information.

Class AssetPropertyVariant

Contains an asset property value (of a single type).

Class AssociateTargetsWithJobRequest

Container for the parameters to the AssociateTargetsWithJob operation. 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.

Class AssociateTargetsWithJobResponse

This is the response object from the AssociateTargetsWithJob operation.

Class AttachPolicyRequest

Container for the parameters to the AttachPolicy operation. Attaches the specified policy to the specified principal (certificate or other credential).

Requires permission to access the AttachPolicy action.

Class AttachPolicyResponse

This is the response object from the AttachPolicy operation.

Class AttachPrincipalPolicyRequest

Container for the parameters to the AttachPrincipalPolicy operation. Attaches the specified policy to the specified principal (certificate or other credential).

Note: This action is deprecated. Please use AttachPolicy instead.

Requires permission to access the AttachPrincipalPolicy action.

Class AttachPrincipalPolicyResponse

This is the response object from the AttachPrincipalPolicy operation.

Class AttachSecurityProfileRequest

Container for the parameters to the AttachSecurityProfile operation. 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.

Class AttachSecurityProfileResponse

This is the response object from the AttachSecurityProfile operation.

Class AttachThingPrincipalRequest

Container for the parameters to the AttachThingPrincipal operation. Attaches 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.

Requires permission to access the AttachThingPrincipal action.

Class AttachThingPrincipalResponse

The output from the AttachThingPrincipal operation.

Class AttributePayload

The attribute payload.

Class AuditCheckConfiguration

Which audit checks are enabled and disabled for this account.

Class AuditCheckDetails

Information about the audit check.

Class AuditFinding

The findings (results) of the audit.

Class AuditMitigationActionExecutionMetadata

Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.

Class AuditMitigationActionsTaskMetadata

Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks.

Class AuditMitigationActionsTaskTarget

Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.

Class AuditNotificationTarget

Information about the targets to which audit notifications are sent.

Class AuditSuppression

Filters out specific findings of a Device Defender audit.

Class AuditTaskMetadata

The audits that were performed.

Class AuthInfo

A collection of authorization information.

Class AuthorizerConfig

An object that specifies the authorization service for a domain.

Class AuthorizerDescription

The authorizer description.

Class AuthorizerSummary

The authorizer summary.

Class AuthResult

The authorizer result.

Class AwsJobAbortConfig

The criteria that determine when and how a job abort takes place.

Class AwsJobAbortCriteria

The criteria that determine when and how a job abort takes place.

Class AwsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

Class AwsJobExponentialRolloutRate

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

Class AwsJobPresignedUrlConfig

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

Class AwsJobRateIncreaseCriteria

The criteria to initiate the increase in rate of rollout for a job.

Class AwsJobTimeoutConfig

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Class Behavior

A Device Defender security profile behavior.

Class BehaviorCriteria

The criteria by which the behavior is determined to be normal.

Class BehaviorModelTrainingSummary

The summary of an ML Detect behavior model.

Class BillingGroupMetadata

Additional information about the billing group.

Class BillingGroupProperties

The properties of a billing group.

Class Bucket

A count of documents that meets a specific aggregation criteria.

Class BucketsAggregationType

The type of bucketed aggregation performed.

Class CACertificate

A CA certificate.

Class CACertificateDescription

Describes a CA certificate.

Class CancelAuditMitigationActionsTaskRequest

Container for the parameters to the CancelAuditMitigationActionsTask operation. 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.

Class CancelAuditMitigationActionsTaskResponse

This is the response object from the CancelAuditMitigationActionsTask operation.

Class CancelAuditTaskRequest

Container for the parameters to the CancelAuditTask operation. 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.

Class CancelAuditTaskResponse

This is the response object from the CancelAuditTask operation.

Class CancelCertificateTransferRequest

Container for the parameters to the CancelCertificateTransfer operation. 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.

Class CancelCertificateTransferResponse

This is the response object from the CancelCertificateTransfer operation.

Class CancelDetectMitigationActionsTaskRequest

Container for the parameters to the CancelDetectMitigationActionsTask operation. Cancels a Device Defender ML Detect mitigation action.

Requires permission to access the CancelDetectMitigationActionsTask action.

Class CancelDetectMitigationActionsTaskResponse

This is the response object from the CancelDetectMitigationActionsTask operation.

Class CancelJobExecutionRequest

Container for the parameters to the CancelJobExecution operation. Cancels the execution of a job for a given thing.

Requires permission to access the CancelJobExecution action.

Class CancelJobExecutionResponse

This is the response object from the CancelJobExecution operation.

Class CancelJobRequest

Container for the parameters to the CancelJob operation. Cancels a job.

Requires permission to access the CancelJob action.

Class CancelJobResponse

This is the response object from the CancelJob operation.

Class Certificate

Information about a certificate.

Class CertificateConflictException

Unable to verify the CA certificate used to sign the device certificate you are attempting to register. This is happens when you have registered more than one CA certificate that has the same subject field and public key.

Class CertificateDescription

Describes a certificate.

Class CertificateStateException

The certificate operation is not allowed.

Class CertificateValidationException

The certificate is invalid.

Class CertificateValidity

When the certificate is valid.

Class ClearDefaultAuthorizerRequest

Container for the parameters to the ClearDefaultAuthorizer operation. Clears the default authorizer.

Requires permission to access the ClearDefaultAuthorizer action.

Class ClearDefaultAuthorizerResponse

This is the response object from the ClearDefaultAuthorizer operation.

Class CloudwatchAlarmAction

Describes an action that updates a CloudWatch alarm.

Class CloudwatchLogsAction

Describes an action that sends data to CloudWatch Logs.

Class CloudwatchMetricAction

Describes an action that captures a CloudWatch metric.

Class CodeSigning

Describes the method to use when code signing a file.

Class CodeSigningCertificateChain

Describes the certificate chain being used when code signing a file.

Class CodeSigningSignature

Describes the signature for a file.

Class Configuration

Configuration.

Class ConfirmTopicRuleDestinationRequest

Container for the parameters to the ConfirmTopicRuleDestination operation. 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.

Class ConfirmTopicRuleDestinationResponse

This is the response object from the ConfirmTopicRuleDestination operation.

Class ConflictException

A resource with the same name already exists.

Class ConflictingResourceUpdateException

A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

Class CreateAuditSuppressionRequest

Container for the parameters to the CreateAuditSuppression operation. Creates a Device Defender audit suppression.

Requires permission to access the CreateAuditSuppression action.

Class CreateAuditSuppressionResponse

This is the response object from the CreateAuditSuppression operation.

Class CreateAuthorizerRequest

Container for the parameters to the CreateAuthorizer operation. Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

Class CreateAuthorizerResponse

This is the response object from the CreateAuthorizer operation.

Class CreateBillingGroupRequest

Container for the parameters to the CreateBillingGroup operation. Creates a billing group.

Requires permission to access the CreateBillingGroup action.

Class CreateBillingGroupResponse

This is the response object from the CreateBillingGroup operation.

Class CreateCertificateFromCsrRequest

Container for the parameters to the CreateCertificateFromCsr operation. Creates 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.

Requires permission to access the CreateCertificateFromCsr action.

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 Amazon Web Services 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"

Class CreateCertificateFromCsrResponse

The output from the CreateCertificateFromCsr operation.

Class CreateCustomMetricRequest

Container for the parameters to the CreateCustomMetric operation. Use this API to define a Custom Metric published by your devices to Device Defender.

Requires permission to access the CreateCustomMetric action.

Class CreateCustomMetricResponse

This is the response object from the CreateCustomMetric operation.

Class CreateDimensionRequest

Container for the parameters to the CreateDimension operation. 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.

Class CreateDimensionResponse

This is the response object from the CreateDimension operation.

Class CreateDomainConfigurationRequest

Container for the parameters to the CreateDomainConfiguration operation. Creates a domain configuration.

Requires permission to access the CreateDomainConfiguration action.

Class CreateDomainConfigurationResponse

This is the response object from the CreateDomainConfiguration operation.

Class CreateDynamicThingGroupRequest

Container for the parameters to the CreateDynamicThingGroup operation. Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup action.

Class CreateDynamicThingGroupResponse

This is the response object from the CreateDynamicThingGroup operation.

Class CreateFleetMetricRequest

Container for the parameters to the CreateFleetMetric operation. Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

Class CreateFleetMetricResponse

This is the response object from the CreateFleetMetric operation.

Class CreateJobRequest

Container for the parameters to the CreateJob operation. Creates a job.

Requires permission to access the CreateJob action.

Class CreateJobResponse

This is the response object from the CreateJob operation.

Class CreateJobTemplateRequest

Container for the parameters to the CreateJobTemplate operation. Creates a job template.

Requires permission to access the CreateJobTemplate action.

Class CreateJobTemplateResponse

This is the response object from the CreateJobTemplate operation.

Class CreateKeysAndCertificateRequest

Container for the parameters to the CreateKeysAndCertificate operation. 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.

Class CreateKeysAndCertificateResponse

The output of the CreateKeysAndCertificate operation.

Class CreateMitigationActionRequest

Container for the parameters to the CreateMitigationAction operation. 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.

Class CreateMitigationActionResponse

This is the response object from the CreateMitigationAction operation.

Class CreateOTAUpdateRequest

Container for the parameters to the CreateOTAUpdate operation. Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate action.

Class CreateOTAUpdateResponse

This is the response object from the CreateOTAUpdate operation.

Class CreatePolicyRequest

Container for the parameters to the CreatePolicy operation. 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.

Class CreatePolicyResponse

The output from the CreatePolicy operation.

Class CreatePolicyVersionRequest

Container for the parameters to the CreatePolicyVersion operation. 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.

Class CreatePolicyVersionResponse

The output of the CreatePolicyVersion operation.

Class CreateProvisioningClaimRequest

Container for the parameters to the CreateProvisioningClaim operation. Creates a provisioning claim.

Requires permission to access the CreateProvisioningClaim action.

Class CreateProvisioningClaimResponse

This is the response object from the CreateProvisioningClaim operation.

Class CreateProvisioningTemplateRequest

Container for the parameters to the CreateProvisioningTemplate operation. Creates a fleet provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

Class CreateProvisioningTemplateResponse

This is the response object from the CreateProvisioningTemplate operation.

Class CreateProvisioningTemplateVersionRequest

Container for the parameters to the CreateProvisioningTemplateVersion operation. Creates a new version of a fleet provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion action.

Class CreateProvisioningTemplateVersionResponse

This is the response object from the CreateProvisioningTemplateVersion operation.

Class CreateRoleAliasRequest

Container for the parameters to the CreateRoleAlias operation. Creates a role alias.

Requires permission to access the CreateRoleAlias action.

Class CreateRoleAliasResponse

This is the response object from the CreateRoleAlias operation.

Class CreateScheduledAuditRequest

Container for the parameters to the CreateScheduledAudit operation. Creates a scheduled audit that is run at a specified time interval.

Requires permission to access the CreateScheduledAudit action.

Class CreateScheduledAuditResponse

This is the response object from the CreateScheduledAudit operation.

Class CreateSecurityProfileRequest

Container for the parameters to the CreateSecurityProfile operation. Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile action.

Class CreateSecurityProfileResponse

This is the response object from the CreateSecurityProfile operation.

Class CreateStreamRequest

Container for the parameters to the CreateStream operation. 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.

Class CreateStreamResponse

This is the response object from the CreateStream operation.

Class CreateThingGroupRequest

Container for the parameters to the CreateThingGroup operation. Create a thing group.

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

Requires permission to access the CreateThingGroup action.

Class CreateThingGroupResponse

This is the response object from the CreateThingGroup operation.

Class CreateThingRequest

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

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

Requires permission to access the CreateThing action.

Class CreateThingResponse

The output of the CreateThing operation.

Class CreateThingTypeRequest

Container for the parameters to the CreateThingType operation. Creates a new thing type.

Requires permission to access the CreateThingType action.

Class CreateThingTypeResponse

The output of the CreateThingType operation.

Class CreateTopicRuleDestinationRequest

Container for the parameters to the CreateTopicRuleDestination operation. Creates a topic rule destination. The destination must be confirmed prior to use.

Requires permission to access the CreateTopicRuleDestination action.

Class CreateTopicRuleDestinationResponse

This is the response object from the CreateTopicRuleDestination operation.

Class CreateTopicRuleRequest

Container for the parameters to the CreateTopicRule operation. 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.

Class CreateTopicRuleResponse

This is the response object from the CreateTopicRule operation.

Class CustomCodeSigning

Describes a custom method used to code sign a file.

Class DeleteAccountAuditConfigurationRequest

Container for the parameters to the DeleteAccountAuditConfiguration operation. 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.

Class DeleteAccountAuditConfigurationResponse

This is the response object from the DeleteAccountAuditConfiguration operation.

Class DeleteAuditSuppressionRequest

Container for the parameters to the DeleteAuditSuppression operation. Deletes a Device Defender audit suppression.

Requires permission to access the DeleteAuditSuppression action.

Class DeleteAuditSuppressionResponse

This is the response object from the DeleteAuditSuppression operation.

Class DeleteAuthorizerRequest

Container for the parameters to the DeleteAuthorizer operation. Deletes an authorizer.

Requires permission to access the DeleteAuthorizer action.

Class DeleteAuthorizerResponse

This is the response object from the DeleteAuthorizer operation.

Class DeleteBillingGroupRequest

Container for the parameters to the DeleteBillingGroup operation. Deletes the billing group.

Requires permission to access the DeleteBillingGroup action.

Class DeleteBillingGroupResponse

This is the response object from the DeleteBillingGroup operation.

Class DeleteCACertificateRequest

Container for the parameters to the DeleteCACertificate operation. Deletes a registered CA certificate.

Requires permission to access the DeleteCACertificate action.

Class DeleteCACertificateResponse

The output for the DeleteCACertificate operation.

Class DeleteCertificateRequest

Container for the parameters to the DeleteCertificate operation. 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.

Class DeleteCertificateResponse

This is the response object from the DeleteCertificate operation.

Class DeleteConflictException

You can't delete the resource because it is attached to one or more resources.

Class DeleteCustomMetricRequest

Container for the parameters to the DeleteCustomMetric operation. Deletes a Device Defender detect custom metric.

Requires permission to access the DeleteCustomMetric action.

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

Class DeleteCustomMetricResponse

This is the response object from the DeleteCustomMetric operation.

Class DeleteDimensionRequest

Container for the parameters to the DeleteDimension operation. Removes the specified dimension from your Amazon Web Services accounts.

Requires permission to access the DeleteDimension action.

Class DeleteDimensionResponse

This is the response object from the DeleteDimension operation.

Class DeleteDomainConfigurationRequest

Container for the parameters to the DeleteDomainConfiguration operation. Deletes the specified domain configuration.

Requires permission to access the DeleteDomainConfiguration action.

Class DeleteDomainConfigurationResponse

This is the response object from the DeleteDomainConfiguration operation.

Class DeleteDynamicThingGroupRequest

Container for the parameters to the DeleteDynamicThingGroup operation. Deletes a dynamic thing group.

Requires permission to access the DeleteDynamicThingGroup action.

Class DeleteDynamicThingGroupResponse

This is the response object from the DeleteDynamicThingGroup operation.

Class DeleteFleetMetricRequest

Container for the parameters to the DeleteFleetMetric operation. 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.

Class DeleteFleetMetricResponse

This is the response object from the DeleteFleetMetric operation.

Class DeleteJobExecutionRequest

Container for the parameters to the DeleteJobExecution operation. Deletes a job execution.

Requires permission to access the DeleteJobExecution action.

Class DeleteJobExecutionResponse

This is the response object from the DeleteJobExecution operation.

Class DeleteJobRequest

Container for the parameters to the DeleteJob operation. 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.

Class DeleteJobResponse

This is the response object from the DeleteJob operation.

Class DeleteJobTemplateRequest

Container for the parameters to the DeleteJobTemplate operation. Deletes the specified job template.

Class DeleteJobTemplateResponse

This is the response object from the DeleteJobTemplate operation.

Class DeleteMitigationActionRequest

Container for the parameters to the DeleteMitigationAction operation. Deletes a defined mitigation action from your Amazon Web Services accounts.

Requires permission to access the DeleteMitigationAction action.

Class DeleteMitigationActionResponse

This is the response object from the DeleteMitigationAction operation.

Class DeleteOTAUpdateRequest

Container for the parameters to the DeleteOTAUpdate operation. Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

Class DeleteOTAUpdateResponse

This is the response object from the DeleteOTAUpdate operation.

Class DeletePolicyRequest

Container for the parameters to the DeletePolicy operation. Deletes the specified policy.

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

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

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

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

Requires permission to access the DeletePolicy action.

Class DeletePolicyResponse

This is the response object from the DeletePolicy operation.

Class DeletePolicyVersionRequest

Container for the parameters to the DeletePolicyVersion operation. 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.

Class DeletePolicyVersionResponse

This is the response object from the DeletePolicyVersion operation.

Class DeleteProvisioningTemplateRequest

Container for the parameters to the DeleteProvisioningTemplate operation. Deletes a fleet provisioning template.

Requires permission to access the DeleteProvisioningTemplate action.

Class DeleteProvisioningTemplateResponse

This is the response object from the DeleteProvisioningTemplate operation.

Class DeleteProvisioningTemplateVersionRequest

Container for the parameters to the DeleteProvisioningTemplateVersion operation. Deletes a fleet provisioning template version.

Requires permission to access the DeleteProvisioningTemplateVersion action.

Class DeleteProvisioningTemplateVersionResponse

This is the response object from the DeleteProvisioningTemplateVersion operation.

Class DeleteRegistrationCodeRequest

Container for the parameters to the DeleteRegistrationCode operation. Deletes a CA certificate registration code.

Requires permission to access the DeleteRegistrationCode action.

Class DeleteRegistrationCodeResponse

The output for the DeleteRegistrationCode operation.

Class DeleteRoleAliasRequest

Container for the parameters to the DeleteRoleAlias operation. Deletes a role alias

Requires permission to access the DeleteRoleAlias action.

Class DeleteRoleAliasResponse

This is the response object from the DeleteRoleAlias operation.

Class DeleteScheduledAuditRequest

Container for the parameters to the DeleteScheduledAudit operation. Deletes a scheduled audit.

Requires permission to access the DeleteScheduledAudit action.

Class DeleteScheduledAuditResponse

This is the response object from the DeleteScheduledAudit operation.

Class DeleteSecurityProfileRequest

Container for the parameters to the DeleteSecurityProfile operation. Deletes a Device Defender security profile.

Requires permission to access the DeleteSecurityProfile action.

Class DeleteSecurityProfileResponse

This is the response object from the DeleteSecurityProfile operation.

Class DeleteStreamRequest

Container for the parameters to the DeleteStream operation. Deletes a stream.

Requires permission to access the DeleteStream action.

Class DeleteStreamResponse

This is the response object from the DeleteStream operation.

Class DeleteThingGroupRequest

Container for the parameters to the DeleteThingGroup operation. Deletes a thing group.

Requires permission to access the DeleteThingGroup action.

Class DeleteThingGroupResponse

This is the response object from the DeleteThingGroup operation.

Class DeleteThingRequest

Container for the parameters to the DeleteThing operation. 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.

Class DeleteThingResponse

The output of the DeleteThing operation.

Class DeleteThingTypeRequest

Container for the parameters to the DeleteThingType operation. 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.

Class DeleteThingTypeResponse

The output for the DeleteThingType operation.

Class DeleteTopicRuleDestinationRequest

Container for the parameters to the DeleteTopicRuleDestination operation. Deletes a topic rule destination.

Requires permission to access the DeleteTopicRuleDestination action.

Class DeleteTopicRuleDestinationResponse

This is the response object from the DeleteTopicRuleDestination operation.

Class DeleteTopicRuleRequest

Container for the parameters to the DeleteTopicRule operation. Deletes the rule.

Requires permission to access the DeleteTopicRule action.

Class DeleteTopicRuleResponse

This is the response object from the DeleteTopicRule operation.

Class DeleteV2LoggingLevelRequest

Container for the parameters to the DeleteV2LoggingLevel operation. Deletes a logging level.

Requires permission to access the DeleteV2LoggingLevel action.

Class DeleteV2LoggingLevelResponse

This is the response object from the DeleteV2LoggingLevel operation.

Class Denied

Contains information that denied the authorization.

Class DeprecateThingTypeRequest

Container for the parameters to the DeprecateThingType operation. Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

Class DeprecateThingTypeResponse

The output for the DeprecateThingType operation.

Class DescribeAccountAuditConfigurationRequest

Container for the parameters to the DescribeAccountAuditConfiguration operation. 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.

Class DescribeAccountAuditConfigurationResponse

This is the response object from the DescribeAccountAuditConfiguration operation.

Class DescribeAuditFindingRequest

Container for the parameters to the DescribeAuditFinding operation. 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.

Class DescribeAuditFindingResponse

This is the response object from the DescribeAuditFinding operation.

Class DescribeAuditMitigationActionsTaskRequest

Container for the parameters to the DescribeAuditMitigationActionsTask operation. 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.

Class DescribeAuditMitigationActionsTaskResponse

This is the response object from the DescribeAuditMitigationActionsTask operation.

Class DescribeAuditSuppressionRequest

Container for the parameters to the DescribeAuditSuppression operation. Gets information about a Device Defender audit suppression.

Class DescribeAuditSuppressionResponse

This is the response object from the DescribeAuditSuppression operation.

Class DescribeAuditTaskRequest

Container for the parameters to the DescribeAuditTask operation. Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask action.

Class DescribeAuditTaskResponse

This is the response object from the DescribeAuditTask operation.

Class DescribeAuthorizerRequest

Container for the parameters to the DescribeAuthorizer operation. Describes an authorizer.

Requires permission to access the DescribeAuthorizer action.

Class DescribeAuthorizerResponse

This is the response object from the DescribeAuthorizer operation.

Class DescribeBillingGroupRequest

Container for the parameters to the DescribeBillingGroup operation. Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

Class DescribeBillingGroupResponse

This is the response object from the DescribeBillingGroup operation.

Class DescribeCACertificateRequest

Container for the parameters to the DescribeCACertificate operation. Describes a registered CA certificate.

Requires permission to access the DescribeCACertificate action.

Class DescribeCACertificateResponse

The output from the DescribeCACertificate operation.

Class DescribeCertificateRequest

Container for the parameters to the DescribeCertificate operation. Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

Class DescribeCertificateResponse

The output of the DescribeCertificate operation.

Class DescribeCustomMetricRequest

Container for the parameters to the DescribeCustomMetric operation. Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

Class DescribeCustomMetricResponse

This is the response object from the DescribeCustomMetric operation.

Class DescribeDefaultAuthorizerRequest

Container for the parameters to the DescribeDefaultAuthorizer operation. Describes the default authorizer.

Requires permission to access the DescribeDefaultAuthorizer action.

Class DescribeDefaultAuthorizerResponse

This is the response object from the DescribeDefaultAuthorizer operation.

Class DescribeDetectMitigationActionsTaskRequest

Container for the parameters to the DescribeDetectMitigationActionsTask operation. Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask action.

Class DescribeDetectMitigationActionsTaskResponse

This is the response object from the DescribeDetectMitigationActionsTask operation.

Class DescribeDimensionRequest

Container for the parameters to the DescribeDimension operation. Provides details about a dimension that is defined in your Amazon Web Services accounts.

Requires permission to access the DescribeDimension action.

Class DescribeDimensionResponse

This is the response object from the DescribeDimension operation.

Class DescribeDomainConfigurationRequest

Container for the parameters to the DescribeDomainConfiguration operation. Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration action.

Class DescribeDomainConfigurationResponse

This is the response object from the DescribeDomainConfiguration operation.

Class DescribeEndpointRequest

Container for the parameters to the DescribeEndpoint operation. Returns a unique endpoint specific to the Amazon Web Services account making the call.

Requires permission to access the DescribeEndpoint action.

Class DescribeEndpointResponse

The output from the DescribeEndpoint operation.

Class DescribeEventConfigurationsRequest

Container for the parameters to the DescribeEventConfigurations operation. Describes event configurations.

Requires permission to access the DescribeEventConfigurations action.

Class DescribeEventConfigurationsResponse

This is the response object from the DescribeEventConfigurations operation.

Class DescribeFleetMetricRequest

Container for the parameters to the DescribeFleetMetric operation. Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

Class DescribeFleetMetricResponse

This is the response object from the DescribeFleetMetric operation.

Class DescribeIndexRequest

Container for the parameters to the DescribeIndex operation. Describes a search index.

Requires permission to access the DescribeIndex action.

Class DescribeIndexResponse

This is the response object from the DescribeIndex operation.

Class DescribeJobExecutionRequest

Container for the parameters to the DescribeJobExecution operation. Describes a job execution.

Requires permission to access the DescribeJobExecution action.

Class DescribeJobExecutionResponse

This is the response object from the DescribeJobExecution operation.

Class DescribeJobRequest

Container for the parameters to the DescribeJob operation. Describes a job.

Requires permission to access the DescribeJob action.

Class DescribeJobResponse

This is the response object from the DescribeJob operation.

Class DescribeJobTemplateRequest

Container for the parameters to the DescribeJobTemplate operation. Returns information about a job template.

Class DescribeJobTemplateResponse

This is the response object from the DescribeJobTemplate operation.

Class DescribeMitigationActionRequest

Container for the parameters to the DescribeMitigationAction operation. Gets information about a mitigation action.

Requires permission to access the DescribeMitigationAction action.

Class DescribeMitigationActionResponse

This is the response object from the DescribeMitigationAction operation.

Class DescribeProvisioningTemplateRequest

Container for the parameters to the DescribeProvisioningTemplate operation. Returns information about a fleet provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

Class DescribeProvisioningTemplateResponse

This is the response object from the DescribeProvisioningTemplate operation.

Class DescribeProvisioningTemplateVersionRequest

Container for the parameters to the DescribeProvisioningTemplateVersion operation. Returns information about a fleet provisioning template version.

Requires permission to access the DescribeProvisioningTemplateVersion action.

Class DescribeProvisioningTemplateVersionResponse

This is the response object from the DescribeProvisioningTemplateVersion operation.

Class DescribeRoleAliasRequest

Container for the parameters to the DescribeRoleAlias operation. Describes a role alias.

Requires permission to access the DescribeRoleAlias action.

Class DescribeRoleAliasResponse

This is the response object from the DescribeRoleAlias operation.

Class DescribeScheduledAuditRequest

Container for the parameters to the DescribeScheduledAudit operation. Gets information about a scheduled audit.

Requires permission to access the DescribeScheduledAudit action.

Class DescribeScheduledAuditResponse

This is the response object from the DescribeScheduledAudit operation.

Class DescribeSecurityProfileRequest

Container for the parameters to the DescribeSecurityProfile operation. Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

Class DescribeSecurityProfileResponse

This is the response object from the DescribeSecurityProfile operation.

Class DescribeStreamRequest

Container for the parameters to the DescribeStream operation. Gets information about a stream.

Requires permission to access the DescribeStream action.

Class DescribeStreamResponse

This is the response object from the DescribeStream operation.

Class DescribeThingGroupRequest

Container for the parameters to the DescribeThingGroup operation. Describe a thing group.

Requires permission to access the DescribeThingGroup action.

Class DescribeThingGroupResponse

This is the response object from the DescribeThingGroup operation.

Class DescribeThingRegistrationTaskRequest

Container for the parameters to the DescribeThingRegistrationTask operation. Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

Class DescribeThingRegistrationTaskResponse

This is the response object from the DescribeThingRegistrationTask operation.

Class DescribeThingRequest

Container for the parameters to the DescribeThing operation. Gets information about the specified thing.

Requires permission to access the DescribeThing action.

Class DescribeThingResponse

The output from the DescribeThing operation.

Class DescribeThingTypeRequest

Container for the parameters to the DescribeThingType operation. Gets information about the specified thing type.

Requires permission to access the DescribeThingType action.

Class DescribeThingTypeResponse

The output for the DescribeThingType operation.

Class Destination

Describes the location of the updated firmware.

Class DetachPolicyRequest

Container for the parameters to the DetachPolicy operation. Detaches a policy from the specified target.

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

Requires permission to access the DetachPolicy action.

Class DetachPolicyResponse

This is the response object from the DetachPolicy operation.

Class DetachPrincipalPolicyRequest

Container for the parameters to the DetachPrincipalPolicy operation. Removes the specified policy from the specified certificate.

This action is deprecated. Please use DetachPolicy instead.

Requires permission to access the DetachPrincipalPolicy action.

Class DetachPrincipalPolicyResponse

This is the response object from the DetachPrincipalPolicy operation.

Class DetachSecurityProfileRequest

Container for the parameters to the DetachSecurityProfile operation. Disassociates a Device Defender security profile from a thing group or from this account.

Requires permission to access the DetachSecurityProfile action.

Class DetachSecurityProfileResponse

This is the response object from the DetachSecurityProfile operation.

Class DetachThingPrincipalRequest

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

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

Requires permission to access the DetachThingPrincipal action.

Class DetachThingPrincipalResponse

The output from the DetachThingPrincipal operation.

Class DetectMitigationActionExecution

Describes which mitigation actions should be executed.

Class DetectMitigationActionsTaskStatistics

The statistics of a mitigation action task.

Class DetectMitigationActionsTaskSummary

The summary of the mitigation action tasks.

Class DetectMitigationActionsTaskTarget

The target of a mitigation action task.

Class DisableTopicRuleRequest

Container for the parameters to the DisableTopicRule operation. Disables the rule.

Requires permission to access the DisableTopicRule action.

Class DisableTopicRuleResponse

This is the response object from the DisableTopicRule operation.

Class DomainConfigurationSummary

The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. A domain configuration can be associated with an Amazon Web Services-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.

  • Data

  • Jobs

  • CredentialProvider

Class DynamoDBAction

Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

"hashKeyValue": "${topic(3)}"

The following field uses the timestamp:

"rangeKeyValue": "${timestamp()}"

Class DynamoDBv2Action

Describes an action to write to a DynamoDB table.

This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.

Class EffectivePolicy

The policy that has the effect on the authorization results.

Class ElasticsearchAction

Describes an action that writes data to an Amazon Elasticsearch Service domain.

This action is deprecated. Use the OpenSearch action instead.

Class EnableIoTLoggingParams

Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.

Class EnableTopicRuleRequest

Container for the parameters to the EnableTopicRule operation. Enables the rule.

Requires permission to access the EnableTopicRule action.

Class EnableTopicRuleResponse

This is the response object from the EnableTopicRule operation.

Class ErrorInfo

Error information.

Class ExplicitDeny

Information that explicitly denies authorization.

Class ExponentialRolloutRate

Allows you to create an exponential rate of rollout for a job.

Class Field

Describes the name and data type at a field.

Class FileLocation

The location of the OTA update.

Class FirehoseAction

Describes an action that writes data to an Amazon Kinesis Firehose stream.

Class FleetMetricNameAndArn

The name and ARN of a fleet metric.

Class GetBehaviorModelTrainingSummariesRequest

Container for the parameters to the GetBehaviorModelTrainingSummaries operation. Returns a Device Defender's ML Detect Security Profile training model's status.

Requires permission to access the GetBehaviorModelTrainingSummaries action.

Class GetBehaviorModelTrainingSummariesResponse

This is the response object from the GetBehaviorModelTrainingSummaries operation.

Class GetBucketsAggregationRequest

Container for the parameters to the GetBucketsAggregation operation. Aggregates on indexed data with search queries pertaining to particular fields.

Requires permission to access the GetBucketsAggregation action.

Class GetBucketsAggregationResponse

This is the response object from the GetBucketsAggregation operation.

Class GetCardinalityRequest

Container for the parameters to the GetCardinality operation. Returns the approximate count of unique values that match the query.

Requires permission to access the GetCardinality action.

Class GetCardinalityResponse

This is the response object from the GetCardinality operation.

Class GetEffectivePoliciesRequest

Container for the parameters to the GetEffectivePolicies operation. 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.

Class GetEffectivePoliciesResponse

This is the response object from the GetEffectivePolicies operation.

Class GetIndexingConfigurationRequest

Container for the parameters to the GetIndexingConfiguration operation. Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration action.

Class GetIndexingConfigurationResponse

This is the response object from the GetIndexingConfiguration operation.

Class GetJobDocumentRequest

Container for the parameters to the GetJobDocument operation. Gets a job document.

Requires permission to access the GetJobDocument action.

Class GetJobDocumentResponse

This is the response object from the GetJobDocument operation.

Class GetLoggingOptionsRequest

Container for the parameters to the GetLoggingOptions operation. Gets the logging options.

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

Requires permission to access the GetLoggingOptions action.

Class GetLoggingOptionsResponse

The output from the GetLoggingOptions operation.

Class GetOTAUpdateRequest

Container for the parameters to the GetOTAUpdate operation. Gets an OTA update.

Requires permission to access the GetOTAUpdate action.

Class GetOTAUpdateResponse

This is the response object from the GetOTAUpdate operation.

Class GetPercentilesRequest

Container for the parameters to the GetPercentiles operation. 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.

Class GetPercentilesResponse

This is the response object from the GetPercentiles operation.

Class GetPolicyRequest

Container for the parameters to the GetPolicy operation. Gets information about the specified policy with the policy document of the default version.

Requires permission to access the GetPolicy action.

Class GetPolicyResponse

The output from the GetPolicy operation.

Class GetPolicyVersionRequest

Container for the parameters to the GetPolicyVersion operation. Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion action.

Class GetPolicyVersionResponse

The output from the GetPolicyVersion operation.

Class GetRegistrationCodeRequest

Container for the parameters to the GetRegistrationCode operation. Gets a registration code used to register a CA certificate with IoT.

Requires permission to access the GetRegistrationCode action.

Class GetRegistrationCodeResponse

The output from the GetRegistrationCode operation.

Class GetStatisticsRequest

Container for the parameters to the GetStatistics operation. 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.

Class GetStatisticsResponse

This is the response object from the GetStatistics operation.

Class GetTopicRuleDestinationRequest

Container for the parameters to the GetTopicRuleDestination operation. Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination action.

Class GetTopicRuleDestinationResponse

This is the response object from the GetTopicRuleDestination operation.

Class GetTopicRuleRequest

Container for the parameters to the GetTopicRule operation. Gets information about the rule.

Requires permission to access the GetTopicRule action.

Class GetTopicRuleResponse

The output from the GetTopicRule operation.

Class GetV2LoggingOptionsRequest

Container for the parameters to the GetV2LoggingOptions operation. Gets the fine grained logging options.

Requires permission to access the GetV2LoggingOptions action.

Class GetV2LoggingOptionsResponse

This is the response object from the GetV2LoggingOptions operation.

Class GroupNameAndArn

The name and ARN of a group.

Class HttpAction

Send data to an HTTPS endpoint.

Class HttpActionHeader

The HTTP action header.

Class HttpAuthorization

The authorization method used to send messages.

Class HttpContext

Specifies the HTTP context to use for the test authorizer request.

Class HttpUrlDestinationConfiguration

HTTP URL destination configuration used by the topic rule's HTTP action.

Class HttpUrlDestinationProperties

HTTP URL destination properties.

Class HttpUrlDestinationSummary

Information about an HTTP URL destination.

Class ImplicitDeny

Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.

Class IndexNotReadyException

The index is not ready.

Class InternalException

An unexpected error has occurred.

Class InternalFailureException

An unexpected error has occurred.

Class InvalidAggregationException

The aggregation is invalid.

Class InvalidQueryException

The query is invalid.

Class InvalidRequestException

The request is not valid.

Class InvalidResponseException

The response is invalid.

Class InvalidStateTransitionException

An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is "IN_PROGRESS" without setting the force parameter.

Class IotAnalyticsAction

Sends message data to an IoT Analytics channel.

Class IotEventsAction

Sends an input to an IoT Events detector.

Class IoTPaginatorFactory

Paginators for the IoT service

Class IotSiteWiseAction

Describes an action to send data from an MQTT message that triggered the rule to IoT SiteWise asset properties.

Class Job

The Job object contains details about a job.

Class JobExecution

The job execution object represents the execution of a job on a particular device.

Class JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

Class JobExecutionStatusDetails

Details of the job execution status.

Class JobExecutionSummary

The job execution summary.

Class JobExecutionSummaryForJob

Contains a summary of information about job executions for a specific job.

Class JobExecutionSummaryForThing

The job execution summary for a thing.

Class JobProcessDetails

The job process details.

Class JobSummary

The job summary.

Class JobTemplateSummary

An object that contains information about the job template.

Class KafkaAction

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

Class KeyPair

Describes a key pair.

Class KinesisAction

Describes an action to write data to an Amazon Kinesis stream.

Class LambdaAction

Describes an action to invoke a Lambda function.

Class LimitExceededException

A limit has been exceeded.

Class ListActiveViolationsRequest

Container for the parameters to the ListActiveViolations operation. Lists the active violations for a given Device Defender security profile.

Requires permission to access the ListActiveViolations action.

Class ListActiveViolationsResponse

This is the response object from the ListActiveViolations operation.

Class ListAttachedPoliciesRequest

Container for the parameters to the ListAttachedPolicies operation. Lists the policies attached to the specified thing group.

Requires permission to access the ListAttachedPolicies action.

Class ListAttachedPoliciesResponse

This is the response object from the ListAttachedPolicies operation.

Class ListAuditFindingsRequest

Container for the parameters to the ListAuditFindings operation. 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.

Class ListAuditFindingsResponse

This is the response object from the ListAuditFindings operation.

Class ListAuditMitigationActionsExecutionsRequest

Container for the parameters to the ListAuditMitigationActionsExecutions operation. Gets the status of audit mitigation action tasks that were executed.

Requires permission to access the ListAuditMitigationActionsExecutions action.

Class ListAuditMitigationActionsExecutionsResponse

This is the response object from the ListAuditMitigationActionsExecutions operation.

Class ListAuditMitigationActionsTasksRequest

Container for the parameters to the ListAuditMitigationActionsTasks operation. Gets a list of audit mitigation action tasks that match the specified filters.

Requires permission to access the ListAuditMitigationActionsTasks action.

Class ListAuditMitigationActionsTasksResponse

This is the response object from the ListAuditMitigationActionsTasks operation.

Class ListAuditSuppressionsRequest

Container for the parameters to the ListAuditSuppressions operation. Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions action.

Class ListAuditSuppressionsResponse

This is the response object from the ListAuditSuppressions operation.

Class ListAuditTasksRequest

Container for the parameters to the ListAuditTasks operation. Lists the Device Defender audits that have been performed during a given time period.

Requires permission to access the ListAuditTasks action.

Class ListAuditTasksResponse

This is the response object from the ListAuditTasks operation.

Class ListAuthorizersRequest

Container for the parameters to the ListAuthorizers operation. Lists the authorizers registered in your account.

Requires permission to access the ListAuthorizers action.

Class ListAuthorizersResponse

This is the response object from the ListAuthorizers operation.

Class ListBillingGroupsRequest

Container for the parameters to the ListBillingGroups operation. Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

Class ListBillingGroupsResponse

This is the response object from the ListBillingGroups operation.

Class ListCACertificatesRequest

Container for the parameters to the ListCACertificates operation. 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.

Class ListCACertificatesResponse

The output from the ListCACertificates operation.

Class ListCertificatesByCARequest

Container for the parameters to the ListCertificatesByCA operation. List the device certificates signed by the specified CA certificate.

Requires permission to access the ListCertificatesByCA action.

Class ListCertificatesByCAResponse

The output of the ListCertificatesByCA operation.

Class ListCertificatesRequest

Container for the parameters to the ListCertificates operation. 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.

Class ListCertificatesResponse

The output of the ListCertificates operation.

Class ListCustomMetricsRequest

Container for the parameters to the ListCustomMetrics operation. Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics action.

Class ListCustomMetricsResponse

This is the response object from the ListCustomMetrics operation.

Class ListDetectMitigationActionsExecutionsRequest

Container for the parameters to the ListDetectMitigationActionsExecutions operation. Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

Requires permission to access the ListDetectMitigationActionsExecutions action.

Class ListDetectMitigationActionsExecutionsResponse

This is the response object from the ListDetectMitigationActionsExecutions operation.

Class ListDetectMitigationActionsTasksRequest

Container for the parameters to the ListDetectMitigationActionsTasks operation. List of Device Defender ML Detect mitigation actions tasks.

Requires permission to access the ListDetectMitigationActionsTasks action.

Class ListDetectMitigationActionsTasksResponse

This is the response object from the ListDetectMitigationActionsTasks operation.

Class ListDimensionsRequest

Container for the parameters to the ListDimensions operation. List the set of dimensions that are defined for your Amazon Web Services accounts.

Requires permission to access the ListDimensions action.

Class ListDimensionsResponse

This is the response object from the ListDimensions operation.

Class ListDomainConfigurationsRequest

Container for the parameters to the ListDomainConfigurations operation. 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.

Class ListDomainConfigurationsResponse

This is the response object from the ListDomainConfigurations operation.

Class ListFleetMetricsRequest

Container for the parameters to the ListFleetMetrics operation. Lists all your fleet metrics.

Requires permission to access the ListFleetMetrics action.

Class ListFleetMetricsResponse

This is the response object from the ListFleetMetrics operation.

Class ListIndicesRequest

Container for the parameters to the ListIndices operation. Lists the search indices.

Requires permission to access the ListIndices action.

Class ListIndicesResponse

This is the response object from the ListIndices operation.

Class ListJobExecutionsForJobRequest

Container for the parameters to the ListJobExecutionsForJob operation. Lists the job executions for a job.

Requires permission to access the ListJobExecutionsForJob action.

Class ListJobExecutionsForJobResponse

This is the response object from the ListJobExecutionsForJob operation.

Class ListJobExecutionsForThingRequest

Container for the parameters to the ListJobExecutionsForThing operation. Lists the job executions for the specified thing.

Requires permission to access the ListJobExecutionsForThing action.

Class ListJobExecutionsForThingResponse

This is the response object from the ListJobExecutionsForThing operation.

Class ListJobsRequest

Container for the parameters to the ListJobs operation. Lists jobs.

Requires permission to access the ListJobs action.

Class ListJobsResponse

This is the response object from the ListJobs operation.

Class ListJobTemplatesRequest

Container for the parameters to the ListJobTemplates operation. Returns a list of job templates.

Requires permission to access the ListJobTemplates action.

Class ListJobTemplatesResponse

This is the response object from the ListJobTemplates operation.

Class ListMitigationActionsRequest

Container for the parameters to the ListMitigationActions operation. Gets a list of all mitigation actions that match the specified filter criteria.

Requires permission to access the ListMitigationActions action.

Class ListMitigationActionsResponse

This is the response object from the ListMitigationActions operation.

Class ListOTAUpdatesRequest

Container for the parameters to the ListOTAUpdates operation. Lists OTA updates.

Requires permission to access the ListOTAUpdates action.

Class ListOTAUpdatesResponse

This is the response object from the ListOTAUpdates operation.

Class ListOutgoingCertificatesRequest

Container for the parameters to the ListOutgoingCertificates operation. Lists certificates that are being transferred but not yet accepted.

Requires permission to access the ListOutgoingCertificates action.

Class ListOutgoingCertificatesResponse

The output from the ListOutgoingCertificates operation.

Class ListPoliciesRequest

Container for the parameters to the ListPolicies operation. Lists your policies.

Requires permission to access the ListPolicies action.

Class ListPoliciesResponse

The output from the ListPolicies operation.

Class ListPolicyPrincipalsRequest

Container for the parameters to the ListPolicyPrincipals operation. Lists the principals associated with the specified policy.

Note: This action is deprecated. Please use ListTargetsForPolicy instead.

Requires permission to access the ListPolicyPrincipals action.

Class ListPolicyPrincipalsResponse

The output from the ListPolicyPrincipals operation.

Class ListPolicyVersionsRequest

Container for the parameters to the ListPolicyVersions operation. Lists the versions of the specified policy and identifies the default version.

Requires permission to access the ListPolicyVersions action.

Class ListPolicyVersionsResponse

The output from the ListPolicyVersions operation.

Class ListPrincipalPoliciesRequest

Container for the parameters to the ListPrincipalPolicies operation. Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

Note: This action is deprecated. Please use ListAttachedPolicies instead.

Requires permission to access the ListPrincipalPolicies action.

Class ListPrincipalPoliciesResponse

The output from the ListPrincipalPolicies operation.

Class ListPrincipalThingsRequest

Container for the parameters to the ListPrincipalThings operation. 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.

Class ListPrincipalThingsResponse

The output from the ListPrincipalThings operation.

Class ListProvisioningTemplatesRequest

Container for the parameters to the ListProvisioningTemplates operation. Lists the fleet provisioning templates in your Amazon Web Services account.

Requires permission to access the ListProvisioningTemplates action.

Class ListProvisioningTemplatesResponse

This is the response object from the ListProvisioningTemplates operation.

Class ListProvisioningTemplateVersionsRequest

Container for the parameters to the ListProvisioningTemplateVersions operation. A list of fleet provisioning template versions.

Requires permission to access the ListProvisioningTemplateVersions action.

Class ListProvisioningTemplateVersionsResponse

This is the response object from the ListProvisioningTemplateVersions operation.

Class ListRoleAliasesRequest

Container for the parameters to the ListRoleAliases operation. Lists the role aliases registered in your account.

Requires permission to access the ListRoleAliases action.

Class ListRoleAliasesResponse

This is the response object from the ListRoleAliases operation.

Class ListScheduledAuditsRequest

Container for the parameters to the ListScheduledAudits operation. Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits action.

Class ListScheduledAuditsResponse

This is the response object from the ListScheduledAudits operation.

Class ListSecurityProfilesForTargetRequest

Container for the parameters to the ListSecurityProfilesForTarget operation. Lists the Device Defender security profiles attached to a target (thing group).

Requires permission to access the ListSecurityProfilesForTarget action.

Class ListSecurityProfilesForTargetResponse

This is the response object from the ListSecurityProfilesForTarget operation.

Class ListSecurityProfilesRequest

Container for the parameters to the ListSecurityProfiles operation. Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.

Requires permission to access the ListSecurityProfiles action.

dimensionName and metricName cannot be used in the same request.

Class ListSecurityProfilesResponse

This is the response object from the ListSecurityProfiles operation.

Class ListStreamsRequest

Container for the parameters to the ListStreams operation. Lists all of the streams in your Amazon Web Services account.

Requires permission to access the ListStreams action.

Class ListStreamsResponse

This is the response object from the ListStreams operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags (metadata) you have assigned to the resource.

Requires permission to access the ListTagsForResource action.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListTargetsForPolicyRequest

Container for the parameters to the ListTargetsForPolicy operation. List targets for the specified policy.

Requires permission to access the ListTargetsForPolicy action.

Class ListTargetsForPolicyResponse

This is the response object from the ListTargetsForPolicy operation.

Class ListTargetsForSecurityProfileRequest

Container for the parameters to the ListTargetsForSecurityProfile operation. Lists the targets (thing groups) associated with a given Device Defender security profile.

Requires permission to access the ListTargetsForSecurityProfile action.

Class ListTargetsForSecurityProfileResponse

This is the response object from the ListTargetsForSecurityProfile operation.

Class ListThingGroupsForThingRequest

Container for the parameters to the ListThingGroupsForThing operation. List the thing groups to which the specified thing belongs.

Requires permission to access the ListThingGroupsForThing action.

Class ListThingGroupsForThingResponse

This is the response object from the ListThingGroupsForThing operation.

Class ListThingGroupsRequest

Container for the parameters to the ListThingGroups operation. List the thing groups in your account.

Requires permission to access the ListThingGroups action.

Class ListThingGroupsResponse

This is the response object from the ListThingGroups operation.

Class ListThingPrincipalsRequest

Container for the parameters to the ListThingPrincipals operation. 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.

Class ListThingPrincipalsResponse

The output from the ListThingPrincipals operation.

Class ListThingRegistrationTaskReportsRequest

Container for the parameters to the ListThingRegistrationTaskReports operation. Information about the thing registration tasks.

Class ListThingRegistrationTaskReportsResponse

This is the response object from the ListThingRegistrationTaskReports operation.

Class ListThingRegistrationTasksRequest

Container for the parameters to the ListThingRegistrationTasks operation. List bulk thing provisioning tasks.

Requires permission to access the ListThingRegistrationTasks action.

Class ListThingRegistrationTasksResponse

This is the response object from the ListThingRegistrationTasks operation.

Class ListThingsInBillingGroupRequest

Container for the parameters to the ListThingsInBillingGroup operation. Lists the things you have added to the given billing group.

Requires permission to access the ListThingsInBillingGroup action.

Class ListThingsInBillingGroupResponse

This is the response object from the ListThingsInBillingGroup operation.

Class ListThingsInThingGroupRequest

Container for the parameters to the ListThingsInThingGroup operation. Lists the things in the specified group.

Requires permission to access the ListThingsInThingGroup action.

Class ListThingsInThingGroupResponse

This is the response object from the ListThingsInThingGroup operation.

Class ListThingsRequest

Container for the parameters to the ListThings operation. 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.

Requires permission to access the ListThings action.

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

Class ListThingsResponse

The output from the ListThings operation.

Class ListThingTypesRequest

Container for the parameters to the ListThingTypes operation. Lists the existing thing types.

Requires permission to access the ListThingTypes action.

Class ListThingTypesResponse

The output for the ListThingTypes operation.

Class ListTopicRuleDestinationsRequest

Container for the parameters to the ListTopicRuleDestinations operation. Lists all the topic rule destinations in your Amazon Web Services account.

Requires permission to access the ListTopicRuleDestinations action.

Class ListTopicRuleDestinationsResponse

This is the response object from the ListTopicRuleDestinations operation.

Class ListTopicRulesRequest

Container for the parameters to the ListTopicRules operation. Lists the rules for the specific topic.

Requires permission to access the ListTopicRules action.

Class ListTopicRulesResponse

The output from the ListTopicRules operation.

Class ListV2LoggingLevelsRequest

Container for the parameters to the ListV2LoggingLevels operation. Lists logging levels.

Requires permission to access the ListV2LoggingLevels action.

Class ListV2LoggingLevelsResponse

This is the response object from the ListV2LoggingLevels operation.

Class ListViolationEventsRequest

Container for the parameters to the ListViolationEvents operation. 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.

Class ListViolationEventsResponse

This is the response object from the ListViolationEvents operation.

Class LoggingOptionsPayload

Describes the logging options payload.

Class LogTarget

A log target.

Class LogTargetConfiguration

The target configuration.

Class MachineLearningDetectionConfig

The configuration of an ML Detect Security Profile.

Class MalformedPolicyException

The policy documentation is not valid.

Class MetricDimension

The dimension of a metric.

Class MetricToRetain

The metric you want to retain. Dimensions are optional.

Class MetricValue

The value to be compared with the metric.

Class MitigationAction

Describes which changes should be applied as part of a mitigation action.

Class MitigationActionIdentifier

Information that identifies a mitigation action. This information is returned by ListMitigationActions.

Class MitigationActionParams

The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).

Class MqttContext

Specifies the MQTT context to use for the test authorizer request

Class NonCompliantResource

Information about the resource that was noncompliant with the audit check.

Class NotConfiguredException

The resource is not configured.

Class OpenSearchAction

Describes an action that writes data to an Amazon OpenSearch Service domain.

Class OTAUpdateFile

Describes a file to be associated with an OTA update.

Class OTAUpdateInfo

Information about an OTA update.

Class OTAUpdateSummary

An OTA update summary.

Class OutgoingCertificate

A certificate that has been transferred but not yet accepted.

Class PercentPair

Describes the percentile and percentile value.

Class Policy

Describes an IoT policy.

Class PolicyVersion

Describes a policy version.

Class PolicyVersionIdentifier

Information about the version of the policy associated with the resource.

Class PresignedUrlConfig

Configuration for pre-signed S3 URLs.

Class ProvisioningHook

Structure that contains payloadVersion and targetArn.

Class ProvisioningTemplateSummary

A summary of information about a fleet provisioning template.

Class ProvisioningTemplateVersionSummary

A summary of information about a fleet provision template version.

Class PublishFindingToSnsParams

Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

Class PutAssetPropertyValueEntry

An asset property value entry containing the following information.

Class PutItemInput

The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.

Class RateIncreaseCriteria

Allows you to define a criteria to initiate the increase in rate of rollout for a job.

Class RegisterCACertificateRequest

Container for the parameters to the RegisterCACertificate operation. Registers a CA certificate with IoT. This CA certificate can then be used to sign device certificates, which can be then registered with IoT. You can register up to 10 CA certificates per Amazon Web Services 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 action.

Requires permission to access the RegisterCACertificate action.

Class RegisterCACertificateResponse

The output from the RegisterCACertificateResponse operation.

Class RegisterCertificateRequest

Container for the parameters to the RegisterCertificate operation. Registers a device certificate with 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.

Requires permission to access the RegisterCertificate action.

Class RegisterCertificateResponse

The output from the RegisterCertificate operation.

Class RegisterCertificateWithoutCARequest

Container for the parameters to the RegisterCertificateWithoutCA operation. Register a certificate that does not have a certificate authority (CA).

Class RegisterCertificateWithoutCAResponse

This is the response object from the RegisterCertificateWithoutCA operation.

Class RegisterThingRequest

Container for the parameters to the RegisterThing operation. Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.

Requires permission to access the RegisterThing action.

Class RegisterThingResponse

This is the response object from the RegisterThing operation.

Class RegistrationCodeValidationException

The registration code is invalid.

Class RegistrationConfig

The registration configuration.

Class RejectCertificateTransferRequest

Container for the parameters to the RejectCertificateTransfer operation. 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.

Class RejectCertificateTransferResponse

This is the response object from the RejectCertificateTransfer operation.

Class RelatedResource

Information about a related resource.

Class RemoveThingFromBillingGroupRequest

Container for the parameters to the RemoveThingFromBillingGroup operation. Removes the given thing from the billing group.

Requires permission to access the RemoveThingFromBillingGroup action.

Class RemoveThingFromBillingGroupResponse

This is the response object from the RemoveThingFromBillingGroup operation.

Class RemoveThingFromThingGroupRequest

Container for the parameters to the RemoveThingFromThingGroup operation. 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.

Class RemoveThingFromThingGroupResponse

This is the response object from the RemoveThingFromThingGroup operation.

Class ReplaceDefaultPolicyVersionParams

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

Class ReplaceTopicRuleRequest

Container for the parameters to the ReplaceTopicRule operation. 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.

Class ReplaceTopicRuleResponse

This is the response object from the ReplaceTopicRule operation.

Class RepublishAction

Describes an action to republish to another topic.

Class ResourceAlreadyExistsException

The resource already exists.

Class ResourceIdentifier

Information that identifies the noncompliant resource.

Class ResourceNotFoundException

The specified resource does not exist.

Class ResourceRegistrationFailureException

The resource registration failed.

Class RoleAliasDescription

Role alias description.

Class S3Action

Describes an action to write data to an Amazon S3 bucket.

Class S3Destination

Describes the location of updated firmware in S3.

Class S3Location

The S3 location.

Class SalesforceAction

Describes an action to write a message to a Salesforce IoT Cloud Input Stream.

Class ScheduledAuditMetadata

Information about the scheduled audit.

Class SearchIndexRequest

Container for the parameters to the SearchIndex operation. The query search index.

Requires permission to access the SearchIndex action.

Class SearchIndexResponse

This is the response object from the SearchIndex operation.

Class SecurityProfileIdentifier

Identifying information for a Device Defender security profile.

Class SecurityProfileTarget

A target to which an alert is sent when a security profile behavior is violated.

Class SecurityProfileTargetMapping

Information about a security profile and the target associated with it.

Class ServerCertificateSummary

An object that contains information about a server certificate.

Class ServiceUnavailableException

The service is temporarily unavailable.

Class SetDefaultAuthorizerRequest

Container for the parameters to the SetDefaultAuthorizer operation. 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.

Class SetDefaultAuthorizerResponse

This is the response object from the SetDefaultAuthorizer operation.

Class SetDefaultPolicyVersionRequest

Container for the parameters to the SetDefaultPolicyVersion operation. 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.

Class SetDefaultPolicyVersionResponse

This is the response object from the SetDefaultPolicyVersion operation.

Class SetLoggingOptionsRequest

Container for the parameters to the SetLoggingOptions operation. Sets the logging options.

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

Requires permission to access the SetLoggingOptions action.

Class SetLoggingOptionsResponse

This is the response object from the SetLoggingOptions operation.

Class SetV2LoggingLevelRequest

Container for the parameters to the SetV2LoggingLevel operation. Sets the logging level.

Requires permission to access the SetV2LoggingLevel action.

Class SetV2LoggingLevelResponse

This is the response object from the SetV2LoggingLevel operation.

Class SetV2LoggingOptionsRequest

Container for the parameters to the SetV2LoggingOptions operation. Sets the logging options for the V2 logging service.

Requires permission to access the SetV2LoggingOptions action.

Class SetV2LoggingOptionsResponse

This is the response object from the SetV2LoggingOptions operation.

Class SigningProfileParameter

Describes the code-signing profile.

Class SigV4Authorization

For more information, see Signature Version 4 signing process.

Class SnsAction

Describes an action to publish to an Amazon SNS topic.

Class SqlParseException

The Rule-SQL expression can't be parsed correctly.

Class SqsAction

Describes an action to publish data to an Amazon SQS queue.

Class StartAuditMitigationActionsTaskRequest

Container for the parameters to the StartAuditMitigationActionsTask operation. Starts a task that applies a set of mitigation actions to the specified target.

Requires permission to access the StartAuditMitigationActionsTask action.

Class StartAuditMitigationActionsTaskResponse

This is the response object from the StartAuditMitigationActionsTask operation.

Class StartDetectMitigationActionsTaskRequest

Container for the parameters to the StartDetectMitigationActionsTask operation. Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask action.

Class StartDetectMitigationActionsTaskResponse

This is the response object from the StartDetectMitigationActionsTask operation.

Class StartOnDemandAuditTaskRequest

Container for the parameters to the StartOnDemandAuditTask operation. Starts an on-demand Device Defender audit.

Requires permission to access the StartOnDemandAuditTask action.

Class StartOnDemandAuditTaskResponse

This is the response object from the StartOnDemandAuditTask operation.

Class StartSigningJobParameter

Information required to start a signing job.

Class StartThingRegistrationTaskRequest

Container for the parameters to the StartThingRegistrationTask operation. Creates a bulk thing provisioning task.

Requires permission to access the StartThingRegistrationTask action.

Class StartThingRegistrationTaskResponse

This is the response object from the StartThingRegistrationTask operation.

Class StatisticalThreshold

A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Class Statistics

A map of key-value pairs for all supported statistics. Currently, only count is supported.

Class StepFunctionsAction

Starts execution of a Step Functions state machine.

Class StopThingRegistrationTaskRequest

Container for the parameters to the StopThingRegistrationTask operation. Cancels a bulk thing provisioning task.

Requires permission to access the StopThingRegistrationTask action.

Class StopThingRegistrationTaskResponse

This is the response object from the StopThingRegistrationTask operation.

Class Stream

Describes a group of files that can be streamed.

Class StreamFile

Represents a file to stream.

Class StreamInfo

Information about a stream.

Class StreamSummary

A summary of a stream.

Class Tag

A set of key/value pairs that are used to manage the resource.

Class TagResourceRequest

Container for the parameters to the TagResource operation. 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.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TaskAlreadyExistsException

This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.

Class TaskStatistics

Statistics for the checks performed during the audit.

Class TaskStatisticsForAuditCheck

Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.

Class TermsAggregation

Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.

Class TestAuthorizationRequest

Container for the parameters to the TestAuthorization operation. 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.

Class TestAuthorizationResponse

This is the response object from the TestAuthorization operation.

Class TestInvokeAuthorizerRequest

Container for the parameters to the TestInvokeAuthorizer operation. 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.

Class TestInvokeAuthorizerResponse

This is the response object from the TestInvokeAuthorizer operation.

Class ThingAttribute

The properties of the thing, including thing name, thing type name, and a list of thing attributes.

Class ThingConnectivity

The connectivity status of the thing.

Class ThingDocument

The thing search index document.

Class ThingGroupDocument

The thing group search index document.

Class ThingGroupIndexingConfiguration

Thing group indexing configuration.

Class ThingGroupMetadata

Thing group metadata.

Class ThingGroupProperties

Thing group properties.

Class ThingIndexingConfiguration

The thing indexing configuration. For more information, see Managing Thing Indexing.

Class ThingTypeDefinition

The definition of the thing type, including thing type name and description.

Class ThingTypeMetadata

The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when time was deprecated.

Class ThingTypeProperties

The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

Class ThrottlingException

The rate exceeds the limit.

Class TimeoutConfig

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Class TimestreamAction

The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.

Class TimestreamDimension

Metadata attributes of the time series that are written in each measure record.

Class TimestreamTimestamp

Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.

Class TlsContext

Specifies the TLS context to use for the test authorizer request.

Class TopicRule

Describes a rule.

Class TopicRuleDestination

A topic rule destination.

Class TopicRuleDestinationConfiguration

Configuration of the topic rule destination.

Class TopicRuleDestinationSummary

Information about the topic rule destination.

Class TopicRuleListItem

Describes a rule.

Class TopicRulePayload

Describes a rule.

Class TransferAlreadyCompletedException

You can't revert the certificate transfer because the transfer is already complete.

Class TransferCertificateRequest

Container for the parameters to the TransferCertificate operation. 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.

Class TransferCertificateResponse

The output from the TransferCertificate operation.

Class TransferConflictException

You can't transfer the certificate because authorization policies are still attached.

Class TransferData

Data used to transfer a certificate to an Amazon Web Services account.

Class UnauthorizedException

You are not authorized to perform this operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes the given tags (metadata) from the resource.

Requires permission to access the UntagResource action.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateAccountAuditConfigurationRequest

Container for the parameters to the UpdateAccountAuditConfiguration operation. 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.

Class UpdateAccountAuditConfigurationResponse

This is the response object from the UpdateAccountAuditConfiguration operation.

Class UpdateAuditSuppressionRequest

Container for the parameters to the UpdateAuditSuppression operation. Updates a Device Defender audit suppression.

Class UpdateAuditSuppressionResponse

This is the response object from the UpdateAuditSuppression operation.

Class UpdateAuthorizerRequest

Container for the parameters to the UpdateAuthorizer operation. Updates an authorizer.

Requires permission to access the UpdateAuthorizer action.

Class UpdateAuthorizerResponse

This is the response object from the UpdateAuthorizer operation.

Class UpdateBillingGroupRequest

Container for the parameters to the UpdateBillingGroup operation. Updates information about the billing group.

Requires permission to access the UpdateBillingGroup action.

Class UpdateBillingGroupResponse

This is the response object from the UpdateBillingGroup operation.

Class UpdateCACertificateParams

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

Class UpdateCACertificateRequest

Container for the parameters to the UpdateCACertificate operation. Updates a registered CA certificate.

Requires permission to access the UpdateCACertificate action.

Class UpdateCACertificateResponse

This is the response object from the UpdateCACertificate operation.

Class UpdateCertificateRequest

Container for the parameters to the UpdateCertificate operation. 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.

Class UpdateCertificateResponse

This is the response object from the UpdateCertificate operation.

Class UpdateCustomMetricRequest

Container for the parameters to the UpdateCustomMetric operation. Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric action.

Class UpdateCustomMetricResponse

This is the response object from the UpdateCustomMetric operation.

Class UpdateDeviceCertificateParams

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

Class UpdateDimensionRequest

Container for the parameters to the UpdateDimension operation. 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.

Class UpdateDimensionResponse

This is the response object from the UpdateDimension operation.

Class UpdateDomainConfigurationRequest

Container for the parameters to the UpdateDomainConfiguration operation. Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.

Requires permission to access the UpdateDomainConfiguration action.

Class UpdateDomainConfigurationResponse

This is the response object from the UpdateDomainConfiguration operation.

Class UpdateDynamicThingGroupRequest

Container for the parameters to the UpdateDynamicThingGroup operation. Updates a dynamic thing group.

Requires permission to access the UpdateDynamicThingGroup action.

Class UpdateDynamicThingGroupResponse

This is the response object from the UpdateDynamicThingGroup operation.

Class UpdateEventConfigurationsRequest

Container for the parameters to the UpdateEventConfigurations operation. Updates the event configurations.

Requires permission to access the UpdateEventConfigurations action.

Class UpdateEventConfigurationsResponse

This is the response object from the UpdateEventConfigurations operation.

Class UpdateFleetMetricRequest

Container for the parameters to the UpdateFleetMetric operation. Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

Class UpdateFleetMetricResponse

This is the response object from the UpdateFleetMetric operation.

Class UpdateIndexingConfigurationRequest

Container for the parameters to the UpdateIndexingConfiguration operation. Updates the search configuration.

Requires permission to access the UpdateIndexingConfiguration action.

Class UpdateIndexingConfigurationResponse

This is the response object from the UpdateIndexingConfiguration operation.

Class UpdateJobRequest

Container for the parameters to the UpdateJob operation. Updates supported fields of the specified job.

Requires permission to access the UpdateJob action.

Class UpdateJobResponse

This is the response object from the UpdateJob operation.

Class UpdateMitigationActionRequest

Container for the parameters to the UpdateMitigationAction operation. Updates the definition for the specified mitigation action.

Requires permission to access the UpdateMitigationAction action.

Class UpdateMitigationActionResponse

This is the response object from the UpdateMitigationAction operation.

Class UpdateProvisioningTemplateRequest

Container for the parameters to the UpdateProvisioningTemplate operation. Updates a fleet provisioning template.

Requires permission to access the UpdateProvisioningTemplate action.

Class UpdateProvisioningTemplateResponse

This is the response object from the UpdateProvisioningTemplate operation.

Class UpdateRoleAliasRequest

Container for the parameters to the UpdateRoleAlias operation. Updates a role alias.

Requires permission to access the UpdateRoleAlias action.

Class UpdateRoleAliasResponse

This is the response object from the UpdateRoleAlias operation.

Class UpdateScheduledAuditRequest

Container for the parameters to the UpdateScheduledAudit operation. Updates a scheduled audit, including which checks are performed and how often the audit takes place.

Requires permission to access the UpdateScheduledAudit action.

Class UpdateScheduledAuditResponse

This is the response object from the UpdateScheduledAudit operation.

Class UpdateSecurityProfileRequest

Container for the parameters to the UpdateSecurityProfile operation. Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

Class UpdateSecurityProfileResponse

This is the response object from the UpdateSecurityProfile operation.

Class UpdateStreamRequest

Container for the parameters to the UpdateStream operation. Updates an existing stream. The stream version will be incremented by one.

Requires permission to access the UpdateStream action.

Class UpdateStreamResponse

This is the response object from the UpdateStream operation.

Class UpdateThingGroupRequest

Container for the parameters to the UpdateThingGroup operation. Update a thing group.

Requires permission to access the UpdateThingGroup action.

Class UpdateThingGroupResponse

This is the response object from the UpdateThingGroup operation.

Class UpdateThingGroupsForThingRequest

Container for the parameters to the UpdateThingGroupsForThing operation. Updates the groups to which the thing belongs.

Requires permission to access the UpdateThingGroupsForThing action.

Class UpdateThingGroupsForThingResponse

This is the response object from the UpdateThingGroupsForThing operation.

Class UpdateThingRequest

Container for the parameters to the UpdateThing operation. Updates the data for a thing.

Requires permission to access the UpdateThing action.

Class UpdateThingResponse

The output from the UpdateThing operation.

Class UpdateTopicRuleDestinationRequest

Container for the parameters to the UpdateTopicRuleDestination operation. 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.

Class UpdateTopicRuleDestinationResponse

This is the response object from the UpdateTopicRuleDestination operation.

Class ValidateSecurityProfileBehaviorsRequest

Container for the parameters to the ValidateSecurityProfileBehaviors operation. Validates a Device Defender security profile behaviors specification.

Requires permission to access the ValidateSecurityProfileBehaviors action.

Class ValidateSecurityProfileBehaviorsResponse

This is the response object from the ValidateSecurityProfileBehaviors operation.

Class ValidationError

Information about an error found in a behavior specification.

Class VersionConflictException

An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

Class VersionsLimitExceededException

The number of policy versions exceeds the limit.

Class ViolationEvent

Information about a Device Defender security profile behavior violation.

Class ViolationEventAdditionalInfo

The details of a violation event.

Class ViolationEventOccurrenceRange

Specifies the time period of which violation events occurred between.

Class VpcDestinationConfiguration

The configuration information for a virtual private cloud (VPC) destination.

Class VpcDestinationProperties

The properties of a virtual private cloud (VPC) destination.

Class VpcDestinationSummary

The summary of a virtual private cloud (VPC) destination.

Interfaces

NameDescription
Interface IGetBehaviorModelTrainingSummariesPaginator

Paginator for the GetBehaviorModelTrainingSummaries operation

Interface IIoTPaginatorFactory

Paginators for the IoT service

Interface IListActiveViolationsPaginator

Paginator for the ListActiveViolations operation

Interface IListAttachedPoliciesPaginator

Paginator for the ListAttachedPolicies operation

Interface IListAuditFindingsPaginator

Paginator for the ListAuditFindings operation

Interface IListAuditMitigationActionsExecutionsPaginator

Paginator for the ListAuditMitigationActionsExecutions operation

Interface IListAuditMitigationActionsTasksPaginator

Paginator for the ListAuditMitigationActionsTasks operation

Interface IListAuditSuppressionsPaginator

Paginator for the ListAuditSuppressions operation

Interface IListAuditTasksPaginator

Paginator for the ListAuditTasks operation

Interface IListAuthorizersPaginator

Paginator for the ListAuthorizers operation

Interface IListBillingGroupsPaginator

Paginator for the ListBillingGroups operation

Interface IListCACertificatesPaginator

Paginator for the ListCACertificates operation

Interface IListCertificatesByCAPaginator

Paginator for the ListCertificatesByCA operation

Interface IListCertificatesPaginator

Paginator for the ListCertificates operation

Interface IListCustomMetricsPaginator

Paginator for the ListCustomMetrics operation

Interface IListDetectMitigationActionsExecutionsPaginator

Paginator for the ListDetectMitigationActionsExecutions operation

Interface IListDetectMitigationActionsTasksPaginator

Paginator for the ListDetectMitigationActionsTasks operation

Interface IListDimensionsPaginator

Paginator for the ListDimensions operation

Interface IListDomainConfigurationsPaginator

Paginator for the ListDomainConfigurations operation

Interface IListFleetMetricsPaginator

Paginator for the ListFleetMetrics operation

Interface IListIndicesPaginator

Paginator for the ListIndices operation

Interface IListJobExecutionsForJobPaginator

Paginator for the ListJobExecutionsForJob operation

Interface IListJobExecutionsForThingPaginator

Paginator for the ListJobExecutionsForThing operation

Interface IListJobsPaginator

Paginator for the ListJobs operation

Interface IListJobTemplatesPaginator

Paginator for the ListJobTemplates operation

Interface IListMitigationActionsPaginator

Paginator for the ListMitigationActions operation

Interface IListOTAUpdatesPaginator

Paginator for the ListOTAUpdates operation

Interface IListOutgoingCertificatesPaginator

Paginator for the ListOutgoingCertificates operation

Interface IListPoliciesPaginator

Paginator for the ListPolicies operation

Interface IListPolicyPrincipalsPaginator

Paginator for the ListPolicyPrincipals operation

Interface IListPrincipalPoliciesPaginator

Paginator for the ListPrincipalPolicies operation

Interface IListProvisioningTemplatesPaginator

Paginator for the ListProvisioningTemplates operation

Interface IListProvisioningTemplateVersionsPaginator

Paginator for the ListProvisioningTemplateVersions operation

Interface IListRoleAliasesPaginator

Paginator for the ListRoleAliases operation

Interface IListScheduledAuditsPaginator

Paginator for the ListScheduledAudits operation

Interface IListSecurityProfilesForTargetPaginator

Paginator for the ListSecurityProfilesForTarget operation

Interface IListSecurityProfilesPaginator

Paginator for the ListSecurityProfiles operation

Interface IListStreamsPaginator

Paginator for the ListStreams operation

Interface IListTagsForResourcePaginator

Paginator for the ListTagsForResource operation

Interface IListTargetsForPolicyPaginator

Paginator for the ListTargetsForPolicy operation

Interface IListTargetsForSecurityProfilePaginator

Paginator for the ListTargetsForSecurityProfile operation

Interface IListThingGroupsForThingPaginator

Paginator for the ListThingGroupsForThing operation

Interface IListThingGroupsPaginator

Paginator for the ListThingGroups operation

Interface IListThingPrincipalsPaginator

Paginator for the ListThingPrincipals operation

Interface IListThingRegistrationTaskReportsPaginator

Paginator for the ListThingRegistrationTaskReports operation

Interface IListThingRegistrationTasksPaginator

Paginator for the ListThingRegistrationTasks operation

Interface IListThingsInBillingGroupPaginator

Paginator for the ListThingsInBillingGroup operation

Interface IListThingsInThingGroupPaginator

Paginator for the ListThingsInThingGroup operation

Interface IListThingTypesPaginator

Paginator for the ListThingTypes operation

Interface IListTopicRuleDestinationsPaginator

Paginator for the ListTopicRuleDestinations operation

Interface IListV2LoggingLevelsPaginator

Paginator for the ListV2LoggingLevels operation

Interface IListViolationEventsPaginator

Paginator for the ListViolationEvents operation