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.

Interface for accessing IoT AWS IoT

AWS IoT provides secure, bi-directional communication between Internet-connected things (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 thing (Thing Registry), configure logging, and create and manage policies and credentials to authenticate things.

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

Inheritance Hierarchy

Amazon.IoT.IAmazonIoT

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

Syntax

C#
public interface IAmazonIoT
         IAmazonService, IDisposable

The IAmazonIoT type exposes the following members

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 AttachPrincipalPolicy(string, string)

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

Public Method AttachPrincipalPolicy(AttachPrincipalPolicyRequest)

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

Public Method AttachPrincipalPolicyAsync(string, string, CancellationToken)

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

Public Method AttachPrincipalPolicyAsync(AttachPrincipalPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the AttachPrincipalPolicy 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 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 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 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 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 CreateThing(CreateThingRequest)

Creates a thing record in the thing registry.

Public Method CreateThingAsync(CreateThingRequest, CancellationToken)

Initiates the asynchronous execution of the CreateThing 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 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 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 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 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 specified rule.

Public Method DeleteTopicRule(DeleteTopicRuleRequest)

Deletes the specified rule.

Public Method DeleteTopicRuleAsync(string, CancellationToken)

Deletes the specified rule.

Public Method DeleteTopicRuleAsync(DeleteTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTopicRule 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 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 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 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 DescribeThingType(DescribeThingTypeRequest)

Gets information about the specified thing type.

Public Method DescribeThingTypeAsync(DescribeThingTypeRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeThingType operation.

Public Method DetachPrincipalPolicy(string, string)

Removes the specified policy from the specified certificate.

Public Method DetachPrincipalPolicy(DetachPrincipalPolicyRequest)

Removes the specified policy from the specified certificate.

Public Method DetachPrincipalPolicyAsync(string, string, CancellationToken)

Removes the specified policy from the specified certificate.

Public Method DetachPrincipalPolicyAsync(DetachPrincipalPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DetachPrincipalPolicy 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 specified rule.

Public Method DisableTopicRuleAsync(DisableTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the DisableTopicRule operation.

Public Method EnableTopicRule(EnableTopicRuleRequest)

Enables the specified rule.

Public Method EnableTopicRuleAsync(EnableTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the EnableTopicRule operation.

Public Method GetLoggingOptions(GetLoggingOptionsRequest)

Gets the logging options.

Public Method GetLoggingOptionsAsync(GetLoggingOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the GetLoggingOptions 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 specified rule.

Public Method GetTopicRule(GetTopicRuleRequest)

Gets information about the specified rule.

Public Method GetTopicRuleAsync(string, CancellationToken)

Gets information about the specified rule.

Public Method GetTopicRuleAsync(GetTopicRuleRequest, CancellationToken)

Initiates the asynchronous execution of the GetTopicRule 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 ListOutgoingCertificates(ListOutgoingCertificatesRequest)

Lists certificates that are being transfered 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.

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.

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.

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.

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 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 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 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 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 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 ReplaceTopicRule(ReplaceTopicRuleRequest)

Replaces the specified 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 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.

Public Method SetLoggingOptionsAsync(SetLoggingOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the SetLoggingOptions 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 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 UpdateThing(UpdateThingRequest)

Updates the data for a thing.

Public Method UpdateThingAsync(UpdateThingRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateThing operation.

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