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.

Implementation for accessing IoT AWS IoT

AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

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

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.IoT.AmazonIoTClient

Namespace: Amazon.IoT
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonIoTClient : AmazonServiceClient
         IAmazonIoT, IAmazonService, IDisposable

The AmazonIoTClient type exposes the following members

Constructors

NameDescription
Public Method AmazonIoTClient()

Constructs AmazonIoTClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonIoTClient(RegionEndpoint)

Constructs AmazonIoTClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonIoTClient(AmazonIoTConfig)

Constructs AmazonIoTClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonIoTClient(AWSCredentials)

Constructs AmazonIoTClient with AWS Credentials

Public Method AmazonIoTClient(AWSCredentials, RegionEndpoint)

Constructs AmazonIoTClient with AWS Credentials

Public Method AmazonIoTClient(AWSCredentials, AmazonIoTConfig)

Constructs AmazonIoTClient with AWS Credentials and an AmazonIoTClient Configuration object.

Public Method AmazonIoTClient(string, string)

Constructs AmazonIoTClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIoTClient(string, string, RegionEndpoint)

Constructs AmazonIoTClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIoTClient(string, string, AmazonIoTConfig)

Constructs AmazonIoTClient with AWS Access Key ID, AWS Secret Key and an AmazonIoTClient Configuration object.

Public Method AmazonIoTClient(string, string, string)

Constructs AmazonIoTClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIoTClient(string, string, string, RegionEndpoint)

Constructs AmazonIoTClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIoTClient(string, string, string, AmazonIoTConfig)

Constructs AmazonIoTClient with AWS Access Key ID, AWS Secret Key and an AmazonIoTClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AcceptCertificateTransfer(AcceptCertificateTransferRequest)

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.

Public Method AcceptCertificateTransferAsync(AcceptCertificateTransferRequest, CancellationToken)

Initiates the asynchronous execution of the AcceptCertificateTransfer operation.

Public Method AddThingToThingGroup(AddThingToThingGroupRequest)

Adds a thing to a thing group.

Public Method AddThingToThingGroupAsync(AddThingToThingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the AddThingToThingGroup operation.

Public Method AssociateTargetsWithJob(AssociateTargetsWithJobRequest)

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.

Public Method AssociateTargetsWithJobAsync(AssociateTargetsWithJobRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateTargetsWithJob operation.

Public Method AttachPolicy(AttachPolicyRequest)

Attaches a policy to the specified target.

Public Method AttachPolicyAsync(AttachPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the AttachPolicy operation.

Public Method AttachPrincipalPolicy(string, string)

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

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

Public Method AttachPrincipalPolicy(AttachPrincipalPolicyRequest)

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

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

Public Method AttachPrincipalPolicyAsync(string, string, CancellationToken)

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

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

Public Method AttachPrincipalPolicyAsync(AttachPrincipalPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the AttachPrincipalPolicy operation.

Public Method AttachSecurityProfile(AttachSecurityProfileRequest)

Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.

Public Method AttachSecurityProfileAsync(AttachSecurityProfileRequest, CancellationToken)

Initiates the asynchronous execution of the AttachSecurityProfile operation.

Public Method AttachThingPrincipal(string, string)

Attaches the specified principal to the specified thing.

Public Method AttachThingPrincipal(AttachThingPrincipalRequest)

Attaches the specified principal to the specified thing.

Public Method AttachThingPrincipalAsync(string, string, CancellationToken)

Attaches the specified principal to the specified thing.

Public Method AttachThingPrincipalAsync(AttachThingPrincipalRequest, CancellationToken)

Initiates the asynchronous execution of the AttachThingPrincipal operation.

Public Method CancelAuditTask(CancelAuditTaskRequest)

Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.

Public Method CancelAuditTaskAsync(CancelAuditTaskRequest, CancellationToken)

Initiates the asynchronous execution of the CancelAuditTask operation.

Public Method CancelCertificateTransfer(string)

Cancels a pending transfer for the specified certificate.

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

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

Public Method CancelCertificateTransfer(CancelCertificateTransferRequest)

Cancels a pending transfer for the specified certificate.

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

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

Public Method CancelCertificateTransferAsync(string, CancellationToken)

Cancels a pending transfer for the specified certificate.

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

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

Public Method CancelCertificateTransferAsync(CancelCertificateTransferRequest, CancellationToken)

Initiates the asynchronous execution of the CancelCertificateTransfer operation.

Public Method CancelJob(CancelJobRequest)

Cancels a job.

Public Method CancelJobAsync(CancelJobRequest, CancellationToken)

Initiates the asynchronous execution of the CancelJob operation.

Public Method CancelJobExecution(CancelJobExecutionRequest)

Cancels the execution of a job for a given thing.

Public Method CancelJobExecutionAsync(CancelJobExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the CancelJobExecution operation.

Public Method ClearDefaultAuthorizer(ClearDefaultAuthorizerRequest)

Clears the default authorizer.

Public Method ClearDefaultAuthorizerAsync(ClearDefaultAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the ClearDefaultAuthorizer operation.

Public Method CreateAuthorizer(CreateAuthorizerRequest)

Creates an authorizer.

Public Method CreateAuthorizerAsync(CreateAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAuthorizer operation.

Public Method CreateCertificateFromCsr(string)

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.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

Public Method CreateCertificateFromCsr(string, bool)

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.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

Public Method CreateCertificateFromCsr(CreateCertificateFromCsrRequest)

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.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

Public Method CreateCertificateFromCsrAsync(string, CancellationToken)

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.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

Public Method CreateCertificateFromCsrAsync(string, bool, CancellationToken)

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.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

Public Method CreateCertificateFromCsrAsync(CreateCertificateFromCsrRequest, CancellationToken)

Initiates the asynchronous execution of the CreateCertificateFromCsr operation.

Public Method CreateJob(CreateJobRequest)

Creates a job.

Public Method CreateJobAsync(CreateJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateJob operation.

Public Method CreateKeysAndCertificate()

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

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

Public Method CreateKeysAndCertificate(bool)

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

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

Public Method CreateKeysAndCertificate(CreateKeysAndCertificateRequest)

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

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

Public Method CreateKeysAndCertificateAsync(CancellationToken)

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

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

Public Method CreateKeysAndCertificateAsync(bool, CancellationToken)

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

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

Public Method CreateKeysAndCertificateAsync(CreateKeysAndCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the CreateKeysAndCertificate operation.

Public Method CreateOTAUpdate(CreateOTAUpdateRequest)

Creates an AWS IoT OTAUpdate on a target group of things or groups.

Public Method CreateOTAUpdateAsync(CreateOTAUpdateRequest, CancellationToken)

Initiates the asynchronous execution of the CreateOTAUpdate operation.

Public Method CreatePolicy(string, string)

Creates an AWS IoT policy.

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

Public Method CreatePolicy(CreatePolicyRequest)

Creates an AWS IoT policy.

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

Public Method CreatePolicyAsync(string, string, CancellationToken)

Creates an AWS IoT policy.

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

Public Method CreatePolicyAsync(CreatePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePolicy operation.

Public Method CreatePolicyVersion(string, string)

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

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

Public Method CreatePolicyVersion(string, string, bool)

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

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

Public Method CreatePolicyVersion(CreatePolicyVersionRequest)

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

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

Public Method CreatePolicyVersionAsync(string, string, CancellationToken)

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

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

Public Method CreatePolicyVersionAsync(string, string, bool, CancellationToken)

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

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

Public Method CreatePolicyVersionAsync(CreatePolicyVersionRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePolicyVersion operation.

Public Method CreateRoleAlias(CreateRoleAliasRequest)

Creates a role alias.

Public Method CreateRoleAliasAsync(CreateRoleAliasRequest, CancellationToken)

Initiates the asynchronous execution of the CreateRoleAlias operation.

Public Method CreateScheduledAudit(CreateScheduledAuditRequest)

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

Public Method CreateScheduledAuditAsync(CreateScheduledAuditRequest, CancellationToken)

Initiates the asynchronous execution of the CreateScheduledAudit operation.

Public Method CreateSecurityProfile(CreateSecurityProfileRequest)

Creates a Device Defender security profile.

Public Method CreateSecurityProfileAsync(CreateSecurityProfileRequest, CancellationToken)

Initiates the asynchronous execution of the CreateSecurityProfile operation.

Public Method CreateStream(CreateStreamRequest)

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. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.

Public Method CreateStreamAsync(CreateStreamRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStream operation.

Public Method CreateThing(CreateThingRequest)

Creates a thing record in the registry.

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

Public Method CreateThingAsync(CreateThingRequest, CancellationToken)

Initiates the asynchronous execution of the CreateThing operation.

Public Method CreateThingGroup(CreateThingGroupRequest)

Create a thing group.

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

Public Method CreateThingGroupAsync(CreateThingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateThingGroup operation.

Public Method CreateThingType(CreateThingTypeRequest)

Creates a new thing type.

Public Method CreateThingTypeAsync(CreateThingTypeRequest, CancellationToken)

Initiates the asynchronous execution of the CreateThingType operation.

Public Method CreateTopicRule(CreateTopicRuleRequest)

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.

Public Method CreateTopicRuleAsync(CreateTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTopicRule operation.

Public Method DeleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest)

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.

Public Method DeleteAccountAuditConfigurationAsync(DeleteAccountAuditConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAccountAuditConfiguration operation.

Public Method DeleteAuthorizer(DeleteAuthorizerRequest)

Deletes an authorizer.

Public Method DeleteAuthorizerAsync(DeleteAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAuthorizer operation.

Public Method DeleteCACertificate(DeleteCACertificateRequest)

Deletes a registered CA certificate.

Public Method DeleteCACertificateAsync(DeleteCACertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCACertificate operation.

Public Method DeleteCertificate(string)

Deletes the specified certificate.

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

Public Method DeleteCertificate(DeleteCertificateRequest)

Deletes the specified certificate.

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

Public Method DeleteCertificateAsync(string, CancellationToken)

Deletes the specified certificate.

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

Public Method DeleteCertificateAsync(DeleteCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCertificate operation.

Public Method DeleteJob(DeleteJobRequest)

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.

Public Method DeleteJobAsync(DeleteJobRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteJob operation.

Public Method DeleteJobExecution(DeleteJobExecutionRequest)

Deletes a job execution.

Public Method DeleteJobExecutionAsync(DeleteJobExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteJobExecution operation.

Public Method DeleteOTAUpdate(DeleteOTAUpdateRequest)

Delete an OTA update.

Public Method DeleteOTAUpdateAsync(DeleteOTAUpdateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteOTAUpdate operation.

Public Method DeletePolicy(string)

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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

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

Public Method DeletePolicy(DeletePolicyRequest)

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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

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

Public Method DeletePolicyAsync(string, CancellationToken)

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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

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

Public Method DeletePolicyAsync(DeletePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePolicy operation.

Public Method DeletePolicyVersion(string, string)

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

Public Method DeletePolicyVersion(DeletePolicyVersionRequest)

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

Public Method DeletePolicyVersionAsync(string, string, CancellationToken)

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

Public Method DeletePolicyVersionAsync(DeletePolicyVersionRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePolicyVersion operation.

Public Method DeleteRegistrationCode(DeleteRegistrationCodeRequest)

Deletes a CA certificate registration code.

Public Method DeleteRegistrationCodeAsync(DeleteRegistrationCodeRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRegistrationCode operation.

Public Method DeleteRoleAlias(DeleteRoleAliasRequest)

Deletes a role alias

Public Method DeleteRoleAliasAsync(DeleteRoleAliasRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRoleAlias operation.

Public Method DeleteScheduledAudit(DeleteScheduledAuditRequest)

Deletes a scheduled audit.

Public Method DeleteScheduledAuditAsync(DeleteScheduledAuditRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteScheduledAudit operation.

Public Method DeleteSecurityProfile(DeleteSecurityProfileRequest)

Deletes a Device Defender security profile.

Public Method DeleteSecurityProfileAsync(DeleteSecurityProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSecurityProfile operation.

Public Method DeleteStream(DeleteStreamRequest)

Deletes a stream.

Public Method DeleteStreamAsync(DeleteStreamRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteStream operation.

Public Method DeleteThing(string)

Deletes the specified thing.

Public Method DeleteThing(DeleteThingRequest)

Deletes the specified thing.

Public Method DeleteThingAsync(string, CancellationToken)

Deletes the specified thing.

Public Method DeleteThingAsync(DeleteThingRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteThing operation.

Public Method DeleteThingGroup(DeleteThingGroupRequest)

Deletes a thing group.

Public Method DeleteThingGroupAsync(DeleteThingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteThingGroup operation.

Public Method DeleteThingType(DeleteThingTypeRequest)

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.

Public Method DeleteThingTypeAsync(DeleteThingTypeRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteThingType operation.

Public Method DeleteTopicRule(string)

Deletes the rule.

Public Method DeleteTopicRule(DeleteTopicRuleRequest)

Deletes the rule.

Public Method DeleteTopicRuleAsync(string, CancellationToken)

Deletes the rule.

Public Method DeleteTopicRuleAsync(DeleteTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTopicRule operation.

Public Method DeleteV2LoggingLevel(DeleteV2LoggingLevelRequest)

Deletes a logging level.

Public Method DeleteV2LoggingLevelAsync(DeleteV2LoggingLevelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteV2LoggingLevel operation.

Public Method DeprecateThingType(DeprecateThingTypeRequest)

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

Public Method DeprecateThingTypeAsync(DeprecateThingTypeRequest, CancellationToken)

Initiates the asynchronous execution of the DeprecateThingType operation.

Public Method DescribeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest)

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.

Public Method DescribeAccountAuditConfigurationAsync(DescribeAccountAuditConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAccountAuditConfiguration operation.

Public Method DescribeAuditTask(DescribeAuditTaskRequest)

Gets information about a Device Defender audit.

Public Method DescribeAuditTaskAsync(DescribeAuditTaskRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAuditTask operation.

Public Method DescribeAuthorizer(DescribeAuthorizerRequest)

Describes an authorizer.

Public Method DescribeAuthorizerAsync(DescribeAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAuthorizer operation.

Public Method DescribeCACertificate(DescribeCACertificateRequest)

Describes a registered CA certificate.

Public Method DescribeCACertificateAsync(DescribeCACertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCACertificate operation.

Public Method DescribeCertificate(string)

Gets information about the specified certificate.

Public Method DescribeCertificate(DescribeCertificateRequest)

Gets information about the specified certificate.

Public Method DescribeCertificateAsync(string, CancellationToken)

Gets information about the specified certificate.

Public Method DescribeCertificateAsync(DescribeCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCertificate operation.

Public Method DescribeDefaultAuthorizer(DescribeDefaultAuthorizerRequest)

Describes the default authorizer.

Public Method DescribeDefaultAuthorizerAsync(DescribeDefaultAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDefaultAuthorizer operation.

Public Method DescribeEndpoint()

Returns a unique endpoint specific to the AWS account making the call.

Public Method DescribeEndpoint(DescribeEndpointRequest)

Returns a unique endpoint specific to the AWS account making the call.

Public Method DescribeEndpointAsync(CancellationToken)

Returns a unique endpoint specific to the AWS account making the call.

Public Method DescribeEndpointAsync(DescribeEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEndpoint operation.

Public Method DescribeEventConfigurations(DescribeEventConfigurationsRequest)

Describes event configurations.

Public Method DescribeEventConfigurationsAsync(DescribeEventConfigurationsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEventConfigurations operation.

Public Method DescribeIndex(DescribeIndexRequest)

Describes a search index.

Public Method DescribeIndexAsync(DescribeIndexRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeIndex operation.

Public Method DescribeJob(DescribeJobRequest)

Describes a job.

Public Method DescribeJobAsync(DescribeJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeJob operation.

Public Method DescribeJobExecution(DescribeJobExecutionRequest)

Describes a job execution.

Public Method DescribeJobExecutionAsync(DescribeJobExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeJobExecution operation.

Public Method DescribeRoleAlias(DescribeRoleAliasRequest)

Describes a role alias.

Public Method DescribeRoleAliasAsync(DescribeRoleAliasRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeRoleAlias operation.

Public Method DescribeScheduledAudit(DescribeScheduledAuditRequest)

Gets information about a scheduled audit.

Public Method DescribeScheduledAuditAsync(DescribeScheduledAuditRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeScheduledAudit operation.

Public Method DescribeSecurityProfile(DescribeSecurityProfileRequest)

Gets information about a Device Defender security profile.

Public Method DescribeSecurityProfileAsync(DescribeSecurityProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeSecurityProfile operation.

Public Method DescribeStream(DescribeStreamRequest)

Gets information about a stream.

Public Method DescribeStreamAsync(DescribeStreamRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeStream operation.

Public Method DescribeThing(string)

Gets information about the specified thing.

Public Method DescribeThing(DescribeThingRequest)

Gets information about the specified thing.

Public Method DescribeThingAsync(string, CancellationToken)

Gets information about the specified thing.

Public Method DescribeThingAsync(DescribeThingRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeThing operation.

Public Method DescribeThingGroup(DescribeThingGroupRequest)

Describe a thing group.

Public Method DescribeThingGroupAsync(DescribeThingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeThingGroup operation.

Public Method DescribeThingRegistrationTask(DescribeThingRegistrationTaskRequest)

Describes a bulk thing provisioning task.

Public Method DescribeThingRegistrationTaskAsync(DescribeThingRegistrationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeThingRegistrationTask operation.

Public Method DescribeThingType(DescribeThingTypeRequest)

Gets information about the specified thing type.

Public Method DescribeThingTypeAsync(DescribeThingTypeRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeThingType operation.

Public Method DetachPolicy(DetachPolicyRequest)

Detaches a policy from the specified target.

Public Method DetachPolicyAsync(DetachPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DetachPolicy operation.

Public Method DetachPrincipalPolicy(string, string)

Removes the specified policy from the specified certificate.

Note: This API is deprecated. Please use DetachPolicy instead.

Public Method DetachPrincipalPolicy(DetachPrincipalPolicyRequest)

Removes the specified policy from the specified certificate.

Note: This API is deprecated. Please use DetachPolicy instead.

Public Method DetachPrincipalPolicyAsync(string, string, CancellationToken)

Removes the specified policy from the specified certificate.

Note: This API is deprecated. Please use DetachPolicy instead.

Public Method DetachPrincipalPolicyAsync(DetachPrincipalPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DetachPrincipalPolicy operation.

Public Method DetachSecurityProfile(DetachSecurityProfileRequest)

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

Public Method DetachSecurityProfileAsync(DetachSecurityProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DetachSecurityProfile operation.

Public Method DetachThingPrincipal(string, string)

Detaches the specified principal from the specified thing.

Public Method DetachThingPrincipal(DetachThingPrincipalRequest)

Detaches the specified principal from the specified thing.

Public Method DetachThingPrincipalAsync(string, string, CancellationToken)

Detaches the specified principal from the specified thing.

Public Method DetachThingPrincipalAsync(DetachThingPrincipalRequest, CancellationToken)

Initiates the asynchronous execution of the DetachThingPrincipal operation.

Public Method DisableTopicRule(DisableTopicRuleRequest)

Disables the rule.

Public Method DisableTopicRuleAsync(DisableTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the DisableTopicRule operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EnableTopicRule(EnableTopicRuleRequest)

Enables the rule.

Public Method EnableTopicRuleAsync(EnableTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the EnableTopicRule operation.

Public Method GetEffectivePolicies(GetEffectivePoliciesRequest)

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.

Public Method GetEffectivePoliciesAsync(GetEffectivePoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the GetEffectivePolicies operation.

Public Method GetIndexingConfiguration(GetIndexingConfigurationRequest)

Gets the search configuration.

Public Method GetIndexingConfigurationAsync(GetIndexingConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the GetIndexingConfiguration operation.

Public Method GetJobDocument(GetJobDocumentRequest)

Gets a job document.

Public Method GetJobDocumentAsync(GetJobDocumentRequest, CancellationToken)

Initiates the asynchronous execution of the GetJobDocument operation.

Public Method GetLoggingOptions(GetLoggingOptionsRequest)

Gets the logging options.

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

Public Method GetLoggingOptionsAsync(GetLoggingOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the GetLoggingOptions operation.

Public Method GetOTAUpdate(GetOTAUpdateRequest)

Gets an OTA update.

Public Method GetOTAUpdateAsync(GetOTAUpdateRequest, CancellationToken)

Initiates the asynchronous execution of the GetOTAUpdate operation.

Public Method GetPolicy(string)

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

Public Method GetPolicy(GetPolicyRequest)

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

Public Method GetPolicyAsync(string, CancellationToken)

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

Public Method GetPolicyAsync(GetPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetPolicy operation.

Public Method GetPolicyVersion(string, string)

Gets information about the specified policy version.

Public Method GetPolicyVersion(GetPolicyVersionRequest)

Gets information about the specified policy version.

Public Method GetPolicyVersionAsync(string, string, CancellationToken)

Gets information about the specified policy version.

Public Method GetPolicyVersionAsync(GetPolicyVersionRequest, CancellationToken)

Initiates the asynchronous execution of the GetPolicyVersion operation.

Public Method GetRegistrationCode(GetRegistrationCodeRequest)

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

Public Method GetRegistrationCodeAsync(GetRegistrationCodeRequest, CancellationToken)

Initiates the asynchronous execution of the GetRegistrationCode operation.

Public Method GetTopicRule(string)

Gets information about the rule.

Public Method GetTopicRule(GetTopicRuleRequest)

Gets information about the rule.

Public Method GetTopicRuleAsync(string, CancellationToken)

Gets information about the rule.

Public Method GetTopicRuleAsync(GetTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the GetTopicRule operation.

Public Method GetV2LoggingOptions(GetV2LoggingOptionsRequest)

Gets the fine grained logging options.

Public Method GetV2LoggingOptionsAsync(GetV2LoggingOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the GetV2LoggingOptions operation.

Public Method ListActiveViolations(ListActiveViolationsRequest)

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

Public Method ListActiveViolationsAsync(ListActiveViolationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListActiveViolations operation.

Public Method ListAttachedPolicies(ListAttachedPoliciesRequest)

Lists the policies attached to the specified thing group.

Public Method ListAttachedPoliciesAsync(ListAttachedPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListAttachedPolicies operation.

Public Method ListAuditFindings(ListAuditFindingsRequest)

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)

Public Method ListAuditFindingsAsync(ListAuditFindingsRequest, CancellationToken)

Initiates the asynchronous execution of the ListAuditFindings operation.

Public Method ListAuditTasks(ListAuditTasksRequest)

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

Public Method ListAuditTasksAsync(ListAuditTasksRequest, CancellationToken)

Initiates the asynchronous execution of the ListAuditTasks operation.

Public Method ListAuthorizers(ListAuthorizersRequest)

Lists the authorizers registered in your account.

Public Method ListAuthorizersAsync(ListAuthorizersRequest, CancellationToken)

Initiates the asynchronous execution of the ListAuthorizers operation.

Public Method ListCACertificates(ListCACertificatesRequest)

Lists the CA certificates registered for your AWS account.

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

Public Method ListCACertificatesAsync(ListCACertificatesRequest, CancellationToken)

Initiates the asynchronous execution of the ListCACertificates operation.

Public Method ListCertificates()

Lists the certificates registered in your AWS account.

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

Public Method ListCertificates(ListCertificatesRequest)

Lists the certificates registered in your AWS account.

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

Public Method ListCertificatesAsync(CancellationToken)

Lists the certificates registered in your AWS account.

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

Public Method ListCertificatesAsync(ListCertificatesRequest, CancellationToken)

Initiates the asynchronous execution of the ListCertificates operation.

Public Method ListCertificatesByCA(ListCertificatesByCARequest)

List the device certificates signed by the specified CA certificate.

Public Method ListCertificatesByCAAsync(ListCertificatesByCARequest, CancellationToken)

Initiates the asynchronous execution of the ListCertificatesByCA operation.

Public Method ListIndices(ListIndicesRequest)

Lists the search indices.

Public Method ListIndicesAsync(ListIndicesRequest, CancellationToken)

Initiates the asynchronous execution of the ListIndices operation.

Public Method ListJobExecutionsForJob(ListJobExecutionsForJobRequest)

Lists the job executions for a job.

Public Method ListJobExecutionsForJobAsync(ListJobExecutionsForJobRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobExecutionsForJob operation.

Public Method ListJobExecutionsForThing(ListJobExecutionsForThingRequest)

Lists the job executions for the specified thing.

Public Method ListJobExecutionsForThingAsync(ListJobExecutionsForThingRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobExecutionsForThing operation.

Public Method ListJobs(ListJobsRequest)

Lists jobs.

Public Method ListJobsAsync(ListJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobs operation.

Public Method ListOTAUpdates(ListOTAUpdatesRequest)

Lists OTA updates.

Public Method ListOTAUpdatesAsync(ListOTAUpdatesRequest, CancellationToken)

Initiates the asynchronous execution of the ListOTAUpdates operation.

Public Method ListOutgoingCertificates(ListOutgoingCertificatesRequest)

Lists certificates that are being transferred but not yet accepted.

Public Method ListOutgoingCertificatesAsync(ListOutgoingCertificatesRequest, CancellationToken)

Initiates the asynchronous execution of the ListOutgoingCertificates operation.

Public Method ListPolicies()

Lists your policies.

Public Method ListPolicies(ListPoliciesRequest)

Lists your policies.

Public Method ListPoliciesAsync(CancellationToken)

Lists your policies.

Public Method ListPoliciesAsync(ListPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListPolicies operation.

Public Method ListPolicyPrincipals(ListPolicyPrincipalsRequest)

Lists the principals associated with the specified policy.

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

Public Method ListPolicyPrincipalsAsync(ListPolicyPrincipalsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPolicyPrincipals operation.

Public Method ListPolicyVersions(string)

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

Public Method ListPolicyVersions(ListPolicyVersionsRequest)

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

Public Method ListPolicyVersionsAsync(string, CancellationToken)

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

Public Method ListPolicyVersionsAsync(ListPolicyVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPolicyVersions operation.

Public Method ListPrincipalPolicies(string)

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

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

Public Method ListPrincipalPolicies(ListPrincipalPoliciesRequest)

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

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

Public Method ListPrincipalPoliciesAsync(string, CancellationToken)

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

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

Public Method ListPrincipalPoliciesAsync(ListPrincipalPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListPrincipalPolicies operation.

Public Method ListPrincipalThings(string)

Lists the things associated with the specified principal.

Public Method ListPrincipalThings(ListPrincipalThingsRequest)

Lists the things associated with the specified principal.

Public Method ListPrincipalThingsAsync(string, CancellationToken)

Lists the things associated with the specified principal.

Public Method ListPrincipalThingsAsync(ListPrincipalThingsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPrincipalThings operation.

Public Method ListRoleAliases(ListRoleAliasesRequest)

Lists the role aliases registered in your account.

Public Method ListRoleAliasesAsync(ListRoleAliasesRequest, CancellationToken)

Initiates the asynchronous execution of the ListRoleAliases operation.

Public Method ListScheduledAudits(ListScheduledAuditsRequest)

Lists all of your scheduled audits.

Public Method ListScheduledAuditsAsync(ListScheduledAuditsRequest, CancellationToken)

Initiates the asynchronous execution of the ListScheduledAudits operation.

Public Method ListSecurityProfiles(ListSecurityProfilesRequest)

Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.

Public Method ListSecurityProfilesAsync(ListSecurityProfilesRequest, CancellationToken)

Initiates the asynchronous execution of the ListSecurityProfiles operation.

Public Method ListSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest)

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

Public Method ListSecurityProfilesForTargetAsync(ListSecurityProfilesForTargetRequest, CancellationToken)

Initiates the asynchronous execution of the ListSecurityProfilesForTarget operation.

Public Method ListStreams(ListStreamsRequest)

Lists all of the streams in your AWS account.

Public Method ListStreamsAsync(ListStreamsRequest, CancellationToken)

Initiates the asynchronous execution of the ListStreams operation.

Public Method ListTargetsForPolicy(ListTargetsForPolicyRequest)

List targets for the specified policy.

Public Method ListTargetsForPolicyAsync(ListTargetsForPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the ListTargetsForPolicy operation.

Public Method ListTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest)

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

Public Method ListTargetsForSecurityProfileAsync(ListTargetsForSecurityProfileRequest, CancellationToken)

Initiates the asynchronous execution of the ListTargetsForSecurityProfile operation.

Public Method ListThingGroups(ListThingGroupsRequest)

List the thing groups in your account.

Public Method ListThingGroupsAsync(ListThingGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the ListThingGroups operation.

Public Method ListThingGroupsForThing(ListThingGroupsForThingRequest)

List the thing groups to which the specified thing belongs.

Public Method ListThingGroupsForThingAsync(ListThingGroupsForThingRequest, CancellationToken)

Initiates the asynchronous execution of the ListThingGroupsForThing operation.

Public Method ListThingPrincipals(string)

Lists the principals associated with the specified thing.

Public Method ListThingPrincipals(ListThingPrincipalsRequest)

Lists the principals associated with the specified thing.

Public Method ListThingPrincipalsAsync(string, CancellationToken)

Lists the principals associated with the specified thing.

Public Method ListThingPrincipalsAsync(ListThingPrincipalsRequest, CancellationToken)

Initiates the asynchronous execution of the ListThingPrincipals operation.

Public Method ListThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest)

Information about the thing registration tasks.

Public Method ListThingRegistrationTaskReportsAsync(ListThingRegistrationTaskReportsRequest, CancellationToken)

Initiates the asynchronous execution of the ListThingRegistrationTaskReports operation.

Public Method ListThingRegistrationTasks(ListThingRegistrationTasksRequest)

List bulk thing provisioning tasks.

Public Method ListThingRegistrationTasksAsync(ListThingRegistrationTasksRequest, CancellationToken)

Initiates the asynchronous execution of the ListThingRegistrationTasks operation.

Public Method ListThings()

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.

Public Method ListThings(ListThingsRequest)

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.

Public Method ListThingsAsync(CancellationToken)

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.

Public Method ListThingsAsync(ListThingsRequest, CancellationToken)

Initiates the asynchronous execution of the ListThings operation.

Public Method ListThingsInThingGroup(ListThingsInThingGroupRequest)

Lists the things in the specified group.

Public Method ListThingsInThingGroupAsync(ListThingsInThingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ListThingsInThingGroup operation.

Public Method ListThingTypes(ListThingTypesRequest)

Lists the existing thing types.

Public Method ListThingTypesAsync(ListThingTypesRequest, CancellationToken)

Initiates the asynchronous execution of the ListThingTypes operation.

Public Method ListTopicRules(string)

Lists the rules for the specific topic.

Public Method ListTopicRules(ListTopicRulesRequest)

Lists the rules for the specific topic.

Public Method ListTopicRulesAsync(string, CancellationToken)

Lists the rules for the specific topic.

Public Method ListTopicRulesAsync(ListTopicRulesRequest, CancellationToken)

Initiates the asynchronous execution of the ListTopicRules operation.

Public Method ListV2LoggingLevels(ListV2LoggingLevelsRequest)

Lists logging levels.

Public Method ListV2LoggingLevelsAsync(ListV2LoggingLevelsRequest, CancellationToken)

Initiates the asynchronous execution of the ListV2LoggingLevels operation.

Public Method ListViolationEvents(ListViolationEventsRequest)

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

Public Method ListViolationEventsAsync(ListViolationEventsRequest, CancellationToken)

Initiates the asynchronous execution of the ListViolationEvents operation.

Public Method RegisterCACertificate(RegisterCACertificateRequest)

Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.

Public Method RegisterCACertificateAsync(RegisterCACertificateRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterCACertificate operation.

Public Method RegisterCertificate(RegisterCertificateRequest)

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

Public Method RegisterCertificateAsync(RegisterCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterCertificate operation.

Public Method RegisterThing(RegisterThingRequest)

Provisions a thing.

Public Method RegisterThingAsync(RegisterThingRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterThing operation.

Public Method RejectCertificateTransfer(string)

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

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

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.

Public Method RejectCertificateTransfer(RejectCertificateTransferRequest)

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

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

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.

Public Method RejectCertificateTransferAsync(string, CancellationToken)

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

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

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.

Public Method RejectCertificateTransferAsync(RejectCertificateTransferRequest, CancellationToken)

Initiates the asynchronous execution of the RejectCertificateTransfer operation.

Public Method RemoveThingFromThingGroup(RemoveThingFromThingGroupRequest)

Remove the specified thing from the specified group.

Public Method RemoveThingFromThingGroupAsync(RemoveThingFromThingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveThingFromThingGroup operation.

Public Method ReplaceTopicRule(ReplaceTopicRuleRequest)

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.

Public Method ReplaceTopicRuleAsync(ReplaceTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the ReplaceTopicRule operation.

Public Method SearchIndex(SearchIndexRequest)

The query search index.

Public Method SearchIndexAsync(SearchIndexRequest, CancellationToken)

Initiates the asynchronous execution of the SearchIndex operation.

Public Method SetDefaultAuthorizer(SetDefaultAuthorizerRequest)

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

Public Method SetDefaultAuthorizerAsync(SetDefaultAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the SetDefaultAuthorizer operation.

Public Method SetDefaultPolicyVersion(string, string)

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 ListPrincipalPolicy API.

Public Method SetDefaultPolicyVersion(SetDefaultPolicyVersionRequest)

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 ListPrincipalPolicy API.

Public Method SetDefaultPolicyVersionAsync(string, string, CancellationToken)

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 ListPrincipalPolicy API.

Public Method SetDefaultPolicyVersionAsync(SetDefaultPolicyVersionRequest, CancellationToken)

Initiates the asynchronous execution of the SetDefaultPolicyVersion operation.

Public Method SetLoggingOptions(SetLoggingOptionsRequest)

Sets the logging options.

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

Public Method SetLoggingOptionsAsync(SetLoggingOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the SetLoggingOptions operation.

Public Method SetV2LoggingLevel(SetV2LoggingLevelRequest)

Sets the logging level.

Public Method SetV2LoggingLevelAsync(SetV2LoggingLevelRequest, CancellationToken)

Initiates the asynchronous execution of the SetV2LoggingLevel operation.

Public Method SetV2LoggingOptions(SetV2LoggingOptionsRequest)

Sets the logging options for the V2 logging service.

Public Method SetV2LoggingOptionsAsync(SetV2LoggingOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the SetV2LoggingOptions operation.

Public Method StartOnDemandAuditTask(StartOnDemandAuditTaskRequest)

Starts an on-demand Device Defender audit.

Public Method StartOnDemandAuditTaskAsync(StartOnDemandAuditTaskRequest, CancellationToken)

Initiates the asynchronous execution of the StartOnDemandAuditTask operation.

Public Method StartThingRegistrationTask(StartThingRegistrationTaskRequest)

Creates a bulk thing provisioning task.

Public Method StartThingRegistrationTaskAsync(StartThingRegistrationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the StartThingRegistrationTask operation.

Public Method StopThingRegistrationTask(StopThingRegistrationTaskRequest)

Cancels a bulk thing provisioning task.

Public Method StopThingRegistrationTaskAsync(StopThingRegistrationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the StopThingRegistrationTask operation.

Public Method TestAuthorization(TestAuthorizationRequest)

Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.

Public Method TestAuthorizationAsync(TestAuthorizationRequest, CancellationToken)

Initiates the asynchronous execution of the TestAuthorization operation.

Public Method TestInvokeAuthorizer(TestInvokeAuthorizerRequest)

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.

Public Method TestInvokeAuthorizerAsync(TestInvokeAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the TestInvokeAuthorizer operation.

Public Method TransferCertificate(string, string)

Transfers the specified certificate to the specified AWS account.

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

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

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

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

Public Method TransferCertificate(TransferCertificateRequest)

Transfers the specified certificate to the specified AWS account.

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

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

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

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

Public Method TransferCertificateAsync(string, string, CancellationToken)

Transfers the specified certificate to the specified AWS account.

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

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

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

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

Public Method TransferCertificateAsync(TransferCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the TransferCertificate operation.

Public Method UpdateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest)

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.

Public Method UpdateAccountAuditConfigurationAsync(UpdateAccountAuditConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAccountAuditConfiguration operation.

Public Method UpdateAuthorizer(UpdateAuthorizerRequest)

Updates an authorizer.

Public Method UpdateAuthorizerAsync(UpdateAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAuthorizer operation.

Public Method UpdateCACertificate(UpdateCACertificateRequest)

Updates a registered CA certificate.

Public Method UpdateCACertificateAsync(UpdateCACertificateRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateCACertificate operation.

Public Method UpdateCertificate(string, CertificateStatus)

Updates the status of the specified certificate. This operation is idempotent.

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

Public Method UpdateCertificate(UpdateCertificateRequest)

Updates the status of the specified certificate. This operation is idempotent.

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

Public Method UpdateCertificateAsync(string, CertificateStatus, CancellationToken)

Updates the status of the specified certificate. This operation is idempotent.

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

Public Method UpdateCertificateAsync(UpdateCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateCertificate operation.

Public Method UpdateEventConfigurations(UpdateEventConfigurationsRequest)

Updates the event configurations.

Public Method UpdateEventConfigurationsAsync(UpdateEventConfigurationsRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateEventConfigurations operation.

Public Method UpdateIndexingConfiguration(UpdateIndexingConfigurationRequest)

Updates the search configuration.

Public Method UpdateIndexingConfigurationAsync(UpdateIndexingConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateIndexingConfiguration operation.

Public Method UpdateRoleAlias(UpdateRoleAliasRequest)

Updates a role alias.

Public Method UpdateRoleAliasAsync(UpdateRoleAliasRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRoleAlias operation.

Public Method UpdateScheduledAudit(UpdateScheduledAuditRequest)

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

Public Method UpdateScheduledAuditAsync(UpdateScheduledAuditRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateScheduledAudit operation.

Public Method UpdateSecurityProfile(UpdateSecurityProfileRequest)

Updates a Device Defender security profile.

Public Method UpdateSecurityProfileAsync(UpdateSecurityProfileRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateSecurityProfile operation.

Public Method UpdateStream(UpdateStreamRequest)

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

Public Method UpdateStreamAsync(UpdateStreamRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateStream operation.

Public Method UpdateThing(UpdateThingRequest)

Updates the data for a thing.

Public Method UpdateThingAsync(UpdateThingRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateThing operation.

Public Method UpdateThingGroup(UpdateThingGroupRequest)

Update a thing group.

Public Method UpdateThingGroupAsync(UpdateThingGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateThingGroup operation.

Public Method UpdateThingGroupsForThing(UpdateThingGroupsForThingRequest)

Updates the groups to which the thing belongs.

Public Method UpdateThingGroupsForThingAsync(UpdateThingGroupsForThingRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateThingGroupsForThing operation.

Public Method ValidateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest)

Validates a Device Defender security profile behaviors specification.

Public Method ValidateSecurityProfileBehaviorsAsync(ValidateSecurityProfileBehaviorsRequest, CancellationToken)

Initiates the asynchronous execution of the ValidateSecurityProfileBehaviors operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms