Iot

accept_certificate_transfer(certificate_id)
accept_certificate_transfer(certificate_id, params::Dict{String,<:Any})

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.

Arguments

• certificate_id: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "setAsActive": Specifies whether the certificate is active.

add_thing_to_billing_group()
add_thing_to_billing_group(params::Dict{String,<:Any})

Adds a thing to a billing group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "billingGroupArn": The ARN of the billing group.
• "billingGroupName": The name of the billing group.
• "thingArn": The ARN of the thing to be added to the billing group.
• "thingName": The name of the thing to be added to the billing group.

add_thing_to_thing_group()
add_thing_to_thing_group(params::Dict{String,<:Any})

Adds a thing to a thing group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "overrideDynamicGroups": Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
• "thingArn": The ARN of the thing to add to a group.
• "thingGroupArn": The ARN of the group to which you are adding a thing.
• "thingGroupName": The name of the group to which you are adding a thing.
• "thingName": The name of the thing to add to a group.

associate_targets_with_job(job_id, targets)
associate_targets_with_job(job_id, targets, params::Dict{String,<:Any})

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.

Arguments

• job_id: The unique identifier you assigned to this job when it was created.
• targets: A list of thing group ARNs that define the targets of the job.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "comment": An optional comment string describing why the job was associated with the targets.
• "namespaceId": The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. aws/things/THINGNAME/jobs/JOBID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.

attach_policy(policy_name, target)
attach_policy(policy_name, target, params::Dict{String,<:Any})

Attaches a policy to the specified target.

Arguments

• policy_name: The name of the policy to attach.
• target: The identity to which the policy is attached. For example, a thing group or a certificate.

attach_principal_policy(policy_name, x-amzn-iot-principal)
attach_principal_policy(policy_name, x-amzn-iot-principal, params::Dict{String,<:Any})

Attaches the specified policy to the specified principal (certificate or other credential). Note: This API is deprecated. Please use AttachPolicy instead.

Arguments

• policy_name: The policy name.
• x-amzn-iot-principal: The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

attach_security_profile(security_profile_name, security_profile_target_arn)
attach_security_profile(security_profile_name, security_profile_target_arn, params::Dict{String,<:Any})

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.

Arguments

• security_profile_name: The security profile that is attached.
• security_profile_target_arn: The ARN of the target (thing group) to which the security profile is attached.

attach_thing_principal(thing_name, x-amzn-principal)
attach_thing_principal(thing_name, x-amzn-principal, params::Dict{String,<:Any})

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.

Arguments

• thing_name: The name of the thing.
• x-amzn-principal: The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

cancel_audit_mitigation_actions_task(task_id)
cancel_audit_mitigation_actions_task(task_id, params::Dict{String,<:Any})

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

Arguments

• task_id: The unique identifier for the task that you want to cancel.

cancel_audit_task(task_id)
cancel_audit_task(task_id, params::Dict{String,<:Any})

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.

Arguments

• task_id: The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".

cancel_certificate_transfer(certificate_id)
cancel_certificate_transfer(certificate_id, params::Dict{String,<:Any})

Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

Arguments

• certificate_id: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

cancel_detect_mitigation_actions_task(task_id)
cancel_detect_mitigation_actions_task(task_id, params::Dict{String,<:Any})

Cancels a Device Defender ML Detect mitigation action.

Arguments

• task_id: The unique identifier of the task.

cancel_job(job_id)
cancel_job(job_id, params::Dict{String,<:Any})

Cancels a job.

Arguments

• job_id: The unique identifier you assigned to this job when it was created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "comment": An optional comment string describing why the job was canceled.
• "force": (Optional) If true job executions with status "INPROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false. Canceling a job which is "INPROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.
• "reasonCode": (Optional)A reason code string that explains why the job was canceled.

cancel_job_execution(job_id, thing_name)
cancel_job_execution(job_id, thing_name, params::Dict{String,<:Any})

Cancels the execution of a job for a given thing.

Arguments

• job_id: The ID of the job to be canceled.
• thing_name: The name of the thing whose execution of the job will be canceled.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "expectedVersion": (Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
• "force": (Optional) If true the job execution will be canceled if it has status INPROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is INPROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false. Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
• "statusDetails": A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

clear_default_authorizer()
clear_default_authorizer(params::Dict{String,<:Any})

Clears the default authorizer.

confirm_topic_rule_destination(confirmation_token)
confirm_topic_rule_destination(confirmation_token, params::Dict{String,<:Any})

Confirms a topic rule destination. When you create a rule requiring a destination, AWS 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.

Arguments

• confirmation_token: The token used to confirm ownership or access to the topic rule confirmation URL.

create_audit_suppression(check_name, client_request_token, resource_identifier)
create_audit_suppression(check_name, client_request_token, resource_identifier, params::Dict{String,<:Any})

Creates a Device Defender audit suppression.

Arguments

• check_name:
• client_request_token: The epoch timestamp in seconds at which this suppression expires.
• resource_identifier:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of the audit suppression.
• "expirationDate": The epoch timestamp in seconds at which this suppression expires.
• "suppressIndefinitely": Indicates whether a suppression should exist indefinitely or not.

create_authorizer(authorizer_function_arn, authorizer_name)
create_authorizer(authorizer_function_arn, authorizer_name, params::Dict{String,<:Any})

Creates an authorizer.

Arguments

• authorizer_function_arn: The ARN of the authorizer's Lambda function.
• authorizer_name: The authorizer name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "signingDisabled": Specifies whether AWS IoT validates the token signature in an authorization request.
• "status": The status of the create authorizer request.
• "tags": Metadata which can be used to manage the custom authorizer. For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
• "tokenKeyName": The name of the token key used to extract the token from the HTTP headers.
• "tokenSigningPublicKeys": The public keys used to verify the digital signature returned by your custom authentication service.

create_billing_group(billing_group_name)
create_billing_group(billing_group_name, params::Dict{String,<:Any})

Creates a billing group.

Arguments

• billing_group_name: The name you wish to give to the billing group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "billingGroupProperties": The properties of the billing group.
• "tags": Metadata which can be used to manage the billing group.

create_certificate_from_csr(certificate_signing_request)
create_certificate_from_csr(certificate_signing_request, params::Dict{String,<:Any})

Creates an X.509 certificate using the specified certificate signing request. Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. Note: Reusing the same certificate signing request (CSR) results in a distinct certificate. You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. Assuming a set of CSRs are located inside of the directory my-csr-directory: On Linux and OS X, the command is: ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr –certificate-signing-request file://my-csr-directory/{} This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR. The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr –certificate-signing-request file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr –certificate-signing-request file://my-csr-directory/_} On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr –certificate-signing-request file://@path"

Arguments

• certificate_signing_request: The certificate signing request (CSR).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "setAsActive": Specifies whether the certificate is active.

create_custom_metric(client_request_token, metric_name, metric_type)
create_custom_metric(client_request_token, metric_name, metric_type, params::Dict{String,<:Any})

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

Arguments

• client_request_token: Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
• metric_name: The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.
• metric_type: The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "displayName": Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
• "tags": Metadata that can be used to manage the custom metric.

create_dimension(client_request_token, name, string_values, type)
create_dimension(client_request_token, name, string_values, type, params::Dict{String,<:Any})

Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS 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.

Arguments

• client_request_token: Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
• name: A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
• string_values: Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
• type: Specifies the type of dimension. Supported types: TOPIC_FILTER.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": Metadata that can be used to manage the dimension.

create_domain_configuration(domain_configuration_name)
create_domain_configuration(domain_configuration_name, params::Dict{String,<:Any})

Creates a domain configuration.

Arguments

• domain_configuration_name: The name of the domain configuration. This value must be unique to a region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "authorizerConfig": An object that specifies the authorization service for a domain.
• "domainName": The name of the domain.
• "serverCertificateArns": The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for AWS-managed domains.
• "serviceType": The type of service delivered by the endpoint. AWS IoT Core currently supports only the DATA service type.
• "tags": Metadata which can be used to manage the domain configuration. For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
• "validationCertificateArn": The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for AWS-managed domains.

create_dynamic_thing_group(query_string, thing_group_name)
create_dynamic_thing_group(query_string, thing_group_name, params::Dict{String,<:Any})

Creates a dynamic thing group.

Arguments

• query_string: The dynamic thing group search query string. See Query Syntax for information about query string syntax.
• thing_group_name: The dynamic thing group name to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "indexName": The dynamic thing group index name. Currently one index is supported: "AWS_Things".
• "queryVersion": The dynamic thing group query version. Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
• "tags": Metadata which can be used to manage the dynamic thing group.
• "thingGroupProperties": The dynamic thing group properties.

create_job(job_id, targets)
create_job(job_id, targets, params::Dict{String,<:Any})

Creates a job.

Arguments

• job_id: A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
• targets: A list of things and thing groups to which the job should be sent.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "abortConfig": Allows you to create criteria to abort a job.
• "description": A short text description of the job.
• "document": The job document. Required if you don't specify a value for documentSource.
• "documentSource": An S3 link to the job document. Required if you don't specify a value for document. If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document. The placeholder link is of the following form: {aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} where bucket is your bucket name and key is the object in the bucket to which you are linking.
• "jobExecutionsRolloutConfig": Allows you to create a staged rollout of the job.
• "jobTemplateArn": The ARN of the job template used to create the job.
• "namespaceId": The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. aws/things/THINGNAME/jobs/JOBID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
• "presignedUrlConfig": Configuration information for pre-signed S3 URLs.
• "tags": Metadata which can be used to manage the job.
• "targetSelection": Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
• "timeoutConfig": Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to INPROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMEDOUT.

create_job_template(description, job_template_id)
create_job_template(description, job_template_id, params::Dict{String,<:Any})

Creates a job template.

Arguments

• description: A description of the job document.
• job_template_id: A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "abortConfig":
• "document": The job document. Required if you don't specify a value for documentSource.
• "documentSource": An S3 link to the job document to use in the template. Required if you don't specify a value for document. If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document. The placeholder link is of the following form: {aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} where bucket is your bucket name and key is the object in the bucket to which you are linking.
• "jobArn": The ARN of the job to use as the basis for the job template.
• "jobExecutionsRolloutConfig":
• "presignedUrlConfig":
• "tags": Metadata that can be used to manage the job template.
• "timeoutConfig":

create_keys_and_certificate()
create_keys_and_certificate(params::Dict{String,<:Any})

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 AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "setAsActive": Specifies whether the certificate is active.

create_mitigation_action(action_name, action_params, role_arn)
create_mitigation_action(action_name, action_params, role_arn, params::Dict{String,<:Any})

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.

Arguments

• action_name: A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).
• action_params: Defines the type of action and the parameters for that action.
• role_arn: The ARN of the IAM role that is used to apply the mitigation action.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": Metadata that can be used to manage the mitigation action.

create_otaupdate(files, ota_update_id, role_arn, targets)
create_otaupdate(files, ota_update_id, role_arn, targets, params::Dict{String,<:Any})

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

Arguments

• files: The files to be streamed by the OTA update.
• ota_update_id: The ID of the OTA update to be created.
• role_arn: The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create an OTA update job.
• targets: The devices targeted to receive OTA updates.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "additionalParameters": A list of additional OTA update parameters which are name-value pairs.
• "awsJobAbortConfig": The criteria that determine when and how a job abort takes place.
• "awsJobExecutionsRolloutConfig": Configuration for the rollout of OTA updates.
• "awsJobPresignedUrlConfig": Configuration information for pre-signed URLs.
• "awsJobTimeoutConfig": Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to INPROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMEDOUT.
• "description": The description of the OTA update.
• "protocols": The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
• "tags": Metadata which can be used to manage updates.
• "targetSelection": Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

create_policy(policy_document, policy_name)
create_policy(policy_document, policy_name, params::Dict{String,<:Any})

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

Arguments

• policy_document: The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.
• policy_name: The policy name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": Metadata which can be used to manage the policy. For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

create_policy_version(policy_document, policy_name)
create_policy_version(policy_document, policy_name, params::Dict{String,<:Any})

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one. Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Arguments

• policy_document: The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.
• policy_name: The policy name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "setAsDefault": Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

create_provisioning_claim(template_name)
create_provisioning_claim(template_name, params::Dict{String,<:Any})

Creates a provisioning claim.

Arguments

• template_name: The name of the provisioning template to use.

create_provisioning_template(provisioning_role_arn, template_body, template_name)
create_provisioning_template(provisioning_role_arn, template_body, template_name, params::Dict{String,<:Any})

Creates a fleet provisioning template.

Arguments

• provisioning_role_arn: The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
• template_body: The JSON formatted contents of the fleet provisioning template.
• template_name: The name of the fleet provisioning template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of the fleet provisioning template.
• "enabled": True to enable the fleet provisioning template, otherwise false.
• "preProvisioningHook": Creates a pre-provisioning hook template.
• "tags": Metadata which can be used to manage the fleet provisioning template. For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

create_provisioning_template_version(template_body, template_name)
create_provisioning_template_version(template_body, template_name, params::Dict{String,<:Any})

Creates a new version of a fleet provisioning template.

Arguments

• template_body: The JSON formatted contents of the fleet provisioning template.
• template_name: The name of the fleet provisioning template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "setAsDefault": Sets a fleet provision template version as the default version.

create_role_alias(role_alias, role_arn)
create_role_alias(role_alias, role_arn, params::Dict{String,<:Any})

Creates a role alias.

Arguments

• role_alias: The role alias that points to a role ARN. This allows you to change the role without having to update the device.
• role_arn: The role ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "credentialDurationSeconds": How long (in seconds) the credentials will be valid.
• "tags": Metadata which can be used to manage the role alias. For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

create_scheduled_audit(frequency, scheduled_audit_name, target_check_names)
create_scheduled_audit(frequency, scheduled_audit_name, target_check_names, params::Dict{String,<:Any})

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

Arguments

• frequency: How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is determined by the system.
• scheduled_audit_name: The name you want to give to the scheduled audit. (Max. 128 chars)
• target_check_names: Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "dayOfMonth": The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the LAST day of the month.
• "dayOfWeek": The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
• "tags": Metadata that can be used to manage the scheduled audit.

create_security_profile(security_profile_name)
create_security_profile(security_profile_name, params::Dict{String,<:Any})

Creates a Device Defender security profile.

Arguments

• security_profile_name: The name you are giving to the security profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "additionalMetricsToRetain": Please use CreateSecurityProfileRequestadditionalMetricsToRetainV2 instead. A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
• "additionalMetricsToRetainV2": A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
• "alertTargets": Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
• "behaviors": Specifies the behaviors that, when violated by a device (thing), cause an alert.
• "securityProfileDescription": A description of the security profile.
• "tags": Metadata that can be used to manage the security profile.

create_stream(files, role_arn, stream_id)
create_stream(files, role_arn, stream_id, params::Dict{String,<:Any})

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.

Arguments

• files: The files to stream.
• role_arn: An IAM role that allows the IoT service principal assumes to access your S3 files.
• stream_id: The stream ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description of the stream.
• "tags": Metadata which can be used to manage streams.

create_thing(thing_name)
create_thing(thing_name, params::Dict{String,<:Any})

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.

Arguments

• thing_name: The name of the thing to create. You can't change a thing's name after you create it. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "attributePayload": The attribute payload, which consists of up to three name/value pairs in a JSON document. For example: {"attributes":{"string1":"string2"}}
• "billingGroupName": The name of the billing group the thing will be added to.
• "thingTypeName": The name of the thing type associated with the new thing.

create_thing_group(thing_group_name)
create_thing_group(thing_group_name, params::Dict{String,<:Any})

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

Arguments

• thing_group_name: The thing group name to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "parentGroupName": The name of the parent thing group.
• "tags": Metadata which can be used to manage the thing group.
• "thingGroupProperties": The thing group properties.

create_thing_type(thing_type_name)
create_thing_type(thing_type_name, params::Dict{String,<:Any})

Creates a new thing type.

Arguments

• thing_type_name: The name of the thing type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": Metadata which can be used to manage the thing type.
• "thingTypeProperties": The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.

create_topic_rule(rule_name, topic_rule_payload)
create_topic_rule(rule_name, topic_rule_payload, params::Dict{String,<:Any})

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.

Arguments

• rule_name: The name of the rule.
• topic_rule_payload: The rule payload.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "x-amz-tagging": Metadata which can be used to manage the topic rule. For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: –tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

create_topic_rule_destination(destination_configuration)
create_topic_rule_destination(destination_configuration, params::Dict{String,<:Any})

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

Arguments

• destination_configuration: The topic rule destination configuration.

delete_account_audit_configuration()
delete_account_audit_configuration(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "deleteScheduledAudits": If true, all scheduled audits are deleted.

delete_audit_suppression(check_name, resource_identifier)
delete_audit_suppression(check_name, resource_identifier, params::Dict{String,<:Any})

Deletes a Device Defender audit suppression.

Arguments

• check_name:
• resource_identifier:

delete_authorizer(authorizer_name)
delete_authorizer(authorizer_name, params::Dict{String,<:Any})

Deletes an authorizer.

Arguments

• authorizer_name: The name of the authorizer to delete.

delete_billing_group(billing_group_name)
delete_billing_group(billing_group_name, params::Dict{String,<:Any})

Deletes the billing group.

Arguments

• billing_group_name: The name of the billing group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "expectedVersion": The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException.

delete_cacertificate(ca_certificate_id)
delete_cacertificate(ca_certificate_id, params::Dict{String,<:Any})

Deletes a registered CA certificate.

Arguments

• ca_certificate_id: The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)

delete_certificate(certificate_id)
delete_certificate(certificate_id, params::Dict{String,<:Any})

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 DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.

Arguments

• certificate_id: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "forceDelete": Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.

delete_custom_metric(metric_name)
delete_custom_metric(metric_name, params::Dict{String,<:Any})

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. Deletes a Device Defender detect custom metric.

Arguments

• metric_name: The name of the custom metric.

delete_dimension(name)
delete_dimension(name, params::Dict{String,<:Any})

Removes the specified dimension from your AWS account.

Arguments

• name: The unique identifier for the dimension that you want to delete.

delete_domain_configuration(domain_configuration_name)
delete_domain_configuration(domain_configuration_name, params::Dict{String,<:Any})

Deletes the specified domain configuration.

Arguments

• domain_configuration_name: The name of the domain configuration to be deleted.

delete_dynamic_thing_group(thing_group_name)
delete_dynamic_thing_group(thing_group_name, params::Dict{String,<:Any})

Deletes a dynamic thing group.

Arguments

• thing_group_name: The name of the dynamic thing group to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "expectedVersion": The expected version of the dynamic thing group to delete.

delete_job(job_id)
delete_job(job_id, params::Dict{String,<:Any})

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 "DELETIONINPROGRESS". Attempting to delete or cancel a job whose status is already "DELETIONINPROGRESS" will result in an error. Only 10 jobs may have status "DELETIONINPROGRESS" at the same time, or a LimitExceededException will occur.

Arguments

• job_id: The ID of the job to be deleted. After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "force": (Optional) When true, you can delete a job which is "INPROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false. Deleting a job which is "INPROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.
• "namespaceId": The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. aws/things/THINGNAME/jobs/JOBID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.

delete_job_execution(execution_number, job_id, thing_name)
delete_job_execution(execution_number, job_id, thing_name, params::Dict{String,<:Any})

Deletes a job execution.

Arguments

• execution_number: The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device. Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.
• job_id: The ID of the job whose execution on a particular device will be deleted.
• thing_name: The name of the thing whose job execution will be deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "force": (Optional) When true, you can delete a job execution which is "INPROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false. Deleting a job execution which is "INPROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
• "namespaceId": The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. aws/things/THINGNAME/jobs/JOBID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.

delete_job_template(job_template_id)
delete_job_template(job_template_id, params::Dict{String,<:Any})

Deletes the specified job template.

Arguments

• job_template_id: The unique identifier of the job template to delete.

delete_mitigation_action(action_name)
delete_mitigation_action(action_name, params::Dict{String,<:Any})

Deletes a defined mitigation action from your AWS account.

Arguments

• action_name: The name of the mitigation action that you want to delete.

delete_otaupdate(ota_update_id)
delete_otaupdate(ota_update_id, params::Dict{String,<:Any})

Delete an OTA update.

Arguments

• ota_update_id: The ID of the OTA update to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "deleteStream": When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.
• "forceDeleteAWSJob": When true, deletes the AWS job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

delete_policy(policy_name)
delete_policy(policy_name, params::Dict{String,<:Any})

Deletes the specified policy. A policy cannot be deleted if it has non-default versions or it is attached to any certificate. To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it.

Arguments

• policy_name: The name of the policy to delete.

delete_policy_version(policy_name, policy_version_id)
delete_policy_version(policy_name, policy_version_id, params::Dict{String,<:Any})

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

Arguments

• policy_name: The name of the policy.
• policy_version_id: The policy version ID.

delete_provisioning_template(template_name)
delete_provisioning_template(template_name, params::Dict{String,<:Any})

Deletes a fleet provisioning template.

Arguments

• template_name: The name of the fleet provision template to delete.

delete_provisioning_template_version(template_name, version_id)
delete_provisioning_template_version(template_name, version_id, params::Dict{String,<:Any})

Deletes a fleet provisioning template version.

Arguments

• template_name: The name of the fleet provisioning template version to delete.
• version_id: The fleet provisioning template version ID to delete.

delete_registration_code()
delete_registration_code(params::Dict{String,<:Any})

Deletes a CA certificate registration code.

delete_role_alias(role_alias)
delete_role_alias(role_alias, params::Dict{String,<:Any})

Deletes a role alias

Arguments

• role_alias: The role alias to delete.

delete_scheduled_audit(scheduled_audit_name)
delete_scheduled_audit(scheduled_audit_name, params::Dict{String,<:Any})

Deletes a scheduled audit.

Arguments

• scheduled_audit_name: The name of the scheduled audit you want to delete.

delete_security_profile(security_profile_name)
delete_security_profile(security_profile_name, params::Dict{String,<:Any})

Deletes a Device Defender security profile.

Arguments

• security_profile_name: The name of the security profile to be deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "expectedVersion": The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

delete_stream(stream_id)
delete_stream(stream_id, params::Dict{String,<:Any})

Deletes a stream.

Arguments

• stream_id: The stream ID.

delete_thing(thing_name)
delete_thing(thing_name, params::Dict{String,<:Any})

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

Arguments

• thing_name: The name of the thing to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "expectedVersion": The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException.

delete_thing_group(thing_group_name)
delete_thing_group(thing_group_name, params::Dict{String,<:Any})

Deletes a thing group.

Arguments

• thing_group_name: The name of the thing group to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "expectedVersion": The expected version of the thing group to delete.

delete_thing_type(thing_type_name)
delete_thing_type(thing_type_name, params::Dict{String,<:Any})

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.

Arguments

• thing_type_name: The name of the thing type.

delete_topic_rule(rule_name)
delete_topic_rule(rule_name, params::Dict{String,<:Any})

Deletes the rule.

Arguments

• rule_name: The name of the rule.

delete_topic_rule_destination(arn)
delete_topic_rule_destination(arn, params::Dict{String,<:Any})

Deletes a topic rule destination.

Arguments

• arn: The ARN of the topic rule destination to delete.

delete_v2_logging_level(target_name, target_type)
delete_v2_logging_level(target_name, target_type, params::Dict{String,<:Any})

Deletes a logging level.

Arguments

• target_name: The name of the resource for which you are configuring logging.
• target_type: The type of resource for which you are configuring logging. Must be THING_Group.

deprecate_thing_type(thing_type_name)
deprecate_thing_type(thing_type_name, params::Dict{String,<:Any})

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

Arguments

• thing_type_name: The name of the thing type to deprecate.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "undoDeprecate": Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

describe_account_audit_configuration()
describe_account_audit_configuration(params::Dict{String,<:Any})

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.

describe_audit_finding(finding_id)
describe_audit_finding(finding_id, params::Dict{String,<:Any})

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.

Arguments

• finding_id: A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

describe_audit_mitigation_actions_task(task_id)
describe_audit_mitigation_actions_task(task_id, params::Dict{String,<:Any})

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.

Arguments

• task_id: The unique identifier for the audit mitigation task.

describe_audit_suppression(check_name, resource_identifier)
describe_audit_suppression(check_name, resource_identifier, params::Dict{String,<:Any})

Gets information about a Device Defender audit suppression.

Arguments

• check_name:
• resource_identifier:

describe_audit_task(task_id)
describe_audit_task(task_id, params::Dict{String,<:Any})

Gets information about a Device Defender audit.

Arguments

• task_id: The ID of the audit whose information you want to get.

describe_authorizer(authorizer_name)
describe_authorizer(authorizer_name, params::Dict{String,<:Any})

Describes an authorizer.

Arguments

• authorizer_name: The name of the authorizer to describe.

describe_billing_group(billing_group_name)
describe_billing_group(billing_group_name, params::Dict{String,<:Any})

Returns information about a billing group.

Arguments

• billing_group_name: The name of the billing group.

describe_cacertificate(ca_certificate_id)
describe_cacertificate(ca_certificate_id, params::Dict{String,<:Any})

Describes a registered CA certificate.

Arguments

• ca_certificate_id: The CA certificate identifier.

describe_certificate(certificate_id)
describe_certificate(certificate_id, params::Dict{String,<:Any})

Gets information about the specified certificate.

Arguments

• certificate_id: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

describe_custom_metric(metric_name)
describe_custom_metric(metric_name, params::Dict{String,<:Any})

Gets information about a Device Defender detect custom metric.

Arguments

• metric_name: The name of the custom metric.

describe_default_authorizer()
describe_default_authorizer(params::Dict{String,<:Any})

Describes the default authorizer.

describe_detect_mitigation_actions_task(task_id)
describe_detect_mitigation_actions_task(task_id, params::Dict{String,<:Any})

Gets information about a Device Defender ML Detect mitigation action.

Arguments

• task_id: The unique identifier of the task.

describe_dimension(name)
describe_dimension(name, params::Dict{String,<:Any})

Provides details about a dimension that is defined in your AWS account.

Arguments

• name: The unique identifier for the dimension.

describe_domain_configuration(domain_configuration_name)
describe_domain_configuration(domain_configuration_name, params::Dict{String,<:Any})

Gets summary information about a domain configuration.

Arguments

• domain_configuration_name: The name of the domain configuration.

describe_endpoint()
describe_endpoint(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "endpointType": The endpoint type. Valid endpoint types include: iot:Data - Returns a VeriSign signed data endpoint. iot:Data-ATS - Returns an ATS signed data endpoint. iot:CredentialProvider - Returns an AWS IoT credentials provider API endpoint. iot:Jobs - Returns an AWS IoT device management Jobs API endpoint. We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.

describe_event_configurations()
describe_event_configurations(params::Dict{String,<:Any})

Describes event configurations.

describe_index(index_name)
describe_index(index_name, params::Dict{String,<:Any})

Describes a search index.

Arguments

• index_name: The index name.

describe_job(job_id)
describe_job(job_id, params::Dict{String,<:Any})

Describes a job.

Arguments

• job_id: The unique identifier you assigned to this job when it was created.

describe_job_execution(job_id, thing_name)
describe_job_execution(job_id, thing_name, params::Dict{String,<:Any})

Describes a job execution.

Arguments

• job_id: The unique identifier you assigned to this job when it was created.
• thing_name: The name of the thing on which the job execution is running.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "executionNumber": A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.

describe_job_template(job_template_id)
describe_job_template(job_template_id, params::Dict{String,<:Any})

Returns information about a job template.

Arguments

• job_template_id: The unique identifier of the job template.

describe_mitigation_action(action_name)
describe_mitigation_action(action_name, params::Dict{String,<:Any})

Gets information about a mitigation action.

Arguments

• action_name: The friendly name that uniquely identifies the mitigation action.

describe_provisioning_template(template_name)
describe_provisioning_template(template_name, params::Dict{String,<:Any})

Returns information about a fleet provisioning template.

Arguments

• template_name: The name of the fleet provisioning template.

describe_provisioning_template_version(template_name, version_id)
describe_provisioning_template_version(template_name, version_id, params::Dict{String,<:Any})

Returns information about a fleet provisioning template version.

Arguments

• template_name: The template name.
• version_id: The fleet provisioning template version ID.

describe_role_alias(role_alias)
describe_role_alias(role_alias, params::Dict{String,<:Any})

Describes a role alias.

Arguments

• role_alias: The role alias to describe.

describe_scheduled_audit(scheduled_audit_name)
describe_scheduled_audit(scheduled_audit_name, params::Dict{String,<:Any})

Gets information about a scheduled audit.

Arguments

• scheduled_audit_name: The name of the scheduled audit whose information you want to get.

describe_security_profile(security_profile_name)
describe_security_profile(security_profile_name, params::Dict{String,<:Any})

Gets information about a Device Defender security profile.

Arguments

• security_profile_name: The name of the security profile whose information you want to get.

describe_stream(stream_id)
describe_stream(stream_id, params::Dict{String,<:Any})

Gets information about a stream.

Arguments

• stream_id: The stream ID.

describe_thing(thing_name)
describe_thing(thing_name, params::Dict{String,<:Any})

Gets information about the specified thing.

Arguments

• thing_name: The name of the thing.

describe_thing_group(thing_group_name)
describe_thing_group(thing_group_name, params::Dict{String,<:Any})

Describe a thing group.

Arguments

• thing_group_name: The name of the thing group.

describe_thing_registration_task(task_id)
describe_thing_registration_task(task_id, params::Dict{String,<:Any})

Describes a bulk thing provisioning task.

Arguments

• task_id: The task ID.

describe_thing_type(thing_type_name)
describe_thing_type(thing_type_name, params::Dict{String,<:Any})

Gets information about the specified thing type.

Arguments

• thing_type_name: The name of the thing type.

detach_policy(policy_name, target)
detach_policy(policy_name, target, params::Dict{String,<:Any})

Detaches a policy from the specified target.

Arguments

• policy_name: The policy to detach.
• target: The target from which the policy will be detached.

detach_principal_policy(policy_name, x-amzn-iot-principal)
detach_principal_policy(policy_name, x-amzn-iot-principal, params::Dict{String,<:Any})

Removes the specified policy from the specified certificate. Note: This API is deprecated. Please use DetachPolicy instead.

Arguments

• policy_name: The name of the policy to detach.
• x-amzn-iot-principal: The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

detach_security_profile(security_profile_name, security_profile_target_arn)
detach_security_profile(security_profile_name, security_profile_target_arn, params::Dict{String,<:Any})

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

Arguments

• security_profile_name: The security profile that is detached.
• security_profile_target_arn: The ARN of the thing group from which the security profile is detached.

detach_thing_principal(thing_name, x-amzn-principal)
detach_thing_principal(thing_name, x-amzn-principal, params::Dict{String,<:Any})

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.

Arguments

• thing_name: The name of the thing.
• x-amzn-principal: If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.

disable_topic_rule(rule_name)
disable_topic_rule(rule_name, params::Dict{String,<:Any})

Disables the rule.

Arguments

• rule_name: The name of the rule to disable.

enable_topic_rule(rule_name)
enable_topic_rule(rule_name, params::Dict{String,<:Any})

Enables the rule.

Arguments

• rule_name: The name of the topic rule to enable.

get_behavior_model_training_summaries()
get_behavior_model_training_summaries(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.
• "securityProfileName": The name of the security profile.

get_cardinality(query_string)
get_cardinality(query_string, params::Dict{String,<:Any})

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

Arguments

• query_string: The search query.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "aggregationField": The field to aggregate.
• "indexName": The name of the index to search.
• "queryVersion": The query version.

get_effective_policies()
get_effective_policies(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "cognitoIdentityPoolId": The Cognito identity pool ID.
• "principal": The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
• "thingName": The thing name.

get_indexing_configuration()
get_indexing_configuration(params::Dict{String,<:Any})

Gets the indexing configuration.

get_job_document(job_id)
get_job_document(job_id, params::Dict{String,<:Any})

Gets a job document.

Arguments

• job_id: The unique identifier you assigned to this job when it was created.

get_logging_options()
get_logging_options(params::Dict{String,<:Any})

Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

get_otaupdate(ota_update_id)
get_otaupdate(ota_update_id, params::Dict{String,<:Any})

Gets an OTA update.

Arguments

• ota_update_id: The OTA update ID.

get_percentiles(query_string)
get_percentiles(query_string, params::Dict{String,<:Any})

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.

Arguments

• query_string: The query string.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "aggregationField": The field to aggregate.
• "indexName": The name of the index to search.
• "percents": The percentile groups returned.
• "queryVersion": The query version.

get_policy(policy_name)
get_policy(policy_name, params::Dict{String,<:Any})

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

Arguments

• policy_name: The name of the policy.

get_policy_version(policy_name, policy_version_id)
get_policy_version(policy_name, policy_version_id, params::Dict{String,<:Any})

Gets information about the specified policy version.

Arguments

• policy_name: The name of the policy.
• policy_version_id: The policy version ID.

get_registration_code()
get_registration_code(params::Dict{String,<:Any})

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

get_statistics(query_string)
get_statistics(query_string, params::Dict{String,<:Any})

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.

Arguments

• query_string: The query used to search. You can specify "*" for the query string to get the count of all indexed things in your AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "aggregationField": The aggregation field name.
• "indexName": The name of the index to search. The default value is AWS_Things.
• "queryVersion": The version of the query used to search.

get_topic_rule(rule_name)
get_topic_rule(rule_name, params::Dict{String,<:Any})

Gets information about the rule.

Arguments

• rule_name: The name of the rule.

get_topic_rule_destination(arn)
get_topic_rule_destination(arn, params::Dict{String,<:Any})

Gets information about a topic rule destination.

Arguments

• arn: The ARN of the topic rule destination.

get_v2_logging_options()
get_v2_logging_options(params::Dict{String,<:Any})

Gets the fine grained logging options.

list_active_violations()
list_active_violations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "behaviorCriteriaType": The criteria for a behavior.
• "listSuppressedAlerts": A list of all suppressed alerts.
• "maxResults": The maximum number of results to return at one time.
• "nextToken": The token for the next set of results.
• "securityProfileName": The name of the Device Defender security profile for which violations are listed.
• "thingName": The name of the thing whose active violations are listed.

list_attached_policies(target)
list_attached_policies(target, params::Dict{String,<:Any})

Lists the policies attached to the specified thing group.

Arguments

• target: The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "marker": The token to retrieve the next set of results.
• "pageSize": The maximum number of results to be returned per request.
• "recursive": When true, recursively list attached policies.

list_audit_findings()
list_audit_findings(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "checkName": A filter to limit results to the findings for the specified audit check.
• "endTime": A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.
• "listSuppressedFindings": Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both suppressed and unsuppressed findings.
• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.
• "resourceIdentifier": Information identifying the noncompliant resource.
• "startTime": A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
• "taskId": A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.

list_audit_mitigation_actions_executions(finding_id, task_id)
list_audit_mitigation_actions_executions(finding_id, task_id, params::Dict{String,<:Any})

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

Arguments

• finding_id: Specify this filter to limit results to those that were applied to a specific audit finding.
• task_id: Specify this filter to limit results to actions for a specific audit mitigation actions task.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "actionStatus": Specify this filter to limit results to those with a specific status.
• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.

list_audit_mitigation_actions_tasks(end_time, start_time)
list_audit_mitigation_actions_tasks(end_time, start_time, params::Dict{String,<:Any})

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

Arguments

• end_time: Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.
• start_time: Specify this filter to limit results to tasks that began on or after a specific date and time.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "auditTaskId": Specify this filter to limit results to tasks that were applied to results for a specific audit.
• "findingId": Specify this filter to limit results to tasks that were applied to a specific audit finding.
• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.
• "taskStatus": Specify this filter to limit results to tasks that are in a specific state.

list_audit_suppressions()
list_audit_suppressions(params::Dict{String,<:Any})

Lists your Device Defender audit listings.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ascendingOrder": Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, ascendingOrder=true.
• "checkName":
• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.
• "resourceIdentifier":

list_audit_tasks(end_time, start_time)
list_audit_tasks(end_time, start_time, params::Dict{String,<:Any})

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

Arguments

• end_time: The end of the time period.
• start_time: The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.
• "taskStatus": A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
• "taskType": A filter to limit the output to the specified type of audit: can be one of "ONDEMANDAUDITTASK" or "SCHEDULED__AUDITTASK".

list_authorizers()
list_authorizers(params::Dict{String,<:Any})

Lists the authorizers registered in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Return the list of authorizers in ascending alphabetical order.
• "marker": A marker used to get the next set of results.
• "pageSize": The maximum number of results to return at one time.
• "status": The status of the list authorizers request.

list_billing_groups()
list_billing_groups(params::Dict{String,<:Any})

Lists the billing groups you have created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return per request.
• "namePrefixFilter": Limit the results to billing groups whose names have the given prefix.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

list_cacertificates()
list_cacertificates(params::Dict{String,<:Any})

Lists the CA certificates registered for your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Determines the order of the results.
• "marker": The marker for the next set of results.
• "pageSize": The result page size.

list_certificates()
list_certificates(params::Dict{String,<:Any})

Lists the certificates registered in your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
• "marker": The marker for the next set of results.
• "pageSize": The result page size.

list_certificates_by_ca(ca_certificate_id)
list_certificates_by_ca(ca_certificate_id, params::Dict{String,<:Any})

List the device certificates signed by the specified CA certificate.

Arguments

• ca_certificate_id: The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
• "marker": The marker for the next set of results.
• "pageSize": The result page size.

list_custom_metrics()
list_custom_metrics(params::Dict{String,<:Any})

Lists your Device Defender detect custom metrics.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.

list_detect_mitigation_actions_executions()
list_detect_mitigation_actions_executions(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "endTime": The end of the time period for which ML Detect mitigation actions executions are returned.
• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.
• "startTime": A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
• "taskId": The unique identifier of the task.
• "thingName": The name of the thing whose mitigation actions are listed.
• "violationId": The unique identifier of the violation.

list_detect_mitigation_actions_tasks(end_time, start_time)
list_detect_mitigation_actions_tasks(end_time, start_time, params::Dict{String,<:Any})

List of Device Defender ML Detect mitigation actions tasks.

Arguments

• end_time: The end of the time period for which ML Detect mitigation actions tasks are returned.
• start_time: A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.

list_dimensions()
list_dimensions(params::Dict{String,<:Any})

List the set of dimensions that are defined for your AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to retrieve at one time.
• "nextToken": The token for the next set of results.

list_domain_configurations()
list_domain_configurations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "marker": The marker for the next set of results.
• "pageSize": The result page size.
• "serviceType": The type of service delivered by the endpoint.

list_indices()
list_indices(params::Dict{String,<:Any})

Lists the search indices.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": The token used to get the next set of results, or null if there are no additional results.

list_job_executions_for_job(job_id)
list_job_executions_for_job(job_id, params::Dict{String,<:Any})

Lists the job executions for a job.

Arguments

• job_id: The unique identifier you assigned to this job when it was created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to be returned per request.
• "nextToken": The token to retrieve the next set of results.
• "status": The status of the job.

list_job_executions_for_thing(thing_name)
list_job_executions_for_thing(thing_name, params::Dict{String,<:Any})

Lists the job executions for the specified thing.

Arguments

• thing_name: The thing name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to be returned per request.
• "namespaceId": The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. aws/things/THINGNAME/jobs/JOBID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
• "nextToken": The token to retrieve the next set of results.
• "status": An optional filter that lets you search for jobs that have the specified status.

list_job_templates()
list_job_templates(params::Dict{String,<:Any})

Returns a list of job templates.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in the list.
• "nextToken": The token to use to return the next set of results in the list.

list_jobs()
list_jobs(params::Dict{String,<:Any})

Lists jobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return per request.
• "namespaceId": The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. aws/things/THINGNAME/jobs/JOBID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
• "nextToken": The token to retrieve the next set of results.
• "status": An optional filter that lets you search for jobs that have the specified status.
• "targetSelection": Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
• "thingGroupId": A filter that limits the returned jobs to those for the specified group.
• "thingGroupName": A filter that limits the returned jobs to those for the specified group.

list_mitigation_actions()
list_mitigation_actions(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "actionType": Specify a value to limit the result to mitigation actions with a specific action type.
• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.

list_otaupdates()
list_otaupdates(params::Dict{String,<:Any})

Lists OTA updates.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": A token used to retrieve the next set of results.
• "otaUpdateStatus": The OTA update job status.

list_outgoing_certificates()
list_outgoing_certificates(params::Dict{String,<:Any})

Lists certificates that are being transferred but not yet accepted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
• "marker": The marker for the next set of results.
• "pageSize": The result page size.

list_policies()
list_policies(params::Dict{String,<:Any})

Lists your policies.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Specifies the order for results. If true, the results are returned in ascending creation order.
• "marker": The marker for the next set of results.
• "pageSize": The result page size.

list_policy_principals(x-amzn-iot-policy)
list_policy_principals(x-amzn-iot-policy, params::Dict{String,<:Any})

Lists the principals associated with the specified policy. Note: This API is deprecated. Please use ListTargetsForPolicy instead.

Arguments

• x-amzn-iot-policy: The policy name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Specifies the order for results. If true, the results are returned in ascending creation order.
• "marker": The marker for the next set of results.
• "pageSize": The result page size.

list_policy_versions(policy_name)
list_policy_versions(policy_name, params::Dict{String,<:Any})

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

Arguments

• policy_name: The policy name.

list_principal_policies(x-amzn-iot-principal)
list_principal_policies(x-amzn-iot-principal, params::Dict{String,<:Any})

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This API is deprecated. Please use ListAttachedPolicies instead.

Arguments

• x-amzn-iot-principal: The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Specifies the order for results. If true, results are returned in ascending creation order.
• "marker": The marker for the next set of results.
• "pageSize": The result page size.

list_principal_things(x-amzn-principal)
list_principal_things(x-amzn-principal, params::Dict{String,<:Any})

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.

Arguments

• x-amzn-principal: The principal.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this operation.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

list_provisioning_template_versions(template_name)
list_provisioning_template_versions(template_name, params::Dict{String,<:Any})

A list of fleet provisioning template versions.

Arguments

• template_name: The name of the fleet provisioning template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": A token to retrieve the next set of results.

list_provisioning_templates()
list_provisioning_templates(params::Dict{String,<:Any})

Lists the fleet provisioning templates in your AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": A token to retrieve the next set of results.

list_role_aliases()
list_role_aliases(params::Dict{String,<:Any})

Lists the role aliases registered in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Return the list of role aliases in ascending alphabetical order.
• "marker": A marker used to get the next set of results.
• "pageSize": The maximum number of results to return at one time.

list_scheduled_audits()
list_scheduled_audits(params::Dict{String,<:Any})

Lists all of your scheduled audits.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time. The default is 25.
• "nextToken": The token for the next set of results.

list_security_profiles()
list_security_profiles(params::Dict{String,<:Any})

Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. dimensionName and metricName cannot be used in the same request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "dimensionName": A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName
• "maxResults": The maximum number of results to return at one time.
• "metricName": The name of the custom metric. Cannot be used with dimensionName.
• "nextToken": The token for the next set of results.

list_security_profiles_for_target(security_profile_target_arn)
list_security_profiles_for_target(security_profile_target_arn, params::Dict{String,<:Any})

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

Arguments

• security_profile_target_arn: The ARN of the target (thing group) whose attached security profiles you want to get.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": The token for the next set of results.
• "recursive": If true, return child groups too.

list_streams()
list_streams(params::Dict{String,<:Any})

Lists all of the streams in your AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "isAscendingOrder": Set to true to return the list of streams in ascending order.
• "maxResults": The maximum number of results to return at a time.
• "nextToken": A token used to get the next set of results.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The ARN of the resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

list_targets_for_policy(policy_name)
list_targets_for_policy(policy_name, params::Dict{String,<:Any})

List targets for the specified policy.

Arguments

• policy_name: The policy name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "marker": A marker used to get the next set of results.
• "pageSize": The maximum number of results to return at one time.

list_targets_for_security_profile(security_profile_name)
list_targets_for_security_profile(security_profile_name, params::Dict{String,<:Any})

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

Arguments

• security_profile_name: The security profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": The token for the next set of results.

list_thing_groups()
list_thing_groups(params::Dict{String,<:Any})

List the thing groups in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "namePrefixFilter": A filter that limits the results to those with the specified name prefix.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
• "parentGroup": A filter that limits the results to those with the specified parent group.
• "recursive": If true, return child groups as well.

list_thing_groups_for_thing(thing_name)
list_thing_groups_for_thing(thing_name, params::Dict{String,<:Any})

List the thing groups to which the specified thing belongs.

Arguments

• thing_name: The thing name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

list_thing_principals(thing_name)
list_thing_principals(thing_name, params::Dict{String,<:Any})

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.

Arguments

• thing_name: The name of the thing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this operation.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

list_thing_registration_task_reports(report_type, task_id)
list_thing_registration_task_reports(report_type, task_id, params::Dict{String,<:Any})

Information about the thing registration tasks.

Arguments

• report_type: The type of task report.
• task_id: The id of the task.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return per request.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

list_thing_registration_tasks()
list_thing_registration_tasks(params::Dict{String,<:Any})

List bulk thing provisioning tasks.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
• "status": The status of the bulk thing provisioning task.

list_thing_types()
list_thing_types(params::Dict{String,<:Any})

Lists the existing thing types.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this operation.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
• "thingTypeName": The name of the thing type.

list_things()
list_things(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "attributeName": The attribute name used to search for things.
• "attributeValue": The attribute value used to search for things.
• "maxResults": The maximum number of results to return in this operation.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
• "thingTypeName": The name of the thing type used to search for things.
• "usePrefixAttributeValue": When true, the action returns the thing resources with attribute values that start with the attributeValue provided. When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.

list_things_in_billing_group(billing_group_name)
list_things_in_billing_group(billing_group_name, params::Dict{String,<:Any})

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

Arguments

• billing_group_name: The name of the billing group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return per request.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

list_things_in_thing_group(thing_group_name)
list_things_in_thing_group(thing_group_name, params::Dict{String,<:Any})

Lists the things in the specified group.

Arguments

• thing_group_name: The thing group name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
• "recursive": When true, list things in this thing group and in all child groups as well.

list_topic_rule_destinations()
list_topic_rule_destinations(params::Dict{String,<:Any})

Lists all the topic rule destinations in your AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

list_topic_rules()
list_topic_rules(params::Dict{String,<:Any})

Lists the rules for the specific topic.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
• "ruleDisabled": Specifies whether the rule is disabled.
• "topic": The topic.

list_v2_logging_levels()
list_v2_logging_levels(params::Dict{String,<:Any})

Lists logging levels.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return at one time.
• "nextToken": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
• "targetType": The type of resource for which you are configuring logging. Must be THING_Group.

list_violation_events(end_time, start_time)
list_violation_events(end_time, start_time, params::Dict{String,<:Any})

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

Arguments

• end_time: The end time for the alerts to be listed.
• start_time: The start time for the alerts to be listed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "behaviorCriteriaType": The criteria for a behavior.
• "listSuppressedAlerts": A list of all suppressed alerts.
• "maxResults": The maximum number of results to return at one time.
• "nextToken": The token for the next set of results.
• "securityProfileName": A filter to limit results to those alerts generated by the specified security profile.
• "thingName": A filter to limit results to those alerts caused by the specified thing.

register_cacertificate(ca_certificate, verification_certificate)
register_cacertificate(ca_certificate, verification_certificate, params::Dict{String,<:Any})

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

Arguments

• ca_certificate: The CA certificate.
• verification_certificate: The private key verification certificate.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "allowAutoRegistration": Allows this CA certificate to be used for auto registration of device certificates.
• "registrationConfig": Information about the registration configuration.
• "setAsActive": A boolean value that specifies if the CA certificate is set to active.
• "tags": Metadata which can be used to manage the CA certificate. For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

register_certificate(certificate_pem)
register_certificate(certificate_pem, params::Dict{String,<:Any})

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

Arguments

• certificate_pem: The certificate data, in PEM format.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "caCertificatePem": The CA certificate used to sign the device certificate being registered.
• "setAsActive": A boolean value that specifies if the certificate is set to active.
• "status": The status of the register certificate request.

register_certificate_without_ca(certificate_pem)
register_certificate_without_ca(certificate_pem, params::Dict{String,<:Any})

Register a certificate that does not have a certificate authority (CA).

Arguments

• certificate_pem: The certificate data, in PEM format.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "status": The status of the register certificate request.

register_thing(template_body)
register_thing(template_body, params::Dict{String,<:Any})

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

Arguments

• template_body: The provisioning template. See Provisioning Devices That Have Device Certificates for more information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "parameters": The parameters for provisioning a thing. See Provisioning Templates for more information.

reject_certificate_transfer(certificate_id)
reject_certificate_transfer(certificate_id, params::Dict{String,<:Any})

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

Arguments

• certificate_id: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "rejectReason": The reason the certificate transfer was rejected.

remove_thing_from_billing_group()
remove_thing_from_billing_group(params::Dict{String,<:Any})

Removes the given thing from the billing group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "billingGroupArn": The ARN of the billing group.
• "billingGroupName": The name of the billing group.
• "thingArn": The ARN of the thing to be removed from the billing group.
• "thingName": The name of the thing to be removed from the billing group.

remove_thing_from_thing_group()
remove_thing_from_thing_group(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "thingArn": The ARN of the thing to remove from the group.
• "thingGroupArn": The group ARN.
• "thingGroupName": The group name.
• "thingName": The name of the thing to remove from the group.

replace_topic_rule(rule_name, topic_rule_payload)
replace_topic_rule(rule_name, topic_rule_payload, params::Dict{String,<:Any})

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.

Arguments

• rule_name: The name of the rule.
• topic_rule_payload: The rule payload.

search_index(query_string)
search_index(query_string, params::Dict{String,<:Any})

The query search index.

Arguments

• query_string: The search query string.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "indexName": The search index name.
• "maxResults": The maximum number of results to return at one time.
• "nextToken": The token used to get the next set of results, or null if there are no additional results.
• "queryVersion": The query version.

set_default_authorizer(authorizer_name)
set_default_authorizer(authorizer_name, params::Dict{String,<:Any})

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

Arguments

• authorizer_name: The authorizer name.

set_default_policy_version(policy_name, policy_version_id)
set_default_policy_version(policy_name, policy_version_id, params::Dict{String,<:Any})

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.

Arguments

• policy_name: The policy name.
• policy_version_id: The policy version ID.

set_logging_options(logging_options_payload)
set_logging_options(logging_options_payload, params::Dict{String,<:Any})

Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.

Arguments

• logging_options_payload: The logging options payload.

set_v2_logging_level(log_level, log_target)
set_v2_logging_level(log_level, log_target, params::Dict{String,<:Any})

Sets the logging level.

Arguments

• log_level: The log level.
• log_target: The log target.

set_v2_logging_options()
set_v2_logging_options(params::Dict{String,<:Any})

Sets the logging options for the V2 logging service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "defaultLogLevel": The default logging level.
• "disableAllLogs": If true all logs are disabled. The default is false.
• "roleArn": The ARN of the role that allows IoT to write to Cloudwatch logs.

start_audit_mitigation_actions_task(audit_check_to_actions_mapping, client_request_token, target, task_id)
start_audit_mitigation_actions_task(audit_check_to_actions_mapping, client_request_token, target, task_id, params::Dict{String,<:Any})

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

Arguments

• audit_check_to_actions_mapping: For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.
• client_request_token: Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.
• target: Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.
• task_id: A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

start_detect_mitigation_actions_task(actions, client_request_token, target, task_id)
start_detect_mitigation_actions_task(actions, client_request_token, target, task_id, params::Dict{String,<:Any})

Starts a Device Defender ML Detect mitigation actions task.

Arguments

• actions: The actions to be performed when a device has unexpected behavior.
• client_request_token: Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
• target: Specifies the ML Detect findings to which the mitigation actions are applied.
• task_id: The unique identifier of the task.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "includeOnlyActiveViolations": Specifies to list only active violations.
• "includeSuppressedAlerts": Specifies to include suppressed alerts.
• "violationEventOccurrenceRange": Specifies the time period of which violation events occurred between.

start_on_demand_audit_task(target_check_names)
start_on_demand_audit_task(target_check_names, params::Dict{String,<:Any})

Starts an on-demand Device Defender audit.

Arguments

• target_check_names: Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.

start_thing_registration_task(input_file_bucket, input_file_key, role_arn, template_body)
start_thing_registration_task(input_file_bucket, input_file_key, role_arn, template_body, params::Dict{String,<:Any})

Creates a bulk thing provisioning task.

Arguments

• input_file_bucket: The S3 bucket that contains the input file.
• input_file_key: The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).
• role_arn: The IAM role ARN that grants permission the input file.
• template_body: The provisioning template.

stop_thing_registration_task(task_id)
stop_thing_registration_task(task_id, params::Dict{String,<:Any})

Cancels a bulk thing provisioning task.

Arguments

• task_id: The bulk thing provisioning task ID.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The ARN of the resource.
• tags: The new or modified tags for the resource.

test_authorization(auth_infos)
test_authorization(auth_infos, params::Dict{String,<:Any})

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

Arguments

• auth_infos: A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientId": The MQTT client ID.
• "cognitoIdentityPoolId": The Cognito identity pool ID.
• "policyNamesToAdd": When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
• "policyNamesToSkip": When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
• "principal": The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

test_invoke_authorizer(authorizer_name)
test_invoke_authorizer(authorizer_name, params::Dict{String,<:Any})

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

Arguments

• authorizer_name: The custom authorizer name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "httpContext": Specifies a test HTTP authorization request.
• "mqttContext": Specifies a test MQTT authorization request.
• "tlsContext": Specifies a test TLS authorization request.
• "token": The token returned by your custom authentication service.
• "tokenSignature": The signature made with the token and your custom authentication service's private key. This value must be Base-64-encoded.

transfer_certificate(certificate_id, target_aws_account)
transfer_certificate(certificate_id, target_aws_account, params::Dict{String,<:Any})

Transfers the specified certificate to the specified AWS account. You can cancel the transfer until it is acknowledged by the recipient. No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target. The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.

Arguments

• certificate_id: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
• target_aws_account: The AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "transferMessage": The transfer message.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes the given tags (metadata) from the resource.

Arguments

• resource_arn: The ARN of the resource.
• tag_keys: A list of the keys of the tags to be removed from the resource.

update_account_audit_configuration()
update_account_audit_configuration(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "auditCheckConfigurations": Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled. Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted. You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself. On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.
• "auditNotificationTargetConfigurations": Information about the targets to which audit notifications are sent.
• "roleArn": The Amazon Resource Name (ARN) of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

update_audit_suppression(check_name, resource_identifier)
update_audit_suppression(check_name, resource_identifier, params::Dict{String,<:Any})

Updates a Device Defender audit suppression.

Arguments

• check_name:
• resource_identifier:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of the audit suppression.
• "expirationDate": The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.
• "suppressIndefinitely": Indicates whether a suppression should exist indefinitely or not.

update_authorizer(authorizer_name)
update_authorizer(authorizer_name, params::Dict{String,<:Any})

Updates an authorizer.

Arguments

• authorizer_name: The authorizer name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "authorizerFunctionArn": The ARN of the authorizer's Lambda function.
• "status": The status of the update authorizer request.
• "tokenKeyName": The key used to extract the token from the HTTP headers.
• "tokenSigningPublicKeys": The public keys used to verify the token signature.

update_billing_group(billing_group_name, billing_group_properties)
update_billing_group(billing_group_name, billing_group_properties, params::Dict{String,<:Any})

Updates information about the billing group.

Arguments

• billing_group_name: The name of the billing group.
• billing_group_properties: The properties of the billing group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "expectedVersion": The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException.

update_cacertificate(ca_certificate_id)
update_cacertificate(ca_certificate_id, params::Dict{String,<:Any})

Updates a registered CA certificate.

Arguments

• ca_certificate_id: The CA certificate identifier.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "newAutoRegistrationStatus": The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".
• "newStatus": The updated status of the CA certificate. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
• "registrationConfig": Information about the registration configuration.
• "removeAutoRegistration": If true, removes auto registration.

update_certificate(certificate_id, new_status)
update_certificate(certificate_id, new_status, params::Dict{String,<:Any})

Updates the status of the specified certificate. This operation is idempotent. Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to AWS IoT. Within a few minutes of updating a certificate from the ACTIVE state to any other state, AWS IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

Arguments

• certificate_id: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
• new_status: The new status. Note: Setting the status to PENDINGTRANSFER or PENDINGACTIVATION will result in an exception being thrown. PENDINGTRANSFER and PENDINGACTIVATION are statuses used internally by AWS IoT. They are not intended for developer use. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

update_custom_metric(display_name, metric_name)
update_custom_metric(display_name, metric_name, params::Dict{String,<:Any})

Updates a Device Defender detect custom metric.

Arguments

• display_name: Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
• metric_name: The name of the custom metric. Cannot be updated.

update_dimension(name, string_values)
update_dimension(name, string_values, params::Dict{String,<:Any})

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

Arguments

• name: A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
• string_values: Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

update_domain_configuration(domain_configuration_name)
update_domain_configuration(domain_configuration_name, params::Dict{String,<:Any})

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

Arguments

• domain_configuration_name: The name of the domain configuration to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "authorizerConfig": An object that specifies the authorization service for a domain.
• "domainConfigurationStatus": The status to which the domain configuration should be updated.
• "removeAuthorizerConfig": Removes the authorization configuration from a domain.

update_dynamic_thing_group(thing_group_name, thing_group_properties)
update_dynamic_thing_group(thing_group_name, thing_group_properties, params::Dict{String,<:Any})

Updates a dynamic thing group.

Arguments

• thing_group_name: The name of the dynamic thing group to update.
• thing_group_properties: The dynamic thing group properties to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "expectedVersion": The expected version of the dynamic thing group to update.
• "indexName": The dynamic thing group index to update. Currently one index is supported: 'AWS_Things'.
• "queryString": The dynamic thing group search query string to update.
• "queryVersion": The dynamic thing group query version to update. Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.

update_event_configurations()
update_event_configurations(params::Dict{String,<:Any})

Updates the event configurations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "eventConfigurations": The new event configuration values.

update_indexing_configuration()
update_indexing_configuration(params::Dict{String,<:Any})

Updates the search configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "thingGroupIndexingConfiguration": Thing group indexing configuration.
• "thingIndexingConfiguration": Thing indexing configuration.

update_job(job_id)
update_job(job_id, params::Dict{String,<:Any})

Updates supported fields of the specified job.

Arguments

• job_id: The ID of the job to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "abortConfig": Allows you to create criteria to abort a job.
• "description": A short text description of the job.
• "jobExecutionsRolloutConfig": Allows you to create a staged rollout of the job.
• "namespaceId": The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. aws/things/THINGNAME/jobs/JOBID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
• "presignedUrlConfig": Configuration information for pre-signed S3 URLs.
• "timeoutConfig": Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to INPROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMEDOUT.

update_mitigation_action(action_name)
update_mitigation_action(action_name, params::Dict{String,<:Any})

Updates the definition for the specified mitigation action.

Arguments

• action_name: The friendly name for the mitigation action. You cannot change the name by using UpdateMitigationAction. Instead, you must delete and recreate the mitigation action with the new name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "actionParams": Defines the type of action and the parameters for that action.
• "roleArn": The ARN of the IAM role that is used to apply the mitigation action.

update_provisioning_template(template_name)
update_provisioning_template(template_name, params::Dict{String,<:Any})

Updates a fleet provisioning template.

Arguments

• template_name: The name of the fleet provisioning template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "defaultVersionId": The ID of the default provisioning template version.
• "description": The description of the fleet provisioning template.
• "enabled": True to enable the fleet provisioning template, otherwise false.
• "preProvisioningHook": Updates the pre-provisioning hook template.
• "provisioningRoleArn": The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
• "removePreProvisioningHook": Removes pre-provisioning hook template.

update_role_alias(role_alias)
update_role_alias(role_alias, params::Dict{String,<:Any})

Updates a role alias.

Arguments

• role_alias: The role alias to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "credentialDurationSeconds": The number of seconds the credential will be valid.
• "roleArn": The role ARN.

update_scheduled_audit(scheduled_audit_name)
update_scheduled_audit(scheduled_audit_name, params::Dict{String,<:Any})

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

Arguments

• scheduled_audit_name: The name of the scheduled audit. (Max. 128 chars)

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "dayOfMonth": The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
• "dayOfWeek": The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.
• "frequency": How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
• "targetCheckNames": Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

update_security_profile(security_profile_name)
update_security_profile(security_profile_name, params::Dict{String,<:Any})

Updates a Device Defender security profile.

Arguments

• security_profile_name: The name of the security profile you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "additionalMetricsToRetain": Please use UpdateSecurityProfileRequestadditionalMetricsToRetainV2 instead. A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
• "additionalMetricsToRetainV2": A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
• "alertTargets": Where the alerts are sent. (Alerts are always sent to the console.)
• "behaviors": Specifies the behaviors that, when violated by a device (thing), cause an alert.
• "deleteAdditionalMetricsToRetain": If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
• "deleteAlertTargets": If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
• "deleteBehaviors": If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
• "expectedVersion": The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
• "securityProfileDescription": A description of the security profile.

update_stream(stream_id)
update_stream(stream_id, params::Dict{String,<:Any})

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

Arguments

• stream_id: The stream ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of the stream.
• "files": The files associated with the stream.
• "roleArn": An IAM role that allows the IoT service principal assumes to access your S3 files.

update_thing(thing_name)
update_thing(thing_name, params::Dict{String,<:Any})

Updates the data for a thing.

Arguments

• thing_name: The name of the thing to update. You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "attributePayload": A list of thing attributes, a JSON string containing name-value pairs. For example: {"attributes":{"name1":"value2"}} This data is used to add new attributes or update existing attributes.
• "expectedVersion": The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.
• "removeThingType": Remove a thing type association. If true, the association is removed.
• "thingTypeName": The name of the thing type.

update_thing_group(thing_group_name, thing_group_properties)
update_thing_group(thing_group_name, thing_group_properties, params::Dict{String,<:Any})

Update a thing group.

Arguments

• thing_group_name: The thing group to update.
• thing_group_properties: The thing group properties.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "expectedVersion": The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.

update_thing_groups_for_thing()
update_thing_groups_for_thing(params::Dict{String,<:Any})

Updates the groups to which the thing belongs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "overrideDynamicGroups": Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
• "thingGroupsToAdd": The groups to which the thing will be added.
• "thingGroupsToRemove": The groups from which the thing will be removed.
• "thingName": The thing whose group memberships will be updated.

update_topic_rule_destination(arn, status)
update_topic_rule_destination(arn, status, params::Dict{String,<:Any})

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

Arguments

• arn: The ARN of the topic rule destination.
• status: The status of the topic rule destination. Valid values are: INPROGRESS A topic rule destination was created but has not been confirmed. You can set status to INPROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. ENABLED Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

validate_security_profile_behaviors(behaviors)
validate_security_profile_behaviors(behaviors, params::Dict{String,<:Any})

Validates a Device Defender security profile behaviors specification.

Arguments

• behaviors: Specifies the behaviors that, when violated by a device (thing), cause an alert.