AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
", "operations": { "AcceptCertificateTransfer": "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.
", "AddThingToThingGroup": "Adds a thing to a thing group.
", "AssociateTargetsWithJob": "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.
Attaches a policy to the specified target.
", "AttachPrincipalPolicy": "Attaches the specified policy to the specified principal (certificate or other credential).
Note: This API is deprecated. Please use AttachPolicy instead.
", "AttachSecurityProfile": "Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.
", "AttachThingPrincipal": "Attaches the specified principal to the specified thing.
", "CancelAuditTask": "Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an \"InvalidRequestException\" occurs.
", "CancelCertificateTransfer": "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.
", "CancelJob": "Cancels a job.
", "CancelJobExecution": "Cancels the execution of a job for a given thing.
", "ClearDefaultAuthorizer": "Clears the default authorizer.
", "CreateAuthorizer": "Creates an authorizer.
", "CreateCertificateFromCsr": "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\"
", "CreateJob": "Creates a job.
", "CreateKeysAndCertificate": "Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
", "CreateOTAUpdate": "Creates an AWS IoT OTAUpdate on a target group of things or groups.
", "CreatePolicy": "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.
", "CreatePolicyVersion": "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).
", "CreateRoleAlias": "Creates a role alias.
", "CreateScheduledAudit": "Creates a scheduled audit that is run at a specified time interval.
", "CreateSecurityProfile": "Creates a Device Defender security profile.
", "CreateStream": "Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.
", "CreateThing": "Creates a thing record in the registry.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Creates a new thing type.
", "CreateTopicRule": "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.
", "DeleteAccountAuditConfiguration": "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.
", "DeleteAuthorizer": "Deletes an authorizer.
", "DeleteCACertificate": "Deletes a registered CA certificate.
", "DeleteCertificate": "Deletes the specified certificate.
A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
", "DeleteJob": "Deletes a job and its related job executions.
Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as \"DELETION_IN_PROGRESS\". Attempting to delete or cancel a job whose status is already \"DELETION_IN_PROGRESS\" will result in an error.
Only 10 jobs may have status \"DELETION_IN_PROGRESS\" at the same time, or a LimitExceededException will occur.
", "DeleteJobExecution": "Deletes a job execution.
", "DeleteOTAUpdate": "Delete an OTA update.
", "DeletePolicy": "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.
", "DeletePolicyVersion": "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.
", "DeleteRegistrationCode": "Deletes a CA certificate registration code.
", "DeleteRoleAlias": "Deletes a role alias
", "DeleteScheduledAudit": "Deletes a scheduled audit.
", "DeleteSecurityProfile": "Deletes a Device Defender security profile.
", "DeleteStream": "Deletes a stream.
", "DeleteThing": "Deletes the specified thing.
", "DeleteThingGroup": "Deletes a thing group.
", "DeleteThingType": "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.
", "DeleteTopicRule": "Deletes the rule.
", "DeleteV2LoggingLevel": "Deletes a logging level.
", "DeprecateThingType": "Deprecates a thing type. You can not associate new things with deprecated thing type.
", "DescribeAccountAuditConfiguration": "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.
", "DescribeAuditTask": "Gets information about a Device Defender audit.
", "DescribeAuthorizer": "Describes an authorizer.
", "DescribeCACertificate": "Describes a registered CA certificate.
", "DescribeCertificate": "Gets information about the specified certificate.
", "DescribeDefaultAuthorizer": "Describes the default authorizer.
", "DescribeEndpoint": "Returns a unique endpoint specific to the AWS account making the call.
", "DescribeEventConfigurations": "Describes event configurations.
", "DescribeIndex": "Describes a search index.
", "DescribeJob": "Describes a job.
", "DescribeJobExecution": "Describes a job execution.
", "DescribeRoleAlias": "Describes a role alias.
", "DescribeScheduledAudit": "Gets information about a scheduled audit.
", "DescribeSecurityProfile": "Gets information about a Device Defender security profile.
", "DescribeStream": "Gets information about a stream.
", "DescribeThing": "Gets information about the specified thing.
", "DescribeThingGroup": "Describe a thing group.
", "DescribeThingRegistrationTask": "Describes a bulk thing provisioning task.
", "DescribeThingType": "Gets information about the specified thing type.
", "DetachPolicy": "Detaches a policy from the specified target.
", "DetachPrincipalPolicy": "Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
", "DetachSecurityProfile": "Disassociates a Device Defender security profile from a thing group or from this account.
", "DetachThingPrincipal": "Detaches the specified principal from the specified thing.
", "DisableTopicRule": "Disables the rule.
", "EnableTopicRule": "Enables the rule.
", "GetEffectivePolicies": "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.
", "GetIndexingConfiguration": "Gets the search configuration.
", "GetJobDocument": "Gets a job document.
", "GetLoggingOptions": "Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
Gets an OTA update.
", "GetPolicy": "Gets information about the specified policy with the policy document of the default version.
", "GetPolicyVersion": "Gets information about the specified policy version.
", "GetRegistrationCode": "Gets a registration code used to register a CA certificate with AWS IoT.
", "GetTopicRule": "Gets information about the rule.
", "GetV2LoggingOptions": "Gets the fine grained logging options.
", "ListActiveViolations": "Lists the active violations for a given Device Defender security profile.
", "ListAttachedPolicies": "Lists the policies attached to the specified thing group.
", "ListAuditFindings": "Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)
", "ListAuditTasks": "Lists the Device Defender audits that have been performed during a given time period.
", "ListAuthorizers": "Lists the authorizers registered in your account.
", "ListCACertificates": "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.
", "ListCertificates": "Lists the certificates registered in your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
", "ListCertificatesByCA": "List the device certificates signed by the specified CA certificate.
", "ListIndices": "Lists the search indices.
", "ListJobExecutionsForJob": "Lists the job executions for a job.
", "ListJobExecutionsForThing": "Lists the job executions for the specified thing.
", "ListJobs": "Lists jobs.
", "ListOTAUpdates": "Lists OTA updates.
", "ListOutgoingCertificates": "Lists certificates that are being transferred but not yet accepted.
", "ListPolicies": "Lists your policies.
", "ListPolicyPrincipals": "Lists the principals associated with the specified policy.
Note: This API is deprecated. Please use ListTargetsForPolicy instead.
", "ListPolicyVersions": "Lists the versions of the specified policy and identifies the default version.
", "ListPrincipalPolicies": "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.
", "ListPrincipalThings": "Lists the things associated with the specified principal.
", "ListRoleAliases": "Lists the role aliases registered in your account.
", "ListScheduledAudits": "Lists all of your scheduled audits.
", "ListSecurityProfiles": "Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
", "ListSecurityProfilesForTarget": "Lists the Device Defender security profiles attached to a target (thing group).
", "ListStreams": "Lists all of the streams in your AWS account.
", "ListTargetsForPolicy": "List targets for the specified policy.
", "ListTargetsForSecurityProfile": "Lists the targets (thing groups) associated with a given Device Defender security profile.
", "ListThingGroups": "List the thing groups in your account.
", "ListThingGroupsForThing": "List the thing groups to which the specified thing belongs.
", "ListThingPrincipals": "Lists the principals associated with the specified thing.
", "ListThingRegistrationTaskReports": "Information about the thing registration tasks.
", "ListThingRegistrationTasks": "List bulk thing provisioning tasks.
", "ListThingTypes": "Lists the existing thing types.
", "ListThings": "Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.
Lists the things in the specified group.
", "ListTopicRules": "Lists the rules for the specific topic.
", "ListV2LoggingLevels": "Lists logging levels.
", "ListViolationEvents": "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).
", "RegisterCACertificate": "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.
", "RegisterCertificate": "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.
", "RegisterThing": "Provisions a thing.
", "RejectCertificateTransfer": "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.
", "RemoveThingFromThingGroup": "Remove the specified thing from the specified group.
", "ReplaceTopicRule": "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.
", "SearchIndex": "The query search index.
", "SetDefaultAuthorizer": "Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
", "SetDefaultPolicyVersion": "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.
", "SetLoggingOptions": "Sets the logging options.
NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
Sets the logging level.
", "SetV2LoggingOptions": "Sets the logging options for the V2 logging service.
", "StartOnDemandAuditTask": "Starts an on-demand Device Defender audit.
", "StartThingRegistrationTask": "Creates a bulk thing provisioning task.
", "StopThingRegistrationTask": "Cancels a bulk thing provisioning task.
", "TestAuthorization": "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.
", "TestInvokeAuthorizer": "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.
", "TransferCertificate": "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.
", "UpdateAccountAuditConfiguration": "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.
", "UpdateAuthorizer": "Updates an authorizer.
", "UpdateCACertificate": "Updates a registered CA certificate.
", "UpdateCertificate": "Updates the status of the specified certificate. This operation is idempotent.
Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.
The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
", "UpdateEventConfigurations": "Updates the event configurations.
", "UpdateIndexingConfiguration": "Updates the search configuration.
", "UpdateRoleAlias": "Updates a role alias.
", "UpdateScheduledAudit": "Updates a scheduled audit, including what checks are performed and how often the audit takes place.
", "UpdateSecurityProfile": "Updates a Device Defender security profile.
", "UpdateStream": "Updates an existing stream. The stream version will be incremented by one.
", "UpdateThing": "Updates the data for a thing.
", "UpdateThingGroup": "Update a thing group.
", "UpdateThingGroupsForThing": "Updates the groups to which the thing belongs.
", "ValidateSecurityProfileBehaviors": "Validates a Device Defender security profile behaviors specification.
" }, "shapes": { "AcceptCertificateTransferRequest": { "base": "The input for the AcceptCertificateTransfer operation.
", "refs": { } }, "Action": { "base": "Describes the actions associated with a rule.
", "refs": { "ActionList$member": null, "TopicRule$errorAction": "The action to perform when an error occurs.
", "TopicRulePayload$errorAction": "The action to take when an error occurs.
" } }, "ActionList": { "base": null, "refs": { "TopicRule$actions": "The actions associated with the rule.
", "TopicRulePayload$actions": "The actions associated with the rule.
" } }, "ActionType": { "base": null, "refs": { "AuthInfo$actionType": "The type of action for which the principal is being authorized.
" } }, "ActiveViolation": { "base": "Information about an active Device Defender security profile behavior violation.
", "refs": { "ActiveViolations$member": null } }, "ActiveViolations": { "base": null, "refs": { "ListActiveViolationsResponse$activeViolations": "The list of active violations.
" } }, "AddThingToThingGroupRequest": { "base": null, "refs": { } }, "AddThingToThingGroupResponse": { "base": null, "refs": { } }, "AdditionalParameterMap": { "base": null, "refs": { "CreateOTAUpdateRequest$additionalParameters": "A list of additional OTA update parameters which are name-value pairs.
", "OTAUpdateInfo$additionalParameters": "A collection of name/value pairs
" } }, "AlarmName": { "base": null, "refs": { "CloudwatchAlarmAction$alarmName": "The CloudWatch alarm name.
" } }, "AlertTarget": { "base": "A structure containing the alert target ARN and the role ARN.
", "refs": { "AlertTargets$value": null } }, "AlertTargetArn": { "base": null, "refs": { "AlertTarget$alertTargetArn": "The ARN of the notification target to which alerts are sent.
" } }, "AlertTargetType": { "base": "The type of alert target: one of \"SNS\".
", "refs": { "AlertTargets$key": null } }, "AlertTargets": { "base": null, "refs": { "CreateSecurityProfileRequest$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.
", "DescribeSecurityProfileResponse$alertTargets": "Where the alerts are sent. (Alerts are always sent to the console.)
", "UpdateSecurityProfileRequest$alertTargets": "Where the alerts are sent. (Alerts are always sent to the console.)
", "UpdateSecurityProfileResponse$alertTargets": "Where the alerts are sent. (Alerts are always sent to the console.)
" } }, "AllowAutoRegistration": { "base": null, "refs": { "RegisterCACertificateRequest$allowAutoRegistration": "Allows this CA certificate to be used for auto registration of device certificates.
" } }, "Allowed": { "base": "Contains information that allowed the authorization.
", "refs": { "AuthResult$allowed": "The policies and statements that allowed the specified action.
" } }, "AscendingOrder": { "base": null, "refs": { "ListAuthorizersRequest$ascendingOrder": "Return the list of authorizers in ascending alphabetical order.
", "ListCACertificatesRequest$ascendingOrder": "Determines the order of the results.
", "ListCertificatesByCARequest$ascendingOrder": "Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
", "ListCertificatesRequest$ascendingOrder": "Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
", "ListOutgoingCertificatesRequest$ascendingOrder": "Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
", "ListPoliciesRequest$ascendingOrder": "Specifies the order for results. If true, the results are returned in ascending creation order.
", "ListPolicyPrincipalsRequest$ascendingOrder": "Specifies the order for results. If true, the results are returned in ascending creation order.
", "ListPrincipalPoliciesRequest$ascendingOrder": "Specifies the order for results. If true, results are returned in ascending creation order.
", "ListRoleAliasesRequest$ascendingOrder": "Return the list of role aliases in ascending alphabetical order.
", "ListStreamsRequest$ascendingOrder": "Set to true to return the list of streams in ascending order.
" } }, "AssociateTargetsWithJobRequest": { "base": null, "refs": { } }, "AssociateTargetsWithJobResponse": { "base": null, "refs": { } }, "AttachPolicyRequest": { "base": null, "refs": { } }, "AttachPrincipalPolicyRequest": { "base": "The input for the AttachPrincipalPolicy operation.
", "refs": { } }, "AttachSecurityProfileRequest": { "base": null, "refs": { } }, "AttachSecurityProfileResponse": { "base": null, "refs": { } }, "AttachThingPrincipalRequest": { "base": "The input for the AttachThingPrincipal operation.
", "refs": { } }, "AttachThingPrincipalResponse": { "base": "The output from the AttachThingPrincipal operation.
", "refs": { } }, "AttributeKey": { "base": null, "refs": { "AdditionalParameterMap$key": null, "AttributesMap$key": null } }, "AttributeName": { "base": null, "refs": { "Attributes$key": null, "ListThingsRequest$attributeName": "The attribute name used to search for things.
", "SearchableAttributes$member": null } }, "AttributePayload": { "base": "The attribute payload.
", "refs": { "CreateThingRequest$attributePayload": "The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:
{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}
The thing group attributes in JSON format.
", "UpdateThingRequest$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.
" } }, "AttributeValue": { "base": null, "refs": { "Attributes$value": null, "ListThingsRequest$attributeValue": "The attribute value used to search for things.
" } }, "Attributes": { "base": null, "refs": { "AttributePayload$attributes": "A JSON string containing up to three key-value pair in JSON format. For example:
{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}
The thing attributes.
", "ThingAttribute$attributes": "A list of thing attributes which are name-value pairs.
", "ThingDocument$attributes": "The attributes.
", "ThingGroupDocument$attributes": "The thing group attributes.
" } }, "AttributesMap": { "base": null, "refs": { "OTAUpdateFile$attributes": "A list of name/attribute pairs.
" } }, "AuditCheckConfiguration": { "base": "Which audit checks are enabled and disabled for this account.
", "refs": { "AuditCheckConfigurations$value": null } }, "AuditCheckConfigurations": { "base": null, "refs": { "DescribeAccountAuditConfigurationResponse$auditCheckConfigurations": "Which audit checks are enabled and disabled for this account.
", "UpdateAccountAuditConfigurationRequest$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.
Note that some data collection may begin 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 is 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.
Information about the audit check.
", "refs": { "AuditDetails$value": null } }, "AuditCheckName": { "base": "An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.)
The audit check that generated this result.
", "ListAuditFindingsRequest$checkName": "A filter to limit results to the findings for the specified audit check.
", "TargetAuditCheckNames$member": null } }, "AuditCheckRunStatus": { "base": null, "refs": { "AuditCheckDetails$checkRunStatus": "The completion status of this check, one of \"IN_PROGRESS\", \"WAITING_FOR_DATA_COLLECTION\", \"CANCELED\", \"COMPLETED_COMPLIANT\", \"COMPLETED_NON_COMPLIANT\", or \"FAILED\".
" } }, "AuditDetails": { "base": null, "refs": { "DescribeAuditTaskResponse$auditDetails": "Detailed information about each check performed during this audit.
" } }, "AuditFinding": { "base": "The findings (results) of the audit.
", "refs": { "AuditFindings$member": null } }, "AuditFindingSeverity": { "base": null, "refs": { "AuditFinding$severity": "The severity of the result (finding).
" } }, "AuditFindings": { "base": null, "refs": { "ListAuditFindingsResponse$findings": "The findings (results) of the audit.
" } }, "AuditFrequency": { "base": null, "refs": { "CreateScheduledAuditRequest$frequency": "How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.
", "DescribeScheduledAuditResponse$frequency": "How often the scheduled audit takes place. One of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.
", "ScheduledAuditMetadata$frequency": "How often the scheduled audit takes place.
", "UpdateScheduledAuditRequest$frequency": "How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.
" } }, "AuditNotificationTarget": { "base": "Information about the targets to which audit notifications are sent.
", "refs": { "AuditNotificationTargetConfigurations$value": null } }, "AuditNotificationTargetConfigurations": { "base": null, "refs": { "DescribeAccountAuditConfigurationResponse$auditNotificationTargetConfigurations": "Information about the targets to which audit notifications are sent for this account.
", "UpdateAccountAuditConfigurationRequest$auditNotificationTargetConfigurations": "Information about the targets to which audit notifications are sent.
" } }, "AuditNotificationType": { "base": null, "refs": { "AuditNotificationTargetConfigurations$key": null } }, "AuditTaskId": { "base": null, "refs": { "AuditFinding$taskId": "The ID of the audit that generated this result (finding)
", "AuditTaskMetadata$taskId": "The ID of this audit.
", "CancelAuditTaskRequest$taskId": "The ID of the audit you want to cancel. You can only cancel an audit that is \"IN_PROGRESS\".
", "DescribeAuditTaskRequest$taskId": "The ID of the audit whose information you want to get.
", "ListAuditFindingsRequest$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.
", "StartOnDemandAuditTaskResponse$taskId": "The ID of the on-demand audit you started.
" } }, "AuditTaskMetadata": { "base": "The audits that were performed.
", "refs": { "AuditTaskMetadataList$member": null } }, "AuditTaskMetadataList": { "base": null, "refs": { "ListAuditTasksResponse$tasks": "The audits that were performed during the specified time period.
" } }, "AuditTaskStatus": { "base": null, "refs": { "AuditTaskMetadata$taskStatus": "The status of this audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\" or \"CANCELED\".
", "DescribeAuditTaskResponse$taskStatus": "The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".
", "ListAuditTasksRequest$taskStatus": "A filter to limit the output to audits with the specified completion status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\" or \"CANCELED\".
" } }, "AuditTaskType": { "base": null, "refs": { "AuditTaskMetadata$taskType": "The type of this audit: one of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".
", "DescribeAuditTaskResponse$taskType": "The type of audit: \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".
", "ListAuditTasksRequest$taskType": "A filter to limit the output to the specified type of audit: can be one of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".
" } }, "AuthDecision": { "base": null, "refs": { "AuthResult$authDecision": "The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.
" } }, "AuthInfo": { "base": "A collection of authorization information.
", "refs": { "AuthInfos$member": null, "AuthResult$authInfo": "Authorization information.
" } }, "AuthInfos": { "base": null, "refs": { "TestAuthorizationRequest$authInfos": "A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
The authorizer result.
", "refs": { "AuthResults$member": null } }, "AuthResults": { "base": null, "refs": { "TestAuthorizationResponse$authResults": "The authentication results.
" } }, "AuthorizerArn": { "base": null, "refs": { "AuthorizerDescription$authorizerArn": "The authorizer ARN.
", "AuthorizerSummary$authorizerArn": "The authorizer ARN.
", "CreateAuthorizerResponse$authorizerArn": "The authorizer ARN.
", "SetDefaultAuthorizerResponse$authorizerArn": "The authorizer ARN.
", "UpdateAuthorizerResponse$authorizerArn": "The authorizer ARN.
" } }, "AuthorizerDescription": { "base": "The authorizer description.
", "refs": { "DescribeAuthorizerResponse$authorizerDescription": "The authorizer description.
", "DescribeDefaultAuthorizerResponse$authorizerDescription": "The default authorizer's description.
" } }, "AuthorizerFunctionArn": { "base": null, "refs": { "AuthorizerDescription$authorizerFunctionArn": "The authorizer's Lambda function ARN.
", "CreateAuthorizerRequest$authorizerFunctionArn": "The ARN of the authorizer's Lambda function.
", "UpdateAuthorizerRequest$authorizerFunctionArn": "The ARN of the authorizer's Lambda function.
" } }, "AuthorizerName": { "base": null, "refs": { "AuthorizerDescription$authorizerName": "The authorizer name.
", "AuthorizerSummary$authorizerName": "The authorizer name.
", "CreateAuthorizerRequest$authorizerName": "The authorizer name.
", "CreateAuthorizerResponse$authorizerName": "The authorizer's name.
", "DeleteAuthorizerRequest$authorizerName": "The name of the authorizer to delete.
", "DescribeAuthorizerRequest$authorizerName": "The name of the authorizer to describe.
", "SetDefaultAuthorizerRequest$authorizerName": "The authorizer name.
", "SetDefaultAuthorizerResponse$authorizerName": "The authorizer name.
", "TestInvokeAuthorizerRequest$authorizerName": "The custom authorizer name.
", "UpdateAuthorizerRequest$authorizerName": "The authorizer name.
", "UpdateAuthorizerResponse$authorizerName": "The authorizer name.
" } }, "AuthorizerStatus": { "base": null, "refs": { "AuthorizerDescription$status": "The status of the authorizer.
", "CreateAuthorizerRequest$status": "The status of the create authorizer request.
", "ListAuthorizersRequest$status": "The status of the list authorizers request.
", "UpdateAuthorizerRequest$status": "The status of the update authorizer request.
" } }, "AuthorizerSummary": { "base": "The authorizer summary.
", "refs": { "Authorizers$member": null } }, "Authorizers": { "base": null, "refs": { "ListAuthorizersResponse$authorizers": "The authorizers.
" } }, "AutoRegistrationStatus": { "base": null, "refs": { "CACertificateDescription$autoRegistrationStatus": "Whether the CA certificate configured for auto registration of device certificates. Valid values are \"ENABLE\" and \"DISABLE\"
", "UpdateCACertificateRequest$newAutoRegistrationStatus": "The new value for the auto registration status. Valid values are: \"ENABLE\" or \"DISABLE\".
" } }, "AwsAccountId": { "base": null, "refs": { "CACertificateDescription$ownedBy": "The owner of the CA certificate.
", "CertificateDescription$ownedBy": "The ID of the AWS account that owns the certificate.
", "CertificateDescription$previousOwnedBy": "The ID of the AWS account of the previous owner of the certificate.
", "OutgoingCertificate$transferredTo": "The AWS account to which the transfer was made.
", "ResourceIdentifier$account": "The account with which the resource is associated.
", "RoleAliasDescription$owner": "The role alias owner.
", "TransferCertificateRequest$targetAwsAccount": "The AWS account.
" } }, "AwsArn": { "base": null, "refs": { "CloudwatchAlarmAction$roleArn": "The IAM role that allows access to the CloudWatch alarm.
", "CloudwatchMetricAction$roleArn": "The IAM role that allows access to the CloudWatch metric.
", "DynamoDBAction$roleArn": "The ARN of the IAM role that grants access to the DynamoDB table.
", "DynamoDBv2Action$roleArn": "The ARN of the IAM role that grants access to the DynamoDB table.
", "ElasticsearchAction$roleArn": "The IAM role ARN that has access to Elasticsearch.
", "FirehoseAction$roleArn": "The IAM role that grants access to the Amazon Kinesis Firehose stream.
", "GetLoggingOptionsResponse$roleArn": "The ARN of the IAM role that grants access.
", "GetV2LoggingOptionsResponse$roleArn": "The IAM role ARN AWS IoT uses to write to your CloudWatch logs.
", "IotAnalyticsAction$channelArn": "(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
", "IotAnalyticsAction$roleArn": "The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
", "KinesisAction$roleArn": "The ARN of the IAM role that grants access to the Amazon Kinesis stream.
", "LoggingOptionsPayload$roleArn": "The ARN of the IAM role that grants access.
", "RepublishAction$roleArn": "The ARN of the IAM role that grants access.
", "S3Action$roleArn": "The ARN of the IAM role that grants access.
", "SetV2LoggingOptionsRequest$roleArn": "The ARN of the role that allows IoT to write to Cloudwatch logs.
", "SnsAction$targetArn": "The ARN of the SNS topic.
", "SnsAction$roleArn": "The ARN of the IAM role that grants access.
", "SqsAction$roleArn": "The ARN of the IAM role that grants access.
", "StepFunctionsAction$roleArn": "The ARN of the role that grants IoT permission to start execution of a state machine (\"Action\":\"states:StartExecution\").
" } }, "AwsIotJobArn": { "base": null, "refs": { "CreateOTAUpdateResponse$awsIotJobArn": "The AWS IoT job ARN associated with the OTA update.
", "OTAUpdateInfo$awsIotJobArn": "The AWS IoT job ARN associated with the OTA update.
" } }, "AwsIotJobId": { "base": null, "refs": { "CreateOTAUpdateResponse$awsIotJobId": "The AWS IoT job ID associated with the OTA update.
", "OTAUpdateInfo$awsIotJobId": "The AWS IoT job ID associated with the OTA update.
" } }, "AwsIotSqlVersion": { "base": null, "refs": { "TopicRule$awsIotSqlVersion": "The version of the SQL rules engine to use when evaluating the rule.
", "TopicRulePayload$awsIotSqlVersion": "The version of the SQL rules engine to use when evaluating the rule.
" } }, "AwsJobExecutionsRolloutConfig": { "base": "Configuration for the rollout of OTA updates.
", "refs": { "CreateOTAUpdateRequest$awsJobExecutionsRolloutConfig": "Configuration for the rollout of OTA updates.
", "OTAUpdateInfo$awsJobExecutionsRolloutConfig": "Configuration for the rollout of OTA updates.
" } }, "Behavior": { "base": "A Device Defender security profile behavior.
", "refs": { "ActiveViolation$behavior": "The behavior which is being violated.
", "Behaviors$member": null, "ViolationEvent$behavior": "The behavior which was violated.
" } }, "BehaviorCriteria": { "base": "The criteria by which the behavior is determined to be normal.
", "refs": { "Behavior$criteria": "The criteria that determine if a device is behaving normally in regard to the metric.
What is measured by the behavior.
" } }, "BehaviorName": { "base": null, "refs": { "Behavior$name": "The name you have given to the behavior.
" } }, "Behaviors": { "base": null, "refs": { "CreateSecurityProfileRequest$behaviors": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
", "DescribeSecurityProfileResponse$behaviors": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
", "UpdateSecurityProfileRequest$behaviors": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
", "UpdateSecurityProfileResponse$behaviors": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
", "ValidateSecurityProfileBehaviorsRequest$behaviors": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
" } }, "Boolean": { "base": null, "refs": { "ThingTypeMetadata$deprecated": "Whether the thing type is deprecated. If true, no new things could be associated with this type.
" } }, "BucketName": { "base": null, "refs": { "S3Action$bucketName": "The Amazon S3 bucket.
" } }, "CACertificate": { "base": "A CA certificate.
", "refs": { "CACertificates$member": null } }, "CACertificateDescription": { "base": "Describes a CA certificate.
", "refs": { "DescribeCACertificateResponse$certificateDescription": "The CA certificate description.
" } }, "CACertificateStatus": { "base": null, "refs": { "CACertificate$status": "The status of the CA certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
", "CACertificateDescription$status": "The status of a CA certificate.
", "UpdateCACertificateRequest$newStatus": "The updated status of the CA certificate.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
" } }, "CACertificates": { "base": null, "refs": { "ListCACertificatesResponse$certificates": "The CA certificates registered in your AWS account.
" } }, "CancelAuditTaskRequest": { "base": null, "refs": { } }, "CancelAuditTaskResponse": { "base": null, "refs": { } }, "CancelCertificateTransferRequest": { "base": "The input for the CancelCertificateTransfer operation.
", "refs": { } }, "CancelJobExecutionRequest": { "base": null, "refs": { } }, "CancelJobRequest": { "base": null, "refs": { } }, "CancelJobResponse": { "base": null, "refs": { } }, "CanceledChecksCount": { "base": null, "refs": { "TaskStatistics$canceledChecks": "The number of checks that did not run because the audit was canceled.
" } }, "CanceledThings": { "base": null, "refs": { "JobProcessDetails$numberOfCanceledThings": "The number of things that cancelled the job.
" } }, "CannedAccessControlList": { "base": null, "refs": { "S3Action$cannedAcl": "The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.
" } }, "Certificate": { "base": "Information about a certificate.
", "refs": { "Certificates$member": null } }, "CertificateArn": { "base": null, "refs": { "CACertificate$certificateArn": "The ARN of the CA certificate.
", "CACertificateDescription$certificateArn": "The CA certificate ARN.
", "Certificate$certificateArn": "The ARN of the certificate.
", "CertificateDescription$certificateArn": "The ARN of the certificate.
", "CreateCertificateFromCsrResponse$certificateArn": "The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.
", "CreateKeysAndCertificateResponse$certificateArn": "The ARN of the certificate.
", "OutgoingCertificate$certificateArn": "The certificate ARN.
", "RegisterCACertificateResponse$certificateArn": "The CA certificate ARN.
", "RegisterCertificateResponse$certificateArn": "The certificate ARN.
", "SigningProfileParameter$certificateArn": "Certificate ARN.
", "TransferCertificateResponse$transferredCertificateArn": "The ARN of the certificate.
" } }, "CertificateConflictException": { "base": "Unable to verify the CA certificate used to sign the device certificate you are attempting to register. This is happens when you have registered more than one CA certificate that has the same subject field and public key.
", "refs": { } }, "CertificateDescription": { "base": "Describes a certificate.
", "refs": { "DescribeCertificateResponse$certificateDescription": "The description of the certificate.
" } }, "CertificateId": { "base": null, "refs": { "AcceptCertificateTransferRequest$certificateId": "The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
", "CACertificate$certificateId": "The ID of the CA certificate.
", "CACertificateDescription$certificateId": "The CA certificate ID.
", "CancelCertificateTransferRequest$certificateId": "The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
", "Certificate$certificateId": "The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
", "CertificateDescription$certificateId": "The ID of the certificate.
", "CertificateDescription$caCertificateId": "The certificate ID of the CA certificate used to sign this certificate.
", "CreateCertificateFromCsrResponse$certificateId": "The ID of the certificate. Certificate management operations only take a certificateId.
", "CreateKeysAndCertificateResponse$certificateId": "The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).
", "DeleteCACertificateRequest$certificateId": "The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)
", "DeleteCertificateRequest$certificateId": "The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
", "DescribeCACertificateRequest$certificateId": "The CA certificate identifier.
", "DescribeCertificateRequest$certificateId": "The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
", "ListCertificatesByCARequest$caCertificateId": "The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.
", "OutgoingCertificate$certificateId": "The certificate ID.
", "RegisterCACertificateResponse$certificateId": "The CA certificate identifier.
", "RegisterCertificateResponse$certificateId": "The certificate identifier.
", "RejectCertificateTransferRequest$certificateId": "The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
", "ResourceIdentifier$deviceCertificateId": "The ID of the certificate attached to the resource.
", "ResourceIdentifier$caCertificateId": "The ID of the CA certificate used to authorize the certificate.
", "TransferCertificateRequest$certificateId": "The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
", "UpdateCACertificateRequest$certificateId": "The CA certificate identifier.
", "UpdateCertificateRequest$certificateId": "The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
" } }, "CertificateName": { "base": null, "refs": { "CodeSigningCertificateChain$certificateName": "The name of the certificate.
" } }, "CertificatePathOnDevice": { "base": null, "refs": { "SigningProfileParameter$certificatePathOnDevice": "The location of the code-signing certificate on your device.
" } }, "CertificatePem": { "base": "The PEM of a certificate.
", "refs": { "CACertificateDescription$certificatePem": "The CA certificate data, in PEM format.
", "CertificateDescription$certificatePem": "The certificate data, in PEM format.
", "CreateCertificateFromCsrResponse$certificatePem": "The certificate data, in PEM format.
", "CreateKeysAndCertificateResponse$certificatePem": "The certificate data, in PEM format.
", "RegisterCACertificateRequest$caCertificate": "The CA certificate.
", "RegisterCACertificateRequest$verificationCertificate": "The private key verification certificate.
", "RegisterCertificateRequest$certificatePem": "The certificate data, in PEM format.
", "RegisterCertificateRequest$caCertificatePem": "The CA certificate used to sign the device certificate being registered.
", "RegisterThingResponse$certificatePem": ".
" } }, "CertificateSigningRequest": { "base": null, "refs": { "CreateCertificateFromCsrRequest$certificateSigningRequest": "The certificate signing request (CSR).
" } }, "CertificateStateException": { "base": "The certificate operation is not allowed.
", "refs": { } }, "CertificateStatus": { "base": null, "refs": { "Certificate$status": "The status of the certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
", "CertificateDescription$status": "The status of the certificate.
", "RegisterCertificateRequest$status": "The status of the register certificate request.
", "UpdateCertificateRequest$newStatus": "The new status.
Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
" } }, "CertificateValidationException": { "base": "The certificate is invalid.
", "refs": { } }, "CertificateValidity": { "base": "When the certificate is valid.
", "refs": { "CACertificateDescription$validity": "When the CA certificate is valid.
", "CertificateDescription$validity": "When the certificate is valid.
" } }, "Certificates": { "base": null, "refs": { "ListCertificatesByCAResponse$certificates": "The device certificates signed by the specified CA certificate.
", "ListCertificatesResponse$certificates": "The descriptions of the certificates.
" } }, "ChannelName": { "base": null, "refs": { "IotAnalyticsAction$channelName": "The name of the IoT Analytics channel to which message data will be sent.
" } }, "CheckCompliant": { "base": null, "refs": { "AuditCheckDetails$checkCompliant": "True if the check completed and found all resources compliant.
" } }, "Cidr": { "base": null, "refs": { "Cidrs$member": null } }, "Cidrs": { "base": null, "refs": { "MetricValue$cidrs": "If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
The default client ID.
", "ResourceIdentifier$clientId": "The client ID.
", "TestAuthorizationRequest$clientId": "The MQTT client ID.
" } }, "CloudwatchAlarmAction": { "base": "Describes an action that updates a CloudWatch alarm.
", "refs": { "Action$cloudwatchAlarm": "Change the state of a CloudWatch alarm.
" } }, "CloudwatchMetricAction": { "base": "Describes an action that captures a CloudWatch metric.
", "refs": { "Action$cloudwatchMetric": "Capture a CloudWatch metric.
" } }, "Code": { "base": null, "refs": { "ErrorInfo$code": "The error code.
" } }, "CodeSigning": { "base": "Describes the method to use when code signing a file.
", "refs": { "OTAUpdateFile$codeSigning": "The code signing method of the file.
" } }, "CodeSigningCertificateChain": { "base": "Describes the certificate chain being used when code signing a file.
", "refs": { "CustomCodeSigning$certificateChain": "The certificate chain.
" } }, "CodeSigningSignature": { "base": "Describes the signature for a file.
", "refs": { "CustomCodeSigning$signature": "The signature for the file.
" } }, "CognitoIdentityPoolId": { "base": null, "refs": { "GetEffectivePoliciesRequest$cognitoIdentityPoolId": "The Cognito identity pool ID.
", "ResourceIdentifier$cognitoIdentityPoolId": "The ID of the Cognito Identity Pool.
", "TestAuthorizationRequest$cognitoIdentityPoolId": "The Cognito identity pool ID.
" } }, "Comment": { "base": null, "refs": { "AssociateTargetsWithJobRequest$comment": "An optional comment string describing why the job was associated with the targets.
", "CancelJobRequest$comment": "An optional comment string describing why the job was canceled.
", "Job$comment": "If the job was updated, describes the reason for the update.
" } }, "ComparisonOperator": { "base": null, "refs": { "BehaviorCriteria$comparisonOperator": "The operator that relates the thing measured (metric) to the criteria (value).
The number of checks that found compliant resources.
" } }, "Configuration": { "base": "Configuration.
", "refs": { "EventConfigurations$value": null } }, "ConflictingResourceUpdateException": { "base": "A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.
", "refs": { } }, "Count": { "base": null, "refs": { "DescribeThingRegistrationTaskResponse$successCount": "The number of things successfully provisioned.
", "DescribeThingRegistrationTaskResponse$failureCount": "The number of things that failed to be provisioned.
" } }, "CreateAuthorizerRequest": { "base": null, "refs": { } }, "CreateAuthorizerResponse": { "base": null, "refs": { } }, "CreateCertificateFromCsrRequest": { "base": "The input for the CreateCertificateFromCsr operation.
", "refs": { } }, "CreateCertificateFromCsrResponse": { "base": "The output from the CreateCertificateFromCsr operation.
", "refs": { } }, "CreateJobRequest": { "base": null, "refs": { } }, "CreateJobResponse": { "base": null, "refs": { } }, "CreateKeysAndCertificateRequest": { "base": "The input for the CreateKeysAndCertificate operation.
", "refs": { } }, "CreateKeysAndCertificateResponse": { "base": "The output of the CreateKeysAndCertificate operation.
", "refs": { } }, "CreateOTAUpdateRequest": { "base": null, "refs": { } }, "CreateOTAUpdateResponse": { "base": null, "refs": { } }, "CreatePolicyRequest": { "base": "The input for the CreatePolicy operation.
", "refs": { } }, "CreatePolicyResponse": { "base": "The output from the CreatePolicy operation.
", "refs": { } }, "CreatePolicyVersionRequest": { "base": "The input for the CreatePolicyVersion operation.
", "refs": { } }, "CreatePolicyVersionResponse": { "base": "The output of the CreatePolicyVersion operation.
", "refs": { } }, "CreateRoleAliasRequest": { "base": null, "refs": { } }, "CreateRoleAliasResponse": { "base": null, "refs": { } }, "CreateScheduledAuditRequest": { "base": null, "refs": { } }, "CreateScheduledAuditResponse": { "base": null, "refs": { } }, "CreateSecurityProfileRequest": { "base": null, "refs": { } }, "CreateSecurityProfileResponse": { "base": null, "refs": { } }, "CreateStreamRequest": { "base": null, "refs": { } }, "CreateStreamResponse": { "base": null, "refs": { } }, "CreateThingGroupRequest": { "base": null, "refs": { } }, "CreateThingGroupResponse": { "base": null, "refs": { } }, "CreateThingRequest": { "base": "The input for the CreateThing operation.
", "refs": { } }, "CreateThingResponse": { "base": "The output of the CreateThing operation.
", "refs": { } }, "CreateThingTypeRequest": { "base": "The input for the CreateThingType operation.
", "refs": { } }, "CreateThingTypeResponse": { "base": "The output of the CreateThingType operation.
", "refs": { } }, "CreateTopicRuleRequest": { "base": "The input for the CreateTopicRule operation.
", "refs": { } }, "CreatedAtDate": { "base": null, "refs": { "TopicRule$createdAt": "The date and time the rule was created.
", "TopicRuleListItem$createdAt": "The date and time the rule was created.
" } }, "CreationDate": { "base": null, "refs": { "DescribeEventConfigurationsResponse$creationDate": "The creation date of the event configuration.
", "DescribeThingRegistrationTaskResponse$creationDate": "The task creation date.
", "ThingGroupMetadata$creationDate": "The UNIX timestamp of when the thing group was created.
", "ThingTypeMetadata$creationDate": "The date and time when the thing type was created.
" } }, "CredentialDurationSeconds": { "base": null, "refs": { "CreateRoleAliasRequest$credentialDurationSeconds": "How long (in seconds) the credentials will be valid.
", "RoleAliasDescription$credentialDurationSeconds": "The number of seconds for which the credential is valid.
", "UpdateRoleAliasRequest$credentialDurationSeconds": "The number of seconds the credential will be valid.
" } }, "CustomCodeSigning": { "base": "Describes a custom method used to code sign a file.
", "refs": { "CodeSigning$customCodeSigning": "A custom method for code signing a file.
" } }, "CustomerVersion": { "base": null, "refs": { "CACertificateDescription$customerVersion": "The customer version of the CA certificate.
", "CertificateDescription$customerVersion": "The customer version of the certificate.
" } }, "DateType": { "base": null, "refs": { "AuthorizerDescription$creationDate": "The UNIX timestamp of when the authorizer was created.
", "AuthorizerDescription$lastModifiedDate": "The UNIX timestamp of when the authorizer was last updated.
", "CACertificate$creationDate": "The date the CA certificate was created.
", "CACertificateDescription$creationDate": "The date the CA certificate was created.
", "CACertificateDescription$lastModifiedDate": "The date the CA certificate was last modified.
", "Certificate$creationDate": "The date and time the certificate was created.
", "CertificateDescription$creationDate": "The date and time the certificate was created.
", "CertificateDescription$lastModifiedDate": "The date and time the certificate was last modified.
", "CertificateValidity$notBefore": "The certificate is not valid before this date.
", "CertificateValidity$notAfter": "The certificate is not valid after this date.
", "GetPolicyResponse$creationDate": "The date the policy was created.
", "GetPolicyResponse$lastModifiedDate": "The date the policy was last modified.
", "GetPolicyVersionResponse$creationDate": "The date the policy version was created.
", "GetPolicyVersionResponse$lastModifiedDate": "The date the policy version was last modified.
", "Job$createdAt": "The time, in milliseconds since the epoch, when the job was created.
", "Job$lastUpdatedAt": "The time, in milliseconds since the epoch, when the job was last updated.
", "Job$completedAt": "The time, in milliseconds since the epoch, when the job was completed.
", "JobExecution$queuedAt": "The time, in milliseconds since the epoch, when the job execution was queued.
", "JobExecution$startedAt": "The time, in milliseconds since the epoch, when the job execution started.
", "JobExecution$lastUpdatedAt": "The time, in milliseconds since the epoch, when the job execution was last updated.
", "JobExecutionSummary$queuedAt": "The time, in milliseconds since the epoch, when the job execution was queued.
", "JobExecutionSummary$startedAt": "The time, in milliseconds since the epoch, when the job execution started.
", "JobExecutionSummary$lastUpdatedAt": "The time, in milliseconds since the epoch, when the job execution was last updated.
", "JobSummary$createdAt": "The time, in milliseconds since the epoch, when the job was created.
", "JobSummary$lastUpdatedAt": "The time, in milliseconds since the epoch, when the job was last updated.
", "JobSummary$completedAt": "The time, in milliseconds since the epoch, when the job completed.
", "OTAUpdateInfo$creationDate": "The date when the OTA update was created.
", "OTAUpdateInfo$lastModifiedDate": "The date when the OTA update was last updated.
", "OTAUpdateSummary$creationDate": "The date when the OTA update was created.
", "OutgoingCertificate$transferDate": "The date the transfer was initiated.
", "OutgoingCertificate$creationDate": "The certificate creation date.
", "PolicyVersion$createDate": "The date and time the policy was created.
", "RoleAliasDescription$creationDate": "The UNIX timestamp of when the role alias was created.
", "RoleAliasDescription$lastModifiedDate": "The UNIX timestamp of when the role alias was last modified.
", "StreamInfo$createdAt": "The date when the stream was created.
", "StreamInfo$lastUpdatedAt": "The date when the stream was last updated.
", "TransferData$transferDate": "The date the transfer took place.
", "TransferData$acceptDate": "The date the transfer was accepted.
", "TransferData$rejectDate": "The date the transfer was rejected.
" } }, "DayOfMonth": { "base": null, "refs": { "CreateScheduledAuditRequest$dayOfMonth": "The day of the month on which the scheduled audit takes place. 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.
", "DescribeScheduledAuditResponse$dayOfMonth": "The day of the month on which the scheduled audit takes place. Will be \"1\" through \"31\" or \"LAST\". 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.
", "ScheduledAuditMetadata$dayOfMonth": "The day of the month on which the scheduled audit is run (if the frequency is \"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.
The day of the month on which the scheduled audit takes place. 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": { "base": null, "refs": { "CreateScheduledAuditRequest$dayOfWeek": "The day of the week on which the scheduled audit takes place. 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\".
", "DescribeScheduledAuditResponse$dayOfWeek": "The day of the week on which the scheduled audit takes place. One of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\".
", "ScheduledAuditMetadata$dayOfWeek": "The day of the week on which the scheduled audit is run (if the frequency is \"WEEKLY\" or \"BIWEEKLY\").
The day of the week on which the scheduled audit takes place. 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\".
" } }, "DeleteAccountAuditConfigurationRequest": { "base": null, "refs": { } }, "DeleteAccountAuditConfigurationResponse": { "base": null, "refs": { } }, "DeleteAuthorizerRequest": { "base": null, "refs": { } }, "DeleteAuthorizerResponse": { "base": null, "refs": { } }, "DeleteCACertificateRequest": { "base": "Input for the DeleteCACertificate operation.
", "refs": { } }, "DeleteCACertificateResponse": { "base": "The output for the DeleteCACertificate operation.
", "refs": { } }, "DeleteCertificateRequest": { "base": "The input for the DeleteCertificate operation.
", "refs": { } }, "DeleteConflictException": { "base": "You can't delete the resource because it is attached to one or more resources.
", "refs": { } }, "DeleteJobExecutionRequest": { "base": null, "refs": { } }, "DeleteJobRequest": { "base": null, "refs": { } }, "DeleteOTAUpdateRequest": { "base": null, "refs": { } }, "DeleteOTAUpdateResponse": { "base": null, "refs": { } }, "DeletePolicyRequest": { "base": "The input for the DeletePolicy operation.
", "refs": { } }, "DeletePolicyVersionRequest": { "base": "The input for the DeletePolicyVersion operation.
", "refs": { } }, "DeleteRegistrationCodeRequest": { "base": "The input for the DeleteRegistrationCode operation.
", "refs": { } }, "DeleteRegistrationCodeResponse": { "base": "The output for the DeleteRegistrationCode operation.
", "refs": { } }, "DeleteRoleAliasRequest": { "base": null, "refs": { } }, "DeleteRoleAliasResponse": { "base": null, "refs": { } }, "DeleteScheduledAuditRequest": { "base": null, "refs": { } }, "DeleteScheduledAuditResponse": { "base": null, "refs": { } }, "DeleteScheduledAudits": { "base": null, "refs": { "DeleteAccountAuditConfigurationRequest$deleteScheduledAudits": "If true, all scheduled audits are deleted.
" } }, "DeleteSecurityProfileRequest": { "base": null, "refs": { } }, "DeleteSecurityProfileResponse": { "base": null, "refs": { } }, "DeleteStream": { "base": null, "refs": { "DeleteOTAUpdateRequest$deleteStream": "Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.
" } }, "DeleteStreamRequest": { "base": null, "refs": { } }, "DeleteStreamResponse": { "base": null, "refs": { } }, "DeleteThingGroupRequest": { "base": null, "refs": { } }, "DeleteThingGroupResponse": { "base": null, "refs": { } }, "DeleteThingRequest": { "base": "The input for the DeleteThing operation.
", "refs": { } }, "DeleteThingResponse": { "base": "The output of the DeleteThing operation.
", "refs": { } }, "DeleteThingTypeRequest": { "base": "The input for the DeleteThingType operation.
", "refs": { } }, "DeleteThingTypeResponse": { "base": "The output for the DeleteThingType operation.
", "refs": { } }, "DeleteTopicRuleRequest": { "base": "The input for the DeleteTopicRule operation.
", "refs": { } }, "DeleteV2LoggingLevelRequest": { "base": null, "refs": { } }, "DeliveryStreamName": { "base": null, "refs": { "FirehoseAction$deliveryStreamName": "The delivery stream name.
" } }, "Denied": { "base": "Contains information that denied the authorization.
", "refs": { "AuthResult$denied": "The policies and statements that denied the specified action.
" } }, "DeprecateThingTypeRequest": { "base": "The input for the DeprecateThingType operation.
", "refs": { } }, "DeprecateThingTypeResponse": { "base": "The output for the DeprecateThingType operation.
", "refs": { } }, "DeprecationDate": { "base": null, "refs": { "ThingTypeMetadata$deprecationDate": "The date and time when the thing type was deprecated.
" } }, "DescribeAccountAuditConfigurationRequest": { "base": null, "refs": { } }, "DescribeAccountAuditConfigurationResponse": { "base": null, "refs": { } }, "DescribeAuditTaskRequest": { "base": null, "refs": { } }, "DescribeAuditTaskResponse": { "base": null, "refs": { } }, "DescribeAuthorizerRequest": { "base": null, "refs": { } }, "DescribeAuthorizerResponse": { "base": null, "refs": { } }, "DescribeCACertificateRequest": { "base": "The input for the DescribeCACertificate operation.
", "refs": { } }, "DescribeCACertificateResponse": { "base": "The output from the DescribeCACertificate operation.
", "refs": { } }, "DescribeCertificateRequest": { "base": "The input for the DescribeCertificate operation.
", "refs": { } }, "DescribeCertificateResponse": { "base": "The output of the DescribeCertificate operation.
", "refs": { } }, "DescribeDefaultAuthorizerRequest": { "base": null, "refs": { } }, "DescribeDefaultAuthorizerResponse": { "base": null, "refs": { } }, "DescribeEndpointRequest": { "base": "The input for the DescribeEndpoint operation.
", "refs": { } }, "DescribeEndpointResponse": { "base": "The output from the DescribeEndpoint operation.
", "refs": { } }, "DescribeEventConfigurationsRequest": { "base": null, "refs": { } }, "DescribeEventConfigurationsResponse": { "base": null, "refs": { } }, "DescribeIndexRequest": { "base": null, "refs": { } }, "DescribeIndexResponse": { "base": null, "refs": { } }, "DescribeJobExecutionRequest": { "base": null, "refs": { } }, "DescribeJobExecutionResponse": { "base": null, "refs": { } }, "DescribeJobRequest": { "base": null, "refs": { } }, "DescribeJobResponse": { "base": null, "refs": { } }, "DescribeRoleAliasRequest": { "base": null, "refs": { } }, "DescribeRoleAliasResponse": { "base": null, "refs": { } }, "DescribeScheduledAuditRequest": { "base": null, "refs": { } }, "DescribeScheduledAuditResponse": { "base": null, "refs": { } }, "DescribeSecurityProfileRequest": { "base": null, "refs": { } }, "DescribeSecurityProfileResponse": { "base": null, "refs": { } }, "DescribeStreamRequest": { "base": null, "refs": { } }, "DescribeStreamResponse": { "base": null, "refs": { } }, "DescribeThingGroupRequest": { "base": null, "refs": { } }, "DescribeThingGroupResponse": { "base": null, "refs": { } }, "DescribeThingRegistrationTaskRequest": { "base": null, "refs": { } }, "DescribeThingRegistrationTaskResponse": { "base": null, "refs": { } }, "DescribeThingRequest": { "base": "The input for the DescribeThing operation.
", "refs": { } }, "DescribeThingResponse": { "base": "The output from the DescribeThing operation.
", "refs": { } }, "DescribeThingTypeRequest": { "base": "The input for the DescribeThingType operation.
", "refs": { } }, "DescribeThingTypeResponse": { "base": "The output for the DescribeThingType operation.
", "refs": { } }, "Description": { "base": null, "refs": { "TopicRule$description": "The description of the rule.
", "TopicRulePayload$description": "The description of the rule.
" } }, "Destination": { "base": "Describes the location of the updated firmware.
", "refs": { "StartSigningJobParameter$destination": "The location to write the code-signed file.
" } }, "DetachPolicyRequest": { "base": null, "refs": { } }, "DetachPrincipalPolicyRequest": { "base": "The input for the DetachPrincipalPolicy operation.
", "refs": { } }, "DetachSecurityProfileRequest": { "base": null, "refs": { } }, "DetachSecurityProfileResponse": { "base": null, "refs": { } }, "DetachThingPrincipalRequest": { "base": "The input for the DetachThingPrincipal operation.
", "refs": { } }, "DetachThingPrincipalResponse": { "base": "The output from the DetachThingPrincipal operation.
", "refs": { } }, "DetailsKey": { "base": null, "refs": { "DetailsMap$key": null } }, "DetailsMap": { "base": null, "refs": { "CancelJobExecutionRequest$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.
", "JobExecutionStatusDetails$detailsMap": "The job execution status.
" } }, "DetailsValue": { "base": null, "refs": { "DetailsMap$value": null } }, "DisableAllLogs": { "base": null, "refs": { "GetV2LoggingOptionsResponse$disableAllLogs": "Disables all logs.
", "SetV2LoggingOptionsRequest$disableAllLogs": "If true all logs are disabled. The default is false.
" } }, "DisableTopicRuleRequest": { "base": "The input for the DisableTopicRuleRequest operation.
", "refs": { } }, "DurationSeconds": { "base": null, "refs": { "BehaviorCriteria$durationSeconds": "Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT).
Describes an action to write to a DynamoDB table.
The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.
The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.
You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:
\"hashKeyValue\": \"${topic(3)}\"
The following field uses the timestamp:
\"rangeKeyValue\": \"${timestamp()}\"
Write to a DynamoDB table.
" } }, "DynamoDBv2Action": { "base": "Describes an action to write to a DynamoDB table.
This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.
", "refs": { "Action$dynamoDBv2": "Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
" } }, "DynamoKeyType": { "base": null, "refs": { "DynamoDBAction$hashKeyType": "The hash key type. Valid values are \"STRING\" or \"NUMBER\"
", "DynamoDBAction$rangeKeyType": "The range key type. Valid values are \"STRING\" or \"NUMBER\"
" } }, "DynamoOperation": { "base": null, "refs": { "DynamoDBAction$operation": "The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.
The effective policies.
" } }, "EffectivePolicy": { "base": "The policy that has the effect on the authorization results.
", "refs": { "EffectivePolicies$member": null } }, "ElasticsearchAction": { "base": "Describes an action that writes data to an Amazon Elasticsearch Service domain.
", "refs": { "Action$elasticsearch": "Write data to an Amazon Elasticsearch Service domain.
" } }, "ElasticsearchEndpoint": { "base": null, "refs": { "ElasticsearchAction$endpoint": "The endpoint of your Elasticsearch domain.
" } }, "ElasticsearchId": { "base": null, "refs": { "ElasticsearchAction$id": "The unique identifier for the document you are storing.
" } }, "ElasticsearchIndex": { "base": null, "refs": { "ElasticsearchAction$index": "The Elasticsearch index where you want to store your data.
" } }, "ElasticsearchType": { "base": null, "refs": { "ElasticsearchAction$type": "The type of document you are storing.
" } }, "EnableTopicRuleRequest": { "base": "The input for the EnableTopicRuleRequest operation.
", "refs": { } }, "Enabled": { "base": null, "refs": { "AuditCheckConfiguration$enabled": "True if this audit check is enabled for this account.
", "AuditNotificationTarget$enabled": "True if notifications to the target are enabled.
", "Configuration$Enabled": "True to enable the configuration.
" } }, "EndpointAddress": { "base": null, "refs": { "DescribeEndpointResponse$endpointAddress": "The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
" } }, "EndpointType": { "base": null, "refs": { "DescribeEndpointRequest$endpointType": "The endpoint type (such as iot:Data, iot:CredentialProvider and iot:Jobs).
The code of any error encountered when performing this check during this audit. One of \"INSUFFICIENT_PERMISSIONS\", or \"AUDIT_CHECK_DISABLED\".
" } }, "ErrorInfo": { "base": "Error information.
", "refs": { "OTAUpdateInfo$errorInfo": "Error information associated with the OTA update.
" } }, "ErrorMessage": { "base": null, "refs": { "AuditCheckDetails$message": "The message associated with any error encountered when performing this check during this audit.
", "DescribeThingRegistrationTaskResponse$message": "The message.
", "ValidationError$errorMessage": "The description of an error found in the behaviors.
" } }, "EventConfigurations": { "base": null, "refs": { "DescribeEventConfigurationsResponse$eventConfigurations": "The event configurations.
", "UpdateEventConfigurationsRequest$eventConfigurations": "The new event configuration values.
" } }, "EventType": { "base": null, "refs": { "EventConfigurations$key": null } }, "ExecutionNamePrefix": { "base": null, "refs": { "StepFunctionsAction$executionNamePrefix": "(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
" } }, "ExecutionNumber": { "base": null, "refs": { "DeleteJobExecutionRequest$executionNumber": "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.
A string (consisting of the digits \"0\" through \"9\" which is used to specify a particular job execution on a particular device.
", "JobExecution$executionNumber": "A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
", "JobExecutionSummary$executionNumber": "A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information.
" } }, "ExpectedVersion": { "base": null, "refs": { "CancelJobExecutionRequest$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.)
" } }, "ExpiresInSec": { "base": null, "refs": { "PresignedUrlConfig$expiresInSec": "How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
" } }, "ExplicitDeny": { "base": "Information that explicitly denies authorization.
", "refs": { "Denied$explicitDeny": "Information that explicitly denies the authorization.
" } }, "FailedChecksCount": { "base": null, "refs": { "TaskStatistics$failedChecks": "The number of checks
" } }, "FailedThings": { "base": null, "refs": { "JobProcessDetails$numberOfFailedThings": "The number of things that failed executing the job.
" } }, "FileId": { "base": null, "refs": { "Stream$fileId": "The ID of a file associated with a stream.
", "StreamFile$fileId": "The file ID.
" } }, "FileLocation": { "base": "The location of the OTA update.
", "refs": { "OTAUpdateFile$fileLocation": "The location of the updated firmware.
" } }, "FileName": { "base": null, "refs": { "OTAUpdateFile$fileName": "The name of the file.
" } }, "FirehoseAction": { "base": "Describes an action that writes data to an Amazon Kinesis Firehose stream.
", "refs": { "Action$firehose": "Write to an Amazon Kinesis Firehose stream.
" } }, "FirehoseSeparator": { "base": null, "refs": { "FirehoseAction$separator": "A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).
" } }, "Flag": { "base": null, "refs": { "AttributePayload$merge": "Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.
To remove an attribute, call UpdateThing with an empty attribute value.
The merge attribute is only valid when calling UpdateThing.
Forces a certificate request to be deleted.
" } }, "ForceDeleteAWSJob": { "base": null, "refs": { "DeleteOTAUpdateRequest$forceDeleteAWSJob": "Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted.
" } }, "ForceFlag": { "base": null, "refs": { "CancelJobExecutionRequest$force": "(Optional) If true the job execution will be canceled if it has status IN_PROGRESS 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 IN_PROGRESS, 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.
", "CancelJobRequest$force": "(Optional) If true job executions with status \"IN_PROGRESS\" and \"QUEUED\" are canceled, otherwise only job executions with status \"QUEUED\" are canceled. The default is false.
Canceling a job which is \"IN_PROGRESS\", 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.
", "DeleteJobExecutionRequest$force": "(Optional) When true, you can delete a job execution which is \"IN_PROGRESS\". 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 \"IN_PROGRESS\", 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.
(Optional) When true, you can delete a job which is \"IN_PROGRESS\". 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 \"IN_PROGRESS\", 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.
Will be true if the job was canceled with the optional force parameter set to true.
Will be true if the job execution was canceled with the optional force parameter set to true.
The ARN of the Lambda function.
" } }, "GEMaxResults": { "base": null, "refs": { "ListTopicRulesRequest$maxResults": "The maximum number of results to return.
" } }, "GenerationId": { "base": null, "refs": { "CACertificateDescription$generationId": "The generation ID of the CA certificate.
", "CertificateDescription$generationId": "The generation ID of the certificate.
", "GetPolicyResponse$generationId": "The generation ID of the policy.
", "GetPolicyVersionResponse$generationId": "The generation ID of the policy version.
" } }, "GetEffectivePoliciesRequest": { "base": null, "refs": { } }, "GetEffectivePoliciesResponse": { "base": null, "refs": { } }, "GetIndexingConfigurationRequest": { "base": null, "refs": { } }, "GetIndexingConfigurationResponse": { "base": null, "refs": { } }, "GetJobDocumentRequest": { "base": null, "refs": { } }, "GetJobDocumentResponse": { "base": null, "refs": { } }, "GetLoggingOptionsRequest": { "base": "The input for the GetLoggingOptions operation.
", "refs": { } }, "GetLoggingOptionsResponse": { "base": "The output from the GetLoggingOptions operation.
", "refs": { } }, "GetOTAUpdateRequest": { "base": null, "refs": { } }, "GetOTAUpdateResponse": { "base": null, "refs": { } }, "GetPolicyRequest": { "base": "The input for the GetPolicy operation.
", "refs": { } }, "GetPolicyResponse": { "base": "The output from the GetPolicy operation.
", "refs": { } }, "GetPolicyVersionRequest": { "base": "The input for the GetPolicyVersion operation.
", "refs": { } }, "GetPolicyVersionResponse": { "base": "The output from the GetPolicyVersion operation.
", "refs": { } }, "GetRegistrationCodeRequest": { "base": "The input to the GetRegistrationCode operation.
", "refs": { } }, "GetRegistrationCodeResponse": { "base": "The output from the GetRegistrationCode operation.
", "refs": { } }, "GetTopicRuleRequest": { "base": "The input for the GetTopicRule operation.
", "refs": { } }, "GetTopicRuleResponse": { "base": "The output from the GetTopicRule operation.
", "refs": { } }, "GetV2LoggingOptionsRequest": { "base": null, "refs": { } }, "GetV2LoggingOptionsResponse": { "base": null, "refs": { } }, "GroupNameAndArn": { "base": "The name and ARN of a group.
", "refs": { "ThingGroupNameAndArnList$member": null } }, "HashAlgorithm": { "base": null, "refs": { "CustomCodeSigning$hashAlgorithm": "The hash algorithm used to code sign the file.
" } }, "HashKeyField": { "base": null, "refs": { "DynamoDBAction$hashKeyField": "The hash key name.
" } }, "HashKeyValue": { "base": null, "refs": { "DynamoDBAction$hashKeyValue": "The hash key value.
" } }, "ImplicitDeny": { "base": "Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.
", "refs": { "Denied$implicitDeny": "Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.
" } }, "InProgressChecksCount": { "base": null, "refs": { "TaskStatistics$inProgressChecks": "The number of checks in progress.
" } }, "InProgressThings": { "base": null, "refs": { "JobProcessDetails$numberOfInProgressThings": "The number of things currently executing the job.
" } }, "IndexName": { "base": null, "refs": { "DescribeIndexRequest$indexName": "The index name.
", "DescribeIndexResponse$indexName": "The index name.
", "IndexNamesList$member": null, "SearchIndexRequest$indexName": "The search index name.
" } }, "IndexNamesList": { "base": null, "refs": { "ListIndicesResponse$indexNames": "The index names.
" } }, "IndexNotReadyException": { "base": "The index is not ready.
", "refs": { } }, "IndexSchema": { "base": null, "refs": { "DescribeIndexResponse$schema": "Contains a value that specifies the type of indexing performed. Valid values are:
REGISTRY – Your thing index will contain only registry data.
REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.
The index status.
" } }, "InlineDocument": { "base": null, "refs": { "CodeSigningCertificateChain$inlineDocument": "A base64 encoded binary representation of the code signing certificate chain.
" } }, "InternalException": { "base": "An unexpected error has occurred.
", "refs": { } }, "InternalFailureException": { "base": "An unexpected error has occurred.
", "refs": { } }, "InvalidQueryException": { "base": "The query is invalid.
", "refs": { } }, "InvalidRequestException": { "base": "The request is not valid.
", "refs": { } }, "InvalidResponseException": { "base": "The response is invalid.
", "refs": { } }, "InvalidStateTransitionException": { "base": "An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is \"IN_PROGRESS\" without setting the force parameter.
Sends messge data to an AWS IoT Analytics channel.
", "refs": { "Action$iotAnalytics": "Sends message data to an AWS IoT Analytics channel.
" } }, "IsAuthenticated": { "base": null, "refs": { "TestInvokeAuthorizerResponse$isAuthenticated": "True if the token is authenticated, otherwise false.
" } }, "IsDefaultVersion": { "base": null, "refs": { "CreatePolicyVersionResponse$isDefaultVersion": "Specifies whether the policy version is the default.
", "GetPolicyVersionResponse$isDefaultVersion": "Specifies whether the policy version is the default.
", "PolicyVersion$isDefaultVersion": "Specifies whether the policy version is the default.
" } }, "IsDisabled": { "base": null, "refs": { "ListTopicRulesRequest$ruleDisabled": "Specifies whether the rule is disabled.
", "TopicRule$ruleDisabled": "Specifies whether the rule is disabled.
", "TopicRuleListItem$ruleDisabled": "Specifies whether the rule is disabled.
", "TopicRulePayload$ruleDisabled": "Specifies whether the rule is disabled.
" } }, "Job": { "base": "The Job object contains details about a job.
Information about the job.
" } }, "JobArn": { "base": null, "refs": { "AssociateTargetsWithJobResponse$jobArn": "An ARN identifying the job.
", "CancelJobResponse$jobArn": "The job ARN.
", "CreateJobResponse$jobArn": "The job ARN.
", "Job$jobArn": "An ARN identifying the job with format \"arn:aws:iot:region:account:job/jobId\".
", "JobSummary$jobArn": "The job ARN.
" } }, "JobDescription": { "base": null, "refs": { "AssociateTargetsWithJobResponse$description": "A short text description of the job.
", "CancelJobResponse$description": "A short text description of the job.
", "CreateJobRequest$description": "A short text description of the job.
", "CreateJobResponse$description": "The job description.
", "Job$description": "A short text description of the job.
" } }, "JobDocument": { "base": null, "refs": { "CreateJobRequest$document": "The job document.
", "GetJobDocumentResponse$document": "The job document content.
" } }, "JobDocumentSource": { "base": null, "refs": { "CreateJobRequest$documentSource": "An S3 link to the job document.
", "DescribeJobResponse$documentSource": "An S3 link to the job document.
" } }, "JobExecution": { "base": "The job execution object represents the execution of a job on a particular device.
", "refs": { "DescribeJobExecutionResponse$execution": "Information about the job execution.
" } }, "JobExecutionStatus": { "base": null, "refs": { "JobExecution$status": "The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
", "JobExecutionSummary$status": "The status of the job execution.
", "ListJobExecutionsForJobRequest$status": "The status of the job.
", "ListJobExecutionsForThingRequest$status": "An optional filter that lets you search for jobs that have the specified status.
" } }, "JobExecutionStatusDetails": { "base": "Details of the job execution status.
", "refs": { "JobExecution$statusDetails": "A collection of name/value pairs that describe the status of the job execution.
" } }, "JobExecutionSummary": { "base": "The job execution summary.
", "refs": { "JobExecutionSummaryForJob$jobExecutionSummary": "Contains a subset of information about a job execution.
", "JobExecutionSummaryForThing$jobExecutionSummary": "Contains a subset of information about a job execution.
" } }, "JobExecutionSummaryForJob": { "base": "Contains a summary of information about job executions for a specific job.
", "refs": { "JobExecutionSummaryForJobList$member": null } }, "JobExecutionSummaryForJobList": { "base": null, "refs": { "ListJobExecutionsForJobResponse$executionSummaries": "A list of job execution summaries.
" } }, "JobExecutionSummaryForThing": { "base": "The job execution summary for a thing.
", "refs": { "JobExecutionSummaryForThingList$member": null } }, "JobExecutionSummaryForThingList": { "base": null, "refs": { "ListJobExecutionsForThingResponse$executionSummaries": "A list of job execution summaries.
" } }, "JobExecutionsRolloutConfig": { "base": "Allows you to create a staged rollout of a job.
", "refs": { "CreateJobRequest$jobExecutionsRolloutConfig": "Allows you to create a staged rollout of the job.
", "Job$jobExecutionsRolloutConfig": "Allows you to create a staged rollout of a job.
" } }, "JobId": { "base": null, "refs": { "AssociateTargetsWithJobRequest$jobId": "The unique identifier you assigned to this job when it was created.
", "AssociateTargetsWithJobResponse$jobId": "The unique identifier you assigned to this job when it was created.
", "CancelJobExecutionRequest$jobId": "The ID of the job to be canceled.
", "CancelJobRequest$jobId": "The unique identifier you assigned to this job when it was created.
", "CancelJobResponse$jobId": "The unique identifier you assigned to this job when it was created.
", "CreateJobRequest$jobId": "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.
", "CreateJobResponse$jobId": "The unique identifier you assigned to this job.
", "DeleteJobExecutionRequest$jobId": "The ID of the job whose execution on a particular device will be deleted.
", "DeleteJobRequest$jobId": "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.
", "DescribeJobExecutionRequest$jobId": "The unique identifier you assigned to this job when it was created.
", "DescribeJobRequest$jobId": "The unique identifier you assigned to this job when it was created.
", "GetJobDocumentRequest$jobId": "The unique identifier you assigned to this job when it was created.
", "Job$jobId": "The unique identifier you assigned to this job when it was created.
", "JobExecution$jobId": "The unique identifier you assigned to the job when it was created.
", "JobExecutionSummaryForThing$jobId": "The unique identifier you assigned to this job when it was created.
", "JobSummary$jobId": "The unique identifier you assigned to this job when it was created.
", "ListJobExecutionsForJobRequest$jobId": "The unique identifier you assigned to this job when it was created.
" } }, "JobProcessDetails": { "base": "The job process details.
", "refs": { "Job$jobProcessDetails": "Details about the job process.
" } }, "JobStatus": { "base": null, "refs": { "Job$status": "The status of the job, one of IN_PROGRESS, CANCELED, or COMPLETED.
The job summary status.
", "ListJobsRequest$status": "An optional filter that lets you search for jobs that have the specified status.
" } }, "JobSummary": { "base": "The job summary.
", "refs": { "JobSummaryList$member": null } }, "JobSummaryList": { "base": null, "refs": { "ListJobsResponse$jobs": "A list of jobs.
" } }, "JobTargets": { "base": null, "refs": { "AssociateTargetsWithJobRequest$targets": "A list of thing group ARNs that define the targets of the job.
", "CreateJobRequest$targets": "A list of things and thing groups to which the job should be sent.
", "Job$targets": "A list of IoT things and thing groups to which the job should be sent.
" } }, "JsonDocument": { "base": null, "refs": { "ThingDocument$shadow": "The shadow.
" } }, "Key": { "base": null, "refs": { "S3Action$key": "The object key.
" } }, "KeyName": { "base": null, "refs": { "PublicKeyMap$key": null } }, "KeyPair": { "base": "Describes a key pair.
", "refs": { "CreateKeysAndCertificateResponse$keyPair": "The generated key pair.
" } }, "KeyValue": { "base": null, "refs": { "PublicKeyMap$value": null } }, "KinesisAction": { "base": "Describes an action to write data to an Amazon Kinesis stream.
", "refs": { "Action$kinesis": "Write data to an Amazon Kinesis stream.
" } }, "LambdaAction": { "base": "Describes an action to invoke a Lambda function.
", "refs": { "Action$lambda": "Invoke a Lambda function.
" } }, "LaserMaxResults": { "base": null, "refs": { "ListJobExecutionsForJobRequest$maxResults": "The maximum number of results to be returned per request.
", "ListJobExecutionsForThingRequest$maxResults": "The maximum number of results to be returned per request.
", "ListJobsRequest$maxResults": "The maximum number of results to return per request.
" } }, "LastModifiedDate": { "base": null, "refs": { "DescribeEventConfigurationsResponse$lastModifiedDate": "The date the event configurations were last modified.
", "DescribeThingRegistrationTaskResponse$lastModifiedDate": "The date when the task was last modified.
" } }, "LimitExceededException": { "base": "A limit has been exceeded.
", "refs": { } }, "ListActiveViolationsRequest": { "base": null, "refs": { } }, "ListActiveViolationsResponse": { "base": null, "refs": { } }, "ListAttachedPoliciesRequest": { "base": null, "refs": { } }, "ListAttachedPoliciesResponse": { "base": null, "refs": { } }, "ListAuditFindingsRequest": { "base": null, "refs": { } }, "ListAuditFindingsResponse": { "base": null, "refs": { } }, "ListAuditTasksRequest": { "base": null, "refs": { } }, "ListAuditTasksResponse": { "base": null, "refs": { } }, "ListAuthorizersRequest": { "base": null, "refs": { } }, "ListAuthorizersResponse": { "base": null, "refs": { } }, "ListCACertificatesRequest": { "base": "Input for the ListCACertificates operation.
", "refs": { } }, "ListCACertificatesResponse": { "base": "The output from the ListCACertificates operation.
", "refs": { } }, "ListCertificatesByCARequest": { "base": "The input to the ListCertificatesByCA operation.
", "refs": { } }, "ListCertificatesByCAResponse": { "base": "The output of the ListCertificatesByCA operation.
", "refs": { } }, "ListCertificatesRequest": { "base": "The input for the ListCertificates operation.
", "refs": { } }, "ListCertificatesResponse": { "base": "The output of the ListCertificates operation.
", "refs": { } }, "ListIndicesRequest": { "base": null, "refs": { } }, "ListIndicesResponse": { "base": null, "refs": { } }, "ListJobExecutionsForJobRequest": { "base": null, "refs": { } }, "ListJobExecutionsForJobResponse": { "base": null, "refs": { } }, "ListJobExecutionsForThingRequest": { "base": null, "refs": { } }, "ListJobExecutionsForThingResponse": { "base": null, "refs": { } }, "ListJobsRequest": { "base": null, "refs": { } }, "ListJobsResponse": { "base": null, "refs": { } }, "ListOTAUpdatesRequest": { "base": null, "refs": { } }, "ListOTAUpdatesResponse": { "base": null, "refs": { } }, "ListOutgoingCertificatesRequest": { "base": "The input to the ListOutgoingCertificates operation.
", "refs": { } }, "ListOutgoingCertificatesResponse": { "base": "The output from the ListOutgoingCertificates operation.
", "refs": { } }, "ListPoliciesRequest": { "base": "The input for the ListPolicies operation.
", "refs": { } }, "ListPoliciesResponse": { "base": "The output from the ListPolicies operation.
", "refs": { } }, "ListPolicyPrincipalsRequest": { "base": "The input for the ListPolicyPrincipals operation.
", "refs": { } }, "ListPolicyPrincipalsResponse": { "base": "The output from the ListPolicyPrincipals operation.
", "refs": { } }, "ListPolicyVersionsRequest": { "base": "The input for the ListPolicyVersions operation.
", "refs": { } }, "ListPolicyVersionsResponse": { "base": "The output from the ListPolicyVersions operation.
", "refs": { } }, "ListPrincipalPoliciesRequest": { "base": "The input for the ListPrincipalPolicies operation.
", "refs": { } }, "ListPrincipalPoliciesResponse": { "base": "The output from the ListPrincipalPolicies operation.
", "refs": { } }, "ListPrincipalThingsRequest": { "base": "The input for the ListPrincipalThings operation.
", "refs": { } }, "ListPrincipalThingsResponse": { "base": "The output from the ListPrincipalThings operation.
", "refs": { } }, "ListRoleAliasesRequest": { "base": null, "refs": { } }, "ListRoleAliasesResponse": { "base": null, "refs": { } }, "ListScheduledAuditsRequest": { "base": null, "refs": { } }, "ListScheduledAuditsResponse": { "base": null, "refs": { } }, "ListSecurityProfilesForTargetRequest": { "base": null, "refs": { } }, "ListSecurityProfilesForTargetResponse": { "base": null, "refs": { } }, "ListSecurityProfilesRequest": { "base": null, "refs": { } }, "ListSecurityProfilesResponse": { "base": null, "refs": { } }, "ListStreamsRequest": { "base": null, "refs": { } }, "ListStreamsResponse": { "base": null, "refs": { } }, "ListTargetsForPolicyRequest": { "base": null, "refs": { } }, "ListTargetsForPolicyResponse": { "base": null, "refs": { } }, "ListTargetsForSecurityProfileRequest": { "base": null, "refs": { } }, "ListTargetsForSecurityProfileResponse": { "base": null, "refs": { } }, "ListThingGroupsForThingRequest": { "base": null, "refs": { } }, "ListThingGroupsForThingResponse": { "base": null, "refs": { } }, "ListThingGroupsRequest": { "base": null, "refs": { } }, "ListThingGroupsResponse": { "base": null, "refs": { } }, "ListThingPrincipalsRequest": { "base": "The input for the ListThingPrincipal operation.
", "refs": { } }, "ListThingPrincipalsResponse": { "base": "The output from the ListThingPrincipals operation.
", "refs": { } }, "ListThingRegistrationTaskReportsRequest": { "base": null, "refs": { } }, "ListThingRegistrationTaskReportsResponse": { "base": null, "refs": { } }, "ListThingRegistrationTasksRequest": { "base": null, "refs": { } }, "ListThingRegistrationTasksResponse": { "base": null, "refs": { } }, "ListThingTypesRequest": { "base": "The input for the ListThingTypes operation.
", "refs": { } }, "ListThingTypesResponse": { "base": "The output for the ListThingTypes operation.
", "refs": { } }, "ListThingsInThingGroupRequest": { "base": null, "refs": { } }, "ListThingsInThingGroupResponse": { "base": null, "refs": { } }, "ListThingsRequest": { "base": "The input for the ListThings operation.
", "refs": { } }, "ListThingsResponse": { "base": "The output from the ListThings operation.
", "refs": { } }, "ListTopicRulesRequest": { "base": "The input for the ListTopicRules operation.
", "refs": { } }, "ListTopicRulesResponse": { "base": "The output from the ListTopicRules operation.
", "refs": { } }, "ListV2LoggingLevelsRequest": { "base": null, "refs": { } }, "ListV2LoggingLevelsResponse": { "base": null, "refs": { } }, "ListViolationEventsRequest": { "base": null, "refs": { } }, "ListViolationEventsResponse": { "base": null, "refs": { } }, "LogLevel": { "base": null, "refs": { "GetLoggingOptionsResponse$logLevel": "The logging level.
", "GetV2LoggingOptionsResponse$defaultLogLevel": "The default log level.
", "LogTargetConfiguration$logLevel": "The logging level.
", "LoggingOptionsPayload$logLevel": "The log level.
", "SetV2LoggingLevelRequest$logLevel": "The log level.
", "SetV2LoggingOptionsRequest$defaultLogLevel": "The default logging level.
" } }, "LogTarget": { "base": "A log target.
", "refs": { "LogTargetConfiguration$logTarget": "A log target
", "SetV2LoggingLevelRequest$logTarget": "The log target.
" } }, "LogTargetConfiguration": { "base": "The target configuration.
", "refs": { "LogTargetConfigurations$member": null } }, "LogTargetConfigurations": { "base": null, "refs": { "ListV2LoggingLevelsResponse$logTargetConfigurations": "The logging configuration for a target.
" } }, "LogTargetName": { "base": null, "refs": { "DeleteV2LoggingLevelRequest$targetName": "The name of the resource for which you are configuring logging.
", "LogTarget$targetName": "The target name.
" } }, "LogTargetType": { "base": null, "refs": { "DeleteV2LoggingLevelRequest$targetType": "The type of resource for which you are configuring logging. Must be THING_Group.
The type of resource for which you are configuring logging. Must be THING_Group.
The target type.
" } }, "LoggingOptionsPayload": { "base": "Describes the logging options payload.
", "refs": { "SetLoggingOptionsRequest$loggingOptionsPayload": "The logging options payload.
" } }, "MalformedPolicyException": { "base": "The policy documentation is not valid.
", "refs": { } }, "Marker": { "base": null, "refs": { "ListAttachedPoliciesRequest$marker": "The token to retrieve the next set of results.
", "ListAttachedPoliciesResponse$nextMarker": "The token to retrieve the next set of results, or ``null`` if there are no more results.
", "ListAuthorizersRequest$marker": "A marker used to get the next set of results.
", "ListAuthorizersResponse$nextMarker": "A marker used to get the next set of results.
", "ListCACertificatesRequest$marker": "The marker for the next set of results.
", "ListCACertificatesResponse$nextMarker": "The current position within the list of CA certificates.
", "ListCertificatesByCARequest$marker": "The marker for the next set of results.
", "ListCertificatesByCAResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
", "ListCertificatesRequest$marker": "The marker for the next set of results.
", "ListCertificatesResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
", "ListOutgoingCertificatesRequest$marker": "The marker for the next set of results.
", "ListOutgoingCertificatesResponse$nextMarker": "The marker for the next set of results.
", "ListPoliciesRequest$marker": "The marker for the next set of results.
", "ListPoliciesResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
", "ListPolicyPrincipalsRequest$marker": "The marker for the next set of results.
", "ListPolicyPrincipalsResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
", "ListPrincipalPoliciesRequest$marker": "The marker for the next set of results.
", "ListPrincipalPoliciesResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
", "ListRoleAliasesRequest$marker": "A marker used to get the next set of results.
", "ListRoleAliasesResponse$nextMarker": "A marker used to get the next set of results.
", "ListTargetsForPolicyRequest$marker": "A marker used to get the next set of results.
", "ListTargetsForPolicyResponse$nextMarker": "A marker used to get the next set of results.
" } }, "MaxJobExecutionsPerMin": { "base": null, "refs": { "JobExecutionsRolloutConfig$maximumPerMinute": "The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
" } }, "MaxResults": { "base": null, "refs": { "ListActiveViolationsRequest$maxResults": "The maximum number of results to return at one time.
", "ListAuditFindingsRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
", "ListAuditTasksRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
", "ListOTAUpdatesRequest$maxResults": "The maximum number of results to return at one time.
", "ListScheduledAuditsRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
", "ListSecurityProfilesForTargetRequest$maxResults": "The maximum number of results to return at one time.
", "ListSecurityProfilesRequest$maxResults": "The maximum number of results to return at one time.
", "ListStreamsRequest$maxResults": "The maximum number of results to return at a time.
", "ListTargetsForSecurityProfileRequest$maxResults": "The maximum number of results to return at one time.
", "ListViolationEventsRequest$maxResults": "The maximum number of results to return at one time.
" } }, "MaximumPerMinute": { "base": null, "refs": { "AwsJobExecutionsRolloutConfig$maximumPerMinute": "The maximum number of OTA update job executions started per minute.
" } }, "Message": { "base": null, "refs": { "OutgoingCertificate$transferMessage": "The transfer message.
", "RejectCertificateTransferRequest$rejectReason": "The reason the certificate transfer was rejected.
", "TransferCertificateRequest$transferMessage": "The transfer message.
", "TransferData$transferMessage": "The transfer message.
", "TransferData$rejectReason": "The reason why the transfer was rejected.
" } }, "MessageFormat": { "base": null, "refs": { "SnsAction$messageFormat": "(Optional) The message format of the message to publish. Accepted values are \"JSON\" and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
" } }, "MetricValue": { "base": "The value to be compared with the metric.
The value of the metric (the measurement) which caused the most recent violation.
", "BehaviorCriteria$value": "The value to be compared with the metric.
The value of the metric (the measurement).
" } }, "MissingContextValue": { "base": null, "refs": { "MissingContextValues$member": null } }, "MissingContextValues": { "base": null, "refs": { "AuthResult$missingContextValues": "Contains any missing context values found while evaluating policy.
" } }, "NextToken": { "base": null, "refs": { "ListActiveViolationsRequest$nextToken": "The token for the next set of results.
", "ListActiveViolationsResponse$nextToken": "A token that can be used to retrieve the next set of results, or null if there are no additional results.
The token for the next set of results.
", "ListAuditFindingsResponse$nextToken": "A token that can be used to retrieve the next set of results, or null if there are no additional results.
The token for the next set of results.
", "ListAuditTasksResponse$nextToken": "A token that can be used to retrieve the next set of results, or null if there are no additional results.
The token used to get the next set of results, or null if there are no additional results.
", "ListIndicesResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListJobExecutionsForJobRequest$nextToken": "The token to retrieve the next set of results.
", "ListJobExecutionsForJobResponse$nextToken": "The token for the next set of results, or null if there are no additional results.
", "ListJobExecutionsForThingRequest$nextToken": "The token to retrieve the next set of results.
", "ListJobExecutionsForThingResponse$nextToken": "The token for the next set of results, or null if there are no additional results.
", "ListJobsRequest$nextToken": "The token to retrieve the next set of results.
", "ListJobsResponse$nextToken": "The token for the next set of results, or null if there are no additional results.
", "ListOTAUpdatesRequest$nextToken": "A token used to retrieve the next set of results.
", "ListOTAUpdatesResponse$nextToken": "A token to use to get the next set of results.
", "ListPrincipalThingsRequest$nextToken": "The token to retrieve the next set of results.
", "ListPrincipalThingsResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListScheduledAuditsRequest$nextToken": "The token for the next set of results.
", "ListScheduledAuditsResponse$nextToken": "A token that can be used to retrieve the next set of results, or null if there are no additional results.
The token for the next set of results.
", "ListSecurityProfilesForTargetResponse$nextToken": "A token that can be used to retrieve the next set of results, or null if there are no additional results.
The token for the next set of results.
", "ListSecurityProfilesResponse$nextToken": "A token that can be used to retrieve the next set of results, or null if there are no additional results.
A token used to get the next set of results.
", "ListStreamsResponse$nextToken": "A token used to get the next set of results.
", "ListTargetsForSecurityProfileRequest$nextToken": "The token for the next set of results.
", "ListTargetsForSecurityProfileResponse$nextToken": "A token that can be used to retrieve the next set of results, or null if there are no additional results.
The token to retrieve the next set of results.
", "ListThingGroupsForThingResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListThingGroupsRequest$nextToken": "The token to retrieve the next set of results.
", "ListThingGroupsResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListThingRegistrationTaskReportsRequest$nextToken": "The token to retrieve the next set of results.
", "ListThingRegistrationTaskReportsResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListThingRegistrationTasksRequest$nextToken": "The token to retrieve the next set of results.
", "ListThingRegistrationTasksResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListThingTypesRequest$nextToken": "The token to retrieve the next set of results.
", "ListThingTypesResponse$nextToken": "The token for the next set of results, or null if there are no additional results.
", "ListThingsInThingGroupRequest$nextToken": "The token to retrieve the next set of results.
", "ListThingsInThingGroupResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListThingsRequest$nextToken": "The token to retrieve the next set of results.
", "ListThingsResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListTopicRulesRequest$nextToken": "A token used to retrieve the next value.
", "ListTopicRulesResponse$nextToken": "A token used to retrieve the next value.
", "ListV2LoggingLevelsRequest$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListV2LoggingLevelsResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
", "ListViolationEventsRequest$nextToken": "The token for the next set of results.
", "ListViolationEventsResponse$nextToken": "A token that can be used to retrieve the next set of results, or null if there are no additional results.
The token used to get the next set of results, or null if there are no additional results.
", "SearchIndexResponse$nextToken": "The token used to get the next set of results, or null if there are no additional results.
" } }, "NonCompliantChecksCount": { "base": null, "refs": { "TaskStatistics$nonCompliantChecks": "The number of checks that found non-compliant resources.
" } }, "NonCompliantResource": { "base": "Information about the resource that was non-compliant with the audit check.
", "refs": { "AuditFinding$nonCompliantResource": "The resource that was found to be non-compliant with the audit check.
" } }, "NonCompliantResourcesCount": { "base": null, "refs": { "AuditCheckDetails$nonCompliantResourcesCount": "The number of resources that the check found non-compliant.
" } }, "NotConfiguredException": { "base": "The resource is not configured.
", "refs": { } }, "OTAUpdateArn": { "base": null, "refs": { "CreateOTAUpdateResponse$otaUpdateArn": "The OTA update ARN.
", "OTAUpdateInfo$otaUpdateArn": "The OTA update ARN.
", "OTAUpdateSummary$otaUpdateArn": "The OTA update ARN.
" } }, "OTAUpdateDescription": { "base": null, "refs": { "CreateOTAUpdateRequest$description": "The description of the OTA update.
", "OTAUpdateInfo$description": "A description of the OTA update.
" } }, "OTAUpdateErrorMessage": { "base": null, "refs": { "ErrorInfo$message": "The error message.
" } }, "OTAUpdateFile": { "base": "Describes a file to be associated with an OTA update.
", "refs": { "OTAUpdateFiles$member": null } }, "OTAUpdateFileVersion": { "base": null, "refs": { "OTAUpdateFile$fileVersion": "The file version.
" } }, "OTAUpdateFiles": { "base": null, "refs": { "CreateOTAUpdateRequest$files": "The files to be streamed by the OTA update.
", "OTAUpdateInfo$otaUpdateFiles": "A list of files associated with the OTA update.
" } }, "OTAUpdateId": { "base": null, "refs": { "CreateOTAUpdateRequest$otaUpdateId": "The ID of the OTA update to be created.
", "CreateOTAUpdateResponse$otaUpdateId": "The OTA update ID.
", "DeleteOTAUpdateRequest$otaUpdateId": "The OTA update ID to delete.
", "GetOTAUpdateRequest$otaUpdateId": "The OTA update ID.
", "OTAUpdateInfo$otaUpdateId": "The OTA update ID.
", "OTAUpdateSummary$otaUpdateId": "The OTA update ID.
" } }, "OTAUpdateInfo": { "base": "Information about an OTA update.
", "refs": { "GetOTAUpdateResponse$otaUpdateInfo": "The OTA update info.
" } }, "OTAUpdateStatus": { "base": null, "refs": { "CreateOTAUpdateResponse$otaUpdateStatus": "The OTA update status.
", "ListOTAUpdatesRequest$otaUpdateStatus": "The OTA update job status.
", "OTAUpdateInfo$otaUpdateStatus": "The status of the OTA update.
" } }, "OTAUpdateSummary": { "base": "An OTA update summary.
", "refs": { "OTAUpdatesSummary$member": null } }, "OTAUpdatesSummary": { "base": null, "refs": { "ListOTAUpdatesResponse$otaUpdates": "A list of OTA update jobs.
" } }, "OptionalVersion": { "base": null, "refs": { "DeleteSecurityProfileRequest$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 than the actual version, a VersionConflictException is thrown.
The expected version of the thing group to delete.
", "DeleteThingRequest$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.
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 than the actual version, a VersionConflictException is thrown.
The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.
", "UpdateThingRequest$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.
A certificate that has been transferred but not yet accepted.
", "refs": { "OutgoingCertificates$member": null } }, "OutgoingCertificates": { "base": null, "refs": { "ListOutgoingCertificatesResponse$outgoingCertificates": "The certificates that are being transferred but not yet accepted.
" } }, "PageSize": { "base": null, "refs": { "ListAttachedPoliciesRequest$pageSize": "The maximum number of results to be returned per request.
", "ListAuthorizersRequest$pageSize": "The maximum number of results to return at one time.
", "ListCACertificatesRequest$pageSize": "The result page size.
", "ListCertificatesByCARequest$pageSize": "The result page size.
", "ListCertificatesRequest$pageSize": "The result page size.
", "ListOutgoingCertificatesRequest$pageSize": "The result page size.
", "ListPoliciesRequest$pageSize": "The result page size.
", "ListPolicyPrincipalsRequest$pageSize": "The result page size.
", "ListPrincipalPoliciesRequest$pageSize": "The result page size.
", "ListRoleAliasesRequest$pageSize": "The maximum number of results to return at one time.
", "ListTargetsForPolicyRequest$pageSize": "The maximum number of results to return at one time.
" } }, "Parameter": { "base": null, "refs": { "Parameters$key": null } }, "Parameters": { "base": null, "refs": { "RegisterThingRequest$parameters": "The parameters for provisioning a thing. See Programmatic Provisioning for more information.
" } }, "PartitionKey": { "base": null, "refs": { "KinesisAction$partitionKey": "The partition key.
" } }, "PayloadField": { "base": null, "refs": { "DynamoDBAction$payloadField": "The action payload. This name can be customized.
" } }, "Percentage": { "base": null, "refs": { "DescribeThingRegistrationTaskResponse$percentageProgress": "The progress of the bulk provisioning task expressed as a percentage.
" } }, "Platform": { "base": null, "refs": { "SigningProfileParameter$platform": "The hardware platform of your device.
" } }, "Policies": { "base": null, "refs": { "Allowed$policies": "A list of policies that allowed the authentication.
", "ExplicitDeny$policies": "The policies that denied the authorization.
", "ImplicitDeny$policies": "Policies that don't contain a matching allow or deny statement for the specified action on the specified resource.
", "ListAttachedPoliciesResponse$policies": "The policies.
", "ListPoliciesResponse$policies": "The descriptions of the policies.
", "ListPrincipalPoliciesResponse$policies": "The policies.
" } }, "Policy": { "base": "Describes an AWS IoT policy.
", "refs": { "Policies$member": null } }, "PolicyArn": { "base": null, "refs": { "CreatePolicyResponse$policyArn": "The policy ARN.
", "CreatePolicyVersionResponse$policyArn": "The policy ARN.
", "EffectivePolicy$policyArn": "The policy ARN.
", "GetPolicyResponse$policyArn": "The policy ARN.
", "GetPolicyVersionResponse$policyArn": "The policy ARN.
", "Policy$policyArn": "The policy ARN.
" } }, "PolicyDocument": { "base": null, "refs": { "CreatePolicyRequest$policyDocument": "The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.
", "CreatePolicyResponse$policyDocument": "The JSON document that describes the policy.
", "CreatePolicyVersionRequest$policyDocument": "The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.
", "CreatePolicyVersionResponse$policyDocument": "The JSON document that describes the policy.
", "EffectivePolicy$policyDocument": "The IAM policy document.
", "GetPolicyResponse$policyDocument": "The JSON document that describes the policy.
", "GetPolicyVersionResponse$policyDocument": "The JSON document that describes the policy.
", "PolicyDocuments$member": null } }, "PolicyDocuments": { "base": null, "refs": { "TestInvokeAuthorizerResponse$policyDocuments": "IAM policy documents.
" } }, "PolicyName": { "base": null, "refs": { "AttachPolicyRequest$policyName": "The name of the policy to attach.
", "AttachPrincipalPolicyRequest$policyName": "The policy name.
", "CreatePolicyRequest$policyName": "The policy name.
", "CreatePolicyResponse$policyName": "The policy name.
", "CreatePolicyVersionRequest$policyName": "The policy name.
", "DeletePolicyRequest$policyName": "The name of the policy to delete.
", "DeletePolicyVersionRequest$policyName": "The name of the policy.
", "DetachPolicyRequest$policyName": "The policy to detach.
", "DetachPrincipalPolicyRequest$policyName": "The name of the policy to detach.
", "EffectivePolicy$policyName": "The policy name.
", "GetPolicyRequest$policyName": "The name of the policy.
", "GetPolicyResponse$policyName": "The policy name.
", "GetPolicyVersionRequest$policyName": "The name of the policy.
", "GetPolicyVersionResponse$policyName": "The policy name.
", "ListPolicyPrincipalsRequest$policyName": "The policy name.
", "ListPolicyVersionsRequest$policyName": "The policy name.
", "ListTargetsForPolicyRequest$policyName": "The policy name.
", "Policy$policyName": "The policy name.
", "PolicyNames$member": null, "PolicyVersionIdentifier$policyName": "The name of the policy.
", "SetDefaultPolicyVersionRequest$policyName": "The policy name.
" } }, "PolicyNames": { "base": null, "refs": { "TestAuthorizationRequest$policyNamesToAdd": "When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
", "TestAuthorizationRequest$policyNamesToSkip": "When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
" } }, "PolicyTarget": { "base": null, "refs": { "AttachPolicyRequest$target": "The identity to which the policy is attached.
", "DetachPolicyRequest$target": "The target from which the policy will be detached.
", "ListAttachedPoliciesRequest$target": "The group for which the policies will be listed.
", "PolicyTargets$member": null } }, "PolicyTargets": { "base": null, "refs": { "ListTargetsForPolicyResponse$targets": "The policy targets.
" } }, "PolicyVersion": { "base": "Describes a policy version.
", "refs": { "PolicyVersions$member": null } }, "PolicyVersionId": { "base": null, "refs": { "CreatePolicyResponse$policyVersionId": "The policy version ID.
", "CreatePolicyVersionResponse$policyVersionId": "The policy version ID.
", "DeletePolicyVersionRequest$policyVersionId": "The policy version ID.
", "GetPolicyResponse$defaultVersionId": "The default policy version ID.
", "GetPolicyVersionRequest$policyVersionId": "The policy version ID.
", "GetPolicyVersionResponse$policyVersionId": "The policy version ID.
", "PolicyVersion$versionId": "The policy version ID.
", "PolicyVersionIdentifier$policyVersionId": "The ID of the version of the policy associated with the resource.
", "SetDefaultPolicyVersionRequest$policyVersionId": "The policy version ID.
" } }, "PolicyVersionIdentifier": { "base": "Information about the version of the policy associated with the resource.
", "refs": { "ResourceIdentifier$policyVersionIdentifier": "The version of the policy associated with the resource.
" } }, "PolicyVersions": { "base": null, "refs": { "ListPolicyVersionsResponse$policyVersions": "The policy versions.
" } }, "Port": { "base": null, "refs": { "Ports$member": null } }, "Ports": { "base": null, "refs": { "MetricValue$ports": "If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
The S3 prefix.
" } }, "PresignedUrlConfig": { "base": "Configuration for pre-signed S3 URLs.
", "refs": { "CreateJobRequest$presignedUrlConfig": "Configuration information for pre-signed S3 URLs.
", "Job$presignedUrlConfig": "Configuration for pre-signed S3 URLs.
" } }, "Principal": { "base": null, "refs": { "AttachPrincipalPolicyRequest$principal": "The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
", "AttachThingPrincipalRequest$principal": "The principal, such as a certificate or other credential.
", "DetachPrincipalPolicyRequest$principal": "The principal.
If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.
", "DetachThingPrincipalRequest$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.
", "GetEffectivePoliciesRequest$principal": "The principal.
", "ListPrincipalPoliciesRequest$principal": "The principal.
", "ListPrincipalThingsRequest$principal": "The principal.
", "TestAuthorizationRequest$principal": "The principal.
" } }, "PrincipalArn": { "base": null, "refs": { "Principals$member": null } }, "PrincipalId": { "base": null, "refs": { "TestInvokeAuthorizerResponse$principalId": "The principal ID.
" } }, "Principals": { "base": null, "refs": { "ListPolicyPrincipalsResponse$principals": "The descriptions of the principals.
", "ListThingPrincipalsResponse$principals": "The principals associated with the thing.
" } }, "PrivateKey": { "base": null, "refs": { "KeyPair$PrivateKey": "The private key.
" } }, "ProcessingTargetName": { "base": null, "refs": { "ProcessingTargetNameList$member": null } }, "ProcessingTargetNameList": { "base": null, "refs": { "JobProcessDetails$processingTargets": "The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.
" } }, "PublicKey": { "base": null, "refs": { "KeyPair$PublicKey": "The public key.
" } }, "PublicKeyMap": { "base": null, "refs": { "AuthorizerDescription$tokenSigningPublicKeys": "The public keys used to validate the token signature returned by your custom authentication service.
", "CreateAuthorizerRequest$tokenSigningPublicKeys": "The public keys used to verify the digital signature returned by your custom authentication service.
", "UpdateAuthorizerRequest$tokenSigningPublicKeys": "The public keys used to verify the token signature.
" } }, "PutItemInput": { "base": "The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
", "refs": { "DynamoDBv2Action$putItem": "Specifies the DynamoDB table to which the message data will be written. For example:
{ \"dynamoDBv2\": { \"roleArn\": \"aws:iam:12341251:my-role\" \"putItem\": { \"tableName\": \"my-table\" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
" } }, "QueryMaxResults": { "base": null, "refs": { "ListIndicesRequest$maxResults": "The maximum number of results to return at one time.
", "SearchIndexRequest$maxResults": "The maximum number of results to return at one time.
" } }, "QueryString": { "base": null, "refs": { "SearchIndexRequest$queryString": "The search query string.
" } }, "QueryVersion": { "base": null, "refs": { "SearchIndexRequest$queryVersion": "The query version.
" } }, "QueueUrl": { "base": null, "refs": { "SqsAction$queueUrl": "The URL of the Amazon SQS queue.
" } }, "QueuedThings": { "base": null, "refs": { "JobProcessDetails$numberOfQueuedThings": "The number of things that are awaiting execution of the job.
" } }, "RangeKeyField": { "base": null, "refs": { "DynamoDBAction$rangeKeyField": "The range key name.
" } }, "RangeKeyValue": { "base": null, "refs": { "DynamoDBAction$rangeKeyValue": "The range key value.
" } }, "ReasonForNonCompliance": { "base": null, "refs": { "AuditFinding$reasonForNonCompliance": "The reason the resource was non-compliant.
" } }, "ReasonForNonComplianceCode": { "base": null, "refs": { "AuditFinding$reasonForNonComplianceCode": "A code which indicates the reason that the resource was non-compliant.
" } }, "Recursive": { "base": null, "refs": { "ListAttachedPoliciesRequest$recursive": "When true, recursively list attached policies.
", "ListSecurityProfilesForTargetRequest$recursive": "If true, return child groups as well.
", "ListThingsInThingGroupRequest$recursive": "When true, list things in this thing group and in all child groups as well.
" } }, "RecursiveWithoutDefault": { "base": null, "refs": { "ListThingGroupsRequest$recursive": "If true, return child groups as well.
" } }, "RegisterCACertificateRequest": { "base": "The input to the RegisterCACertificate operation.
", "refs": { } }, "RegisterCACertificateResponse": { "base": "The output from the RegisterCACertificateResponse operation.
", "refs": { } }, "RegisterCertificateRequest": { "base": "The input to the RegisterCertificate operation.
", "refs": { } }, "RegisterCertificateResponse": { "base": "The output from the RegisterCertificate operation.
", "refs": { } }, "RegisterThingRequest": { "base": null, "refs": { } }, "RegisterThingResponse": { "base": null, "refs": { } }, "RegistrationCode": { "base": null, "refs": { "GetRegistrationCodeResponse$registrationCode": "The CA certificate registration code.
" } }, "RegistrationCodeValidationException": { "base": "The registration code is invalid.
", "refs": { } }, "RegistrationConfig": { "base": "The registration configuration.
", "refs": { "DescribeCACertificateResponse$registrationConfig": "Information about the registration configuration.
", "RegisterCACertificateRequest$registrationConfig": "Information about the registration configuration.
", "UpdateCACertificateRequest$registrationConfig": "Information about the registration configuration.
" } }, "RegistryMaxResults": { "base": null, "refs": { "ListPrincipalThingsRequest$maxResults": "The maximum number of results to return in this operation.
", "ListThingGroupsForThingRequest$maxResults": "The maximum number of results to return at one time.
", "ListThingGroupsRequest$maxResults": "The maximum number of results to return at one time.
", "ListThingRegistrationTaskReportsRequest$maxResults": "The maximum number of results to return per request.
", "ListThingRegistrationTasksRequest$maxResults": "The maximum number of results to return at one time.
", "ListThingTypesRequest$maxResults": "The maximum number of results to return in this operation.
", "ListThingsInThingGroupRequest$maxResults": "The maximum number of results to return at one time.
", "ListThingsRequest$maxResults": "The maximum number of results to return in this operation.
" } }, "RegistryS3BucketName": { "base": null, "refs": { "DescribeThingRegistrationTaskResponse$inputFileBucket": "The S3 bucket that contains the input file.
", "StartThingRegistrationTaskRequest$inputFileBucket": "The S3 bucket that contains the input file.
" } }, "RegistryS3KeyName": { "base": null, "refs": { "DescribeThingRegistrationTaskResponse$inputFileKey": "The input file key.
", "StartThingRegistrationTaskRequest$inputFileKey": "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).
" } }, "RejectCertificateTransferRequest": { "base": "The input for the RejectCertificateTransfer operation.
", "refs": { } }, "RejectedThings": { "base": null, "refs": { "JobProcessDetails$numberOfRejectedThings": "The number of things that rejected the job.
" } }, "RelatedResource": { "base": "Information about a related resource.
", "refs": { "RelatedResources$member": null } }, "RelatedResources": { "base": null, "refs": { "AuditFinding$relatedResources": "The list of related resources.
" } }, "RemoveAutoRegistration": { "base": null, "refs": { "UpdateCACertificateRequest$removeAutoRegistration": "If true, remove auto registration.
" } }, "RemoveThingFromThingGroupRequest": { "base": null, "refs": { } }, "RemoveThingFromThingGroupResponse": { "base": null, "refs": { } }, "RemoveThingType": { "base": null, "refs": { "UpdateThingRequest$removeThingType": "Remove a thing type association. If true, the association is removed.
" } }, "RemovedThings": { "base": null, "refs": { "JobProcessDetails$numberOfRemovedThings": "The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.
" } }, "ReplaceTopicRuleRequest": { "base": "The input for the ReplaceTopicRule operation.
", "refs": { } }, "ReportType": { "base": null, "refs": { "ListThingRegistrationTaskReportsRequest$reportType": "The type of task report.
", "ListThingRegistrationTaskReportsResponse$reportType": "The type of task report.
" } }, "RepublishAction": { "base": "Describes an action to republish to another topic.
", "refs": { "Action$republish": "Publish to another MQTT topic.
" } }, "Resource": { "base": null, "refs": { "Resources$member": null } }, "ResourceAlreadyExistsException": { "base": "The resource already exists.
", "refs": { } }, "ResourceArn": { "base": null, "refs": { "ResourceArns$value": null } }, "ResourceArns": { "base": null, "refs": { "RegisterThingResponse$resourceArns": "ARNs for the generated resources.
" } }, "ResourceIdentifier": { "base": "Information identifying the non-compliant resource.
", "refs": { "ListAuditFindingsRequest$resourceIdentifier": "Information identifying the non-compliant resource.
", "NonCompliantResource$resourceIdentifier": "Information identifying the non-compliant resource.
", "RelatedResource$resourceIdentifier": "Information identifying the resource.
" } }, "ResourceLogicalId": { "base": null, "refs": { "ResourceArns$key": null } }, "ResourceNotFoundException": { "base": "The specified resource does not exist.
", "refs": { } }, "ResourceRegistrationFailureException": { "base": "The resource registration failed.
", "refs": { } }, "ResourceType": { "base": null, "refs": { "NonCompliantResource$resourceType": "The type of the non-compliant resource.
", "RelatedResource$resourceType": "The type of resource.
" } }, "Resources": { "base": null, "refs": { "AuthInfo$resources": "The resources for which the principal is being authorized to perform the specified action.
" } }, "RoleAlias": { "base": null, "refs": { "CreateRoleAliasRequest$roleAlias": "The role alias that points to a role ARN. This allows you to change the role without having to update the device.
", "CreateRoleAliasResponse$roleAlias": "The role alias.
", "DeleteRoleAliasRequest$roleAlias": "The role alias to delete.
", "DescribeRoleAliasRequest$roleAlias": "The role alias to describe.
", "RoleAliasDescription$roleAlias": "The role alias.
", "RoleAliases$member": null, "UpdateRoleAliasRequest$roleAlias": "The role alias to update.
", "UpdateRoleAliasResponse$roleAlias": "The role alias.
" } }, "RoleAliasArn": { "base": null, "refs": { "CreateRoleAliasResponse$roleAliasArn": "The role alias ARN.
", "RoleAliasDescription$roleAliasArn": "The ARN of the role alias.
", "UpdateRoleAliasResponse$roleAliasArn": "The role alias ARN.
" } }, "RoleAliasDescription": { "base": "Role alias description.
", "refs": { "DescribeRoleAliasResponse$roleAliasDescription": "The role alias description.
" } }, "RoleAliases": { "base": null, "refs": { "ListRoleAliasesResponse$roleAliases": "The role aliases.
" } }, "RoleArn": { "base": null, "refs": { "AlertTarget$roleArn": "The ARN of the role that grants permission to send alerts to the notification target.
", "AuditNotificationTarget$roleArn": "The ARN of the role that grants permission to send notifications to the target.
", "CreateOTAUpdateRequest$roleArn": "The IAM role that allows access to the AWS IoT Jobs service.
", "CreateRoleAliasRequest$roleArn": "The role ARN.
", "CreateStreamRequest$roleArn": "An IAM role that allows the IoT service principal assumes to access your S3 files.
", "DescribeAccountAuditConfigurationResponse$roleArn": "The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.
On the first call to UpdateAccountAuditConfiguration this parameter is required.
The role ARN that grants access to the input file bucket.
", "PresignedUrlConfig$roleArn": "The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
", "RegistrationConfig$roleArn": "The ARN of the role.
", "RoleAliasDescription$roleArn": "The role ARN.
", "StartThingRegistrationTaskRequest$roleArn": "The IAM role ARN that grants permission the input file.
", "StreamInfo$roleArn": "An IAM role AWS IoT assumes to access your S3 files.
", "UpdateAccountAuditConfigurationRequest$roleArn": "The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.
", "UpdateRoleAliasRequest$roleArn": "The role ARN.
", "UpdateStreamRequest$roleArn": "An IAM role that allows the IoT service principal assumes to access your S3 files.
" } }, "RuleArn": { "base": null, "refs": { "GetTopicRuleResponse$ruleArn": "The rule ARN.
", "TopicRuleListItem$ruleArn": "The rule ARN.
" } }, "RuleName": { "base": null, "refs": { "CreateTopicRuleRequest$ruleName": "The name of the rule.
", "DeleteTopicRuleRequest$ruleName": "The name of the rule.
", "DisableTopicRuleRequest$ruleName": "The name of the rule to disable.
", "EnableTopicRuleRequest$ruleName": "The name of the topic rule to enable.
", "GetTopicRuleRequest$ruleName": "The name of the rule.
", "ReplaceTopicRuleRequest$ruleName": "The name of the rule.
", "TopicRule$ruleName": "The name of the rule.
", "TopicRuleListItem$ruleName": "The name of the rule.
" } }, "S3Action": { "base": "Describes an action to write data to an Amazon S3 bucket.
", "refs": { "Action$s3": "Write to an Amazon S3 bucket.
" } }, "S3Bucket": { "base": null, "refs": { "S3Destination$bucket": "The S3 bucket that contains the updated firmware.
", "S3Location$bucket": "The S3 bucket.
" } }, "S3Destination": { "base": "Describes the location of updated firmware in S3.
", "refs": { "Destination$s3Destination": "Describes the location in S3 of the updated firmware.
" } }, "S3FileUrl": { "base": null, "refs": { "S3FileUrlList$member": null } }, "S3FileUrlList": { "base": null, "refs": { "ListThingRegistrationTaskReportsResponse$resourceLinks": "Links to the task resources.
" } }, "S3Key": { "base": null, "refs": { "S3Location$key": "The S3 key.
" } }, "S3Location": { "base": "The S3 location.
", "refs": { "FileLocation$s3Location": "The location of the updated firmware in S3.
", "StreamFile$s3Location": "The location of the file in S3.
" } }, "S3Version": { "base": null, "refs": { "S3Location$version": "The S3 bucket version.
" } }, "SQL": { "base": null, "refs": { "TopicRule$sql": "The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
", "TopicRulePayload$sql": "The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
" } }, "SalesforceAction": { "base": "Describes an action to write a message to a Salesforce IoT Cloud Input Stream.
", "refs": { "Action$salesforce": "Send a message to a Salesforce IoT Cloud Input Stream.
" } }, "SalesforceEndpoint": { "base": null, "refs": { "SalesforceAction$url": "The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
" } }, "SalesforceToken": { "base": null, "refs": { "SalesforceAction$token": "The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
" } }, "ScheduledAuditArn": { "base": null, "refs": { "CreateScheduledAuditResponse$scheduledAuditArn": "The ARN of the scheduled audit.
", "DescribeScheduledAuditResponse$scheduledAuditArn": "The ARN of the scheduled audit.
", "ScheduledAuditMetadata$scheduledAuditArn": "The ARN of the scheduled audit.
", "UpdateScheduledAuditResponse$scheduledAuditArn": "The ARN of the scheduled audit.
" } }, "ScheduledAuditMetadata": { "base": "Information about the scheduled audit.
", "refs": { "ScheduledAuditMetadataList$member": null } }, "ScheduledAuditMetadataList": { "base": null, "refs": { "ListScheduledAuditsResponse$scheduledAudits": "The list of scheduled audits.
" } }, "ScheduledAuditName": { "base": null, "refs": { "CreateScheduledAuditRequest$scheduledAuditName": "The name you want to give to the scheduled audit. (Max. 128 chars)
", "DeleteScheduledAuditRequest$scheduledAuditName": "The name of the scheduled audit you want to delete.
", "DescribeAuditTaskResponse$scheduledAuditName": "The name of the scheduled audit (only if the audit was a scheduled audit).
", "DescribeScheduledAuditRequest$scheduledAuditName": "The name of the scheduled audit whose information you want to get.
", "DescribeScheduledAuditResponse$scheduledAuditName": "The name of the scheduled audit.
", "ScheduledAuditMetadata$scheduledAuditName": "The name of the scheduled audit.
", "UpdateScheduledAuditRequest$scheduledAuditName": "The name of the scheduled audit. (Max. 128 chars)
" } }, "SearchIndexRequest": { "base": null, "refs": { } }, "SearchIndexResponse": { "base": null, "refs": { } }, "SearchableAttributes": { "base": null, "refs": { "ThingTypeProperties$searchableAttributes": "A list of searchable thing attribute names.
" } }, "Seconds": { "base": null, "refs": { "TestInvokeAuthorizerResponse$refreshAfterInSeconds": "The number of seconds after which the temporary credentials are refreshed.
", "TestInvokeAuthorizerResponse$disconnectAfterInSeconds": "The number of seconds after which the connection is terminated.
" } }, "SecurityProfileArn": { "base": null, "refs": { "CreateSecurityProfileResponse$securityProfileArn": "The ARN of the security profile.
", "DescribeSecurityProfileResponse$securityProfileArn": "The ARN of the security profile.
", "SecurityProfileIdentifier$arn": "The ARN of the security profile.
", "UpdateSecurityProfileResponse$securityProfileArn": "The ARN of the security profile that was updated.
" } }, "SecurityProfileDescription": { "base": null, "refs": { "CreateSecurityProfileRequest$securityProfileDescription": "A description of the security profile.
", "DescribeSecurityProfileResponse$securityProfileDescription": "A description of the security profile (associated with the security profile when it was created or updated).
", "UpdateSecurityProfileRequest$securityProfileDescription": "A description of the security profile.
", "UpdateSecurityProfileResponse$securityProfileDescription": "The description of the security profile.
" } }, "SecurityProfileIdentifier": { "base": "Identifying information for a Device Defender security profile.
", "refs": { "SecurityProfileIdentifiers$member": null, "SecurityProfileTargetMapping$securityProfileIdentifier": "Information that identifies the security profile.
" } }, "SecurityProfileIdentifiers": { "base": null, "refs": { "ListSecurityProfilesResponse$securityProfileIdentifiers": "A list of security profile identifiers (names and ARNs).
" } }, "SecurityProfileName": { "base": null, "refs": { "ActiveViolation$securityProfileName": "The security profile whose behavior is in violation.
", "AttachSecurityProfileRequest$securityProfileName": "The security profile that is attached.
", "CreateSecurityProfileRequest$securityProfileName": "The name you are giving to the security profile.
", "CreateSecurityProfileResponse$securityProfileName": "The name you gave to the security profile.
", "DeleteSecurityProfileRequest$securityProfileName": "The name of the security profile to be deleted.
", "DescribeSecurityProfileRequest$securityProfileName": "The name of the security profile whose information you want to get.
", "DescribeSecurityProfileResponse$securityProfileName": "The name of the security profile.
", "DetachSecurityProfileRequest$securityProfileName": "The security profile that is detached.
", "ListActiveViolationsRequest$securityProfileName": "The name of the Device Defender security profile for which violations are listed.
", "ListTargetsForSecurityProfileRequest$securityProfileName": "The security profile.
", "ListViolationEventsRequest$securityProfileName": "A filter to limit results to those alerts generated by the specified security profile.
", "SecurityProfileIdentifier$name": "The name you have given to the security profile.
", "UpdateSecurityProfileRequest$securityProfileName": "The name of the security profile you want to update.
", "UpdateSecurityProfileResponse$securityProfileName": "The name of the security profile that was updated.
", "ViolationEvent$securityProfileName": "The name of the security profile whose behavior was violated.
" } }, "SecurityProfileTarget": { "base": "A target to which an alert is sent when a security profile behavior is violated.
", "refs": { "SecurityProfileTargetMapping$target": "Information about the target (thing group) associated with the security profile.
", "SecurityProfileTargets$member": null } }, "SecurityProfileTargetArn": { "base": null, "refs": { "AttachSecurityProfileRequest$securityProfileTargetArn": "The ARN of the target (thing group) to which the security profile is attached.
", "DetachSecurityProfileRequest$securityProfileTargetArn": "The ARN of the thing group from which the security profile is detached.
", "ListSecurityProfilesForTargetRequest$securityProfileTargetArn": "The ARN of the target (thing group) whose attached security profiles you want to get.
", "SecurityProfileTarget$arn": "The ARN of the security profile.
" } }, "SecurityProfileTargetMapping": { "base": "Information about a security profile and the target associated with it.
", "refs": { "SecurityProfileTargetMappings$member": null } }, "SecurityProfileTargetMappings": { "base": null, "refs": { "ListSecurityProfilesForTargetResponse$securityProfileTargetMappings": "A list of security profiles and their associated targets.
" } }, "SecurityProfileTargets": { "base": null, "refs": { "ListTargetsForSecurityProfileResponse$securityProfileTargets": "The thing groups to which the security profile is attached.
" } }, "ServiceUnavailableException": { "base": "The service is temporarily unavailable.
", "refs": { } }, "SetAsActive": { "base": null, "refs": { "AcceptCertificateTransferRequest$setAsActive": "Specifies whether the certificate is active.
", "CreateCertificateFromCsrRequest$setAsActive": "Specifies whether the certificate is active.
", "CreateKeysAndCertificateRequest$setAsActive": "Specifies whether the certificate is active.
", "RegisterCACertificateRequest$setAsActive": "A boolean value that specifies if the CA certificate is set to active.
" } }, "SetAsActiveFlag": { "base": null, "refs": { "RegisterCertificateRequest$setAsActive": "A boolean value that specifies if the CA certificate is set to active.
" } }, "SetAsDefault": { "base": null, "refs": { "CreatePolicyVersionRequest$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).
" } }, "SetDefaultAuthorizerRequest": { "base": null, "refs": { } }, "SetDefaultAuthorizerResponse": { "base": null, "refs": { } }, "SetDefaultPolicyVersionRequest": { "base": "The input for the SetDefaultPolicyVersion operation.
", "refs": { } }, "SetLoggingOptionsRequest": { "base": "The input for the SetLoggingOptions operation.
", "refs": { } }, "SetV2LoggingLevelRequest": { "base": null, "refs": { } }, "SetV2LoggingOptionsRequest": { "base": null, "refs": { } }, "Signature": { "base": null, "refs": { "CodeSigningSignature$inlineDocument": "A base64 encoded binary representation of the code signing signature.
" } }, "SignatureAlgorithm": { "base": null, "refs": { "CustomCodeSigning$signatureAlgorithm": "The signature algorithm used to code sign the file.
" } }, "SigningJobId": { "base": null, "refs": { "CodeSigning$awsSignerJobId": "The ID of the AWSSignerJob which was created to sign the file.
" } }, "SigningProfileName": { "base": null, "refs": { "StartSigningJobParameter$signingProfileName": "The code-signing profile name.
" } }, "SigningProfileParameter": { "base": "Describes the code-signing profile.
", "refs": { "StartSigningJobParameter$signingProfileParameter": "Describes the code-signing profile.
" } }, "SkyfallMaxResults": { "base": null, "refs": { "ListV2LoggingLevelsRequest$maxResults": "The maximum number of results to return at one time.
" } }, "SnsAction": { "base": "Describes an action to publish to an Amazon SNS topic.
", "refs": { "Action$sns": "Publish to an Amazon SNS topic.
" } }, "SqlParseException": { "base": "The Rule-SQL expression can't be parsed correctly.
", "refs": { } }, "SqsAction": { "base": "Describes an action to publish data to an Amazon SQS queue.
", "refs": { "Action$sqs": "Publish to an Amazon SQS queue.
" } }, "StartOnDemandAuditTaskRequest": { "base": null, "refs": { } }, "StartOnDemandAuditTaskResponse": { "base": null, "refs": { } }, "StartSigningJobParameter": { "base": "Information required to start a signing job.
", "refs": { "CodeSigning$startSigningJobParameter": "Describes the code-signing job.
" } }, "StartThingRegistrationTaskRequest": { "base": null, "refs": { } }, "StartThingRegistrationTaskResponse": { "base": null, "refs": { } }, "StateMachineName": { "base": null, "refs": { "StepFunctionsAction$stateMachineName": "The name of the Step Functions state machine whose execution will be started.
" } }, "StateReason": { "base": null, "refs": { "CloudwatchAlarmAction$stateReason": "The reason for the alarm change.
" } }, "StateValue": { "base": null, "refs": { "CloudwatchAlarmAction$stateValue": "The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
" } }, "Status": { "base": null, "refs": { "DescribeThingRegistrationTaskResponse$status": "The status of the bulk thing provisioning task.
", "ListThingRegistrationTasksRequest$status": "The status of the bulk thing provisioning task.
" } }, "StepFunctionsAction": { "base": "Starts execution of a Step Functions state machine.
", "refs": { "Action$stepFunctions": "Starts execution of a Step Functions state machine.
" } }, "StopThingRegistrationTaskRequest": { "base": null, "refs": { } }, "StopThingRegistrationTaskResponse": { "base": null, "refs": { } }, "Stream": { "base": "Describes a group of files that can be streamed.
", "refs": { "FileLocation$stream": "The stream that contains the OTA update.
" } }, "StreamArn": { "base": null, "refs": { "CreateStreamResponse$streamArn": "The stream ARN.
", "StreamInfo$streamArn": "The stream ARN.
", "StreamSummary$streamArn": "The stream ARN.
", "UpdateStreamResponse$streamArn": "The stream ARN.
" } }, "StreamDescription": { "base": null, "refs": { "CreateStreamRequest$description": "A description of the stream.
", "CreateStreamResponse$description": "A description of the stream.
", "StreamInfo$description": "The description of the stream.
", "StreamSummary$description": "A description of the stream.
", "UpdateStreamRequest$description": "The description of the stream.
", "UpdateStreamResponse$description": "A description of the stream.
" } }, "StreamFile": { "base": "Represents a file to stream.
", "refs": { "StreamFiles$member": null } }, "StreamFiles": { "base": null, "refs": { "CreateStreamRequest$files": "The files to stream.
", "StreamInfo$files": "The files to stream.
", "UpdateStreamRequest$files": "The files associated with the stream.
" } }, "StreamId": { "base": null, "refs": { "CreateStreamRequest$streamId": "The stream ID.
", "CreateStreamResponse$streamId": "The stream ID.
", "DeleteStreamRequest$streamId": "The stream ID.
", "DescribeStreamRequest$streamId": "The stream ID.
", "Stream$streamId": "The stream ID.
", "StreamInfo$streamId": "The stream ID.
", "StreamSummary$streamId": "The stream ID.
", "UpdateStreamRequest$streamId": "The stream ID.
", "UpdateStreamResponse$streamId": "The stream ID.
" } }, "StreamInfo": { "base": "Information about a stream.
", "refs": { "DescribeStreamResponse$streamInfo": "Information about the stream.
" } }, "StreamName": { "base": null, "refs": { "KinesisAction$streamName": "The name of the Amazon Kinesis stream.
" } }, "StreamSummary": { "base": "A summary of a stream.
", "refs": { "StreamsSummary$member": null } }, "StreamVersion": { "base": null, "refs": { "CreateStreamResponse$streamVersion": "The version of the stream.
", "StreamInfo$streamVersion": "The stream version.
", "StreamSummary$streamVersion": "The stream version.
", "UpdateStreamResponse$streamVersion": "The stream version.
" } }, "StreamsSummary": { "base": null, "refs": { "ListStreamsResponse$streams": "A list of streams.
" } }, "String": { "base": null, "refs": { "CloudwatchMetricAction$metricNamespace": "The CloudWatch metric namespace name.
", "CloudwatchMetricAction$metricName": "The CloudWatch metric name.
", "CloudwatchMetricAction$metricValue": "The CloudWatch metric value.
", "CloudwatchMetricAction$metricUnit": "The metric unit supported by CloudWatch.
", "CloudwatchMetricAction$metricTimestamp": "An optional Unix timestamp.
", "StringMap$key": null, "StringMap$value": null } }, "StringMap": { "base": null, "refs": { "NonCompliantResource$additionalInfo": "Additional information about the non-compliant resource.
", "RelatedResource$additionalInfo": "Additional information about the resource.
" } }, "SucceededThings": { "base": null, "refs": { "JobProcessDetails$numberOfSucceededThings": "The number of things which successfully completed the job.
" } }, "TableName": { "base": null, "refs": { "DynamoDBAction$tableName": "The name of the DynamoDB table.
", "PutItemInput$tableName": "The table where the message data will be written
" } }, "Target": { "base": null, "refs": { "Targets$member": null } }, "TargetArn": { "base": null, "refs": { "AuditNotificationTarget$targetArn": "The ARN of the target (SNS topic) to which audit notifications are sent.
", "JobTargets$member": null } }, "TargetAuditCheckNames": { "base": null, "refs": { "CreateScheduledAuditRequest$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 UpdateAccountAuditConfiguration to select which checks are enabled.)
Which checks are performed during the scheduled audit. (Note that checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.)
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.
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 UpdateAccountAuditConfiguration to select which checks are enabled.)
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.
", "CreateOTAUpdateRequest$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.
", "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 device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
", "JobSummary$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.
", "ListJobsRequest$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.
", "OTAUpdateInfo$targetSelection": "Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
" } }, "Targets": { "base": null, "refs": { "CreateOTAUpdateRequest$targets": "The targeted devices to receive OTA updates.
", "OTAUpdateInfo$targets": "The targets of the OTA update.
" } }, "TaskId": { "base": null, "refs": { "DescribeThingRegistrationTaskRequest$taskId": "The task ID.
", "DescribeThingRegistrationTaskResponse$taskId": "The task ID.
", "ListThingRegistrationTaskReportsRequest$taskId": "The id of the task.
", "StartThingRegistrationTaskResponse$taskId": "The bulk thing provisioning task ID.
", "StopThingRegistrationTaskRequest$taskId": "The bulk thing provisioning task ID.
", "TaskIdList$member": null } }, "TaskIdList": { "base": null, "refs": { "ListThingRegistrationTasksResponse$taskIds": "A list of bulk thing provisioning task IDs.
" } }, "TaskStatistics": { "base": "Statistics for the checks performed during the audit.
", "refs": { "DescribeAuditTaskResponse$taskStatistics": "Statistical information about the audit.
" } }, "TemplateBody": { "base": null, "refs": { "DescribeThingRegistrationTaskResponse$templateBody": "The task's template.
", "RegisterThingRequest$templateBody": "The provisioning template. See Programmatic Provisioning for more information.
", "RegistrationConfig$templateBody": "The template body.
", "StartThingRegistrationTaskRequest$templateBody": "The provisioning template.
" } }, "TestAuthorizationRequest": { "base": null, "refs": { } }, "TestAuthorizationResponse": { "base": null, "refs": { } }, "TestInvokeAuthorizerRequest": { "base": null, "refs": { } }, "TestInvokeAuthorizerResponse": { "base": null, "refs": { } }, "ThingArn": { "base": null, "refs": { "AddThingToThingGroupRequest$thingArn": "The ARN of the thing to add to a group.
", "CreateThingResponse$thingArn": "The ARN of the new thing.
", "DescribeThingResponse$thingArn": "The ARN of the thing to describe.
", "JobExecution$thingArn": "The ARN of the thing on which the job execution is running.
", "JobExecutionSummaryForJob$thingArn": "The ARN of the thing on which the job execution is running.
", "RemoveThingFromThingGroupRequest$thingArn": "The ARN of the thing to remove from the group.
", "ThingAttribute$thingArn": "The thing ARN.
" } }, "ThingAttribute": { "base": "The properties of the thing, including thing name, thing type name, and a list of thing attributes.
", "refs": { "ThingAttributeList$member": null } }, "ThingAttributeList": { "base": null, "refs": { "ListThingsResponse$things": "The things.
" } }, "ThingDocument": { "base": "The thing search index document.
", "refs": { "ThingDocumentList$member": null } }, "ThingDocumentList": { "base": null, "refs": { "SearchIndexResponse$things": "The things that match the search query.
" } }, "ThingGroupArn": { "base": null, "refs": { "AddThingToThingGroupRequest$thingGroupArn": "The ARN of the group to which you are adding a thing.
", "CreateThingGroupResponse$thingGroupArn": "The thing group ARN.
", "DescribeThingGroupResponse$thingGroupArn": "The thing group ARN.
", "GroupNameAndArn$groupArn": "The group ARN.
", "RemoveThingFromThingGroupRequest$thingGroupArn": "The group ARN.
" } }, "ThingGroupDescription": { "base": null, "refs": { "ThingGroupDocument$thingGroupDescription": "The thing group description.
", "ThingGroupProperties$thingGroupDescription": "The thing group description.
" } }, "ThingGroupDocument": { "base": "The thing group search index document.
", "refs": { "ThingGroupDocumentList$member": null } }, "ThingGroupDocumentList": { "base": null, "refs": { "SearchIndexResponse$thingGroups": "The thing groups that match the search query.
" } }, "ThingGroupId": { "base": null, "refs": { "CreateThingGroupResponse$thingGroupId": "The thing group ID.
", "DescribeThingGroupResponse$thingGroupId": "The thing group ID.
", "JobSummary$thingGroupId": "The ID of the thing group.
", "ListJobsRequest$thingGroupId": "A filter that limits the returned jobs to those for the specified group.
", "ThingGroupDocument$thingGroupId": "The thing group ID.
" } }, "ThingGroupIndexingConfiguration": { "base": "Thing group indexing configuration.
", "refs": { "GetIndexingConfigurationResponse$thingGroupIndexingConfiguration": "The index configuration.
", "UpdateIndexingConfigurationRequest$thingGroupIndexingConfiguration": "Thing group indexing configuration.
" } }, "ThingGroupIndexingMode": { "base": null, "refs": { "ThingGroupIndexingConfiguration$thingGroupIndexingMode": "Thing group indexing mode.
" } }, "ThingGroupList": { "base": null, "refs": { "UpdateThingGroupsForThingRequest$thingGroupsToAdd": "The groups to which the thing will be added.
", "UpdateThingGroupsForThingRequest$thingGroupsToRemove": "The groups from which the thing will be removed.
" } }, "ThingGroupMetadata": { "base": "Thing group metadata.
", "refs": { "DescribeThingGroupResponse$thingGroupMetadata": "Thing group metadata.
" } }, "ThingGroupName": { "base": null, "refs": { "AddThingToThingGroupRequest$thingGroupName": "The name of the group to which you are adding a thing.
", "CreateThingGroupRequest$thingGroupName": "The thing group name to create.
", "CreateThingGroupRequest$parentGroupName": "The name of the parent thing group.
", "CreateThingGroupResponse$thingGroupName": "The thing group name.
", "DeleteThingGroupRequest$thingGroupName": "The name of the thing group to delete.
", "DescribeThingGroupRequest$thingGroupName": "The name of the thing group.
", "DescribeThingGroupResponse$thingGroupName": "The name of the thing group.
", "GroupNameAndArn$groupName": "The group name.
", "ListJobsRequest$thingGroupName": "A filter that limits the returned jobs to those for the specified group.
", "ListThingGroupsRequest$parentGroup": "A filter that limits the results to those with the specified parent group.
", "ListThingGroupsRequest$namePrefixFilter": "A filter that limits the results to those with the specified name prefix.
", "ListThingsInThingGroupRequest$thingGroupName": "The thing group name.
", "RemoveThingFromThingGroupRequest$thingGroupName": "The group name.
", "ThingGroupDocument$thingGroupName": "The thing group name.
", "ThingGroupList$member": null, "ThingGroupMetadata$parentGroupName": "The parent thing group name.
", "ThingGroupNameList$member": null, "UpdateThingGroupRequest$thingGroupName": "The thing group to update.
" } }, "ThingGroupNameAndArnList": { "base": null, "refs": { "ListThingGroupsForThingResponse$thingGroups": "The thing groups.
", "ListThingGroupsResponse$thingGroups": "The thing groups.
", "ThingGroupMetadata$rootToParentThingGroups": "The root parent thing group.
" } }, "ThingGroupNameList": { "base": null, "refs": { "ThingDocument$thingGroupNames": "Thing group names.
", "ThingGroupDocument$parentGroupNames": "Parent group names.
" } }, "ThingGroupProperties": { "base": "Thing group properties.
", "refs": { "CreateThingGroupRequest$thingGroupProperties": "The thing group properties.
", "DescribeThingGroupResponse$thingGroupProperties": "The thing group properties.
", "UpdateThingGroupRequest$thingGroupProperties": "The thing group properties.
" } }, "ThingId": { "base": null, "refs": { "CreateThingResponse$thingId": "The thing ID.
", "DescribeThingResponse$thingId": "The ID of the thing to describe.
", "ThingDocument$thingId": "The thing ID.
" } }, "ThingIndexingConfiguration": { "base": "Thing indexing configuration.
", "refs": { "GetIndexingConfigurationResponse$thingIndexingConfiguration": "Thing indexing configuration.
", "UpdateIndexingConfigurationRequest$thingIndexingConfiguration": "Thing indexing configuration.
" } }, "ThingIndexingMode": { "base": null, "refs": { "ThingIndexingConfiguration$thingIndexingMode": "Thing indexing mode. Valid values are:
REGISTRY – Your thing index will contain only registry data.
REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.
OFF - Thing indexing is disabled.
The name of the thing responsible for the active violation.
", "AddThingToThingGroupRequest$thingName": "The name of the thing to add to a group.
", "AttachThingPrincipalRequest$thingName": "The name of the thing.
", "CancelJobExecutionRequest$thingName": "The name of the thing whose execution of the job will be canceled.
", "CreateThingRequest$thingName": "The name of the thing to create.
", "CreateThingResponse$thingName": "The name of the new thing.
", "DeleteJobExecutionRequest$thingName": "The name of the thing whose job execution will be deleted.
", "DeleteThingRequest$thingName": "The name of the thing to delete.
", "DescribeJobExecutionRequest$thingName": "The name of the thing on which the job execution is running.
", "DescribeThingRequest$thingName": "The name of the thing.
", "DescribeThingResponse$thingName": "The name of the thing.
", "DetachThingPrincipalRequest$thingName": "The name of the thing.
", "GetEffectivePoliciesRequest$thingName": "The thing name.
", "ListActiveViolationsRequest$thingName": "The name of the thing whose active violations are listed.
", "ListJobExecutionsForThingRequest$thingName": "The thing name.
", "ListThingGroupsForThingRequest$thingName": "The thing name.
", "ListThingPrincipalsRequest$thingName": "The name of the thing.
", "ListViolationEventsRequest$thingName": "A filter to limit results to those alerts caused by the specified thing.
", "RemoveThingFromThingGroupRequest$thingName": "The name of the thing to remove from the group.
", "ThingAttribute$thingName": "The name of the thing.
", "ThingDocument$thingName": "The thing name.
", "ThingNameList$member": null, "UpdateThingGroupsForThingRequest$thingName": "The thing whose group memberships will be updated.
", "UpdateThingRequest$thingName": "The name of the thing to update.
", "ViolationEvent$thingName": "The name of the thing responsible for the violation event.
" } }, "ThingNameList": { "base": null, "refs": { "ListPrincipalThingsResponse$things": "The things.
", "ListThingsInThingGroupResponse$things": "The things in the specified thing group.
" } }, "ThingTypeArn": { "base": null, "refs": { "CreateThingTypeResponse$thingTypeArn": "The Amazon Resource Name (ARN) of the thing type.
", "DescribeThingTypeResponse$thingTypeArn": "The thing type ARN.
", "ThingTypeDefinition$thingTypeArn": "The thing type ARN.
" } }, "ThingTypeDefinition": { "base": "The definition of the thing type, including thing type name and description.
", "refs": { "ThingTypeList$member": null } }, "ThingTypeDescription": { "base": null, "refs": { "ThingTypeProperties$thingTypeDescription": "The description of the thing type.
" } }, "ThingTypeId": { "base": null, "refs": { "CreateThingTypeResponse$thingTypeId": "The thing type ID.
", "DescribeThingTypeResponse$thingTypeId": "The thing type ID.
" } }, "ThingTypeList": { "base": null, "refs": { "ListThingTypesResponse$thingTypes": "The thing types.
" } }, "ThingTypeMetadata": { "base": "The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when time was deprecated.
", "refs": { "DescribeThingTypeResponse$thingTypeMetadata": "The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
", "ThingTypeDefinition$thingTypeMetadata": "The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
" } }, "ThingTypeName": { "base": null, "refs": { "CreateThingRequest$thingTypeName": "The name of the thing type associated with the new thing.
", "CreateThingTypeRequest$thingTypeName": "The name of the thing type.
", "CreateThingTypeResponse$thingTypeName": "The name of the thing type.
", "DeleteThingTypeRequest$thingTypeName": "The name of the thing type.
", "DeprecateThingTypeRequest$thingTypeName": "The name of the thing type to deprecate.
", "DescribeThingResponse$thingTypeName": "The thing type name.
", "DescribeThingTypeRequest$thingTypeName": "The name of the thing type.
", "DescribeThingTypeResponse$thingTypeName": "The name of the thing type.
", "ListThingTypesRequest$thingTypeName": "The name of the thing type.
", "ListThingsRequest$thingTypeName": "The name of the thing type used to search for things.
", "ThingAttribute$thingTypeName": "The name of the thing type, if the thing has been associated with a type.
", "ThingDocument$thingTypeName": "The thing type name.
", "ThingTypeDefinition$thingTypeName": "The name of the thing type.
", "UpdateThingRequest$thingTypeName": "The name of the thing type.
" } }, "ThingTypeProperties": { "base": "The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.
", "refs": { "CreateThingTypeRequest$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.
", "DescribeThingTypeResponse$thingTypeProperties": "The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.
", "ThingTypeDefinition$thingTypeProperties": "The ThingTypeProperties for the thing type.
" } }, "ThrottlingException": { "base": "The rate exceeds the limit.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "ActiveViolation$lastViolationTime": "The time the most recent violation occurred.
", "ActiveViolation$violationStartTime": "The time the violation started.
", "AuditFinding$taskStartTime": "The time the audit started.
", "AuditFinding$findingTime": "The time the result (finding) was discovered.
", "DescribeAuditTaskResponse$taskStartTime": "The time the audit started.
", "DescribeSecurityProfileResponse$creationDate": "The time the security profile was created.
", "DescribeSecurityProfileResponse$lastModifiedDate": "The time the security profile was last modified.
", "ListAuditFindingsRequest$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.
", "ListAuditFindingsRequest$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.
", "ListAuditTasksRequest$startTime": "The beginning of the time period. Note that audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an \"InvalidRequestException\".
", "ListAuditTasksRequest$endTime": "The end of the time period.
", "ListViolationEventsRequest$startTime": "The start time for the alerts to be listed.
", "ListViolationEventsRequest$endTime": "The end time for the alerts to be listed.
", "UpdateSecurityProfileResponse$creationDate": "The time the security profile was created.
", "UpdateSecurityProfileResponse$lastModifiedDate": "The time the security profile was last modified.
", "ViolationEvent$violationEventTime": "The time the violation event occurred.
" } }, "Token": { "base": null, "refs": { "TestInvokeAuthorizerRequest$token": "The token returned by your custom authentication service.
" } }, "TokenKeyName": { "base": null, "refs": { "AuthorizerDescription$tokenKeyName": "The key used to extract the token from the HTTP headers.
", "CreateAuthorizerRequest$tokenKeyName": "The name of the token key used to extract the token from the HTTP headers.
", "UpdateAuthorizerRequest$tokenKeyName": "The key used to extract the token from the HTTP headers.
" } }, "TokenSignature": { "base": null, "refs": { "TestInvokeAuthorizerRequest$tokenSignature": "The signature made with the token and your custom authentication service's private key.
" } }, "Topic": { "base": null, "refs": { "ListTopicRulesRequest$topic": "The topic.
" } }, "TopicPattern": { "base": null, "refs": { "RepublishAction$topic": "The name of the MQTT topic.
", "TopicRuleListItem$topicPattern": "The pattern for the topic names that apply.
" } }, "TopicRule": { "base": "Describes a rule.
", "refs": { "GetTopicRuleResponse$rule": "The rule.
" } }, "TopicRuleList": { "base": null, "refs": { "ListTopicRulesResponse$rules": "The rules.
" } }, "TopicRuleListItem": { "base": "Describes a rule.
", "refs": { "TopicRuleList$member": null } }, "TopicRulePayload": { "base": "Describes a rule.
", "refs": { "CreateTopicRuleRequest$topicRulePayload": "The rule payload.
", "ReplaceTopicRuleRequest$topicRulePayload": "The rule payload.
" } }, "TotalChecksCount": { "base": null, "refs": { "TaskStatistics$totalChecks": "The number of checks in this audit.
" } }, "TotalResourcesCount": { "base": null, "refs": { "AuditCheckDetails$totalResourcesCount": "The number of resources on which the check was performed.
" } }, "TransferAlreadyCompletedException": { "base": "You can't revert the certificate transfer because the transfer is already complete.
", "refs": { } }, "TransferCertificateRequest": { "base": "The input for the TransferCertificate operation.
", "refs": { } }, "TransferCertificateResponse": { "base": "The output from the TransferCertificate operation.
", "refs": { } }, "TransferConflictException": { "base": "You can't transfer the certificate because authorization policies are still attached.
", "refs": { } }, "TransferData": { "base": "Data used to transfer a certificate to an AWS account.
", "refs": { "CertificateDescription$transferData": "The transfer data.
" } }, "UnauthorizedException": { "base": "You are not authorized to perform this operation.
", "refs": { } }, "UndoDeprecate": { "base": null, "refs": { "DeprecateThingTypeRequest$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.
" } }, "UnsignedLong": { "base": null, "refs": { "MetricValue$count": "If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.
The input to the UpdateCACertificate operation.
", "refs": { } }, "UpdateCertificateRequest": { "base": "The input for the UpdateCertificate operation.
", "refs": { } }, "UpdateEventConfigurationsRequest": { "base": null, "refs": { } }, "UpdateEventConfigurationsResponse": { "base": null, "refs": { } }, "UpdateIndexingConfigurationRequest": { "base": null, "refs": { } }, "UpdateIndexingConfigurationResponse": { "base": null, "refs": { } }, "UpdateRoleAliasRequest": { "base": null, "refs": { } }, "UpdateRoleAliasResponse": { "base": null, "refs": { } }, "UpdateScheduledAuditRequest": { "base": null, "refs": { } }, "UpdateScheduledAuditResponse": { "base": null, "refs": { } }, "UpdateSecurityProfileRequest": { "base": null, "refs": { } }, "UpdateSecurityProfileResponse": { "base": null, "refs": { } }, "UpdateStreamRequest": { "base": null, "refs": { } }, "UpdateStreamResponse": { "base": null, "refs": { } }, "UpdateThingGroupRequest": { "base": null, "refs": { } }, "UpdateThingGroupResponse": { "base": null, "refs": { } }, "UpdateThingGroupsForThingRequest": { "base": null, "refs": { } }, "UpdateThingGroupsForThingResponse": { "base": null, "refs": { } }, "UpdateThingRequest": { "base": "The input for the UpdateThing operation.
", "refs": { } }, "UpdateThingResponse": { "base": "The output from the UpdateThing operation.
", "refs": { } }, "UseBase64": { "base": null, "refs": { "SqsAction$useBase64": "Specifies whether to use Base64 encoding.
" } }, "Valid": { "base": null, "refs": { "ValidateSecurityProfileBehaviorsResponse$valid": "True if the behaviors were valid.
" } }, "ValidateSecurityProfileBehaviorsRequest": { "base": null, "refs": { } }, "ValidateSecurityProfileBehaviorsResponse": { "base": null, "refs": { } }, "ValidationError": { "base": "Information about an error found in a behavior specification.
", "refs": { "ValidationErrors$member": null } }, "ValidationErrors": { "base": null, "refs": { "ValidateSecurityProfileBehaviorsResponse$validationErrors": "The list of any errors found in the behaviors.
" } }, "Value": { "base": null, "refs": { "AdditionalParameterMap$value": null, "AttributesMap$value": null, "Parameters$value": null } }, "Version": { "base": null, "refs": { "DescribeSecurityProfileResponse$version": "The version of the security profile. A new version is generated whenever the security profile is updated.
", "DescribeThingGroupResponse$version": "The version of the thing group.
", "DescribeThingResponse$version": "The current version of the thing record in the registry.
To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.
The version of the thing record in the registry.
", "UpdateSecurityProfileResponse$version": "The updated version of the security profile.
", "UpdateThingGroupResponse$version": "The version of the updated thing group.
" } }, "VersionConflictException": { "base": "An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
" } }, "VersionsLimitExceededException": { "base": "The number of policy versions exceeds the limit.
", "refs": { } }, "ViolationEvent": { "base": "Information about a Device Defender security profile behavior violation.
", "refs": { "ViolationEvents$member": null } }, "ViolationEventType": { "base": null, "refs": { "ViolationEvent$violationEventType": "The type of violation event.
" } }, "ViolationEvents": { "base": null, "refs": { "ListViolationEventsResponse$violationEvents": "The security profile violation alerts issued for this account during the given time frame, potentially filtered by security profile, behavior violated, or thing (device) violating.
" } }, "ViolationId": { "base": null, "refs": { "ActiveViolation$violationId": "The ID of the active violation.
", "ViolationEvent$violationId": "The ID of the violation event.
" } }, "WaitingForDataCollectionChecksCount": { "base": null, "refs": { "TaskStatistics$waitingForDataCollectionChecks": "The number of checks waiting for data collection.
" } }, "errorMessage": { "base": null, "refs": { "CertificateConflictException$message": "The message for the exception.
", "CertificateStateException$message": "The message for the exception.
", "CertificateValidationException$message": "Additional information about the exception.
", "ConflictingResourceUpdateException$message": "The message for the exception.
", "DeleteConflictException$message": "The message for the exception.
", "IndexNotReadyException$message": "The message for the exception.
", "InternalException$message": "The message for the exception.
", "InternalFailureException$message": "The message for the exception.
", "InvalidQueryException$message": "The message for the exception.
", "InvalidRequestException$message": "The message for the exception.
", "InvalidResponseException$message": "The message for the exception.
", "InvalidStateTransitionException$message": "The message for the exception.
", "LimitExceededException$message": "The message for the exception.
", "MalformedPolicyException$message": "The message for the exception.
", "NotConfiguredException$message": "The message for the exception.
", "RegistrationCodeValidationException$message": "Additional information about the exception.
", "ResourceAlreadyExistsException$message": "The message for the exception.
", "ResourceNotFoundException$message": "The message for the exception.
", "ResourceRegistrationFailureException$message": "The message for the exception.
", "ServiceUnavailableException$message": "The message for the exception.
", "SqlParseException$message": "The message for the exception.
", "ThrottlingException$message": "The message for the exception.
", "TransferAlreadyCompletedException$message": "The message for the exception.
", "TransferConflictException$message": "The message for the exception.
", "UnauthorizedException$message": "The message for the exception.
", "VersionConflictException$message": "The message for the exception.
", "VersionsLimitExceededException$message": "The message for the exception.
" } }, "resourceArn": { "base": null, "refs": { "ResourceAlreadyExistsException$resourceArn": "The ARN of the resource that caused the exception.
" } }, "resourceId": { "base": null, "refs": { "ResourceAlreadyExistsException$resourceId": "The ID of the resource that caused the exception.
" } } } }