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 IoT

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

The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.

The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.

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

For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services 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.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

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.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

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.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

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.
Public Property Paginators Amazon.IoT.Model.IIoTPaginatorFactory

Paginators for the service

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.

Requires permission to access the AcceptCertificateTransfer action.

Public Method AcceptCertificateTransferAsync(AcceptCertificateTransferRequest, CancellationToken)

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

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

Requires permission to access the AcceptCertificateTransfer action.

Public Method AddThingToBillingGroup(AddThingToBillingGroupRequest)

Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup action.

Public Method AddThingToBillingGroupAsync(AddThingToBillingGroupRequest, CancellationToken)

Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup action.

Public Method AddThingToThingGroup(AddThingToThingGroupRequest)

Adds a thing to a thing group.

Requires permission to access the AddThingToThingGroup action.

Public Method AddThingToThingGroupAsync(AddThingToThingGroupRequest, CancellationToken)

Adds a thing to a thing group.

Requires permission to access the AddThingToThingGroup action.

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.

Requires permission to access the AssociateTargetsWithJob action.

Public Method AssociateTargetsWithJobAsync(AssociateTargetsWithJobRequest, CancellationToken)

Associates a group with a continuous job. The following criteria must be met:

  • The job must have been created with the targetSelection field set to "CONTINUOUS".

  • The job status must currently be "IN_PROGRESS".

  • The total number of targets associated with a job must not exceed 100.

Requires permission to access the AssociateTargetsWithJob action.

Public Method AttachPolicy(AttachPolicyRequest)

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

Requires permission to access the AttachPolicy action.

Public Method AttachPolicyAsync(AttachPolicyRequest, CancellationToken)

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

Requires permission to access the AttachPolicy action.

Public Method AttachPrincipalPolicy(string, string)

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

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.

Requires permission to access the AttachPrincipalPolicy action.

Public Method AttachPrincipalPolicy(AttachPrincipalPolicyRequest)

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

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.

Requires permission to access the AttachPrincipalPolicy action.

Public Method AttachPrincipalPolicyAsync(string, string, CancellationToken)

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

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.

Requires permission to access the AttachPrincipalPolicy action.

Public Method AttachPrincipalPolicyAsync(AttachPrincipalPolicyRequest, CancellationToken)

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

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.

Requires permission to access the AttachPrincipalPolicy action.

Public Method AttachSecurityProfile(AttachSecurityProfileRequest)

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

Requires permission to access the AttachSecurityProfile action.

Public Method AttachSecurityProfileAsync(AttachSecurityProfileRequest, CancellationToken)

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

Requires permission to access the AttachSecurityProfile action.

Public Method AttachThingPrincipal(string, string)

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the AttachThingPrincipal action.

Public Method AttachThingPrincipal(AttachThingPrincipalRequest)

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the AttachThingPrincipal action.

Public Method AttachThingPrincipalAsync(string, string, CancellationToken)

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the AttachThingPrincipal action.

Public Method AttachThingPrincipalAsync(AttachThingPrincipalRequest, CancellationToken)

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the AttachThingPrincipal action.

Public Method CancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest)

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

Requires permission to access the CancelAuditMitigationActionsTask action.

Public Method CancelAuditMitigationActionsTaskAsync(CancelAuditMitigationActionsTaskRequest, CancellationToken)

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

Requires permission to access the CancelAuditMitigationActionsTask action.

Public Method CancelAuditTask(CancelAuditTaskRequest)

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

Requires permission to access the CancelAuditTask action.

Public Method CancelAuditTaskAsync(CancelAuditTaskRequest, CancellationToken)

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

Requires permission to access the CancelAuditTask action.

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, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

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

Requires permission to access the CancelCertificateTransfer action.

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, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

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

Requires permission to access the CancelCertificateTransfer action.

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, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

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

Requires permission to access the CancelCertificateTransfer action.

Public Method CancelCertificateTransferAsync(CancelCertificateTransferRequest, 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, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

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

Requires permission to access the CancelCertificateTransfer action.

Public Method CancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest)

Cancels a Device Defender ML Detect mitigation action.

Requires permission to access the CancelDetectMitigationActionsTask action.

Public Method CancelDetectMitigationActionsTaskAsync(CancelDetectMitigationActionsTaskRequest, CancellationToken)

Cancels a Device Defender ML Detect mitigation action.

Requires permission to access the CancelDetectMitigationActionsTask action.

Public Method CancelJob(CancelJobRequest)

Cancels a job.

Requires permission to access the CancelJob action.

Public Method CancelJobAsync(CancelJobRequest, CancellationToken)

Cancels a job.

Requires permission to access the CancelJob action.

Public Method CancelJobExecution(CancelJobExecutionRequest)

Cancels the execution of a job for a given thing.

Requires permission to access the CancelJobExecution action.

Public Method CancelJobExecutionAsync(CancelJobExecutionRequest, CancellationToken)

Cancels the execution of a job for a given thing.

Requires permission to access the CancelJobExecution action.

Public Method ClearDefaultAuthorizer(ClearDefaultAuthorizerRequest)

Clears the default authorizer.

Requires permission to access the ClearDefaultAuthorizer action.

Public Method ClearDefaultAuthorizerAsync(ClearDefaultAuthorizerRequest, CancellationToken)

Clears the default authorizer.

Requires permission to access the ClearDefaultAuthorizer action.

Public Method ConfirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest)

Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

Requires permission to access the ConfirmTopicRuleDestination action.

Public Method ConfirmTopicRuleDestinationAsync(ConfirmTopicRuleDestinationRequest, CancellationToken)

Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

Requires permission to access the ConfirmTopicRuleDestination action.

Public Method CreateAuditSuppression(CreateAuditSuppressionRequest)

Creates a Device Defender audit suppression.

Requires permission to access the CreateAuditSuppression action.

Public Method CreateAuditSuppressionAsync(CreateAuditSuppressionRequest, CancellationToken)

Creates a Device Defender audit suppression.

Requires permission to access the CreateAuditSuppression action.

Public Method CreateAuthorizer(CreateAuthorizerRequest)

Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

Public Method CreateAuthorizerAsync(CreateAuthorizerRequest, CancellationToken)

Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

Public Method CreateBillingGroup(CreateBillingGroupRequest)

Creates a billing group.

Requires permission to access the CreateBillingGroup action.

Public Method CreateBillingGroupAsync(CreateBillingGroupRequest, CancellationToken)

Creates a billing group.

Requires permission to access the CreateBillingGroup action.

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

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

Requires permission to access the CreateCertificateFromCsr action.

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

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

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

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

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

Requires permission to access the CreateCertificateFromCsr action.

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

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

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

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

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

Requires permission to access the CreateCertificateFromCsr action.

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

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

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

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

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

Requires permission to access the CreateCertificateFromCsr action.

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

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

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

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

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

Requires permission to access the CreateCertificateFromCsr action.

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

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

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

Public Method CreateCertificateFromCsrAsync(CreateCertificateFromCsrRequest, 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, NIST P-384, or NIST P-512 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

Requires permission to access the CreateCertificateFromCsr action.

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

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

On Linux and OS X, the command is:

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

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

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

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

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

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

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

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

Public Method CreateCustomMetric(CreateCustomMetricRequest)

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

Requires permission to access the CreateCustomMetric action.

Public Method CreateCustomMetricAsync(CreateCustomMetricRequest, CancellationToken)

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

Requires permission to access the CreateCustomMetric action.

Public Method CreateDimension(CreateDimensionRequest)

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

Requires permission to access the CreateDimension action.

Public Method CreateDimensionAsync(CreateDimensionRequest, CancellationToken)

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

Requires permission to access the CreateDimension action.

Public Method CreateDomainConfiguration(CreateDomainConfigurationRequest)

Creates a domain configuration.

Requires permission to access the CreateDomainConfiguration action.

Public Method CreateDomainConfigurationAsync(CreateDomainConfigurationRequest, CancellationToken)

Creates a domain configuration.

Requires permission to access the CreateDomainConfiguration action.

Public Method CreateDynamicThingGroup(CreateDynamicThingGroupRequest)

Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup action.

Public Method CreateDynamicThingGroupAsync(CreateDynamicThingGroupRequest, CancellationToken)

Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup action.

Public Method CreateFleetMetric(CreateFleetMetricRequest)

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

Public Method CreateFleetMetricAsync(CreateFleetMetricRequest, CancellationToken)

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

Public Method CreateJob(CreateJobRequest)

Creates a job.

Requires permission to access the CreateJob action.

Public Method CreateJobAsync(CreateJobRequest, CancellationToken)

Creates a job.

Requires permission to access the CreateJob action.

Public Method CreateJobTemplate(CreateJobTemplateRequest)

Creates a job template.

Requires permission to access the CreateJobTemplate action.

Public Method CreateJobTemplateAsync(CreateJobTemplateRequest, CancellationToken)

Creates a job template.

Requires permission to access the CreateJobTemplate action.

Public Method CreateKeysAndCertificate()

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

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

Requires permission to access the CreateKeysAndCertificate action.

Public Method CreateKeysAndCertificate(bool)

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

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

Requires permission to access the CreateKeysAndCertificate action.

Public Method CreateKeysAndCertificate(CreateKeysAndCertificateRequest)

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

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

Requires permission to access the CreateKeysAndCertificate action.

Public Method CreateKeysAndCertificateAsync(CancellationToken)

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

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

Requires permission to access the CreateKeysAndCertificate action.

Public Method CreateKeysAndCertificateAsync(bool, CancellationToken)

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

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

Requires permission to access the CreateKeysAndCertificate action.

Public Method CreateKeysAndCertificateAsync(CreateKeysAndCertificateRequest, CancellationToken)

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

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

Requires permission to access the CreateKeysAndCertificate action.

Public Method CreateMitigationAction(CreateMitigationActionRequest)

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

Requires permission to access the CreateMitigationAction action.

Public Method CreateMitigationActionAsync(CreateMitigationActionRequest, CancellationToken)

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

Requires permission to access the CreateMitigationAction action.

Public Method CreateOTAUpdate(CreateOTAUpdateRequest)

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

Requires permission to access the CreateOTAUpdate action.

Public Method CreateOTAUpdateAsync(CreateOTAUpdateRequest, CancellationToken)

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

Requires permission to access the CreateOTAUpdate action.

Public Method CreatePolicy(string, string)

Creates an IoT policy.

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

Requires permission to access the CreatePolicy action.

Public Method CreatePolicy(CreatePolicyRequest)

Creates an IoT policy.

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

Requires permission to access the CreatePolicy action.

Public Method CreatePolicyAsync(string, string, CancellationToken)

Creates an IoT policy.

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

Requires permission to access the CreatePolicy action.

Public Method CreatePolicyAsync(CreatePolicyRequest, CancellationToken)

Creates an IoT policy.

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

Requires permission to access the CreatePolicy action.

Public Method CreatePolicyVersion(string, string)

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

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

Public Method CreatePolicyVersion(string, string, bool)

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

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

Public Method CreatePolicyVersion(CreatePolicyVersionRequest)

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

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

Public Method CreatePolicyVersionAsync(string, string, CancellationToken)

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

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

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

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

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

Public Method CreatePolicyVersionAsync(CreatePolicyVersionRequest, CancellationToken)

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

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

Public Method CreateProvisioningClaim(CreateProvisioningClaimRequest)

Creates a provisioning claim.

Requires permission to access the CreateProvisioningClaim action.

Public Method CreateProvisioningClaimAsync(CreateProvisioningClaimRequest, CancellationToken)

Creates a provisioning claim.

Requires permission to access the CreateProvisioningClaim action.

Public Method CreateProvisioningTemplate(CreateProvisioningTemplateRequest)

Creates a provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

Public Method CreateProvisioningTemplateAsync(CreateProvisioningTemplateRequest, CancellationToken)

Creates a provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

Public Method CreateProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest)

Creates a new version of a provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion action.

Public Method CreateProvisioningTemplateVersionAsync(CreateProvisioningTemplateVersionRequest, CancellationToken)

Creates a new version of a provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion action.

Public Method CreateRoleAlias(CreateRoleAliasRequest)

Creates a role alias.

Requires permission to access the CreateRoleAlias action.

Public Method CreateRoleAliasAsync(CreateRoleAliasRequest, CancellationToken)

Creates a role alias.

Requires permission to access the CreateRoleAlias action.

Public Method CreateScheduledAudit(CreateScheduledAuditRequest)

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

Requires permission to access the CreateScheduledAudit action.

Public Method CreateScheduledAuditAsync(CreateScheduledAuditRequest, CancellationToken)

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

Requires permission to access the CreateScheduledAudit action.

Public Method CreateSecurityProfile(CreateSecurityProfileRequest)

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile action.

Public Method CreateSecurityProfileAsync(CreateSecurityProfileRequest, CancellationToken)

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile action.

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.

Requires permission to access the CreateStream action.

Public Method CreateStreamAsync(CreateStreamRequest, CancellationToken)

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.

Requires permission to access the CreateStream action.

Public Method CreateThing(CreateThingRequest)

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

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

Requires permission to access the CreateThing action.

Public Method CreateThingAsync(CreateThingRequest, CancellationToken)

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

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

Requires permission to access the CreateThing action.

Public Method CreateThingGroup(CreateThingGroupRequest)

Create a thing group.

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

Requires permission to access the CreateThingGroup action.

Public Method CreateThingGroupAsync(CreateThingGroupRequest, CancellationToken)

Create a thing group.

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

Requires permission to access the CreateThingGroup action.

Public Method CreateThingType(CreateThingTypeRequest)

Creates a new thing type.

Requires permission to access the CreateThingType action.

Public Method CreateThingTypeAsync(CreateThingTypeRequest, CancellationToken)

Creates a new thing type.

Requires permission to access the CreateThingType action.

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.

Requires permission to access the CreateTopicRule action.

Public Method CreateTopicRuleAsync(CreateTopicRuleRequest, CancellationToken)

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Requires permission to access the CreateTopicRule action.

Public Method CreateTopicRuleDestination(CreateTopicRuleDestinationRequest)

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

Requires permission to access the CreateTopicRuleDestination action.

Public Method CreateTopicRuleDestinationAsync(CreateTopicRuleDestinationRequest, CancellationToken)

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

Requires permission to access the CreateTopicRuleDestination action.

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.

Requires permission to access the DeleteAccountAuditConfiguration action.

Public Method DeleteAccountAuditConfigurationAsync(DeleteAccountAuditConfigurationRequest, CancellationToken)

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.

Requires permission to access the DeleteAccountAuditConfiguration action.

Public Method DeleteAuditSuppression(DeleteAuditSuppressionRequest)

Deletes a Device Defender audit suppression.

Requires permission to access the DeleteAuditSuppression action.

Public Method DeleteAuditSuppressionAsync(DeleteAuditSuppressionRequest, CancellationToken)

Deletes a Device Defender audit suppression.

Requires permission to access the DeleteAuditSuppression action.

Public Method DeleteAuthorizer(DeleteAuthorizerRequest)

Deletes an authorizer.

Requires permission to access the DeleteAuthorizer action.

Public Method DeleteAuthorizerAsync(DeleteAuthorizerRequest, CancellationToken)

Deletes an authorizer.

Requires permission to access the DeleteAuthorizer action.

Public Method DeleteBillingGroup(DeleteBillingGroupRequest)

Deletes the billing group.

Requires permission to access the DeleteBillingGroup action.

Public Method DeleteBillingGroupAsync(DeleteBillingGroupRequest, CancellationToken)

Deletes the billing group.

Requires permission to access the DeleteBillingGroup action.

Public Method DeleteCACertificate(DeleteCACertificateRequest)

Deletes a registered CA certificate.

Requires permission to access the DeleteCACertificate action.

Public Method DeleteCACertificateAsync(DeleteCACertificateRequest, CancellationToken)

Deletes a registered CA certificate.

Requires permission to access the DeleteCACertificate action.

Public Method DeleteCertificate(string)

Deletes the specified certificate.

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

Requires permission to access the DeleteCertificate action.

Public Method DeleteCertificate(DeleteCertificateRequest)

Deletes the specified certificate.

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

Requires permission to access the DeleteCertificate action.

Public Method DeleteCertificateAsync(string, CancellationToken)

Deletes the specified certificate.

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

Requires permission to access the DeleteCertificate action.

Public Method DeleteCertificateAsync(DeleteCertificateRequest, CancellationToken)

Deletes the specified certificate.

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

Requires permission to access the DeleteCertificate action.

Public Method DeleteCustomMetric(DeleteCustomMetricRequest)

Deletes a Device Defender detect custom metric.

Requires permission to access the DeleteCustomMetric action.

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

Public Method DeleteCustomMetricAsync(DeleteCustomMetricRequest, CancellationToken)

Deletes a Device Defender detect custom metric.

Requires permission to access the DeleteCustomMetric action.

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

Public Method DeleteDimension(DeleteDimensionRequest)

Removes the specified dimension from your Amazon Web Services accounts.

Requires permission to access the DeleteDimension action.

Public Method DeleteDimensionAsync(DeleteDimensionRequest, CancellationToken)

Removes the specified dimension from your Amazon Web Services accounts.

Requires permission to access the DeleteDimension action.

Public Method DeleteDomainConfiguration(DeleteDomainConfigurationRequest)

Deletes the specified domain configuration.

Requires permission to access the DeleteDomainConfiguration action.

Public Method DeleteDomainConfigurationAsync(DeleteDomainConfigurationRequest, CancellationToken)

Deletes the specified domain configuration.

Requires permission to access the DeleteDomainConfiguration action.

Public Method DeleteDynamicThingGroup(DeleteDynamicThingGroupRequest)

Deletes a dynamic thing group.

Requires permission to access the DeleteDynamicThingGroup action.

Public Method DeleteDynamicThingGroupAsync(DeleteDynamicThingGroupRequest, CancellationToken)

Deletes a dynamic thing group.

Requires permission to access the DeleteDynamicThingGroup action.

Public Method DeleteFleetMetric(DeleteFleetMetricRequest)

Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.

Requires permission to access the DeleteFleetMetric action.

Public Method DeleteFleetMetricAsync(DeleteFleetMetricRequest, CancellationToken)

Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.

Requires permission to access the DeleteFleetMetric action.

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.

Requires permission to access the DeleteJob action.

Public Method DeleteJobAsync(DeleteJobRequest, CancellationToken)

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

Requires permission to access the DeleteJob action.

Public Method DeleteJobExecution(DeleteJobExecutionRequest)

Deletes a job execution.

Requires permission to access the DeleteJobExecution action.

Public Method DeleteJobExecutionAsync(DeleteJobExecutionRequest, CancellationToken)

Deletes a job execution.

Requires permission to access the DeleteJobExecution action.

Public Method DeleteJobTemplate(DeleteJobTemplateRequest)

Deletes the specified job template.

Public Method DeleteJobTemplateAsync(DeleteJobTemplateRequest, CancellationToken)

Deletes the specified job template.

Public Method DeleteMitigationAction(DeleteMitigationActionRequest)

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

Requires permission to access the DeleteMitigationAction action.

Public Method DeleteMitigationActionAsync(DeleteMitigationActionRequest, CancellationToken)

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

Requires permission to access the DeleteMitigationAction action.

Public Method DeleteOTAUpdate(DeleteOTAUpdateRequest)

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

Public Method DeleteOTAUpdateAsync(DeleteOTAUpdateRequest, CancellationToken)

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

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

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

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

Requires permission to access the DeletePolicy action.

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

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

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

Requires permission to access the DeletePolicy action.

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

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

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

Requires permission to access the DeletePolicy action.

Public Method DeletePolicyAsync(DeletePolicyRequest, 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 action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.

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

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

Requires permission to access the DeletePolicy action.

Public Method DeletePolicyVersion(string, string)

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

Requires permission to access the DeletePolicyVersion action.

Public Method DeletePolicyVersion(DeletePolicyVersionRequest)

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

Requires permission to access the DeletePolicyVersion action.

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 action. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

Requires permission to access the DeletePolicyVersion action.

Public Method DeletePolicyVersionAsync(DeletePolicyVersionRequest, CancellationToken)

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

Requires permission to access the DeletePolicyVersion action.

Public Method DeleteProvisioningTemplate(DeleteProvisioningTemplateRequest)

Deletes a provisioning template.

Requires permission to access the DeleteProvisioningTemplate action.

Public Method DeleteProvisioningTemplateAsync(DeleteProvisioningTemplateRequest, CancellationToken)

Deletes a provisioning template.

Requires permission to access the DeleteProvisioningTemplate action.

Public Method DeleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest)

Deletes a provisioning template version.

Requires permission to access the DeleteProvisioningTemplateVersion action.

Public Method DeleteProvisioningTemplateVersionAsync(DeleteProvisioningTemplateVersionRequest, CancellationToken)

Deletes a provisioning template version.

Requires permission to access the DeleteProvisioningTemplateVersion action.

Public Method DeleteRegistrationCode(DeleteRegistrationCodeRequest)

Deletes a CA certificate registration code.

Requires permission to access the DeleteRegistrationCode action.

Public Method DeleteRegistrationCodeAsync(DeleteRegistrationCodeRequest, CancellationToken)

Deletes a CA certificate registration code.

Requires permission to access the DeleteRegistrationCode action.

Public Method DeleteRoleAlias(DeleteRoleAliasRequest)

Deletes a role alias

Requires permission to access the DeleteRoleAlias action.

Public Method DeleteRoleAliasAsync(DeleteRoleAliasRequest, CancellationToken)

Deletes a role alias

Requires permission to access the DeleteRoleAlias action.

Public Method DeleteScheduledAudit(DeleteScheduledAuditRequest)

Deletes a scheduled audit.

Requires permission to access the DeleteScheduledAudit action.

Public Method DeleteScheduledAuditAsync(DeleteScheduledAuditRequest, CancellationToken)

Deletes a scheduled audit.

Requires permission to access the DeleteScheduledAudit action.

Public Method DeleteSecurityProfile(DeleteSecurityProfileRequest)

Deletes a Device Defender security profile.

Requires permission to access the DeleteSecurityProfile action.

Public Method DeleteSecurityProfileAsync(DeleteSecurityProfileRequest, CancellationToken)

Deletes a Device Defender security profile.

Requires permission to access the DeleteSecurityProfile action.

Public Method DeleteStream(DeleteStreamRequest)

Deletes a stream.

Requires permission to access the DeleteStream action.

Public Method DeleteStreamAsync(DeleteStreamRequest, CancellationToken)

Deletes a stream.

Requires permission to access the DeleteStream action.

Public Method DeleteThing(string)

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

Requires permission to access the DeleteThing action.

Public Method DeleteThing(DeleteThingRequest)

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

Requires permission to access the DeleteThing action.

Public Method DeleteThingAsync(string, CancellationToken)

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

Requires permission to access the DeleteThing action.

Public Method DeleteThingAsync(DeleteThingRequest, CancellationToken)

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

Requires permission to access the DeleteThing action.

Public Method DeleteThingGroup(DeleteThingGroupRequest)

Deletes a thing group.

Requires permission to access the DeleteThingGroup action.

Public Method DeleteThingGroupAsync(DeleteThingGroupRequest, CancellationToken)

Deletes a thing group.

Requires permission to access the DeleteThingGroup action.

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.

Requires permission to access the DeleteThingType action.

Public Method DeleteThingTypeAsync(DeleteThingTypeRequest, CancellationToken)

Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

Requires permission to access the DeleteThingType action.

Public Method DeleteTopicRule(string)

Deletes the rule.

Requires permission to access the DeleteTopicRule action.

Public Method DeleteTopicRule(DeleteTopicRuleRequest)

Deletes the rule.

Requires permission to access the DeleteTopicRule action.

Public Method DeleteTopicRuleAsync(string, CancellationToken)

Deletes the rule.

Requires permission to access the DeleteTopicRule action.

Public Method DeleteTopicRuleAsync(DeleteTopicRuleRequest, CancellationToken)

Deletes the rule.

Requires permission to access the DeleteTopicRule action.

Public Method DeleteTopicRuleDestination(DeleteTopicRuleDestinationRequest)

Deletes a topic rule destination.

Requires permission to access the DeleteTopicRuleDestination action.

Public Method DeleteTopicRuleDestinationAsync(DeleteTopicRuleDestinationRequest, CancellationToken)

Deletes a topic rule destination.

Requires permission to access the DeleteTopicRuleDestination action.

Public Method DeleteV2LoggingLevel(DeleteV2LoggingLevelRequest)

Deletes a logging level.

Requires permission to access the DeleteV2LoggingLevel action.

Public Method DeleteV2LoggingLevelAsync(DeleteV2LoggingLevelRequest, CancellationToken)

Deletes a logging level.

Requires permission to access the DeleteV2LoggingLevel action.

Public Method DeprecateThingType(DeprecateThingTypeRequest)

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

Requires permission to access the DeprecateThingType action.

Public Method DeprecateThingTypeAsync(DeprecateThingTypeRequest, CancellationToken)

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

Requires permission to access the DeprecateThingType action.

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.

Requires permission to access the DescribeAccountAuditConfiguration action.

Public Method DescribeAccountAuditConfigurationAsync(DescribeAccountAuditConfigurationRequest, CancellationToken)

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

Requires permission to access the DescribeAccountAuditConfiguration action.

Public Method DescribeAuditFinding(DescribeAuditFindingRequest)

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.

Requires permission to access the DescribeAuditFinding action.

Public Method DescribeAuditFindingAsync(DescribeAuditFindingRequest, CancellationToken)

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.

Requires permission to access the DescribeAuditFinding action.

Public Method DescribeAuditMitigationActionsTask(DescribeAuditMitigationActionsTaskRequest)

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

Public Method DescribeAuditMitigationActionsTaskAsync(DescribeAuditMitigationActionsTaskRequest, CancellationToken)

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

Public Method DescribeAuditSuppression(DescribeAuditSuppressionRequest)

Gets information about a Device Defender audit suppression.

Public Method DescribeAuditSuppressionAsync(DescribeAuditSuppressionRequest, CancellationToken)

Gets information about a Device Defender audit suppression.

Public Method DescribeAuditTask(DescribeAuditTaskRequest)

Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask action.

Public Method DescribeAuditTaskAsync(DescribeAuditTaskRequest, CancellationToken)

Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask action.

Public Method DescribeAuthorizer(DescribeAuthorizerRequest)

Describes an authorizer.

Requires permission to access the DescribeAuthorizer action.

Public Method DescribeAuthorizerAsync(DescribeAuthorizerRequest, CancellationToken)

Describes an authorizer.

Requires permission to access the DescribeAuthorizer action.

Public Method DescribeBillingGroup(DescribeBillingGroupRequest)

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

Public Method DescribeBillingGroupAsync(DescribeBillingGroupRequest, CancellationToken)

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

Public Method DescribeCACertificate(DescribeCACertificateRequest)

Describes a registered CA certificate.

Requires permission to access the DescribeCACertificate action.

Public Method DescribeCACertificateAsync(DescribeCACertificateRequest, CancellationToken)

Describes a registered CA certificate.

Requires permission to access the DescribeCACertificate action.

Public Method DescribeCertificate(string)

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

Public Method DescribeCertificate(DescribeCertificateRequest)

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

Public Method DescribeCertificateAsync(string, CancellationToken)

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

Public Method DescribeCertificateAsync(DescribeCertificateRequest, CancellationToken)

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

Public Method DescribeCustomMetric(DescribeCustomMetricRequest)

Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

Public Method DescribeCustomMetricAsync(DescribeCustomMetricRequest, CancellationToken)

Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

Public Method DescribeDefaultAuthorizer(DescribeDefaultAuthorizerRequest)

Describes the default authorizer.

Requires permission to access the DescribeDefaultAuthorizer action.

Public Method DescribeDefaultAuthorizerAsync(DescribeDefaultAuthorizerRequest, CancellationToken)

Describes the default authorizer.

Requires permission to access the DescribeDefaultAuthorizer action.

Public Method DescribeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest)

Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask action.

Public Method DescribeDetectMitigationActionsTaskAsync(DescribeDetectMitigationActionsTaskRequest, CancellationToken)

Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask action.

Public Method DescribeDimension(DescribeDimensionRequest)

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

Requires permission to access the DescribeDimension action.

Public Method DescribeDimensionAsync(DescribeDimensionRequest, CancellationToken)

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

Requires permission to access the DescribeDimension action.

Public Method DescribeDomainConfiguration(DescribeDomainConfigurationRequest)

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration action.

Public Method DescribeDomainConfigurationAsync(DescribeDomainConfigurationRequest, CancellationToken)

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration action.

Public Method DescribeEndpoint()

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

Requires permission to access the DescribeEndpoint action.

Public Method DescribeEndpoint(DescribeEndpointRequest)

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

Requires permission to access the DescribeEndpoint action.

Public Method DescribeEndpointAsync(CancellationToken)

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

Requires permission to access the DescribeEndpoint action.

Public Method DescribeEndpointAsync(DescribeEndpointRequest, CancellationToken)

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

Requires permission to access the DescribeEndpoint action.

Public Method DescribeEventConfigurations(DescribeEventConfigurationsRequest)

Describes event configurations.

Requires permission to access the DescribeEventConfigurations action.

Public Method DescribeEventConfigurationsAsync(DescribeEventConfigurationsRequest, CancellationToken)

Describes event configurations.

Requires permission to access the DescribeEventConfigurations action.

Public Method DescribeFleetMetric(DescribeFleetMetricRequest)

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

Public Method DescribeFleetMetricAsync(DescribeFleetMetricRequest, CancellationToken)

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

Public Method DescribeIndex(DescribeIndexRequest)

Describes a search index.

Requires permission to access the DescribeIndex action.

Public Method DescribeIndexAsync(DescribeIndexRequest, CancellationToken)

Describes a search index.

Requires permission to access the DescribeIndex action.

Public Method DescribeJob(DescribeJobRequest)

Describes a job.

Requires permission to access the DescribeJob action.

Public Method DescribeJobAsync(DescribeJobRequest, CancellationToken)

Describes a job.

Requires permission to access the DescribeJob action.

Public Method DescribeJobExecution(DescribeJobExecutionRequest)

Describes a job execution.

Requires permission to access the DescribeJobExecution action.

Public Method DescribeJobExecutionAsync(DescribeJobExecutionRequest, CancellationToken)

Describes a job execution.

Requires permission to access the DescribeJobExecution action.

Public Method DescribeJobTemplate(DescribeJobTemplateRequest)

Returns information about a job template.

Public Method DescribeJobTemplateAsync(DescribeJobTemplateRequest, CancellationToken)

Returns information about a job template.

Public Method DescribeManagedJobTemplate(DescribeManagedJobTemplateRequest)

View details of a managed job template.

Public Method DescribeManagedJobTemplateAsync(DescribeManagedJobTemplateRequest, CancellationToken)

View details of a managed job template.

Public Method DescribeMitigationAction(DescribeMitigationActionRequest)

Gets information about a mitigation action.

Requires permission to access the DescribeMitigationAction action.

Public Method DescribeMitigationActionAsync(DescribeMitigationActionRequest, CancellationToken)

Gets information about a mitigation action.

Requires permission to access the DescribeMitigationAction action.

Public Method DescribeProvisioningTemplate(DescribeProvisioningTemplateRequest)

Returns information about a provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

Public Method DescribeProvisioningTemplateAsync(DescribeProvisioningTemplateRequest, CancellationToken)

Returns information about a provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

Public Method DescribeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest)

Returns information about a provisioning template version.

Requires permission to access the DescribeProvisioningTemplateVersion action.

Public Method DescribeProvisioningTemplateVersionAsync(DescribeProvisioningTemplateVersionRequest, CancellationToken)

Returns information about a provisioning template version.

Requires permission to access the DescribeProvisioningTemplateVersion action.

Public Method DescribeRoleAlias(DescribeRoleAliasRequest)

Describes a role alias.

Requires permission to access the DescribeRoleAlias action.

Public Method DescribeRoleAliasAsync(DescribeRoleAliasRequest, CancellationToken)

Describes a role alias.

Requires permission to access the DescribeRoleAlias action.

Public Method DescribeScheduledAudit(DescribeScheduledAuditRequest)

Gets information about a scheduled audit.

Requires permission to access the DescribeScheduledAudit action.

Public Method DescribeScheduledAuditAsync(DescribeScheduledAuditRequest, CancellationToken)

Gets information about a scheduled audit.

Requires permission to access the DescribeScheduledAudit action.

Public Method DescribeSecurityProfile(DescribeSecurityProfileRequest)

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

Public Method DescribeSecurityProfileAsync(DescribeSecurityProfileRequest, CancellationToken)

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

Public Method DescribeStream(DescribeStreamRequest)

Gets information about a stream.

Requires permission to access the DescribeStream action.

Public Method DescribeStreamAsync(DescribeStreamRequest, CancellationToken)

Gets information about a stream.

Requires permission to access the DescribeStream action.

Public Method DescribeThing(string)

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

Public Method DescribeThing(DescribeThingRequest)

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

Public Method DescribeThingAsync(string, CancellationToken)

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

Public Method DescribeThingAsync(DescribeThingRequest, CancellationToken)

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

Public Method DescribeThingGroup(DescribeThingGroupRequest)

Describe a thing group.

Requires permission to access the DescribeThingGroup action.

Public Method DescribeThingGroupAsync(DescribeThingGroupRequest, CancellationToken)

Describe a thing group.

Requires permission to access the DescribeThingGroup action.

Public Method DescribeThingRegistrationTask(DescribeThingRegistrationTaskRequest)

Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

Public Method DescribeThingRegistrationTaskAsync(DescribeThingRegistrationTaskRequest, CancellationToken)

Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

Public Method DescribeThingType(DescribeThingTypeRequest)

Gets information about the specified thing type.

Requires permission to access the DescribeThingType action.

Public Method DescribeThingTypeAsync(DescribeThingTypeRequest, CancellationToken)

Gets information about the specified thing type.

Requires permission to access the DescribeThingType action.

Public Method DetachPolicy(DetachPolicyRequest)

Detaches a policy from the specified target.

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

Requires permission to access the DetachPolicy action.

Public Method DetachPolicyAsync(DetachPolicyRequest, CancellationToken)

Detaches a policy from the specified target.

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

Requires permission to access the DetachPolicy action.

Public Method DetachPrincipalPolicy(string, string)

Removes the specified policy from the specified certificate.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.

Requires permission to access the DetachPrincipalPolicy action.

Public Method DetachPrincipalPolicy(DetachPrincipalPolicyRequest)

Removes the specified policy from the specified certificate.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.

Requires permission to access the DetachPrincipalPolicy action.

Public Method DetachPrincipalPolicyAsync(string, string, CancellationToken)

Removes the specified policy from the specified certificate.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.

Requires permission to access the DetachPrincipalPolicy action.

Public Method DetachPrincipalPolicyAsync(DetachPrincipalPolicyRequest, CancellationToken)

Removes the specified policy from the specified certificate.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.

Requires permission to access the DetachPrincipalPolicy action.

Public Method DetachSecurityProfile(DetachSecurityProfileRequest)

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

Requires permission to access the DetachSecurityProfile action.

Public Method DetachSecurityProfileAsync(DetachSecurityProfileRequest, CancellationToken)

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

Requires permission to access the DetachSecurityProfile action.

Public Method DetachThingPrincipal(string, string)

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

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

Requires permission to access the DetachThingPrincipal action.

Public Method DetachThingPrincipal(DetachThingPrincipalRequest)

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

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

Requires permission to access the DetachThingPrincipal action.

Public Method DetachThingPrincipalAsync(string, string, CancellationToken)

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

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

Requires permission to access the DetachThingPrincipal action.

Public Method DetachThingPrincipalAsync(DetachThingPrincipalRequest, CancellationToken)

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

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

Requires permission to access the DetachThingPrincipal action.

Public Method DisableTopicRule(DisableTopicRuleRequest)

Disables the rule.

Requires permission to access the DisableTopicRule action.

Public Method DisableTopicRuleAsync(DisableTopicRuleRequest, CancellationToken)

Disables the rule.

Requires permission to access the DisableTopicRule action.

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

Enables the rule.

Requires permission to access the EnableTopicRule action.

Public Method EnableTopicRuleAsync(EnableTopicRuleRequest, CancellationToken)

Enables the rule.

Requires permission to access the EnableTopicRule action.

Public Method GetBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest)

Returns a Device Defender's ML Detect Security Profile training model's status.

Requires permission to access the GetBehaviorModelTrainingSummaries action.

Public Method GetBehaviorModelTrainingSummariesAsync(GetBehaviorModelTrainingSummariesRequest, CancellationToken)

Returns a Device Defender's ML Detect Security Profile training model's status.

Requires permission to access the GetBehaviorModelTrainingSummaries action.

Public Method GetBucketsAggregation(GetBucketsAggregationRequest)

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

Requires permission to access the GetBucketsAggregation action.

Public Method GetBucketsAggregationAsync(GetBucketsAggregationRequest, CancellationToken)

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

Requires permission to access the GetBucketsAggregation action.

Public Method GetCardinality(GetCardinalityRequest)

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

Requires permission to access the GetCardinality action.

Public Method GetCardinalityAsync(GetCardinalityRequest, CancellationToken)

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

Requires permission to access the GetCardinality action.

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 IoT device gateway.

Requires permission to access the GetEffectivePolicies action.

Public Method GetEffectivePoliciesAsync(GetEffectivePoliciesRequest, CancellationToken)

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

Requires permission to access the GetEffectivePolicies action.

Public Method GetIndexingConfiguration(GetIndexingConfigurationRequest)

Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration action.

Public Method GetIndexingConfigurationAsync(GetIndexingConfigurationRequest, CancellationToken)

Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration action.

Public Method GetJobDocument(GetJobDocumentRequest)

Gets a job document.

Requires permission to access the GetJobDocument action.

Public Method GetJobDocumentAsync(GetJobDocumentRequest, CancellationToken)

Gets a job document.

Requires permission to access the GetJobDocument action.

Public Method GetLoggingOptions(GetLoggingOptionsRequest)

Gets the logging options.

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

Requires permission to access the GetLoggingOptions action.

Public Method GetLoggingOptionsAsync(GetLoggingOptionsRequest, CancellationToken)

Gets the logging options.

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

Requires permission to access the GetLoggingOptions action.

Public Method GetOTAUpdate(GetOTAUpdateRequest)

Gets an OTA update.

Requires permission to access the GetOTAUpdate action.

Public Method GetOTAUpdateAsync(GetOTAUpdateRequest, CancellationToken)

Gets an OTA update.

Requires permission to access the GetOTAUpdate action.

Public Method GetPercentiles(GetPercentilesRequest)

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

Requires permission to access the GetPercentiles action.

Public Method GetPercentilesAsync(GetPercentilesRequest, CancellationToken)

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

Requires permission to access the GetPercentiles action.

Public Method GetPolicy(string)

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

Requires permission to access the GetPolicy action.

Public Method GetPolicy(GetPolicyRequest)

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

Requires permission to access the GetPolicy action.

Public Method GetPolicyAsync(string, CancellationToken)

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

Requires permission to access the GetPolicy action.

Public Method GetPolicyAsync(GetPolicyRequest, CancellationToken)

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

Requires permission to access the GetPolicy action.

Public Method GetPolicyVersion(string, string)

Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion action.

Public Method GetPolicyVersion(GetPolicyVersionRequest)

Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion action.

Public Method GetPolicyVersionAsync(string, string, CancellationToken)

Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion action.

Public Method GetPolicyVersionAsync(GetPolicyVersionRequest, CancellationToken)

Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion action.

Public Method GetRegistrationCode(GetRegistrationCodeRequest)

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

Requires permission to access the GetRegistrationCode action.

Public Method GetRegistrationCodeAsync(GetRegistrationCodeRequest, CancellationToken)

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

Requires permission to access the GetRegistrationCode action.

Public Method GetStatistics(GetStatisticsRequest)

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

Requires permission to access the GetStatistics action.

Public Method GetStatisticsAsync(GetStatisticsRequest, CancellationToken)

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

Requires permission to access the GetStatistics action.

Public Method GetTopicRule(string)

Gets information about the rule.

Requires permission to access the GetTopicRule action.

Public Method GetTopicRule(GetTopicRuleRequest)

Gets information about the rule.

Requires permission to access the GetTopicRule action.

Public Method GetTopicRuleAsync(string, CancellationToken)

Gets information about the rule.

Requires permission to access the GetTopicRule action.

Public Method GetTopicRuleAsync(GetTopicRuleRequest, CancellationToken)

Gets information about the rule.

Requires permission to access the GetTopicRule action.

Public Method GetTopicRuleDestination(GetTopicRuleDestinationRequest)

Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination action.

Public Method GetTopicRuleDestinationAsync(GetTopicRuleDestinationRequest, CancellationToken)

Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination action.

Public Method GetV2LoggingOptions(GetV2LoggingOptionsRequest)

Gets the fine grained logging options.

Requires permission to access the GetV2LoggingOptions action.

Public Method GetV2LoggingOptionsAsync(GetV2LoggingOptionsRequest, CancellationToken)

Gets the fine grained logging options.

Requires permission to access the GetV2LoggingOptions action.

Public Method ListActiveViolations(ListActiveViolationsRequest)

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

Requires permission to access the ListActiveViolations action.

Public Method ListActiveViolationsAsync(ListActiveViolationsRequest, CancellationToken)

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

Requires permission to access the ListActiveViolations action.

Public Method ListAttachedPolicies(ListAttachedPoliciesRequest)

Lists the policies attached to the specified thing group.

Requires permission to access the ListAttachedPolicies action.

Public Method ListAttachedPoliciesAsync(ListAttachedPoliciesRequest, CancellationToken)

Lists the policies attached to the specified thing group.

Requires permission to access the ListAttachedPolicies action.

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

Requires permission to access the ListAuditFindings action.

Public Method ListAuditFindingsAsync(ListAuditFindingsRequest, CancellationToken)

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

Requires permission to access the ListAuditFindings action.

Public Method ListAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest)

Gets the status of audit mitigation action tasks that were executed.

Requires permission to access the ListAuditMitigationActionsExecutions action.

Public Method ListAuditMitigationActionsExecutionsAsync(ListAuditMitigationActionsExecutionsRequest, CancellationToken)

Gets the status of audit mitigation action tasks that were executed.

Requires permission to access the ListAuditMitigationActionsExecutions action.

Public Method ListAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest)

Gets a list of audit mitigation action tasks that match the specified filters.

Requires permission to access the ListAuditMitigationActionsTasks action.

Public Method ListAuditMitigationActionsTasksAsync(ListAuditMitigationActionsTasksRequest, CancellationToken)

Gets a list of audit mitigation action tasks that match the specified filters.

Requires permission to access the ListAuditMitigationActionsTasks action.

Public Method ListAuditSuppressions(ListAuditSuppressionsRequest)

Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions action.

Public Method ListAuditSuppressionsAsync(ListAuditSuppressionsRequest, CancellationToken)

Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions action.

Public Method ListAuditTasks(ListAuditTasksRequest)

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

Requires permission to access the ListAuditTasks action.

Public Method ListAuditTasksAsync(ListAuditTasksRequest, CancellationToken)

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

Requires permission to access the ListAuditTasks action.

Public Method ListAuthorizers(ListAuthorizersRequest)

Lists the authorizers registered in your account.

Requires permission to access the ListAuthorizers action.

Public Method ListAuthorizersAsync(ListAuthorizersRequest, CancellationToken)

Lists the authorizers registered in your account.

Requires permission to access the ListAuthorizers action.

Public Method ListBillingGroups(ListBillingGroupsRequest)

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

Public Method ListBillingGroupsAsync(ListBillingGroupsRequest, CancellationToken)

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

Public Method ListCACertificates(ListCACertificatesRequest)

Lists the CA certificates registered for your Amazon Web Services account.

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

Requires permission to access the ListCACertificates action.

Public Method ListCACertificatesAsync(ListCACertificatesRequest, CancellationToken)

Lists the CA certificates registered for your Amazon Web Services account.

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

Requires permission to access the ListCACertificates action.

Public Method ListCertificates()

Lists the certificates registered in your Amazon Web Services account.

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

Requires permission to access the ListCertificates action.

Public Method ListCertificates(ListCertificatesRequest)

Lists the certificates registered in your Amazon Web Services account.

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

Requires permission to access the ListCertificates action.

Public Method ListCertificatesAsync(CancellationToken)

Lists the certificates registered in your Amazon Web Services account.

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

Requires permission to access the ListCertificates action.

Public Method ListCertificatesAsync(ListCertificatesRequest, CancellationToken)

Lists the certificates registered in your Amazon Web Services account.

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

Requires permission to access the ListCertificates action.

Public Method ListCertificatesByCA(ListCertificatesByCARequest)

List the device certificates signed by the specified CA certificate.

Requires permission to access the ListCertificatesByCA action.

Public Method ListCertificatesByCAAsync(ListCertificatesByCARequest, CancellationToken)

List the device certificates signed by the specified CA certificate.

Requires permission to access the ListCertificatesByCA action.

Public Method ListCustomMetrics(ListCustomMetricsRequest)

Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics action.

Public Method ListCustomMetricsAsync(ListCustomMetricsRequest, CancellationToken)

Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics action.

Public Method ListDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest)

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

Requires permission to access the ListDetectMitigationActionsExecutions action.

Public Method ListDetectMitigationActionsExecutionsAsync(ListDetectMitigationActionsExecutionsRequest, CancellationToken)

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

Requires permission to access the ListDetectMitigationActionsExecutions action.

Public Method ListDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest)

List of Device Defender ML Detect mitigation actions tasks.

Requires permission to access the ListDetectMitigationActionsTasks action.

Public Method ListDetectMitigationActionsTasksAsync(ListDetectMitigationActionsTasksRequest, CancellationToken)

List of Device Defender ML Detect mitigation actions tasks.

Requires permission to access the ListDetectMitigationActionsTasks action.

Public Method ListDimensions(ListDimensionsRequest)

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

Requires permission to access the ListDimensions action.

Public Method ListDimensionsAsync(ListDimensionsRequest, CancellationToken)

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

Requires permission to access the ListDimensions action.

Public Method ListDomainConfigurations(ListDomainConfigurationsRequest)

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

Requires permission to access the ListDomainConfigurations action.

Public Method ListDomainConfigurationsAsync(ListDomainConfigurationsRequest, CancellationToken)

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

Requires permission to access the ListDomainConfigurations action.

Public Method ListFleetMetrics(ListFleetMetricsRequest)

Lists all your fleet metrics.

Requires permission to access the ListFleetMetrics action.

Public Method ListFleetMetricsAsync(ListFleetMetricsRequest, CancellationToken)

Lists all your fleet metrics.

Requires permission to access the ListFleetMetrics action.

Public Method ListIndices(ListIndicesRequest)

Lists the search indices.

Requires permission to access the ListIndices action.

Public Method ListIndicesAsync(ListIndicesRequest, CancellationToken)

Lists the search indices.

Requires permission to access the ListIndices action.

Public Method ListJobExecutionsForJob(ListJobExecutionsForJobRequest)

Lists the job executions for a job.

Requires permission to access the ListJobExecutionsForJob action.

Public Method ListJobExecutionsForJobAsync(ListJobExecutionsForJobRequest, CancellationToken)

Lists the job executions for a job.

Requires permission to access the ListJobExecutionsForJob action.

Public Method ListJobExecutionsForThing(ListJobExecutionsForThingRequest)

Lists the job executions for the specified thing.

Requires permission to access the ListJobExecutionsForThing action.

Public Method ListJobExecutionsForThingAsync(ListJobExecutionsForThingRequest, CancellationToken)

Lists the job executions for the specified thing.

Requires permission to access the ListJobExecutionsForThing action.

Public Method ListJobs(ListJobsRequest)

Lists jobs.

Requires permission to access the ListJobs action.

Public Method ListJobsAsync(ListJobsRequest, CancellationToken)

Lists jobs.

Requires permission to access the ListJobs action.

Public Method ListJobTemplates(ListJobTemplatesRequest)

Returns a list of job templates.

Requires permission to access the ListJobTemplates action.

Public Method ListJobTemplatesAsync(ListJobTemplatesRequest, CancellationToken)

Returns a list of job templates.

Requires permission to access the ListJobTemplates action.

Public Method ListManagedJobTemplates(ListManagedJobTemplatesRequest)

Returns a list of managed job templates.

Public Method ListManagedJobTemplatesAsync(ListManagedJobTemplatesRequest, CancellationToken)

Returns a list of managed job templates.

Public Method ListMetricValues(ListMetricValuesRequest)

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

Public Method ListMetricValuesAsync(ListMetricValuesRequest, CancellationToken)

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

Public Method ListMitigationActions(ListMitigationActionsRequest)

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

Requires permission to access the ListMitigationActions action.

Public Method ListMitigationActionsAsync(ListMitigationActionsRequest, CancellationToken)

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

Requires permission to access the ListMitigationActions action.

Public Method ListOTAUpdates(ListOTAUpdatesRequest)

Lists OTA updates.

Requires permission to access the ListOTAUpdates action.

Public Method ListOTAUpdatesAsync(ListOTAUpdatesRequest, CancellationToken)

Lists OTA updates.

Requires permission to access the ListOTAUpdates action.

Public Method ListOutgoingCertificates(ListOutgoingCertificatesRequest)

Lists certificates that are being transferred but not yet accepted.

Requires permission to access the ListOutgoingCertificates action.

Public Method ListOutgoingCertificatesAsync(ListOutgoingCertificatesRequest, CancellationToken)

Lists certificates that are being transferred but not yet accepted.

Requires permission to access the ListOutgoingCertificates action.

Public Method ListPolicies()

Lists your policies.

Requires permission to access the ListPolicies action.

Public Method ListPolicies(ListPoliciesRequest)

Lists your policies.

Requires permission to access the ListPolicies action.

Public Method ListPoliciesAsync(CancellationToken)

Lists your policies.

Requires permission to access the ListPolicies action.

Public Method ListPoliciesAsync(ListPoliciesRequest, CancellationToken)

Lists your policies.

Requires permission to access the ListPolicies action.

Public Method ListPolicyPrincipals(ListPolicyPrincipalsRequest)

Lists the principals associated with the specified policy.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.

Requires permission to access the ListPolicyPrincipals action.

Public Method ListPolicyPrincipalsAsync(ListPolicyPrincipalsRequest, CancellationToken)

Lists the principals associated with the specified policy.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.

Requires permission to access the ListPolicyPrincipals action.

Public Method ListPolicyVersions(string)

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

Requires permission to access the ListPolicyVersions action.

Public Method ListPolicyVersions(ListPolicyVersionsRequest)

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

Requires permission to access the ListPolicyVersions action.

Public Method ListPolicyVersionsAsync(string, CancellationToken)

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

Requires permission to access the ListPolicyVersions action.

Public Method ListPolicyVersionsAsync(ListPolicyVersionsRequest, CancellationToken)

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

Requires permission to access the ListPolicyVersions action.

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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.

Requires permission to access the ListPrincipalPolicies action.

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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.

Requires permission to access the ListPrincipalPolicies action.

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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.

Requires permission to access the ListPrincipalPolicies action.

Public Method ListPrincipalPoliciesAsync(ListPrincipalPoliciesRequest, 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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.

Requires permission to access the ListPrincipalPolicies action.

Public Method ListPrincipalThings(string)

Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListPrincipalThings action.

Public Method ListPrincipalThings(ListPrincipalThingsRequest)

Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListPrincipalThings action.

Public Method ListPrincipalThingsAsync(string, CancellationToken)

Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListPrincipalThings action.

Public Method ListPrincipalThingsAsync(ListPrincipalThingsRequest, CancellationToken)

Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListPrincipalThings action.

Public Method ListProvisioningTemplates(ListProvisioningTemplatesRequest)

Lists the provisioning templates in your Amazon Web Services account.

Requires permission to access the ListProvisioningTemplates action.

Public Method ListProvisioningTemplatesAsync(ListProvisioningTemplatesRequest, CancellationToken)

Lists the provisioning templates in your Amazon Web Services account.

Requires permission to access the ListProvisioningTemplates action.

Public Method ListProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest)

A list of provisioning template versions.

Requires permission to access the ListProvisioningTemplateVersions action.

Public Method ListProvisioningTemplateVersionsAsync(ListProvisioningTemplateVersionsRequest, CancellationToken)

A list of provisioning template versions.

Requires permission to access the ListProvisioningTemplateVersions action.

Public Method ListRoleAliases(ListRoleAliasesRequest)

Lists the role aliases registered in your account.

Requires permission to access the ListRoleAliases action.

Public Method ListRoleAliasesAsync(ListRoleAliasesRequest, CancellationToken)

Lists the role aliases registered in your account.

Requires permission to access the ListRoleAliases action.

Public Method ListScheduledAudits(ListScheduledAuditsRequest)

Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits action.

Public Method ListScheduledAuditsAsync(ListScheduledAuditsRequest, CancellationToken)

Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits action.

Public Method ListSecurityProfiles(ListSecurityProfilesRequest)

Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.

Requires permission to access the ListSecurityProfiles action.

dimensionName and metricName cannot be used in the same request.

Public Method ListSecurityProfilesAsync(ListSecurityProfilesRequest, CancellationToken)

Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.

Requires permission to access the ListSecurityProfiles action.

dimensionName and metricName cannot be used in the same request.

Public Method ListSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest)

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

Requires permission to access the ListSecurityProfilesForTarget action.

Public Method ListSecurityProfilesForTargetAsync(ListSecurityProfilesForTargetRequest, CancellationToken)

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

Requires permission to access the ListSecurityProfilesForTarget action.

Public Method ListStreams(ListStreamsRequest)

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

Requires permission to access the ListStreams action.

Public Method ListStreamsAsync(ListStreamsRequest, CancellationToken)

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

Requires permission to access the ListStreams action.

Public Method ListTagsForResource(ListTagsForResourceRequest)

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

Requires permission to access the ListTagsForResource action.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

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

Requires permission to access the ListTagsForResource action.

Public Method ListTargetsForPolicy(ListTargetsForPolicyRequest)

List targets for the specified policy.

Requires permission to access the ListTargetsForPolicy action.

Public Method ListTargetsForPolicyAsync(ListTargetsForPolicyRequest, CancellationToken)

List targets for the specified policy.

Requires permission to access the ListTargetsForPolicy action.

Public Method ListTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest)

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

Requires permission to access the ListTargetsForSecurityProfile action.

Public Method ListTargetsForSecurityProfileAsync(ListTargetsForSecurityProfileRequest, CancellationToken)

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

Requires permission to access the ListTargetsForSecurityProfile action.

Public Method ListThingGroups(ListThingGroupsRequest)

List the thing groups in your account.

Requires permission to access the ListThingGroups action.

Public Method ListThingGroupsAsync(ListThingGroupsRequest, CancellationToken)

List the thing groups in your account.

Requires permission to access the ListThingGroups action.

Public Method ListThingGroupsForThing(ListThingGroupsForThingRequest)

List the thing groups to which the specified thing belongs.

Requires permission to access the ListThingGroupsForThing action.

Public Method ListThingGroupsForThingAsync(ListThingGroupsForThingRequest, CancellationToken)

List the thing groups to which the specified thing belongs.

Requires permission to access the ListThingGroupsForThing action.

Public Method ListThingPrincipals(string)

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListThingPrincipals action.

Public Method ListThingPrincipals(ListThingPrincipalsRequest)

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListThingPrincipals action.

Public Method ListThingPrincipalsAsync(string, CancellationToken)

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListThingPrincipals action.

Public Method ListThingPrincipalsAsync(ListThingPrincipalsRequest, CancellationToken)

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListThingPrincipals action.

Public Method ListThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest)

Information about the thing registration tasks.

Public Method ListThingRegistrationTaskReportsAsync(ListThingRegistrationTaskReportsRequest, CancellationToken)

Information about the thing registration tasks.

Public Method ListThingRegistrationTasks(ListThingRegistrationTasksRequest)

List bulk thing provisioning tasks.

Requires permission to access the ListThingRegistrationTasks action.

Public Method ListThingRegistrationTasksAsync(ListThingRegistrationTasksRequest, CancellationToken)

List bulk thing provisioning tasks.

Requires permission to access the ListThingRegistrationTasks action.

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.

Requires permission to access the ListThings action.

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

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.

Requires permission to access the ListThings action.

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

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.

Requires permission to access the ListThings action.

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

Public Method ListThingsAsync(ListThingsRequest, 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.

Requires permission to access the ListThings action.

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

Public Method ListThingsInBillingGroup(ListThingsInBillingGroupRequest)

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

Requires permission to access the ListThingsInBillingGroup action.

Public Method ListThingsInBillingGroupAsync(ListThingsInBillingGroupRequest, CancellationToken)

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

Requires permission to access the ListThingsInBillingGroup action.

Public Method ListThingsInThingGroup(ListThingsInThingGroupRequest)

Lists the things in the specified group.

Requires permission to access the ListThingsInThingGroup action.

Public Method ListThingsInThingGroupAsync(ListThingsInThingGroupRequest, CancellationToken)

Lists the things in the specified group.

Requires permission to access the ListThingsInThingGroup action.

Public Method ListThingTypes(ListThingTypesRequest)

Lists the existing thing types.

Requires permission to access the ListThingTypes action.

Public Method ListThingTypesAsync(ListThingTypesRequest, CancellationToken)

Lists the existing thing types.

Requires permission to access the ListThingTypes action.

Public Method ListTopicRuleDestinations(ListTopicRuleDestinationsRequest)

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

Requires permission to access the ListTopicRuleDestinations action.

Public Method ListTopicRuleDestinationsAsync(ListTopicRuleDestinationsRequest, CancellationToken)

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

Requires permission to access the ListTopicRuleDestinations action.

Public Method ListTopicRules(string)

Lists the rules for the specific topic.

Requires permission to access the ListTopicRules action.

Public Method ListTopicRules(ListTopicRulesRequest)

Lists the rules for the specific topic.

Requires permission to access the ListTopicRules action.

Public Method ListTopicRulesAsync(string, CancellationToken)

Lists the rules for the specific topic.

Requires permission to access the ListTopicRules action.

Public Method ListTopicRulesAsync(ListTopicRulesRequest, CancellationToken)

Lists the rules for the specific topic.

Requires permission to access the ListTopicRules action.

Public Method ListV2LoggingLevels(ListV2LoggingLevelsRequest)

Lists logging levels.

Requires permission to access the ListV2LoggingLevels action.

Public Method ListV2LoggingLevelsAsync(ListV2LoggingLevelsRequest, CancellationToken)

Lists logging levels.

Requires permission to access the ListV2LoggingLevels action.

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

Requires permission to access the ListViolationEvents action.

Public Method ListViolationEventsAsync(ListViolationEventsRequest, CancellationToken)

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).

Requires permission to access the ListViolationEvents action.

Public Method PutVerificationStateOnViolation(PutVerificationStateOnViolationRequest)

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

Public Method PutVerificationStateOnViolationAsync(PutVerificationStateOnViolationRequest, CancellationToken)

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

Public Method RegisterCACertificate(RegisterCACertificateRequest)

Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

Requires permission to access the RegisterCACertificate action.

Public Method RegisterCACertificateAsync(RegisterCACertificateRequest, CancellationToken)

Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

Requires permission to access the RegisterCACertificate action.

Public Method RegisterCertificate(RegisterCertificateRequest)

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

Requires permission to access the RegisterCertificate action.

Public Method RegisterCertificateAsync(RegisterCertificateRequest, CancellationToken)

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

Requires permission to access the RegisterCertificate action.

Public Method RegisterCertificateWithoutCA(RegisterCertificateWithoutCARequest)

Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.

Public Method RegisterCertificateWithoutCAAsync(RegisterCertificateWithoutCARequest, CancellationToken)

Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.

Public Method RegisterThing(RegisterThingRequest)

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

Requires permission to access the RegisterThing action.

Public Method RegisterThingAsync(RegisterThingRequest, CancellationToken)

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

Requires permission to access the RegisterThing action.

Public Method RejectCertificateTransfer(string)

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

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

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

Requires permission to access the RejectCertificateTransfer action.

Public Method RejectCertificateTransfer(RejectCertificateTransferRequest)

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

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

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

Requires permission to access the RejectCertificateTransfer action.

Public Method RejectCertificateTransferAsync(string, CancellationToken)

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

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

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

Requires permission to access the RejectCertificateTransfer action.

Public Method RejectCertificateTransferAsync(RejectCertificateTransferRequest, CancellationToken)

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

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

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

Requires permission to access the RejectCertificateTransfer action.

Public Method RemoveThingFromBillingGroup(RemoveThingFromBillingGroupRequest)

Removes the given thing from the billing group.

Requires permission to access the RemoveThingFromBillingGroup action.

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

Public Method RemoveThingFromBillingGroupAsync(RemoveThingFromBillingGroupRequest, CancellationToken)

Removes the given thing from the billing group.

Requires permission to access the RemoveThingFromBillingGroup action.

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

Public Method RemoveThingFromThingGroup(RemoveThingFromThingGroupRequest)

Remove the specified thing from the specified group.

You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.

Requires permission to access the RemoveThingFromThingGroup action.

Public Method RemoveThingFromThingGroupAsync(RemoveThingFromThingGroupRequest, CancellationToken)

Remove the specified thing from the specified group.

You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.

Requires permission to access the RemoveThingFromThingGroup action.

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.

Requires permission to access the ReplaceTopicRule action.

Public Method ReplaceTopicRuleAsync(ReplaceTopicRuleRequest, CancellationToken)

Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Requires permission to access the ReplaceTopicRule action.

Public Method SearchIndex(SearchIndexRequest)

The query search index.

Requires permission to access the SearchIndex action.

Public Method SearchIndexAsync(SearchIndexRequest, CancellationToken)

The query search index.

Requires permission to access the SearchIndex action.

Public Method SetDefaultAuthorizer(SetDefaultAuthorizerRequest)

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

Requires permission to access the SetDefaultAuthorizer action.

Public Method SetDefaultAuthorizerAsync(SetDefaultAuthorizerRequest, CancellationToken)

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

Requires permission to access the SetDefaultAuthorizer action.

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 ListPrincipalPolicies action.

Requires permission to access the SetDefaultPolicyVersion action.

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 ListPrincipalPolicies action.

Requires permission to access the SetDefaultPolicyVersion action.

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 ListPrincipalPolicies action.

Requires permission to access the SetDefaultPolicyVersion action.

Public Method SetDefaultPolicyVersionAsync(SetDefaultPolicyVersionRequest, 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 ListPrincipalPolicies action.

Requires permission to access the SetDefaultPolicyVersion action.

Public Method SetLoggingOptions(SetLoggingOptionsRequest)

Sets the logging options.

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

Requires permission to access the SetLoggingOptions action.

Public Method SetLoggingOptionsAsync(SetLoggingOptionsRequest, CancellationToken)

Sets the logging options.

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

Requires permission to access the SetLoggingOptions action.

Public Method SetV2LoggingLevel(SetV2LoggingLevelRequest)

Sets the logging level.

Requires permission to access the SetV2LoggingLevel action.

Public Method SetV2LoggingLevelAsync(SetV2LoggingLevelRequest, CancellationToken)

Sets the logging level.

Requires permission to access the SetV2LoggingLevel action.

Public Method SetV2LoggingOptions(SetV2LoggingOptionsRequest)

Sets the logging options for the V2 logging service.

Requires permission to access the SetV2LoggingOptions action.

Public Method SetV2LoggingOptionsAsync(SetV2LoggingOptionsRequest, CancellationToken)

Sets the logging options for the V2 logging service.

Requires permission to access the SetV2LoggingOptions action.

Public Method StartAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest)

Starts a task that applies a set of mitigation actions to the specified target.

Requires permission to access the StartAuditMitigationActionsTask action.

Public Method StartAuditMitigationActionsTaskAsync(StartAuditMitigationActionsTaskRequest, CancellationToken)

Starts a task that applies a set of mitigation actions to the specified target.

Requires permission to access the StartAuditMitigationActionsTask action.

Public Method StartDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest)

Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask action.

Public Method StartDetectMitigationActionsTaskAsync(StartDetectMitigationActionsTaskRequest, CancellationToken)

Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask action.

Public Method StartOnDemandAuditTask(StartOnDemandAuditTaskRequest)

Starts an on-demand Device Defender audit.

Requires permission to access the StartOnDemandAuditTask action.

Public Method StartOnDemandAuditTaskAsync(StartOnDemandAuditTaskRequest, CancellationToken)

Starts an on-demand Device Defender audit.

Requires permission to access the StartOnDemandAuditTask action.

Public Method StartThingRegistrationTask(StartThingRegistrationTaskRequest)

Creates a bulk thing provisioning task.

Requires permission to access the StartThingRegistrationTask action.

Public Method StartThingRegistrationTaskAsync(StartThingRegistrationTaskRequest, CancellationToken)

Creates a bulk thing provisioning task.

Requires permission to access the StartThingRegistrationTask action.

Public Method StopThingRegistrationTask(StopThingRegistrationTaskRequest)

Cancels a bulk thing provisioning task.

Requires permission to access the StopThingRegistrationTask action.

Public Method StopThingRegistrationTaskAsync(StopThingRegistrationTaskRequest, CancellationToken)

Cancels a bulk thing provisioning task.

Requires permission to access the StopThingRegistrationTask action.

Public Method TagResource(TagResourceRequest)

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

Requires permission to access the TagResource action.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

Requires permission to access the TagResource action.

Public Method TestAuthorization(TestAuthorizationRequest)

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

Requires permission to access the TestAuthorization action.

Public Method TestAuthorizationAsync(TestAuthorizationRequest, CancellationToken)

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

Requires permission to access the TestAuthorization action.

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 IoT device gateway.

Requires permission to access the TestInvokeAuthorizer action.

Public Method TestInvokeAuthorizerAsync(TestInvokeAuthorizerRequest, CancellationToken)

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

Requires permission to access the TestInvokeAuthorizer action.

Public Method TransferCertificate(string, string)

Transfers the specified certificate to the specified Amazon Web Services account.

Requires permission to access the TransferCertificate action.

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

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

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

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

Public Method TransferCertificate(TransferCertificateRequest)

Transfers the specified certificate to the specified Amazon Web Services account.

Requires permission to access the TransferCertificate action.

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

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

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

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

Public Method TransferCertificateAsync(string, string, CancellationToken)

Transfers the specified certificate to the specified Amazon Web Services account.

Requires permission to access the TransferCertificate action.

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

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

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

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

Public Method TransferCertificateAsync(TransferCertificateRequest, CancellationToken)

Transfers the specified certificate to the specified Amazon Web Services account.

Requires permission to access the TransferCertificate action.

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

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

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

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

Public Method UntagResource(UntagResourceRequest)

Removes the given tags (metadata) from the resource.

Requires permission to access the UntagResource action.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes the given tags (metadata) from the resource.

Requires permission to access the UntagResource action.

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.

Requires permission to access the UpdateAccountAuditConfiguration action.

Public Method UpdateAccountAuditConfigurationAsync(UpdateAccountAuditConfigurationRequest, CancellationToken)

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

Requires permission to access the UpdateAccountAuditConfiguration action.

Public Method UpdateAuditSuppression(UpdateAuditSuppressionRequest)

Updates a Device Defender audit suppression.

Public Method UpdateAuditSuppressionAsync(UpdateAuditSuppressionRequest, CancellationToken)

Updates a Device Defender audit suppression.

Public Method UpdateAuthorizer(UpdateAuthorizerRequest)

Updates an authorizer.

Requires permission to access the UpdateAuthorizer action.

Public Method UpdateAuthorizerAsync(UpdateAuthorizerRequest, CancellationToken)

Updates an authorizer.

Requires permission to access the UpdateAuthorizer action.

Public Method UpdateBillingGroup(UpdateBillingGroupRequest)

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup action.

Public Method UpdateBillingGroupAsync(UpdateBillingGroupRequest, CancellationToken)

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup action.

Public Method UpdateCACertificate(UpdateCACertificateRequest)

Updates a registered CA certificate.

Requires permission to access the UpdateCACertificate action.

Public Method UpdateCACertificateAsync(UpdateCACertificateRequest, CancellationToken)

Updates a registered CA certificate.

Requires permission to access the UpdateCACertificate action.

Public Method UpdateCertificate(string, CertificateStatus)

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

Requires permission to access the UpdateCertificate action.

Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

Public Method UpdateCertificate(UpdateCertificateRequest)

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

Requires permission to access the UpdateCertificate action.

Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

Public Method UpdateCertificateAsync(string, CertificateStatus, CancellationToken)

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

Requires permission to access the UpdateCertificate action.

Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

Public Method UpdateCertificateAsync(UpdateCertificateRequest, CancellationToken)

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

Requires permission to access the UpdateCertificate action.

Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

Public Method UpdateCustomMetric(UpdateCustomMetricRequest)

Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric action.

Public Method UpdateCustomMetricAsync(UpdateCustomMetricRequest, CancellationToken)

Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric action.

Public Method UpdateDimension(UpdateDimensionRequest)

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

Requires permission to access the UpdateDimension action.

Public Method UpdateDimensionAsync(UpdateDimensionRequest, CancellationToken)

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

Requires permission to access the UpdateDimension action.

Public Method UpdateDomainConfiguration(UpdateDomainConfigurationRequest)

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

Requires permission to access the UpdateDomainConfiguration action.

Public Method UpdateDomainConfigurationAsync(UpdateDomainConfigurationRequest, CancellationToken)

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

Requires permission to access the UpdateDomainConfiguration action.

Public Method UpdateDynamicThingGroup(UpdateDynamicThingGroupRequest)

Updates a dynamic thing group.

Requires permission to access the UpdateDynamicThingGroup action.

Public Method UpdateDynamicThingGroupAsync(UpdateDynamicThingGroupRequest, CancellationToken)

Updates a dynamic thing group.

Requires permission to access the UpdateDynamicThingGroup action.

Public Method UpdateEventConfigurations(UpdateEventConfigurationsRequest)

Updates the event configurations.

Requires permission to access the UpdateEventConfigurations action.

Public Method UpdateEventConfigurationsAsync(UpdateEventConfigurationsRequest, CancellationToken)

Updates the event configurations.

Requires permission to access the UpdateEventConfigurations action.

Public Method UpdateFleetMetric(UpdateFleetMetricRequest)

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

Public Method UpdateFleetMetricAsync(UpdateFleetMetricRequest, CancellationToken)

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

Public Method UpdateIndexingConfiguration(UpdateIndexingConfigurationRequest)

Updates the search configuration.

Requires permission to access the UpdateIndexingConfiguration action.

Public Method UpdateIndexingConfigurationAsync(UpdateIndexingConfigurationRequest, CancellationToken)

Updates the search configuration.

Requires permission to access the UpdateIndexingConfiguration action.

Public Method UpdateJob(UpdateJobRequest)

Updates supported fields of the specified job.

Requires permission to access the UpdateJob action.

Public Method UpdateJobAsync(UpdateJobRequest, CancellationToken)

Updates supported fields of the specified job.

Requires permission to access the UpdateJob action.

Public Method UpdateMitigationAction(UpdateMitigationActionRequest)

Updates the definition for the specified mitigation action.

Requires permission to access the UpdateMitigationAction action.

Public Method UpdateMitigationActionAsync(UpdateMitigationActionRequest, CancellationToken)

Updates the definition for the specified mitigation action.

Requires permission to access the UpdateMitigationAction action.

Public Method UpdateProvisioningTemplate(UpdateProvisioningTemplateRequest)

Updates a provisioning template.

Requires permission to access the UpdateProvisioningTemplate action.

Public Method UpdateProvisioningTemplateAsync(UpdateProvisioningTemplateRequest, CancellationToken)

Updates a provisioning template.

Requires permission to access the UpdateProvisioningTemplate action.

Public Method UpdateRoleAlias(UpdateRoleAliasRequest)

Updates a role alias.

Requires permission to access the UpdateRoleAlias action.

Public Method UpdateRoleAliasAsync(UpdateRoleAliasRequest, CancellationToken)

Updates a role alias.

Requires permission to access the UpdateRoleAlias action.

Public Method UpdateScheduledAudit(UpdateScheduledAuditRequest)

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

Requires permission to access the UpdateScheduledAudit action.

Public Method UpdateScheduledAuditAsync(UpdateScheduledAuditRequest, CancellationToken)

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

Requires permission to access the UpdateScheduledAudit action.

Public Method UpdateSecurityProfile(UpdateSecurityProfileRequest)

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

Public Method UpdateSecurityProfileAsync(UpdateSecurityProfileRequest, CancellationToken)

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

Public Method UpdateStream(UpdateStreamRequest)

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

Requires permission to access the UpdateStream action.

Public Method UpdateStreamAsync(UpdateStreamRequest, CancellationToken)

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

Requires permission to access the UpdateStream action.

Public Method UpdateThing(UpdateThingRequest)

Updates the data for a thing.

Requires permission to access the UpdateThing action.

Public Method UpdateThingAsync(UpdateThingRequest, CancellationToken)

Updates the data for a thing.

Requires permission to access the UpdateThing action.

Public Method UpdateThingGroup(UpdateThingGroupRequest)

Update a thing group.

Requires permission to access the UpdateThingGroup action.

Public Method UpdateThingGroupAsync(UpdateThingGroupRequest, CancellationToken)

Update a thing group.

Requires permission to access the UpdateThingGroup action.

Public Method UpdateThingGroupsForThing(UpdateThingGroupsForThingRequest)

Updates the groups to which the thing belongs.

Requires permission to access the UpdateThingGroupsForThing action.

Public Method UpdateThingGroupsForThingAsync(UpdateThingGroupsForThingRequest, CancellationToken)

Updates the groups to which the thing belongs.

Requires permission to access the UpdateThingGroupsForThing action.

Public Method UpdateTopicRuleDestination(UpdateTopicRuleDestinationRequest)

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

Requires permission to access the UpdateTopicRuleDestination action.

Public Method UpdateTopicRuleDestinationAsync(UpdateTopicRuleDestinationRequest, CancellationToken)

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

Requires permission to access the UpdateTopicRuleDestination action.

Public Method ValidateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest)

Validates a Device Defender security profile behaviors specification.

Requires permission to access the ValidateSecurityProfileBehaviors action.

Public Method ValidateSecurityProfileBehaviorsAsync(ValidateSecurityProfileBehaviorsRequest, CancellationToken)

Validates a Device Defender security profile behaviors specification.

Requires permission to access the ValidateSecurityProfileBehaviors action.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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