IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.
The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.
For more information about how IoT works, see the Developer Guide.
For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.
', '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.
Requires permission to access the AcceptCertificateTransfer action.
', 'AddThingToBillingGroup' => 'Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
', 'AddThingToThingGroup' => 'Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
', '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.
Requires permission to access the AssociateTargetsWithJob action.
', 'AttachPolicy' => 'Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
', 'AttachPrincipalPolicy' => 'Attaches the specified policy to the specified principal (certificate or other credential).
Note: This action is deprecated and works as expected for backward compatibility, but we won\'t add enhancements. Use AttachPolicy instead.
Requires permission to access the AttachPrincipalPolicy action.
', 'AttachSecurityProfile' => 'Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
Requires permission to access the AttachSecurityProfile action.
', 'AttachThingPrincipal' => 'Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities.
Requires permission to access the AttachThingPrincipal action.
', 'CancelAuditMitigationActionsTask' => 'Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
Requires permission to access the CancelAuditMitigationActionsTask action.
', 'CancelAuditTask' => 'Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn\'t in progress, an "InvalidRequestException" occurs.
Requires permission to access the CancelAuditTask action.
', '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, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
Requires permission to access the CancelCertificateTransfer action.
', 'CancelDetectMitigationActionsTask' => 'Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
', 'CancelJob' => 'Cancels a job.
Requires permission to access the CancelJob action.
', 'CancelJobExecution' => 'Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
', 'ClearDefaultAuthorizer' => 'Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
', 'ConfirmTopicRuleDestination' => 'Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.
Requires permission to access the ConfirmTopicRuleDestination action.
', 'CreateAuditSuppression' => 'Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
', 'CreateAuthorizer' => 'Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
', 'CreateBillingGroup' => 'Creates a billing group.
Requires permission to access the CreateBillingGroup action.
', 'CreateCertificateFromCsr' => 'Creates an X.509 certificate using the specified certificate signing request.
Requires permission to access the CreateCertificateFromCsr action.
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. For supported certificates, consult Certificate signing algorithms supported by IoT.
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. In the following commands, we assume that a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the corresponding CSR.
You can also run the aws iot create-certificate-from-csr part of the command 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"
Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
', 'CreateDimension' => 'Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
Requires permission to access the CreateDimension action.
', 'CreateDomainConfiguration' => 'Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
', 'CreateDynamicThingGroup' => 'Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
', 'CreateFleetMetric' => 'Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
', 'CreateJob' => 'Creates a job.
Requires permission to access the CreateJob action.
', 'CreateJobTemplate' => 'Creates a job template.
Requires permission to access the CreateJobTemplate action.
', 'CreateKeysAndCertificate' => 'Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.
Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.
Requires permission to access the CreateKeysAndCertificate action.
', 'CreateMitigationAction' => 'Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.
Requires permission to access the CreateMitigationAction action.
', 'CreateOTAUpdate' => 'Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
', 'CreatePackage' => 'Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
', 'CreatePackageVersion' => 'Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
', 'CreatePolicy' => 'Creates an IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy\'s default version.
Requires permission to access the CreatePolicy action.
', 'CreatePolicyVersion' => 'Creates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy\'s default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
Requires permission to access the CreatePolicyVersion action.
', 'CreateProvisioningClaim' => 'Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
', 'CreateProvisioningTemplate' => 'Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
', 'CreateProvisioningTemplateVersion' => 'Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
', 'CreateRoleAlias' => 'Creates a role alias.
Requires permission to access the CreateRoleAlias action.
', 'CreateScheduledAudit' => 'Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
', 'CreateSecurityProfile' => 'Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
', '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.
Requires permission to access the CreateStream action.
', 'CreateThing' => 'Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Requires permission to access the CreateThing action.
', 'CreateThingGroup' => 'Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Requires permission to access the CreateThingGroup action.
', 'CreateThingType' => 'Creates a new thing type.
Requires permission to access the CreateThingType action.
', '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.
Requires permission to access the CreateTopicRule action.
', 'CreateTopicRuleDestination' => 'Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
', '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.
Requires permission to access the DeleteAccountAuditConfiguration action.
', 'DeleteAuditSuppression' => 'Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
', 'DeleteAuthorizer' => 'Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
', 'DeleteBillingGroup' => 'Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
', 'DeleteCACertificate' => 'Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
', 'DeleteCertificate' => 'Deletes the specified certificate.
A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.
Requires permission to access the DeleteCertificate action.
', 'DeleteCustomMetric' => 'Deletes a Device Defender detect custom metric.
Requires permission to access the DeleteCustomMetric action.
Before you can delete a custom metric, you must first remove the custom metric from all security profiles it\'s a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
', 'DeleteDomainConfiguration' => 'Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
', 'DeleteDynamicThingGroup' => 'Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
', 'DeleteFleetMetric' => 'Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn\'t exist.
Requires permission to access the DeleteFleetMetric action.
', '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.
Requires permission to access the DeleteJob action.
', 'DeleteJobExecution' => 'Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
', 'DeleteJobTemplate' => 'Deletes the specified job template.
', 'DeleteMitigationAction' => 'Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
', 'DeleteOTAUpdate' => 'Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
', 'DeletePackage' => 'Deletes a specific version from a software package.
Note: All package versions must be deleted before deleting the software package.
Requires permission to access the DeletePackageVersion action.
', 'DeletePackageVersion' => 'Deletes a specific version from a software package.
Note: If a package version is designated as default, you must remove the designation from the package using the UpdatePackage action.
', '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 action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it\'s ready to be deleted.
Requires permission to access the DeletePolicy action.
', 'DeletePolicyVersion' => 'Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
Requires permission to access the DeletePolicyVersion action.
', 'DeleteProvisioningTemplate' => 'Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
', 'DeleteProvisioningTemplateVersion' => 'Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
', 'DeleteRegistrationCode' => 'Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
', 'DeleteRoleAlias' => 'Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
', 'DeleteScheduledAudit' => 'Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
', 'DeleteSecurityProfile' => 'Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
', 'DeleteStream' => 'Deletes a stream.
Requires permission to access the DeleteStream action.
', 'DeleteThing' => 'Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn\'t exist.
Requires permission to access the DeleteThing action.
', 'DeleteThingGroup' => 'Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
', '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.
Requires permission to access the DeleteThingType action.
', 'DeleteTopicRule' => 'Deletes the rule.
Requires permission to access the DeleteTopicRule action.
', 'DeleteTopicRuleDestination' => 'Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
', 'DeleteV2LoggingLevel' => 'Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
', 'DeprecateThingType' => 'Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
', '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.
Requires permission to access the DescribeAccountAuditConfiguration action.
', 'DescribeAuditFinding' => 'Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
Requires permission to access the DescribeAuditFinding action.
', 'DescribeAuditMitigationActionsTask' => 'Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they\'re being applied, the task status, and aggregated task statistics.
', 'DescribeAuditSuppression' => 'Gets information about a Device Defender audit suppression.
', 'DescribeAuditTask' => 'Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
', 'DescribeAuthorizer' => 'Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
', 'DescribeBillingGroup' => 'Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
', 'DescribeCACertificate' => 'Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
', 'DescribeCertificate' => 'Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
', 'DescribeCustomMetric' => 'Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
', 'DescribeDefaultAuthorizer' => 'Describes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
', 'DescribeDetectMitigationActionsTask' => 'Gets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
', 'DescribeDimension' => 'Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
', 'DescribeDomainConfiguration' => 'Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
', 'DescribeEndpoint' => 'Returns a unique endpoint specific to the Amazon Web Services account making the call.
Requires permission to access the DescribeEndpoint action.
', 'DescribeEventConfigurations' => 'Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
', 'DescribeFleetMetric' => 'Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
', 'DescribeIndex' => 'Describes a search index.
Requires permission to access the DescribeIndex action.
', 'DescribeJob' => 'Describes a job.
Requires permission to access the DescribeJob action.
', 'DescribeJobExecution' => 'Describes a job execution.
Requires permission to access the DescribeJobExecution action.
', 'DescribeJobTemplate' => 'Returns information about a job template.
', 'DescribeManagedJobTemplate' => 'View details of a managed job template.
', 'DescribeMitigationAction' => 'Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
', 'DescribeProvisioningTemplate' => 'Returns information about a provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
', 'DescribeProvisioningTemplateVersion' => 'Returns information about a provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
', 'DescribeRoleAlias' => 'Describes a role alias.
Requires permission to access the DescribeRoleAlias action.
', 'DescribeScheduledAudit' => 'Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
', 'DescribeSecurityProfile' => 'Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
', 'DescribeStream' => 'Gets information about a stream.
Requires permission to access the DescribeStream action.
', 'DescribeThing' => 'Gets information about the specified thing.
Requires permission to access the DescribeThing action.
', 'DescribeThingGroup' => 'Describe a thing group.
Requires permission to access the DescribeThingGroup action.
', 'DescribeThingRegistrationTask' => 'Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
', 'DescribeThingType' => 'Gets information about the specified thing type.
Requires permission to access the DescribeThingType action.
', 'DetachPolicy' => 'Detaches a policy from the specified target.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it\'s ready to be deleted.
Requires permission to access the DetachPolicy action.
', 'DetachPrincipalPolicy' => 'Removes the specified policy from the specified certificate.
Note: This action is deprecated and works as expected for backward compatibility, but we won\'t add enhancements. Use DetachPolicy instead.
Requires permission to access the DetachPrincipalPolicy action.
', 'DetachSecurityProfile' => 'Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
', 'DetachThingPrincipal' => 'Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This call is asynchronous. It might take several seconds for the detachment to propagate.
Requires permission to access the DetachThingPrincipal action.
', 'DisableTopicRule' => 'Disables the rule.
Requires permission to access the DisableTopicRule action.
', 'EnableTopicRule' => 'Enables the rule.
Requires permission to access the EnableTopicRule action.
', 'GetBehaviorModelTrainingSummaries' => 'Returns a Device Defender\'s ML Detect Security Profile training model\'s status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
', 'GetBucketsAggregation' => 'Aggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
', 'GetCardinality' => 'Returns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
', 'GetEffectivePolicies' => 'Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway.
Requires permission to access the GetEffectivePolicies action.
', 'GetIndexingConfiguration' => 'Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
', 'GetJobDocument' => 'Gets a job document.
Requires permission to access the GetJobDocument action.
', 'GetLoggingOptions' => 'Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
Requires permission to access the GetLoggingOptions action.
', 'GetOTAUpdate' => 'Gets an OTA update.
Requires permission to access the GetOTAUpdate action.
', 'GetPackage' => 'Gets information about the specified software package.
Requires permission to access the GetPackage action.
', 'GetPackageConfiguration' => 'Gets information about the specified software package\'s configuration.
Requires permission to access the GetPackageConfiguration action.
', 'GetPackageVersion' => 'Gets information about the specified package version.
Requires permission to access the GetPackageVersion action.
', 'GetPercentiles' => 'Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.
Requires permission to access the GetPercentiles action.
', 'GetPolicy' => 'Gets information about the specified policy with the policy document of the default version.
Requires permission to access the GetPolicy action.
', 'GetPolicyVersion' => 'Gets information about the specified policy version.
Requires permission to access the GetPolicyVersion action.
', 'GetRegistrationCode' => 'Gets a registration code used to register a CA certificate with IoT.
Requires permission to access the GetRegistrationCode action.
', 'GetStatistics' => 'Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.
Requires permission to access the GetStatistics action.
', 'GetTopicRule' => 'Gets information about the rule.
Requires permission to access the GetTopicRule action.
', 'GetTopicRuleDestination' => 'Gets information about a topic rule destination.
Requires permission to access the GetTopicRuleDestination action.
', 'GetV2LoggingOptions' => 'Gets the fine grained logging options.
Requires permission to access the GetV2LoggingOptions action.
', 'ListActiveViolations' => 'Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
', 'ListAttachedPolicies' => 'Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
', 'ListAuditFindings' => 'Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)
Requires permission to access the ListAuditFindings action.
', 'ListAuditMitigationActionsExecutions' => 'Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
', 'ListAuditMitigationActionsTasks' => 'Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
', 'ListAuditSuppressions' => 'Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
', 'ListAuditTasks' => 'Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
', 'ListAuthorizers' => 'Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
', 'ListBillingGroups' => 'Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
', 'ListCACertificates' => 'Lists the CA certificates registered for your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCACertificates action.
', 'ListCertificates' => 'Lists the certificates registered in your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCertificates action.
', 'ListCertificatesByCA' => 'List the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
', 'ListCustomMetrics' => 'Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
', 'ListDetectMitigationActionsExecutions' => 'Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
', 'ListDetectMitigationActionsTasks' => 'List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
', 'ListDimensions' => 'List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
', 'ListDomainConfigurations' => 'Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
Requires permission to access the ListDomainConfigurations action.
', 'ListFleetMetrics' => 'Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
', 'ListIndices' => 'Lists the search indices.
Requires permission to access the ListIndices action.
', 'ListJobExecutionsForJob' => 'Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
', 'ListJobExecutionsForThing' => 'Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
', 'ListJobTemplates' => 'Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
', 'ListJobs' => 'Lists jobs.
Requires permission to access the ListJobs action.
', 'ListManagedJobTemplates' => 'Returns a list of managed job templates.
', 'ListMetricValues' => 'Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.
', 'ListMitigationActions' => 'Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
', 'ListOTAUpdates' => 'Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
', 'ListOutgoingCertificates' => 'Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
', 'ListPackageVersions' => 'Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
', 'ListPackages' => 'Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
', 'ListPolicies' => 'Lists your policies.
Requires permission to access the ListPolicies action.
', 'ListPolicyPrincipals' => 'Lists the principals associated with the specified policy.
Note: This action is deprecated and works as expected for backward compatibility, but we won\'t add enhancements. Use ListTargetsForPolicy instead.
Requires permission to access the ListPolicyPrincipals action.
', 'ListPolicyVersions' => 'Lists the versions of the specified policy and identifies the default version.
Requires permission to access the ListPolicyVersions action.
', '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 action is deprecated and works as expected for backward compatibility, but we won\'t add enhancements. Use ListAttachedPolicies instead.
Requires permission to access the ListPrincipalPolicies action.
', 'ListPrincipalThings' => 'Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListPrincipalThings action.
', 'ListProvisioningTemplateVersions' => 'A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
', 'ListProvisioningTemplates' => 'Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
', 'ListRelatedResourcesForAuditFinding' => 'The related resources of an Audit finding. The following resources can be returned from calling this API:
DEVICE_CERTIFICATE
CA_CERTIFICATE
IOT_POLICY
COGNITO_IDENTITY_POOL
CLIENT_ID
ACCOUNT_SETTINGS
ROLE_ALIAS
IAM_ROLE
ISSUER_CERTIFICATE
This API is similar to DescribeAuditFinding\'s RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
', 'ListScheduledAudits' => 'Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
', 'ListSecurityProfiles' => 'Lists the Device Defender security profiles you\'ve created. You can filter security profiles by dimension or custom metric.
Requires permission to access the ListSecurityProfiles action.
dimensionName and metricName cannot be used in the same request.
Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
', 'ListStreams' => 'Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
', 'ListTagsForResource' => 'Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
', 'ListTargetsForPolicy' => 'List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
', 'ListTargetsForSecurityProfile' => 'Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
', 'ListThingGroups' => 'List the thing groups in your account.
Requires permission to access the ListThingGroups action.
', 'ListThingGroupsForThing' => 'List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
', 'ListThingPrincipals' => 'Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListThingPrincipals action.
', 'ListThingRegistrationTaskReports' => 'Information about the thing registration tasks.
', 'ListThingRegistrationTasks' => 'List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
', 'ListThingTypes' => 'Lists the existing thing types.
Requires permission to access the ListThingTypes action.
', '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. For more information, see List Things from the Amazon Web Services IoT Core Developer Guide.
Requires permission to access the ListThings action.
You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.
Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
', 'ListThingsInThingGroup' => 'Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
', 'ListTopicRuleDestinations' => 'Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
', 'ListTopicRules' => 'Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
', 'ListV2LoggingLevels' => 'Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
', '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).
Requires permission to access the ListViolationEvents action.
', 'PutVerificationStateOnViolation' => 'Set a verification state and provide a description of that verification state on a violation (detect alarm).
', 'RegisterCACertificate' => 'Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.
Requires permission to access the RegisterCACertificate action.
', 'RegisterCertificate' => 'Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
Requires permission to access the RegisterCertificate action.
', 'RegisterCertificateWithoutCA' => 'Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.
', 'RegisterThing' => 'Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.
Requires permission to access the RegisterThing action.
', 'RejectCertificateTransfer' => 'Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source\'s account in the INACTIVE state.
Requires permission to access the RejectCertificateTransfer action.
', 'RemoveThingFromBillingGroup' => 'Removes the given thing from the billing group.
Requires permission to access the RemoveThingFromBillingGroup action.
This call is asynchronous. It might take several seconds for the detachment to propagate.
Remove the specified thing from the specified group.
You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.
Requires permission to access the RemoveThingFromThingGroup action.
', '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.
Requires permission to access the ReplaceTopicRule action.
', 'SearchIndex' => 'The query search index.
Requires permission to access the SearchIndex action.
', 'SetDefaultAuthorizer' => 'Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
Requires permission to access the SetDefaultAuthorizer action.
', '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 ListPrincipalPolicies action.
Requires permission to access the SetDefaultPolicyVersion action.
', 'SetLoggingOptions' => 'Sets the logging options.
NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
Requires permission to access the SetLoggingOptions action.
', 'SetV2LoggingLevel' => 'Sets the logging level.
Requires permission to access the SetV2LoggingLevel action.
', 'SetV2LoggingOptions' => 'Sets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
', 'StartAuditMitigationActionsTask' => 'Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
', 'StartDetectMitigationActionsTask' => 'Starts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
', 'StartOnDemandAuditTask' => 'Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
', 'StartThingRegistrationTask' => 'Creates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
', 'StopThingRegistrationTask' => 'Cancels a bulk thing provisioning task.
Requires permission to access the StopThingRegistrationTask action.
', 'TagResource' => 'Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
Requires permission to access the TagResource action.
', 'TestAuthorization' => 'Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestAuthorization action.
', '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 IoT device gateway.
Requires permission to access the TestInvokeAuthorizer action.
', 'TransferCertificate' => 'Transfers the specified certificate to the specified Amazon Web Services account.
Requires permission to access the TransferCertificate action.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination\'s account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.
', 'UntagResource' => 'Removes the given tags (metadata) from the resource.
Requires permission to access the UntagResource action.
', '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.
Requires permission to access the UpdateAccountAuditConfiguration action.
', 'UpdateAuditSuppression' => 'Updates a Device Defender audit suppression.
', 'UpdateAuthorizer' => 'Updates an authorizer.
Requires permission to access the UpdateAuthorizer action.
', 'UpdateBillingGroup' => 'Updates information about the billing group.
Requires permission to access the UpdateBillingGroup action.
', 'UpdateCACertificate' => 'Updates a registered CA certificate.
Requires permission to access the UpdateCACertificate action.
', 'UpdateCertificate' => 'Updates the status of the specified certificate. This operation is idempotent.
Requires permission to access the UpdateCertificate action.
Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.
Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
', 'UpdateCustomMetric' => 'Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
', 'UpdateDimension' => 'Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
Requires permission to access the UpdateDimension action.
', 'UpdateDomainConfiguration' => 'Updates values stored in the domain configuration. Domain configurations for default endpoints can\'t be updated.
Requires permission to access the UpdateDomainConfiguration action.
', 'UpdateDynamicThingGroup' => 'Updates a dynamic thing group.
Requires permission to access the UpdateDynamicThingGroup action.
', 'UpdateEventConfigurations' => 'Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
', 'UpdateFleetMetric' => 'Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
', 'UpdateIndexingConfiguration' => 'Updates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
', 'UpdateJob' => 'Updates supported fields of the specified job.
Requires permission to access the UpdateJob action.
', 'UpdateMitigationAction' => 'Updates the definition for the specified mitigation action.
Requires permission to access the UpdateMitigationAction action.
', 'UpdatePackage' => 'Updates the supported fields for a specific package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
', 'UpdatePackageConfiguration' => 'Updates the package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
', 'UpdatePackageVersion' => 'Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
', 'UpdateProvisioningTemplate' => 'Updates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
', 'UpdateRoleAlias' => 'Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
', 'UpdateScheduledAudit' => 'Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Requires permission to access the UpdateScheduledAudit action.
', 'UpdateSecurityProfile' => 'Updates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
', 'UpdateStream' => 'Updates an existing stream. The stream version will be incremented by one.
Requires permission to access the UpdateStream action.
', 'UpdateThing' => 'Updates the data for a thing.
Requires permission to access the UpdateThing action.
', 'UpdateThingGroup' => 'Update a thing group.
Requires permission to access the UpdateThingGroup action.
', 'UpdateThingGroupsForThing' => 'Updates the groups to which the thing belongs.
Requires permission to access the UpdateThingGroupsForThing action.
', 'UpdateTopicRuleDestination' => 'Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
Requires permission to access the UpdateTopicRuleDestination action.
', 'ValidateSecurityProfileBehaviors' => 'Validates a Device Defender security profile behaviors specification.
Requires permission to access the ValidateSecurityProfileBehaviors action.
', ], 'shapes' => [ 'AbortAction' => [ 'base' => NULL, 'refs' => [ 'AbortCriteria$action' => 'The type of job action to take to initiate the job abort.
', ], ], 'AbortConfig' => [ 'base' => 'The criteria that determine when and how a job abort takes place.
', 'refs' => [ 'CreateJobRequest$abortConfig' => 'Allows you to create the criteria to abort a job.
', 'CreateJobTemplateRequest$abortConfig' => NULL, 'DescribeJobTemplateResponse$abortConfig' => NULL, 'Job$abortConfig' => 'Configuration for criteria to abort the job.
', 'UpdateJobRequest$abortConfig' => 'Allows you to create criteria to abort a job.
', ], ], 'AbortCriteria' => [ 'base' => 'The criteria that determine when and how a job abort takes place.
', 'refs' => [ 'AbortCriteriaList$member' => NULL, ], ], 'AbortCriteriaList' => [ 'base' => NULL, 'refs' => [ 'AbortConfig$criteriaList' => 'The list of criteria that determine when and how to abort the job.
', ], ], 'AbortThresholdPercentage' => [ 'base' => NULL, 'refs' => [ 'AbortCriteria$thresholdPercentage' => 'The minimum percentage of job execution failures that must occur to initiate the job abort.
Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
', ], ], 'AcceptCertificateTransferRequest' => [ 'base' => 'The input for the AcceptCertificateTransfer operation.
', 'refs' => [], ], 'AcmCertificateArn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainConfigurationRequest$validationCertificateArn' => 'The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.
', 'ServerCertificateArns$member' => NULL, 'ServerCertificateSummary$serverCertificateArn' => 'The ARN of the server certificate.
', ], ], '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.
', ], ], 'AddThingToBillingGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddThingToBillingGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AddThingToThingGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddThingToThingGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AddThingsToThingGroupParams' => [ 'base' => 'Parameters used when defining a mitigation action that move a set of things to a thing group.
', 'refs' => [ 'MitigationActionParams$addThingsToThingGroupParams' => 'Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.
', ], ], 'AdditionalMetricsToRetainList' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$additionalMetricsToRetain' => 'Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile\'s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile\'s behaviors, but it is also retained for any metric specified here.
Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile\'s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile\'s behaviors, but it is also retained for any metric specified here.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile\'s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile\'s behaviors, but it is also retained for any metric specified here.
', 'UpdateSecurityProfileRequest$additionalMetricsToRetainV2' => 'A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile\'s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
', 'UpdateSecurityProfileResponse$additionalMetricsToRetainV2' => 'A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile\'s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
', ], ], '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
', ], ], 'AggregationField' => [ 'base' => NULL, 'refs' => [ 'CreateFleetMetricRequest$aggregationField' => 'The field to aggregate.
', 'DescribeFleetMetricResponse$aggregationField' => 'The field to aggregate.
', 'GetBucketsAggregationRequest$aggregationField' => 'The aggregation field.
', 'GetCardinalityRequest$aggregationField' => 'The field to aggregate.
', 'GetPercentilesRequest$aggregationField' => 'The field to aggregate.
', 'GetStatisticsRequest$aggregationField' => 'The aggregation field name.
', 'UpdateFleetMetricRequest$aggregationField' => 'The field to aggregate.
', ], ], 'AggregationType' => [ 'base' => 'The type of aggregation queries.
', 'refs' => [ 'CreateFleetMetricRequest$aggregationType' => 'The type of the aggregation query.
', 'DescribeFleetMetricResponse$aggregationType' => 'The type of the aggregation query.
', 'UpdateFleetMetricRequest$aggregationType' => 'The type of the aggregation query.
', ], ], 'AggregationTypeName' => [ 'base' => NULL, 'refs' => [ 'AggregationType$name' => 'The name of the aggregation type.
', ], ], 'AggregationTypeValue' => [ 'base' => NULL, 'refs' => [ 'AggregationTypeValues$member' => NULL, ], ], 'AggregationTypeValues' => [ 'base' => NULL, 'refs' => [ 'AggregationType$values' => 'A list of the values of aggregation types.
', ], ], '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 Amazon Resource Name (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.)
', ], ], 'AllowAuthorizerOverride' => [ 'base' => NULL, 'refs' => [ 'AuthorizerConfig$allowAuthorizerOverride' => 'A Boolean that specifies whether the domain configuration\'s authorization service can be overridden.
', ], ], '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.
', ], ], 'ApproximateSecondsBeforeTimedOut' => [ 'base' => NULL, 'refs' => [ 'JobExecution$approximateSecondsBeforeTimedOut' => 'The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn\'t provided, ascendingOrder=true.
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.
', ], ], 'AssetId' => [ 'base' => NULL, 'refs' => [ 'PutAssetPropertyValueEntry$assetId' => 'The ID of the IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.
The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.
Optional. A string that contains the boolean value (true or false) of the value entry. Accepts substitution templates.
Optional. A string that contains the double value of the value entry. Accepts substitution templates.
', ], ], 'AssetPropertyEntryId' => [ 'base' => NULL, 'refs' => [ 'PutAssetPropertyValueEntry$entryId' => 'Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
', ], ], 'AssetPropertyId' => [ 'base' => NULL, 'refs' => [ 'PutAssetPropertyValueEntry$propertyId' => 'The ID of the asset\'s property. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.
Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
', ], ], 'AssetPropertyOffsetInNanos' => [ 'base' => NULL, 'refs' => [ 'AssetPropertyTimestamp$offsetInNanos' => 'Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
', ], ], 'AssetPropertyQuality' => [ 'base' => NULL, 'refs' => [ 'AssetPropertyValue$quality' => 'Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD, BAD, or UNCERTAIN.
Optional. The string value of the value entry. Accepts substitution templates.
', ], ], 'AssetPropertyTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'AssetPropertyTimestamp$timeInSeconds' => 'A string that contains the time in seconds since epoch. Accepts substitution templates.
', ], ], 'AssetPropertyTimestamp' => [ 'base' => 'An asset property timestamp entry containing the following information.
', 'refs' => [ 'AssetPropertyValue$timestamp' => 'The asset property value timestamp.
', ], ], 'AssetPropertyValue' => [ 'base' => 'An asset property value entry containing the following information.
', 'refs' => [ 'AssetPropertyValueList$member' => NULL, ], ], 'AssetPropertyValueList' => [ 'base' => NULL, 'refs' => [ 'PutAssetPropertyValueEntry$propertyValues' => 'A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
', ], ], 'AssetPropertyVariant' => [ 'base' => 'Contains an asset property value (of a single type).
', 'refs' => [ 'AssetPropertyValue$value' => 'The value of the asset property.
', ], ], '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.
Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.
You cannot disable a check if it\'s used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.
On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.
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 use UpdateAccountAuditConfiguration to select which checks are enabled.)
The audit check that generated this result.
', 'AuditMitigationActionsTaskStatistics$key' => NULL, 'AuditSuppression$checkName' => NULL, 'CreateAuditSuppressionRequest$checkName' => NULL, 'DeleteAuditSuppressionRequest$checkName' => NULL, 'DescribeAuditSuppressionRequest$checkName' => NULL, 'DescribeAuditSuppressionResponse$checkName' => NULL, 'ListAuditFindingsRequest$checkName' => 'A filter to limit results to the findings for the specified audit check.
', 'ListAuditSuppressionsRequest$checkName' => NULL, 'TargetAuditCheckNames$member' => NULL, 'UpdateAuditSuppressionRequest$checkName' => 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".
', ], ], 'AuditCheckToActionsMapping' => [ 'base' => NULL, 'refs' => [ 'DescribeAuditMitigationActionsTaskResponse$auditCheckToActionsMapping' => 'Specifies the mitigation actions that should be applied to specific audit checks.
', 'StartAuditMitigationActionsTaskRequest$auditCheckToActionsMapping' => 'For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.
', ], ], 'AuditCheckToReasonCodeFilter' => [ 'base' => NULL, 'refs' => [ 'AuditMitigationActionsTaskTarget$auditCheckToReasonCodeFilter' => 'Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.
', ], ], 'AuditDescription' => [ 'base' => NULL, 'refs' => [ 'AuditSuppression$description' => 'The description of the audit suppression.
', 'CreateAuditSuppressionRequest$description' => 'The description of the audit suppression.
', 'DescribeAuditSuppressionResponse$description' => 'The description of the audit suppression.
', 'UpdateAuditSuppressionRequest$description' => 'The description of the audit suppression.
', ], ], '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, 'DescribeAuditFindingResponse$finding' => 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, either DAILY, WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is determined by the system.
How often the scheduled audit takes place, either one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
How often the scheduled audit occurs.
', 'UpdateScheduledAuditRequest$frequency' => 'How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.
', 'refs' => [ 'AuditMitigationActionExecutionMetadataList$member' => NULL, ], ], 'AuditMitigationActionExecutionMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListAuditMitigationActionsExecutionsResponse$actionsExecutions' => 'A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.
', ], ], 'AuditMitigationActionsExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'AuditMitigationActionExecutionMetadata$status' => 'The current status of the task being executed.
', 'ListAuditMitigationActionsExecutionsRequest$actionStatus' => 'Specify this filter to limit results to those with a specific status.
', ], ], 'AuditMitigationActionsTaskMetadata' => [ 'base' => 'Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks.
The collection of audit mitigation tasks that matched the filter criteria.
', ], ], 'AuditMitigationActionsTaskStatistics' => [ 'base' => NULL, 'refs' => [ 'DescribeAuditMitigationActionsTaskResponse$taskStatistics' => 'Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.
', ], ], 'AuditMitigationActionsTaskStatus' => [ 'base' => NULL, 'refs' => [ 'AuditMitigationActionsTaskMetadata$taskStatus' => 'The current state of the audit mitigation actions task.
', 'DescribeAuditMitigationActionsTaskResponse$taskStatus' => 'The current status of the task.
', 'ListAuditMitigationActionsTasksRequest$taskStatus' => 'Specify this filter to limit results to tasks that are in a specific state.
', ], ], 'AuditMitigationActionsTaskTarget' => [ 'base' => 'Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.
', 'refs' => [ 'DescribeAuditMitigationActionsTaskResponse$target' => 'Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.
', 'StartAuditMitigationActionsTaskRequest$target' => 'Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.
', ], ], '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, ], ], 'AuditSuppression' => [ 'base' => 'Filters out specific findings of a Device Defender audit.
', 'refs' => [ 'AuditSuppressionList$member' => NULL, ], ], 'AuditSuppressionList' => [ 'base' => NULL, 'refs' => [ 'ListAuditSuppressionsResponse$suppressions' => 'List of audit suppressions.
', ], ], 'AuditTaskId' => [ 'base' => NULL, 'refs' => [ 'AuditFinding$taskId' => 'The ID of the audit that generated this result (finding).
', 'AuditMitigationActionsTaskTarget$auditTaskId' => 'If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.
', '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.
', 'ListAuditMitigationActionsTasksRequest$auditTaskId' => 'Specify this filter to limit results to tasks that were applied to results for a specific audit.
', '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.
', ], ], 'AuthorizerConfig' => [ 'base' => 'An object that specifies the authorization service for a domain.
', 'refs' => [ 'CreateDomainConfigurationRequest$authorizerConfig' => 'An object that specifies the authorization service for a domain.
', 'DescribeDomainConfigurationResponse$authorizerConfig' => 'An object that specifies the authorization service for a domain.
', 'UpdateDomainConfigurationRequest$authorizerConfig' => 'An object that specifies the authorization service for a domain.
', ], ], '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' => [ 'AuthorizerConfig$defaultAuthorizerName' => 'The name of the authorization service for a domain configuration.
', '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".
', ], ], 'Average' => [ 'base' => NULL, 'refs' => [ 'Statistics$average' => 'The average of the aggregated field values.
', ], ], 'AwsAccountId' => [ 'base' => NULL, 'refs' => [ 'CACertificateDescription$ownedBy' => 'The owner of the CA certificate.
', 'CertificateDescription$ownedBy' => 'The ID of the Amazon Web Services account that owns the certificate.
', 'CertificateDescription$previousOwnedBy' => 'The ID of the Amazon Web Services account of the previous owner of the certificate.
', 'OutgoingCertificate$transferredTo' => 'The Amazon Web Services 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 Amazon Web Services account.
', ], ], 'AwsArn' => [ 'base' => NULL, 'refs' => [ 'CloudwatchAlarmAction$roleArn' => 'The IAM role that allows access to the CloudWatch alarm.
', 'CloudwatchLogsAction$roleArn' => 'The IAM role that allows access to the CloudWatch log.
', 'CloudwatchMetricAction$roleArn' => 'The IAM role that allows access to the CloudWatch metric.
', 'DeleteTopicRuleDestinationRequest$arn' => 'The ARN of the topic rule destination to delete.
', '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 OpenSearch.
', '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.
', 'GetTopicRuleDestinationRequest$arn' => 'The ARN of the topic rule destination.
', 'GetV2LoggingOptionsResponse$roleArn' => 'The IAM role ARN 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).
', 'IotEventsAction$roleArn' => 'The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").
', 'IotSiteWiseAction$roleArn' => 'The ARN of the role that grants IoT permission to send an asset property value to IoT SiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue"). The trust policy can restrict access to specific asset hierarchy paths.
The ARN of Kafka action\'s VPC TopicRuleDestination.
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
', 'LocationAction$roleArn' => 'The IAM role that grants permission to write to the Amazon Location resource.
', 'LoggingOptionsPayload$roleArn' => 'The ARN of the IAM role that grants access.
', 'OpenSearchAction$roleArn' => 'The IAM role ARN that has access to OpenSearch.
', '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.
', 'SigV4Authorization$roleArn' => 'The ARN of the signing role.
', '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").
', 'TimestreamAction$roleArn' => 'The ARN of the role that grants permission to write to the Amazon Timestream database table.
', 'TopicRuleDestination$arn' => 'The topic rule destination URL.
', 'TopicRuleDestinationSummary$arn' => 'The topic rule destination ARN.
', 'UpdateTopicRuleDestinationRequest$arn' => 'The ARN of the topic rule destination.
', 'VpcDestinationConfiguration$roleArn' => 'The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
', 'VpcDestinationProperties$roleArn' => 'The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
', 'VpcDestinationSummary$roleArn' => 'The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
', ], ], 'AwsIotJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateOTAUpdateResponse$awsIotJobArn' => 'The IoT job ARN associated with the OTA update.
', 'OTAUpdateInfo$awsIotJobArn' => 'The IoT job ARN associated with the OTA update.
', ], ], 'AwsIotJobId' => [ 'base' => NULL, 'refs' => [ 'CreateOTAUpdateResponse$awsIotJobId' => 'The IoT job ID associated with the OTA update.
', 'OTAUpdateInfo$awsIotJobId' => 'The 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.
', ], ], 'AwsJobAbortConfig' => [ 'base' => 'The criteria that determine when and how a job abort takes place.
', 'refs' => [ 'CreateOTAUpdateRequest$awsJobAbortConfig' => 'The criteria that determine when and how a job abort takes place.
', ], ], 'AwsJobAbortCriteria' => [ 'base' => 'The criteria that determine when and how a job abort takes place.
', 'refs' => [ 'AwsJobAbortCriteriaList$member' => NULL, ], ], 'AwsJobAbortCriteriaAbortAction' => [ 'base' => NULL, 'refs' => [ 'AwsJobAbortCriteria$action' => 'The type of job action to take to initiate the job abort.
', ], ], 'AwsJobAbortCriteriaAbortThresholdPercentage' => [ 'base' => NULL, 'refs' => [ 'AwsJobAbortCriteria$thresholdPercentage' => 'The minimum percentage of job execution failures that must occur to initiate the job abort.
Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
', ], ], 'AwsJobAbortCriteriaFailureType' => [ 'base' => NULL, 'refs' => [ 'AwsJobAbortCriteria$failureType' => 'The type of job execution failures that can initiate a job abort.
', ], ], 'AwsJobAbortCriteriaList' => [ 'base' => NULL, 'refs' => [ 'AwsJobAbortConfig$abortCriteriaList' => 'The list of criteria that determine when and how to abort the job.
', ], ], 'AwsJobAbortCriteriaMinimumNumberOfExecutedThings' => [ 'base' => NULL, 'refs' => [ 'AwsJobAbortCriteria$minNumberOfExecutedThings' => 'The minimum number of things which must receive job execution notifications before the job can be aborted.
', ], ], '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.
', ], ], 'AwsJobExponentialRolloutRate' => [ 'base' => 'The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.
', 'refs' => [ 'AwsJobExecutionsRolloutConfig$exponentialRate' => 'The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.
', ], ], 'AwsJobPresignedUrlConfig' => [ 'base' => 'Configuration information for pre-signed URLs. Valid when protocols contains HTTP.
Configuration information for pre-signed URLs.
', 'OTAUpdateInfo$awsJobPresignedUrlConfig' => 'Configuration information for pre-signed URLs. Valid when protocols contains HTTP.
The criteria to initiate the increase in rate of rollout for a job.
', 'refs' => [ 'AwsJobExponentialRolloutRate$rateIncreaseCriteria' => 'The criteria to initiate the increase in rate of rollout for a job.
Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).
', ], ], 'AwsJobRateIncreaseCriteriaNumberOfThings' => [ 'base' => NULL, 'refs' => [ 'AwsJobRateIncreaseCriteria$numberOfNotifiedThings' => 'When this number of things have been notified, it will initiate an increase in the rollout rate.
', 'AwsJobRateIncreaseCriteria$numberOfSucceededThings' => 'When this number of things have succeeded in their job execution, it will initiate an increase in the rollout rate.
', ], ], 'AwsJobRolloutIncrementFactor' => [ 'base' => NULL, 'refs' => [ 'AwsJobExponentialRolloutRate$incrementFactor' => 'The rate of increase for a job rollout. The number of things notified is multiplied by this factor.
', ], ], 'AwsJobRolloutRatePerMinute' => [ 'base' => NULL, 'refs' => [ 'AwsJobExponentialRolloutRate$baseRatePerMinute' => 'The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout.
', ], ], 'AwsJobTimeoutConfig' => [ 'base' => 'Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can\'t be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
Indicates whether batches of log records will be extracted and uploaded into CloudWatch. Values include true or false (default).
Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false.
When batchMode is true and the rule\'s SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch request. The resulting array can\'t have more than 500 records.
Whether to process the action as a batch. The default value is false.
When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the IoT Analytics channel. The resulting array can\'t have more than 100 messages.
Whether to process the event actions as a batch. The default value is false.
When batchMode is true, you can\'t specify a messageId.
When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it\'s sent to IoT Events by calling BatchPutMessage . The resulting array can\'t have more than 10 messages.
A Device Defender security profile behavior.
', 'refs' => [ 'ActiveViolation$behavior' => 'The behavior that is being violated.
', 'Behaviors$member' => NULL, 'ViolationEvent$behavior' => 'The behavior that 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.
The criteria for a behavior.
', 'ListViolationEventsRequest$behaviorCriteriaType' => 'The criteria for a behavior.
', ], ], 'BehaviorMetric' => [ 'base' => NULL, 'refs' => [ 'AdditionalMetricsToRetainList$member' => NULL, 'Behavior$metric' => 'What is measured by the behavior.
', 'ListMetricValuesRequest$metricName' => 'The name of the security profile metric for which values are returned.
', 'MetricToRetain$metric' => 'What is measured by the behavior.
', ], ], 'BehaviorModelTrainingSummaries' => [ 'base' => NULL, 'refs' => [ 'GetBehaviorModelTrainingSummariesResponse$summaries' => 'A list of all ML Detect behaviors and their model status for a given Security Profile.
', ], ], 'BehaviorModelTrainingSummary' => [ 'base' => 'The summary of an ML Detect behavior model.
', 'refs' => [ 'BehaviorModelTrainingSummaries$member' => NULL, ], ], 'BehaviorName' => [ 'base' => NULL, 'refs' => [ 'Behavior$name' => 'The name you\'ve given to the behavior.
', 'BehaviorModelTrainingSummary$behaviorName' => 'The name of the behavior.
', 'DetectMitigationActionsTaskTarget$behaviorName' => 'The name of 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.
', ], ], 'BillingGroupArn' => [ 'base' => NULL, 'refs' => [ 'AddThingToBillingGroupRequest$billingGroupArn' => 'The ARN of the billing group.
', 'CreateBillingGroupResponse$billingGroupArn' => 'The ARN of the billing group.
', 'DescribeBillingGroupResponse$billingGroupArn' => 'The ARN of the billing group.
', 'RemoveThingFromBillingGroupRequest$billingGroupArn' => 'The ARN of the billing group.
', ], ], 'BillingGroupDescription' => [ 'base' => NULL, 'refs' => [ 'BillingGroupProperties$billingGroupDescription' => 'The description of the billing group.
', ], ], 'BillingGroupId' => [ 'base' => NULL, 'refs' => [ 'CreateBillingGroupResponse$billingGroupId' => 'The ID of the billing group.
', 'DescribeBillingGroupResponse$billingGroupId' => 'The ID of the billing group.
', ], ], 'BillingGroupMetadata' => [ 'base' => 'Additional information about the billing group.
', 'refs' => [ 'DescribeBillingGroupResponse$billingGroupMetadata' => 'Additional information about the billing group.
', ], ], 'BillingGroupName' => [ 'base' => NULL, 'refs' => [ 'AddThingToBillingGroupRequest$billingGroupName' => 'The name of the billing group.
This call is asynchronous. It might take several seconds for the detachment to propagate.
The name you wish to give to the billing group.
', 'CreateBillingGroupResponse$billingGroupName' => 'The name you gave to the billing group.
', 'CreateThingRequest$billingGroupName' => 'The name of the billing group the thing will be added to.
', 'DeleteBillingGroupRequest$billingGroupName' => 'The name of the billing group.
', 'DescribeBillingGroupRequest$billingGroupName' => 'The name of the billing group.
', 'DescribeBillingGroupResponse$billingGroupName' => 'The name of the billing group.
', 'DescribeThingResponse$billingGroupName' => 'The name of the billing group the thing belongs to.
', 'ListBillingGroupsRequest$namePrefixFilter' => 'Limit the results to billing groups whose names have the given prefix.
', 'ListThingsInBillingGroupRequest$billingGroupName' => 'The name of the billing group.
', 'RemoveThingFromBillingGroupRequest$billingGroupName' => 'The name of the billing group.
', 'UpdateBillingGroupRequest$billingGroupName' => 'The name of the billing group.
', ], ], 'BillingGroupNameAndArnList' => [ 'base' => NULL, 'refs' => [ 'ListBillingGroupsResponse$billingGroups' => 'The list of billing groups.
', ], ], 'BillingGroupProperties' => [ 'base' => 'The properties of a billing group.
', 'refs' => [ 'CreateBillingGroupRequest$billingGroupProperties' => 'The properties of the billing group.
', 'DescribeBillingGroupResponse$billingGroupProperties' => 'The properties of the billing group.
', 'UpdateBillingGroupRequest$billingGroupProperties' => 'The properties of the billing group.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ThingConnectivity$connected' => 'True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.
', 'ThingTypeMetadata$deprecated' => 'Whether the thing type is deprecated. If true, no new things could be associated with this type.
', ], ], 'BooleanKey' => [ 'base' => NULL, 'refs' => [ 'AuthorizerDescription$signingDisabled' => 'Specifies whether IoT validates the token signature in an authorization request.
', 'CreateAuthorizerRequest$signingDisabled' => 'Specifies whether IoT validates the token signature in an authorization request.
', ], ], 'BooleanWrapperObject' => [ 'base' => NULL, 'refs' => [ 'Job$isConcurrent' => 'Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.
', 'JobSummary$isConcurrent' => 'Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.
', ], ], 'Bucket' => [ 'base' => 'A count of documents that meets a specific aggregation criteria.
', 'refs' => [ 'Buckets$member' => NULL, ], ], 'BucketKeyValue' => [ 'base' => NULL, 'refs' => [ 'Bucket$keyValue' => 'The value counted for the particular bucket.
', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'S3Action$bucketName' => 'The Amazon S3 bucket.
', ], ], 'Buckets' => [ 'base' => NULL, 'refs' => [ 'GetBucketsAggregationResponse$buckets' => 'The main part of the response with a list of buckets. Each bucket contains a keyValue and a count.
keyValue: The aggregation field value counted for the particular bucket.
count: The number of documents that have that value.
The type of bucketed aggregation performed.
', 'refs' => [ 'GetBucketsAggregationRequest$bucketsAggregationType' => 'The basic control of the response shape and the bucket aggregation type to perform.
', ], ], '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.
', ], ], 'CACertificateUpdateAction' => [ 'base' => NULL, 'refs' => [ 'UpdateCACertificateParams$action' => 'The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE.
The CA certificates registered in your Amazon Web Services account.
', ], ], 'CancelAuditMitigationActionsTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelAuditMitigationActionsTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelAuditTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelAuditTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelCertificateTransferRequest' => [ 'base' => 'The input for the CancelCertificateTransfer operation.
', 'refs' => [], ], 'CancelDetectMitigationActionsTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDetectMitigationActionsTaskResponse' => [ 'base' => NULL, '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.
', ], ], 'CanceledFindingsCount' => [ 'base' => NULL, 'refs' => [ 'TaskStatisticsForAuditCheck$canceledFindingsCount' => 'The number of findings to which the mitigation action task was canceled when applied.
', ], ], '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.
', 'RegisterCertificateWithoutCAResponse$certificateArn' => 'The Amazon Resource Name (ARN) of the registered certificate.
', 'ResourceIdentifier$deviceCertificateArn' => 'The ARN of the identified device certificate.
', '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. IoT issues a default subject name for the certificate (for example, IoT Certificate).
', 'CreateProvisioningClaimResponse$certificateId' => 'The ID of the 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.
', 'RegisterCertificateWithoutCAResponse$certificateId' => 'The ID of the registered certificate. (The last part of the certificate ARN contains the certificate ID.
', '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.)
', ], ], 'CertificateMode' => [ 'base' => NULL, 'refs' => [ 'CACertificateDescription$certificateMode' => 'The mode of the CA.
All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode.
', 'Certificate$certificateMode' => 'The mode of the certificate.
DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren\'t required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.
SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.
The mode of the certificate.
DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren\'t required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.
SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.
For more information about the value for SNI extension, see Transport security in IoT.
', 'RegisterCACertificateRequest$certificateMode' => 'Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.
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.
', 'CreateProvisioningClaimResponse$certificatePem' => 'The provisioning claim certificate.
', 'RegisterCACertificateRequest$caCertificate' => 'The CA certificate.
', 'RegisterCACertificateRequest$verificationCertificate' => 'The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.
The certificate data, in PEM format.
', 'RegisterCertificateRequest$caCertificatePem' => 'The CA certificate used to sign the device certificate being registered.
', 'RegisterCertificateWithoutCARequest$certificatePem' => 'The certificate data, in PEM format.
', 'RegisterThingResponse$certificatePem' => 'The certificate data, in PEM format.
', ], ], '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. Valid values that you can use include ACTIVE, INACTIVE, and REVOKED.
The status of the register certificate request.
', 'UpdateCertificateRequest$newStatus' => 'The new status.
Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by IoT. They are 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 is complete 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 MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing\'s registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.
This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
', 'ResourceIdentifier$clientId' => 'The client ID.
', 'TestAuthorizationRequest$clientId' => 'The MQTT client ID.
', ], ], 'ClientProperties' => [ 'base' => NULL, 'refs' => [ 'KafkaAction$clientProperties' => 'Properties of the Apache Kafka producer client.
', ], ], 'ClientRequestToken' => [ 'base' => NULL, 'refs' => [ 'CreateAuditSuppressionRequest$clientRequestToken' => 'Each audit supression must have a unique client request token. If you try to create a new audit suppression with the same token as one that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
', 'CreateCustomMetricRequest$clientRequestToken' => 'Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
', 'CreateDimensionRequest$clientRequestToken' => 'Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
', 'StartAuditMitigationActionsTaskRequest$clientRequestToken' => 'Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.
', 'StartDetectMitigationActionsTaskRequest$clientRequestToken' => 'Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$clientToken' => 'A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don\'t reuse this client token if a new idempotent request is required.
', 'CreatePackageVersionRequest$clientToken' => 'A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don\'t reuse this client token if a new idempotent request is required.
', 'DeletePackageRequest$clientToken' => 'A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don\'t reuse this client token if a new idempotent request is required.
', 'DeletePackageVersionRequest$clientToken' => 'A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don\'t reuse this client token if a new idempotent request is required.
', 'UpdatePackageConfigurationRequest$clientToken' => 'A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don\'t reuse this client token if a new idempotent request is required.
', 'UpdatePackageRequest$clientToken' => 'A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don\'t reuse this client token if a new idempotent request is required.
', 'UpdatePackageVersionRequest$clientToken' => 'A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don\'t reuse this client token if a new idempotent request is required.
', ], ], 'CloudwatchAlarmAction' => [ 'base' => 'Describes an action that updates a CloudWatch alarm.
', 'refs' => [ 'Action$cloudwatchAlarm' => 'Change the state of a CloudWatch alarm.
', ], ], 'CloudwatchLogsAction' => [ 'base' => 'Describes an action that sends data to CloudWatch Logs.
', 'refs' => [ 'Action$cloudwatchLogs' => 'Send data to CloudWatch Logs.
', ], ], '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 Amazon 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 (containing a value or statisticalThreshold). Valid operators include:
string-list: in-set and not-in-set
number-list: in-set and not-in-set
ip-address-list: in-cidr-set and not-in-cidr-set
number: less-than, less-than-equals, greater-than, and greater-than-equals
The number of checks that found compliant resources.
', ], ], 'ConfidenceLevel' => [ 'base' => NULL, 'refs' => [ 'MachineLearningDetectionConfig$confidenceLevel' => ' The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
Configuration.
', 'refs' => [ 'EventConfigurations$value' => NULL, ], ], 'ConfirmTopicRuleDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmTopicRuleDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmationToken' => [ 'base' => NULL, 'refs' => [ 'ConfirmTopicRuleDestinationRequest$confirmationToken' => 'The token used to confirm ownership or access to the topic rule confirmation URL.
', ], ], 'ConflictException' => [ 'base' => 'A resource with the same name already exists.
', 'refs' => [], ], 'ConflictingResourceUpdateException' => [ 'base' => 'A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.
', 'refs' => [], ], 'ConnectivityTimestamp' => [ 'base' => NULL, 'refs' => [ 'ThingConnectivity$timestamp' => 'The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for approximately an hour, the time value might be missing.
', ], ], 'ConsecutiveDatapointsToAlarm' => [ 'base' => NULL, 'refs' => [ 'BehaviorCriteria$consecutiveDatapointsToAlarm' => 'If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
', ], ], 'ConsecutiveDatapointsToClear' => [ 'base' => NULL, 'refs' => [ 'BehaviorCriteria$consecutiveDatapointsToClear' => 'If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'MqttHeaders$contentType' => 'A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type from the MQTT Version 5.0 specification.
Supports substitution templates.
', ], ], 'CorrelationData' => [ 'base' => NULL, 'refs' => [ 'MqttHeaders$correlationData' => 'The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it\'s received.
For more information, see Correlation Data from the MQTT Version 5.0 specification.
This binary data must be based64-encoded.
Supports substitution templates.
', ], ], 'Count' => [ 'base' => NULL, 'refs' => [ 'Bucket$count' => 'The number of documents that have the value counted for the particular bucket.
', 'DescribeThingRegistrationTaskResponse$successCount' => 'The number of things successfully provisioned.
', 'DescribeThingRegistrationTaskResponse$failureCount' => 'The number of things that failed to be provisioned.
', 'GetBucketsAggregationResponse$totalCount' => 'The total number of things that fit the query string criteria.
', 'GetCardinalityResponse$cardinality' => 'The approximate count of unique values that match the query.
', 'Statistics$count' => 'The count of things that match the query string criteria and contain a valid aggregation field value.
', ], ], 'CreateAuditSuppressionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAuditSuppressionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAuthorizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAuthorizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateBillingGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBillingGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCertificateFromCsrRequest' => [ 'base' => 'The input for the CreateCertificateFromCsr operation.
', 'refs' => [], ], 'CreateCertificateFromCsrResponse' => [ 'base' => 'The output from the CreateCertificateFromCsr operation.
', 'refs' => [], ], 'CreateCustomMetricRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCustomMetricResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDimensionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDimensionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDynamicThingGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDynamicThingGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFleetMetricRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFleetMetricResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateJobTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateJobTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateKeysAndCertificateRequest' => [ 'base' => 'The input for the CreateKeysAndCertificate operation.
Requires permission to access the CreateKeysAndCertificateRequest action.
', 'refs' => [], ], 'CreateKeysAndCertificateResponse' => [ 'base' => 'The output of the CreateKeysAndCertificate operation.
', 'refs' => [], ], 'CreateMitigationActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMitigationActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateOTAUpdateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateOTAUpdateResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePackageResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePackageVersionResponse' => [ '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' => [], ], 'CreateProvisioningClaimRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisioningClaimResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisioningTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisioningTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisioningTemplateVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisioningTemplateVersionResponse' => [ 'base' => NULL, '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' => [], ], 'CreateTopicRuleDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicRuleDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicRuleRequest' => [ 'base' => 'The input for the CreateTopicRule operation.
', 'refs' => [], ], 'CreatedAtDate' => [ 'base' => NULL, 'refs' => [ 'TopicRule$createdAt' => 'The date and time the rule was created.
', 'TopicRuleDestination$createdAt' => 'The date and time when the topic rule destination was created.
', 'TopicRuleDestinationSummary$createdAt' => 'The date and time when the topic rule destination was created.
', 'TopicRuleListItem$createdAt' => 'The date and time the rule was created.
', ], ], 'CreationDate' => [ 'base' => NULL, 'refs' => [ 'BillingGroupMetadata$creationDate' => 'The date the billing group was created.
', 'DescribeEventConfigurationsResponse$creationDate' => 'The creation date of the event configuration.
', 'DescribeFleetMetricResponse$creationDate' => 'The date when the fleet metric is created.
', 'DescribeThingRegistrationTaskResponse$creationDate' => 'The task creation date.
', 'GetPackageResponse$creationDate' => 'The date the package was created.
', 'GetPackageVersionResponse$creationDate' => 'The date when the package version was created.
', 'PackageSummary$creationDate' => 'The date that the package was created.
', 'PackageVersionSummary$creationDate' => 'The date that the package version was created.
', '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. The default value is 3,600 seconds.
This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.
', 'RoleAliasDescription$credentialDurationSeconds' => 'The number of seconds for which the credential is valid.
', 'UpdateRoleAliasRequest$credentialDurationSeconds' => 'The number of seconds the credential will be valid.
This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.
', ], ], 'CronExpression' => [ 'base' => NULL, 'refs' => [ 'MaintenanceWindow$startTime' => 'Displays the start time of the next maintenance window.
', ], ], 'CustomCodeSigning' => [ 'base' => 'Describes a custom method used to code sign a file.
', 'refs' => [ 'CodeSigning$customCodeSigning' => 'A custom method for code signing a file.
', ], ], 'CustomMetricArn' => [ 'base' => NULL, 'refs' => [ 'CreateCustomMetricResponse$metricArn' => ' The Amazon Resource Number (ARN) of the custom metric. For example, arn:aws-partition:iot:region:accountId:custommetric/metricName
The Amazon Resource Number (ARN) of the custom metric.
', 'UpdateCustomMetricResponse$metricArn' => 'The Amazon Resource Number (ARN) of the custom metric.
', ], ], 'CustomMetricDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateCustomMetricRequest$displayName' => 'The friendly name in the console for the custom metric. This name doesn\'t have to be unique. Don\'t use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
', 'DescribeCustomMetricResponse$displayName' => 'Field represents a friendly name in the console for the custom metric; doesn\'t have to be unique. Don\'t use this name as the metric identifier in the device metric report. Can be updated.
', 'UpdateCustomMetricRequest$displayName' => 'Field represents a friendly name in the console for the custom metric, it doesn\'t have to be unique. Don\'t use this name as the metric identifier in the device metric report. Can be updated.
', 'UpdateCustomMetricResponse$displayName' => 'A friendly name in the console for the custom metric
', ], ], 'CustomMetricType' => [ 'base' => NULL, 'refs' => [ 'CreateCustomMetricRequest$metricType' => 'The type of the custom metric.
The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
The type of the custom metric.
The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.
The type of the custom metric.
The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.
The customer version of the CA certificate.
', 'CertificateDescription$customerVersion' => 'The customer version of the certificate.
', ], ], 'DataCollectionPercentage' => [ 'base' => NULL, 'refs' => [ 'BehaviorModelTrainingSummary$datapointsCollectionPercentage' => 'The percentage of datapoints collected.
', ], ], '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.
', 'CreateProvisioningClaimResponse$expiration' => 'The provisioning claim expiration time.
', 'DescribeDomainConfigurationResponse$lastStatusChangeDate' => 'The date and time the domain configuration\'s status was last changed.
', 'DescribeJobTemplateResponse$createdAt' => 'The time, in seconds since the epoch, when the job template was created.
', 'DescribeProvisioningTemplateResponse$creationDate' => 'The date when the provisioning template was created.
', 'DescribeProvisioningTemplateResponse$lastModifiedDate' => 'The date when the provisioning template was last modified.
', 'DescribeProvisioningTemplateVersionResponse$creationDate' => 'The date when the provisioning template version was created.
', 'GetPolicyResponse$creationDate' => 'The date the policy was created.
', 'GetPolicyResponse$lastModifiedDate' => 'The date the policy was last modified.
', 'GetPolicyVersionResponse$creationDate' => 'The date the policy was created.
', 'GetPolicyVersionResponse$lastModifiedDate' => 'The date the policy was last modified.
', 'Job$createdAt' => 'The time, in seconds since the epoch, when the job was created.
', 'Job$lastUpdatedAt' => 'The time, in seconds since the epoch, when the job was last updated.
', 'Job$completedAt' => 'The time, in seconds since the epoch, when the job was completed.
', 'JobExecution$queuedAt' => 'The time, in seconds since the epoch, when the job execution was queued.
', 'JobExecution$startedAt' => 'The time, in seconds since the epoch, when the job execution started.
', 'JobExecution$lastUpdatedAt' => 'The time, in seconds since the epoch, when the job execution was last updated.
', 'JobExecutionSummary$queuedAt' => 'The time, in seconds since the epoch, when the job execution was queued.
', 'JobExecutionSummary$startedAt' => 'The time, in seconds since the epoch, when the job execution started.
', 'JobExecutionSummary$lastUpdatedAt' => 'The time, in seconds since the epoch, when the job execution was last updated.
', 'JobSummary$createdAt' => 'The time, in seconds since the epoch, when the job was created.
', 'JobSummary$lastUpdatedAt' => 'The time, in seconds since the epoch, when the job was last updated.
', 'JobSummary$completedAt' => 'The time, in seconds since the epoch, when the job completed.
', 'JobTemplateSummary$createdAt' => 'The time, in seconds since the epoch, when the job template was created.
', '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.
', 'ProvisioningTemplateSummary$creationDate' => 'The date when the provisioning template summary was created.
', 'ProvisioningTemplateSummary$lastModifiedDate' => 'The date when the provisioning template summary was last modified.
', 'ProvisioningTemplateVersionSummary$creationDate' => 'The date when the provisioning template version 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. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to MONTHLY. If days 29 to 31 are specified, and the month doesn\'t have that many days, the audit takes place on the LAST day of the month.
The day of the month on which the scheduled audit takes place. This is 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.
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. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
The day of the week on which the scheduled audit takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.
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. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.
If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
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' => [], ], 'DeleteCustomMetricRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomMetricResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDimensionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDimensionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDynamicThingGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDynamicThingGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFleetMetricRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMitigationActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMitigationActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOTAUpdateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOTAUpdateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePolicyRequest' => [ 'base' => 'The input for the DeletePolicy operation.
', 'refs' => [], ], 'DeletePolicyVersionRequest' => [ 'base' => 'The input for the DeletePolicyVersion operation.
', 'refs' => [], ], 'DeleteProvisioningTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisioningTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisioningTemplateVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisioningTemplateVersionResponse' => [ 'base' => NULL, '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' => 'When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.
', ], ], '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' => [], ], 'DeleteTopicRuleDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicRuleDestinationResponse' => [ 'base' => NULL, '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' => [], ], 'DescribeAuditFindingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAuditFindingResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAuditMitigationActionsTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAuditMitigationActionsTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAuditSuppressionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAuditSuppressionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAuditTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAuditTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAuthorizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAuthorizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBillingGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBillingGroupResponse' => [ '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' => [], ], 'DescribeCustomMetricRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCustomMetricResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDefaultAuthorizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDefaultAuthorizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDetectMitigationActionsTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDetectMitigationActionsTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDimensionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDimensionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainConfigurationResponse' => [ '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' => [], ], 'DescribeFleetMetricRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFleetMetricResponse' => [ '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' => [], ], 'DescribeJobTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeJobTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedJobTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedJobTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMitigationActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMitigationActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningTemplateVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningTemplateVersionResponse' => [ '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.
', ], ], 'DestinationPackageVersions' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$destinationPackageVersions' => 'The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single string. Up to five strings are allowed.
', 'CreateJobTemplateRequest$destinationPackageVersions' => 'The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single string. Up to five strings are allowed.
', 'DescribeJobTemplateResponse$destinationPackageVersions' => 'The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single string. Up to five strings are allowed.
', 'Job$destinationPackageVersions' => 'The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single string. Up to five strings are allowed.
', ], ], '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, ], ], 'DetectMitigationActionExecution' => [ 'base' => 'Describes which mitigation actions should be executed.
', 'refs' => [ 'DetectMitigationActionExecutionList$member' => NULL, ], ], 'DetectMitigationActionExecutionErrorCode' => [ 'base' => NULL, 'refs' => [ 'DetectMitigationActionExecution$errorCode' => 'The error code of a mitigation action.
', ], ], 'DetectMitigationActionExecutionList' => [ 'base' => NULL, 'refs' => [ 'ListDetectMitigationActionsExecutionsResponse$actionsExecutions' => 'List of actions executions.
', ], ], 'DetectMitigationActionExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DetectMitigationActionExecution$status' => 'The status of a mitigation action.
', ], ], 'DetectMitigationActionsTaskStatistics' => [ 'base' => 'The statistics of a mitigation action task.
', 'refs' => [ 'DetectMitigationActionsTaskSummary$taskStatistics' => 'The statistics of a mitigation action task.
', ], ], 'DetectMitigationActionsTaskStatus' => [ 'base' => NULL, 'refs' => [ 'DetectMitigationActionsTaskSummary$taskStatus' => 'The status of the task.
', ], ], 'DetectMitigationActionsTaskSummary' => [ 'base' => 'The summary of the mitigation action tasks.
', 'refs' => [ 'DescribeDetectMitigationActionsTaskResponse$taskSummary' => 'The description of a task.
', 'DetectMitigationActionsTaskSummaryList$member' => NULL, ], ], 'DetectMitigationActionsTaskSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDetectMitigationActionsTasksResponse$tasks' => 'The collection of ML Detect mitigation tasks that matched the filter criteria.
', ], ], 'DetectMitigationActionsTaskTarget' => [ 'base' => 'The target of a mitigation action task.
', 'refs' => [ 'DetectMitigationActionsTaskSummary$target' => 'Specifies the ML Detect findings to which the mitigation actions are applied.
', 'StartDetectMitigationActionsTaskRequest$target' => 'Specifies the ML Detect findings to which the mitigation actions are applied.
', ], ], 'DetectMitigationActionsToExecuteList' => [ 'base' => NULL, 'refs' => [ 'StartDetectMitigationActionsTaskRequest$actions' => 'The actions to be performed when a device has unexpected behavior.
', ], ], 'DeviceCertificateUpdateAction' => [ 'base' => NULL, 'refs' => [ 'UpdateDeviceCertificateParams$action' => 'The action that you want to apply to the device certificate. The only supported value is DEACTIVATE.
Device Defender indexing mode. Valid values are:
VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.
OFF - Device Defender indexing is disabled.
For more information about Device Defender violations, see Device Defender Detect.
', ], ], 'DeviceDefenderThingName' => [ 'base' => NULL, 'refs' => [ 'ActiveViolation$thingName' => 'The name of the thing responsible for the active violation.
', 'DetectMitigationActionExecution$thingName' => 'The name of the thing.
', 'ListActiveViolationsRequest$thingName' => 'The name of the thing whose active violations are listed.
', 'ListDetectMitigationActionsExecutionsRequest$thingName' => 'The name of the thing whose mitigation actions are listed.
', 'ListMetricValuesRequest$thingName' => 'The name of the thing for which security profile metric values are returned.
', 'ListViolationEventsRequest$thingName' => 'A filter to limit results to those alerts caused by the specified thing.
', 'ViolationEvent$thingName' => 'The name of the thing responsible for the violation event.
', ], ], 'DimensionArn' => [ 'base' => NULL, 'refs' => [ 'CreateDimensionResponse$arn' => 'The Amazon Resource Name (ARN) of the created dimension.
', 'DescribeDimensionResponse$arn' => 'The Amazon Resource Name (ARN) for the dimension.
', 'UpdateDimensionResponse$arn' => 'The Amazon Resource Name (ARN)of the created dimension.
', ], ], 'DimensionName' => [ 'base' => NULL, 'refs' => [ 'CreateDimensionRequest$name' => 'A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
', 'CreateDimensionResponse$name' => 'A unique identifier for the dimension.
', 'DeleteDimensionRequest$name' => 'The unique identifier for the dimension that you want to delete.
', 'DescribeDimensionRequest$name' => 'The unique identifier for the dimension.
', 'DescribeDimensionResponse$name' => 'The unique identifier for the dimension.
', 'DimensionNames$member' => NULL, 'ListMetricValuesRequest$dimensionName' => 'The dimension name.
', 'ListSecurityProfilesRequest$dimensionName' => 'A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName
A unique identifier for the dimension.
', 'UpdateDimensionRequest$name' => 'A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
', 'UpdateDimensionResponse$name' => 'A unique identifier for the dimension.
', ], ], 'DimensionNames' => [ 'base' => NULL, 'refs' => [ 'ListDimensionsResponse$dimensionNames' => 'A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.
Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.
', 'UpdateDimensionRequest$stringValues' => 'Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.
', ], ], 'DimensionType' => [ 'base' => NULL, 'refs' => [ 'CreateDimensionRequest$type' => 'Specifies the type of dimension. Supported types: TOPIC_FILTER.
The type of the dimension.
', 'UpdateDimensionResponse$type' => 'The type of the dimension.
', ], ], 'DimensionValueOperator' => [ 'base' => NULL, 'refs' => [ 'ListMetricValuesRequest$dimensionValueOperator' => 'The dimension value operator.
', 'MetricDimension$operator' => 'Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn\'t match any of the topic filters. The operator is optional: if it\'s not provided (is null), it will be interpreted as IN.
Disables all logs.
', 'SetV2LoggingOptionsRequest$disableAllLogs' => 'If true all logs are disabled. The default is false.
', ], ], 'DisableTopicRuleRequest' => [ 'base' => 'The input for the DisableTopicRuleRequest operation.
', 'refs' => [], ], 'DisconnectReason' => [ 'base' => NULL, 'refs' => [ 'ThingConnectivity$disconnectReason' => 'The reason why the client is disconnected. If the thing has been disconnected for approximately an hour, the disconnectReason value might be missing.
A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.
documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can\'t be used with custom job templates or to create jobs from them.
A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.
documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can\'t be used with custom job templates or to create jobs from them.
The ARN of the domain configuration.
', 'DescribeDomainConfigurationResponse$domainConfigurationArn' => 'The ARN of the domain configuration.
', 'DomainConfigurationSummary$domainConfigurationArn' => 'The ARN of the domain configuration.
', 'UpdateDomainConfigurationResponse$domainConfigurationArn' => 'The ARN of the domain configuration that was updated.
', ], ], 'DomainConfigurationName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainConfigurationRequest$domainConfigurationName' => 'The name of the domain configuration. This value must be unique to a region.
', 'CreateDomainConfigurationResponse$domainConfigurationName' => 'The name of the domain configuration.
', 'DeleteDomainConfigurationRequest$domainConfigurationName' => 'The name of the domain configuration to be deleted.
', ], ], 'DomainConfigurationStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainConfigurationResponse$domainConfigurationStatus' => 'A Boolean value that specifies the current state of the domain configuration.
', 'UpdateDomainConfigurationRequest$domainConfigurationStatus' => 'The status to which the domain configuration should be updated.
', ], ], 'DomainConfigurationSummary' => [ 'base' => 'The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. A domain configuration can be associated with an Amazon Web Services-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.
Data
Jobs
CredentialProvider
A list of objects that contain summary information about the user\'s domain configurations.
', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainConfigurationRequest$domainName' => 'The name of the domain.
', 'DescribeDomainConfigurationResponse$domainName' => 'The name of the domain.
', ], ], 'DomainType' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainConfigurationResponse$domainType' => 'The type of the domain.
', ], ], 'DurationInMinutes' => [ 'base' => NULL, 'refs' => [ 'MaintenanceWindow$durationInMinutes' => 'Displays the duration of the next maintenance window.
', ], ], 'DurationSeconds' => [ 'base' => NULL, 'refs' => [ 'BehaviorCriteria$durationSeconds' => 'Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.
The dynamic thing group status.
', ], ], 'DynamoDBAction' => [ 'base' => '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 OpenSearch Service domain.
The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.
Write data to an Amazon OpenSearch Service domain.
The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.
The endpoint of your OpenSearch domain.
', 'OpenSearchAction$endpoint' => 'The endpoint of your OpenSearch domain.
', ], ], 'ElasticsearchId' => [ 'base' => NULL, 'refs' => [ 'ElasticsearchAction$id' => 'The unique identifier for the document you are storing.
', 'OpenSearchAction$id' => 'The unique identifier for the document you are storing.
', ], ], 'ElasticsearchIndex' => [ 'base' => NULL, 'refs' => [ 'ElasticsearchAction$index' => 'The index where you want to store your data.
', 'OpenSearchAction$index' => 'The OpenSearch index where you want to store your data.
', ], ], 'ElasticsearchType' => [ 'base' => NULL, 'refs' => [ 'ElasticsearchAction$type' => 'The type of document you are storing.
', 'OpenSearchAction$type' => 'The type of document you are storing.
', ], ], 'EnableCachingForHttp' => [ 'base' => NULL, 'refs' => [ 'AuthorizerDescription$enableCachingForHttp' => 'When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.
When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.
The default value is false.
When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.
Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.
', 'refs' => [ 'MitigationActionParams$enableIoTLoggingParams' => 'Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.
', ], ], '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.
', 'CreateProvisioningTemplateRequest$enabled' => 'True to enable the provisioning template, otherwise false.
', 'DescribeProvisioningTemplateResponse$enabled' => 'True if the provisioning template is enabled, otherwise false.
', 'ProvisioningTemplateSummary$enabled' => 'True if the fleet provision template is enabled, otherwise false.
', 'UpdateProvisioningTemplateRequest$enabled' => 'True to enable the provisioning template, otherwise false.
', ], ], 'EnabledBoolean' => [ 'base' => NULL, 'refs' => [ 'VersionUpdateByJobsConfig$enabled' => 'Indicates whether the Job is enabled or not.
', ], ], '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. Valid endpoint types include:
iot:Data - Returns a VeriSign signed data endpoint.
iot:Data-ATS - Returns an ATS signed data endpoint.
iot:CredentialProvider - Returns an IoT credentials provider API endpoint.
iot:Jobs - Returns an IoT device management Jobs API endpoint.
We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.
A list of environments that are supported with the managed job template.
', 'ManagedJobTemplateSummary$environments' => 'A list of environments that are supported with the managed job template.
', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'AuditCheckDetails$errorCode' => 'The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".
', 'AuditMitigationActionExecutionMetadata$errorCode' => 'If an error occurred, the code that indicates which type of error occurred.
', ], ], '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 this check is performed during this audit.
', 'AuditMitigationActionExecutionMetadata$message' => 'If an error occurred, a message that describes the error.
', 'DescribeThingRegistrationTaskResponse$message' => 'The message.
', 'DetectMitigationActionExecution$message' => 'The message of a mitigation action.
', 'ValidationError$errorMessage' => 'The description of an error found in the behaviors.
', ], ], 'EvaluationStatistic' => [ 'base' => NULL, 'refs' => [ 'StatisticalThreshold$statistic' => 'The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
The event configurations.
', 'UpdateEventConfigurationsRequest$eventConfigurations' => 'The new event configuration values.
', ], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'EventConfigurations$key' => NULL, ], ], 'Example' => [ 'base' => NULL, 'refs' => [ 'DocumentParameter$example' => 'An example illustrating a pattern that need to be replaced in a managed template job document schema.
', ], ], '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.
', ], ], 'ExpiresInSeconds' => [ 'base' => NULL, 'refs' => [ 'AwsJobPresignedUrlConfig$expiresInSec' => 'How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.
', ], ], 'ExplicitDeny' => [ 'base' => 'Information that explicitly denies authorization.
', 'refs' => [ 'Denied$explicitDeny' => 'Information that explicitly denies the authorization.
', ], ], 'ExponentialRolloutRate' => [ 'base' => 'Allows you to create an exponential rate of rollout for a job.
', 'refs' => [ 'JobExecutionsRolloutConfig$exponentialRate' => 'The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
', ], ], 'FailedChecksCount' => [ 'base' => NULL, 'refs' => [ 'TaskStatistics$failedChecks' => 'The number of checks.
', ], ], 'FailedFindingsCount' => [ 'base' => NULL, 'refs' => [ 'TaskStatisticsForAuditCheck$failedFindingsCount' => 'The number of findings for which at least one of the actions failed when applied.
', ], ], 'FailedThings' => [ 'base' => NULL, 'refs' => [ 'JobProcessDetails$numberOfFailedThings' => 'The number of things that failed executing the job.
', ], ], 'Field' => [ 'base' => 'Describes the name and data type at a field.
', 'refs' => [ 'Fields$member' => NULL, ], ], 'FieldName' => [ 'base' => NULL, 'refs' => [ 'Field$name' => 'The name of the field.
', ], ], 'FieldType' => [ 'base' => NULL, 'refs' => [ 'Field$type' => 'The data type of the field.
', ], ], 'Fields' => [ 'base' => NULL, 'refs' => [ 'ThingGroupIndexingConfiguration$managedFields' => 'Contains fields that are indexed and whose types are already known by the Fleet Indexing service. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.
', 'ThingGroupIndexingConfiguration$customFields' => 'A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
Contains custom field names and their data type.
', 'ThingIndexingConfiguration$managedFields' => 'Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
', 'ThingIndexingConfiguration$customFields' => 'Contains custom field names and their data type.
', ], ], '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.
', ], ], 'FileType' => [ 'base' => NULL, 'refs' => [ 'OTAUpdateFile$fileType' => 'An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.
', ], ], 'FindingId' => [ 'base' => NULL, 'refs' => [ 'AuditFinding$findingId' => 'A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.
', 'AuditMitigationActionExecutionMetadata$findingId' => 'The unique identifier for the findings to which the task and associated mitigation action are applied.
', 'DescribeAuditFindingRequest$findingId' => 'A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.
', 'FindingIds$member' => NULL, 'ListAuditMitigationActionsExecutionsRequest$findingId' => 'Specify this filter to limit results to those that were applied to a specific audit finding.
', 'ListAuditMitigationActionsTasksRequest$findingId' => 'Specify this filter to limit results to tasks that were applied to a specific audit finding.
', 'ListRelatedResourcesForAuditFindingRequest$findingId' => 'The finding Id.
', ], ], 'FindingIds' => [ 'base' => NULL, 'refs' => [ 'AuditMitigationActionsTaskTarget$findingIds' => 'If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.
', ], ], '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 or UpdateThingGroup.
The Amazon Resource Name (ARN) of the new fleet metric.
', 'DescribeFleetMetricResponse$metricArn' => 'The ARN of the fleet metric to describe.
', 'FleetMetricNameAndArn$metricArn' => 'The fleet metric ARN.
', ], ], 'FleetMetricDescription' => [ 'base' => NULL, 'refs' => [ 'CreateFleetMetricRequest$description' => 'The fleet metric description.
', 'DescribeFleetMetricResponse$description' => 'The fleet metric description.
', 'UpdateFleetMetricRequest$description' => 'The description of the fleet metric.
', ], ], 'FleetMetricName' => [ 'base' => NULL, 'refs' => [ 'CreateFleetMetricRequest$metricName' => 'The name of the fleet metric to create.
', 'CreateFleetMetricResponse$metricName' => 'The name of the fleet metric to create.
', 'DeleteFleetMetricRequest$metricName' => 'The name of the fleet metric to delete.
', 'DescribeFleetMetricRequest$metricName' => 'The name of the fleet metric to describe.
', 'DescribeFleetMetricResponse$metricName' => 'The name of the fleet metric to describe.
', 'FleetMetricNameAndArn$metricName' => 'The fleet metric name.
', 'UpdateFleetMetricRequest$metricName' => 'The name of the fleet metric to update.
', ], ], 'FleetMetricNameAndArn' => [ 'base' => 'The name and ARN of a fleet metric.
', 'refs' => [ 'FleetMetricNameAndArnList$member' => NULL, ], ], 'FleetMetricNameAndArnList' => [ 'base' => NULL, 'refs' => [ 'ListFleetMetricsResponse$fleetMetrics' => 'The list of fleet metrics objects.
', ], ], 'FleetMetricPeriod' => [ 'base' => NULL, 'refs' => [ 'CreateFleetMetricRequest$period' => 'The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
', 'DescribeFleetMetricResponse$period' => 'The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
', 'UpdateFleetMetricRequest$period' => 'The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
', ], ], 'FleetMetricUnit' => [ 'base' => NULL, 'refs' => [ 'CreateFleetMetricRequest$unit' => 'Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.
', 'DescribeFleetMetricResponse$unit' => 'Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
', 'UpdateFleetMetricRequest$unit' => 'Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
', ], ], 'ForceDelete' => [ 'base' => NULL, 'refs' => [ 'DeleteCertificateRequest$forceDelete' => 'Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.
', ], ], 'ForceDeleteAWSJob' => [ 'base' => NULL, 'refs' => [ 'DeleteOTAUpdateRequest$forceDeleteAWSJob' => 'When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.
', ], ], '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.
', ], ], '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.
', ], ], 'GenericLongValue' => [ 'base' => NULL, 'refs' => [ 'DetectMitigationActionsTaskStatistics$actionsExecuted' => 'The actions that were performed.
', 'DetectMitigationActionsTaskStatistics$actionsSkipped' => 'The actions that were skipped.
', 'DetectMitigationActionsTaskStatistics$actionsFailed' => 'The actions that failed.
', ], ], 'GetBehaviorModelTrainingSummariesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBehaviorModelTrainingSummariesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketsAggregationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketsAggregationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCardinalityRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCardinalityResponse' => [ 'base' => NULL, 'refs' => [], ], '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' => [], ], 'GetPackageConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPercentilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPercentilesResponse' => [ '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' => [], ], 'GetStatisticsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStatisticsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTopicRuleDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTopicRuleDestinationResponse' => [ 'base' => NULL, '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' => [ 'BillingGroupNameAndArnList$member' => NULL, 'ThingGroupNameAndArnList$member' => NULL, ], ], 'HashAlgorithm' => [ 'base' => NULL, 'refs' => [ 'CustomCodeSigning$hashAlgorithm' => 'The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses SHA256 or SHA1, so you can pass either of them based on which was used for generating the signature.
The hash key name.
', ], ], 'HashKeyValue' => [ 'base' => NULL, 'refs' => [ 'DynamoDBAction$hashKeyValue' => 'The hash key value.
', ], ], 'HeaderKey' => [ 'base' => NULL, 'refs' => [ 'HttpActionHeader$key' => 'The HTTP header key.
', ], ], 'HeaderList' => [ 'base' => NULL, 'refs' => [ 'HttpAction$headers' => 'The HTTP headers to send with the message data.
', ], ], 'HeaderValue' => [ 'base' => NULL, 'refs' => [ 'HttpActionHeader$value' => 'The HTTP header value. Substitution templates are supported.
', ], ], 'HttpAction' => [ 'base' => 'Send data to an HTTPS endpoint.
', 'refs' => [ 'Action$http' => 'Send data to an HTTPS endpoint.
', ], ], 'HttpActionHeader' => [ 'base' => 'The HTTP action header.
', 'refs' => [ 'HeaderList$member' => NULL, ], ], 'HttpAuthorization' => [ 'base' => 'The authorization method used to send messages.
', 'refs' => [ 'HttpAction$auth' => 'The authentication method to use when sending data to an HTTPS endpoint.
', ], ], 'HttpContext' => [ 'base' => 'Specifies the HTTP context to use for the test authorizer request.
', 'refs' => [ 'TestInvokeAuthorizerRequest$httpContext' => 'Specifies a test HTTP authorization request.
', ], ], 'HttpHeaderName' => [ 'base' => NULL, 'refs' => [ 'HttpHeaders$key' => NULL, ], ], 'HttpHeaderValue' => [ 'base' => NULL, 'refs' => [ 'HttpHeaders$value' => NULL, ], ], 'HttpHeaders' => [ 'base' => NULL, 'refs' => [ 'HttpContext$headers' => 'The header keys and values in an HTTP authorization request.
', ], ], 'HttpQueryString' => [ 'base' => NULL, 'refs' => [ 'HttpContext$queryString' => 'The query string keys and values in an HTTP authorization request.
', ], ], 'HttpUrlDestinationConfiguration' => [ 'base' => 'HTTP URL destination configuration used by the topic rule\'s HTTP action.
', 'refs' => [ 'TopicRuleDestinationConfiguration$httpUrlConfiguration' => 'Configuration of the HTTP URL.
', ], ], 'HttpUrlDestinationProperties' => [ 'base' => 'HTTP URL destination properties.
', 'refs' => [ 'TopicRuleDestination$httpUrlProperties' => 'Properties of the HTTP URL.
', ], ], 'HttpUrlDestinationSummary' => [ 'base' => 'Information about an HTTP URL destination.
', 'refs' => [ 'TopicRuleDestinationSummary$httpUrlSummary' => 'Information about the HTTP URL.
', ], ], '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.
', ], ], 'InProgressTimeoutInMinutes' => [ 'base' => NULL, 'refs' => [ 'TimeoutConfig$inProgressTimeoutInMinutes' => 'Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can\'t be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
The exponential factor to increase the rate of rollout for a job.
Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).
', ], ], 'IndexName' => [ 'base' => NULL, 'refs' => [ 'CreateDynamicThingGroupRequest$indexName' => 'The dynamic thing group index name.
Currently one index is supported: AWS_Things.
The dynamic thing group index name.
', 'CreateFleetMetricRequest$indexName' => 'The name of the index to search.
', 'DescribeFleetMetricResponse$indexName' => 'The name of the index to search.
', 'DescribeIndexRequest$indexName' => 'The index name.
', 'DescribeIndexResponse$indexName' => 'The index name.
', 'DescribeThingGroupResponse$indexName' => 'The dynamic thing group index name.
', 'GetBucketsAggregationRequest$indexName' => 'The name of the index to search.
', 'GetCardinalityRequest$indexName' => 'The name of the index to search.
', 'GetPercentilesRequest$indexName' => 'The name of the index to search.
', 'GetStatisticsRequest$indexName' => 'The name of the index to search. The default value is AWS_Things.
The search index name.
', 'UpdateDynamicThingGroupRequest$indexName' => 'The dynamic thing group index to update.
Currently one index is supported: AWS_Things.
The name of the index to search.
', ], ], '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 contains only registry data.
REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.
REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.
MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.
The index status.
', ], ], 'IndexingFilter' => [ 'base' => 'Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.
Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.
A base64 encoded binary representation of the code signing certificate chain.
', ], ], 'InputName' => [ 'base' => NULL, 'refs' => [ 'IotEventsAction$inputName' => 'The name of the IoT Events input.
', ], ], 'InternalException' => [ 'base' => 'An unexpected error has occurred.
', 'refs' => [], ], 'InternalFailureException' => [ 'base' => 'An unexpected error has occurred.
', 'refs' => [], ], 'InternalServerException' => [ 'base' => 'Internal error from the service that indicates an unexpected error or that the service is unavailable.
', 'refs' => [], ], 'InvalidAggregationException' => [ 'base' => 'The aggregation is invalid.
', '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 message data to an IoT Analytics channel.
', 'refs' => [ 'Action$iotAnalytics' => 'Sends message data to an IoT Analytics channel.
', ], ], 'IotEventsAction' => [ 'base' => 'Sends an input to an IoT Events detector.
', 'refs' => [ 'Action$iotEvents' => 'Sends an input to an IoT Events detector.
', ], ], 'IotSiteWiseAction' => [ 'base' => 'Describes an action to send data from an MQTT message that triggered the rule to IoT SiteWise asset properties.
', 'refs' => [ 'Action$iotSiteWise' => 'Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.
', ], ], '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.
', 'CreateProvisioningTemplateVersionResponse$isDefaultVersion' => 'True if the provisioning template version is the default version, otherwise false.
', 'DescribeProvisioningTemplateVersionResponse$isDefaultVersion' => 'True if the provisioning template version is the default version.
', 'GetPolicyVersionResponse$isDefaultVersion' => 'Specifies whether the policy version is the default.
', 'PolicyVersion$isDefaultVersion' => 'Specifies whether the policy version is the default.
', 'ProvisioningTemplateVersionSummary$isDefaultVersion' => 'True if the provisioning template version is the default version, otherwise false.
', ], ], '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.
', ], ], 'IsSuppressed' => [ 'base' => NULL, 'refs' => [ 'AuditFinding$isSuppressed' => 'Indicates whether the audit finding was suppressed or not during reporting.
', ], ], 'IssuerCertificateIdentifier' => [ 'base' => 'The certificate issuer indentifier.
', 'refs' => [ 'ResourceIdentifier$issuerCertificateIdentifier' => 'The issuer certificate identifier.
', ], ], 'IssuerCertificateSerialNumber' => [ 'base' => NULL, 'refs' => [ 'IssuerCertificateIdentifier$issuerCertificateSerialNumber' => 'The issuer certificate serial number.
', ], ], 'IssuerCertificateSubject' => [ 'base' => NULL, 'refs' => [ 'IssuerCertificateIdentifier$issuerCertificateSubject' => 'The subject of the issuer certificate.
', ], ], 'IssuerId' => [ 'base' => NULL, 'refs' => [ 'IssuerCertificateIdentifier$issuerId' => 'The issuer ID.
', ], ], '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.
', 'CreateJobTemplateRequest$jobArn' => 'The ARN of the job to use as the basis for the job template.
', '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.
', 'CreateJobTemplateRequest$description' => 'A description of the job document.
', 'DescribeJobTemplateResponse$description' => 'A description of the job template.
', 'DescribeManagedJobTemplateResponse$description' => 'The unique description of a managed template.
', 'DocumentParameter$description' => 'Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
', 'Job$description' => 'A short text description of the job.
', 'JobTemplateSummary$description' => 'A description of the job template.
', 'ManagedJobTemplateSummary$description' => 'The description for a managed template.
', 'UpdateJobRequest$description' => 'A short text description of the job.
', ], ], 'JobDocument' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$document' => 'The job document. Required if you don\'t specify a value for documentSource.
The job document. Required if you don\'t specify a value for documentSource.
The job document.
', 'DescribeManagedJobTemplateResponse$document' => 'The document schema for a managed job template.
', 'GetJobDocumentResponse$document' => 'The job document content.
', ], ], 'JobDocumentSource' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$documentSource' => 'An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don\'t specify a value for document.
For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
For more information, see Methods for accessing a bucket.
', 'CreateJobTemplateRequest$documentSource' => 'An S3 link to the job document to use in the template. Required if you don\'t specify a value for document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
An S3 link to the job document.
', 'DescribeJobTemplateResponse$documentSource' => 'An S3 link to the job document.
', ], ], 'JobEndBehavior' => [ 'base' => NULL, 'refs' => [ 'SchedulingConfig$endBehavior' => 'Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.
The job execution object represents the execution of a job on a particular device.
', 'refs' => [ 'DescribeJobExecutionResponse$execution' => 'Information about the job execution.
', ], ], 'JobExecutionFailureType' => [ 'base' => NULL, 'refs' => [ 'AbortCriteria$failureType' => 'The type of job execution failures that can initiate a job abort.
', ], ], 'JobExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'JobExecution$status' => 'The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, 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.
', ], ], 'JobExecutionsRetryConfig' => [ 'base' => 'The configuration that determines how many retries are allowed for each failure type for a job.
', 'refs' => [ 'CreateJobRequest$jobExecutionsRetryConfig' => 'Allows you to create the criteria to retry a job.
', 'CreateJobTemplateRequest$jobExecutionsRetryConfig' => 'Allows you to create the criteria to retry a job.
', 'DescribeJobTemplateResponse$jobExecutionsRetryConfig' => 'The configuration that determines how many retries are allowed for each failure type for a job.
', 'Job$jobExecutionsRetryConfig' => 'The configuration for the criteria to retry the job.
', 'UpdateJobRequest$jobExecutionsRetryConfig' => 'Allows you to create the criteria to retry a job.
', ], ], '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.
', 'CreateJobTemplateRequest$jobExecutionsRolloutConfig' => NULL, 'DescribeJobTemplateResponse$jobExecutionsRolloutConfig' => NULL, 'Job$jobExecutionsRolloutConfig' => 'Allows you to create a staged rollout of a job.
', 'UpdateJobRequest$jobExecutionsRolloutConfig' => 'Allows you to create a staged rollout of the 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 Amazon Web Services 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.
', 'ListJobExecutionsForThingRequest$jobId' => 'The unique identifier you assigned to this job when it was created.
', 'UpdateJobRequest$jobId' => 'The ID of the job to be updated.
', ], ], '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, DELETION_IN_PROGRESS 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.
', ], ], 'JobTemplateArn' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$jobTemplateArn' => 'The ARN of the job template used to create the job.
', 'CreateJobTemplateResponse$jobTemplateArn' => 'The ARN of the job template.
', 'DescribeJobTemplateResponse$jobTemplateArn' => 'The ARN of the job template.
', 'DescribeManagedJobTemplateResponse$templateArn' => 'The unique Amazon Resource Name (ARN) of the managed template.
', 'Job$jobTemplateArn' => 'The ARN of the job template used to create the job.
', 'JobTemplateSummary$jobTemplateArn' => 'The ARN of the job template.
', 'ManagedJobTemplateSummary$templateArn' => 'The Amazon Resource Name (ARN) for a managed template.
', ], ], 'JobTemplateId' => [ 'base' => NULL, 'refs' => [ 'CreateJobTemplateRequest$jobTemplateId' => 'A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
', 'CreateJobTemplateResponse$jobTemplateId' => 'The unique identifier of the job template.
', 'DeleteJobTemplateRequest$jobTemplateId' => 'The unique identifier of the job template to delete.
', 'DescribeJobTemplateRequest$jobTemplateId' => 'The unique identifier of the job template.
', 'DescribeJobTemplateResponse$jobTemplateId' => 'The unique identifier of the job template.
', 'JobTemplateSummary$jobTemplateId' => 'The unique identifier of the job template.
', ], ], 'JobTemplateSummary' => [ 'base' => 'An object that contains information about the job template.
', 'refs' => [ 'JobTemplateSummaryList$member' => NULL, ], ], 'JobTemplateSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListJobTemplatesResponse$jobTemplates' => 'A list of objects that contain information about the job templates.
', ], ], 'JsonDocument' => [ 'base' => NULL, 'refs' => [ 'ThingDocument$shadow' => 'The unnamed shadow and named shadow.
For more information about shadows, see IoT Device Shadow service.
', 'ThingDocument$deviceDefender' => 'Contains Device Defender data.
For more information about Device Defender, see Device Defender.
', ], ], 'KafkaAction' => [ 'base' => 'Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
', 'refs' => [ 'Action$kafka' => 'Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'S3Action$key' => 'The object key. For more information, see Actions, resources, and condition keys for Amazon S3.
', ], ], 'KeyName' => [ 'base' => NULL, 'refs' => [ 'PublicKeyMap$key' => NULL, ], ], 'KeyPair' => [ 'base' => 'Describes a key pair.
', 'refs' => [ 'CreateKeysAndCertificateResponse$keyPair' => 'The generated key pair.
', 'CreateProvisioningClaimResponse$keyPair' => 'The provisioning claim 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.
', 'ListJobTemplatesRequest$maxResults' => 'The maximum number of results to return in the list.
', 'ListJobsRequest$maxResults' => 'The maximum number of results to return per request.
', 'ListManagedJobTemplatesRequest$maxResults' => 'Maximum number of entries that can be returned.
', ], ], 'LastModifiedDate' => [ 'base' => NULL, 'refs' => [ 'DescribeEventConfigurationsResponse$lastModifiedDate' => 'The date the event configurations were last modified.
', 'DescribeFleetMetricResponse$lastModifiedDate' => 'The date when the fleet metric is last modified.
', 'DescribeThingRegistrationTaskResponse$lastModifiedDate' => 'The date when the task was last modified.
', 'GetPackageResponse$lastModifiedDate' => 'The date when the package was last updated.
', 'GetPackageVersionResponse$lastModifiedDate' => 'The date when the package version was last updated.
', 'PackageSummary$lastModifiedDate' => 'The date that the package was last updated.
', 'PackageVersionSummary$lastModifiedDate' => 'The date that the package version was last updated.
', ], ], 'LastUpdatedAtDate' => [ 'base' => NULL, 'refs' => [ 'TopicRuleDestination$lastUpdatedAt' => 'The date and time when the topic rule destination was last updated.
', 'TopicRuleDestinationSummary$lastUpdatedAt' => 'The date and time when the topic rule destination was last updated.
', ], ], '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' => [], ], 'ListAuditMitigationActionsExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAuditMitigationActionsExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAuditMitigationActionsTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAuditMitigationActionsTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAuditSuppressionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAuditSuppressionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAuditTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAuditTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAuthorizersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAuthorizersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListBillingGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBillingGroupsResponse' => [ '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' => [], ], 'ListCustomMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDetectMitigationActionsExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDetectMitigationActionsExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDetectMitigationActionsTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDetectMitigationActionsTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDimensionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDimensionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFleetMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFleetMetricsResponse' => [ 'base' => NULL, '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' => [], ], 'ListJobTemplatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListJobTemplatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListManagedJobTemplatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListManagedJobTemplatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricValuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricValuesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMitigationActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMitigationActionsResponse' => [ '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' => [], ], 'ListPackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesResponse' => [ 'base' => NULL, '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' => [], ], 'ListProvisioningTemplateVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningTemplateVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningTemplatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningTemplatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRelatedResourcesForAuditFindingRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRelatedResourcesForAuditFindingResponse' => [ 'base' => NULL, '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' => [], ], 'ListSuppressedAlerts' => [ 'base' => NULL, 'refs' => [ 'ListActiveViolationsRequest$listSuppressedAlerts' => 'A list of all suppressed alerts.
', 'ListViolationEventsRequest$listSuppressedAlerts' => 'A list of all suppressed alerts.
', ], ], 'ListSuppressedFindings' => [ 'base' => NULL, 'refs' => [ 'ListAuditFindingsRequest$listSuppressedFindings' => 'Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn\'t provided, the response will list both suppressed and unsuppressed findings.
', ], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ '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' => [], ], 'ListThingsInBillingGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListThingsInBillingGroupResponse' => [ 'base' => NULL, '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' => [], ], 'ListTopicRuleDestinationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicRuleDestinationsResponse' => [ 'base' => NULL, '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' => [], ], 'LocationAction' => [ 'base' => 'The Amazon Location rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.
', 'refs' => [ 'Action$location' => 'The Amazon Location Service rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.
', ], ], 'LocationTimestamp' => [ 'base' => 'Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
', 'refs' => [ 'LocationAction$timestamp' => 'The time that the location data was sampled. The default value is the time the MQTT message was processed.
', ], ], 'LogGroupName' => [ 'base' => NULL, 'refs' => [ 'CloudwatchLogsAction$logGroupName' => 'The CloudWatch log group to which the action sends data.
', ], ], 'LogLevel' => [ 'base' => NULL, 'refs' => [ 'EnableIoTLoggingParams$logLevel' => 'Specifies the type of information to be logged.
', '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.
', ], ], 'MachineLearningDetectionConfig' => [ 'base' => 'The configuration of an ML Detect Security Profile.
', 'refs' => [ 'BehaviorCriteria$mlDetectionConfig' => 'The configuration of an ML Detect
', ], ], 'MaintenanceWindow' => [ 'base' => 'An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.
Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
', 'DescribeJobTemplateResponse$maintenanceWindows' => 'Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
', 'SchedulingConfig$maintenanceWindows' => 'An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.
The policy documentation is not valid.
', 'refs' => [], ], 'ManagedJobTemplateName' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedJobTemplateRequest$templateName' => 'The unique name of a managed job template, which is required.
', 'DescribeManagedJobTemplateResponse$templateName' => 'The unique name of a managed template, such as AWS-Reboot.
An optional parameter for template name. If specified, only the versions of the managed job templates that have the specified template name will be returned.
', 'ManagedJobTemplateSummary$templateName' => 'The unique Name for a managed template.
', ], ], 'ManagedJobTemplateSummary' => [ 'base' => 'An object that contains information about the managed template.
', 'refs' => [ 'ManagedJobTemplatesSummaryList$member' => NULL, ], ], 'ManagedJobTemplatesSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListManagedJobTemplatesResponse$managedJobTemplates' => 'A list of managed job templates that are returned.
', ], ], 'ManagedTemplateVersion' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedJobTemplateRequest$templateVersion' => 'An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.
', 'DescribeManagedJobTemplateResponse$templateVersion' => 'The version for a managed template.
', 'ManagedJobTemplateSummary$templateVersion' => 'The version for a managed template.
', ], ], '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.
', 'ListDomainConfigurationsRequest$marker' => 'The marker for the next set of results.
', 'ListDomainConfigurationsResponse$nextMarker' => 'The marker for the next set of 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.
', ], ], 'MaxBuckets' => [ 'base' => NULL, 'refs' => [ 'TermsAggregation$maxBuckets' => 'The number of buckets to return in the response. Default to 10.
', ], ], '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.
', 'ListAuditMitigationActionsExecutionsRequest$maxResults' => 'The maximum number of results to return at one time. The default is 25.
', 'ListAuditMitigationActionsTasksRequest$maxResults' => 'The maximum number of results to return at one time. The default is 25.
', 'ListAuditSuppressionsRequest$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.
', 'ListCustomMetricsRequest$maxResults' => 'The maximum number of results to return at one time. The default is 25.
', 'ListDetectMitigationActionsExecutionsRequest$maxResults' => 'The maximum number of results to return at one time. The default is 25.
', 'ListDetectMitigationActionsTasksRequest$maxResults' => 'The maximum number of results to return at one time. The default is 25.
', 'ListDimensionsRequest$maxResults' => 'The maximum number of results to retrieve at one time.
', 'ListFleetMetricsRequest$maxResults' => 'The maximum number of results to return in this operation.
', 'ListMetricValuesRequest$maxResults' => 'The maximum number of results to return at one time.
', 'ListMitigationActionsRequest$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.
', 'ListProvisioningTemplateVersionsRequest$maxResults' => 'The maximum number of results to return at one time.
', 'ListProvisioningTemplatesRequest$maxResults' => 'The maximum number of results to return at one time.
', 'ListRelatedResourcesForAuditFindingRequest$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.
', ], ], 'Maximum' => [ 'base' => NULL, 'refs' => [ 'Statistics$maximum' => 'The maximum aggregated field value.
', ], ], '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.
', ], ], 'MessageExpiry' => [ 'base' => NULL, 'refs' => [ 'MqttHeaders$messageExpiry' => 'A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it\'s no longer relevant to the subscriber. The value of messageExpiry represents the number of seconds before it expires. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
Supports substitution templates.
', ], ], '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 https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
', ], ], 'MessageId' => [ 'base' => NULL, 'refs' => [ 'IotEventsAction$messageId' => 'The ID of the message. The default messageId is a new UUID value.
When batchMode is true, you can\'t specify a messageId--a new UUID value will be assigned.
Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.
A metric.
', 'refs' => [ 'MetricDatumList$member' => NULL, ], ], 'MetricDatumList' => [ 'base' => NULL, 'refs' => [ 'ListMetricValuesResponse$metricDatumList' => 'The data the thing reports for the metric during the specified time period.
', ], ], 'MetricDimension' => [ 'base' => 'The dimension of a metric.
', 'refs' => [ 'Behavior$metricDimension' => 'The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can\'t be used with custom metrics.
The dimension of a metric. This can\'t be used with custom metrics.
', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'CreateCustomMetricRequest$metricName' => ' The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can\'t begin with aws:. You can\'t change the name after you define it.
The name of the custom metric to be used in the metric report.
', 'DeleteCustomMetricRequest$metricName' => 'The name of the custom metric.
', 'DescribeCustomMetricRequest$metricName' => 'The name of the custom metric.
', 'DescribeCustomMetricResponse$metricName' => 'The name of the custom metric.
', 'ListSecurityProfilesRequest$metricName' => ' The name of the custom metric. Cannot be used with dimensionName.
The name of the custom metric. Cannot be updated.
', 'UpdateCustomMetricResponse$metricName' => 'The name of the custom metric.
', ], ], 'MetricNames' => [ 'base' => NULL, 'refs' => [ 'ListCustomMetricsResponse$metricNames' => 'The name of the custom metric.
', ], ], 'MetricToRetain' => [ 'base' => 'The metric you want to retain. Dimensions are optional.
', 'refs' => [ 'AdditionalMetricsToRetainV2List$member' => NULL, ], ], 'MetricValue' => [ 'base' => 'The value to be compared with the metric.
The value of the metric (the measurement) that caused the most recent violation.
', 'BehaviorCriteria$value' => 'The value to be compared with the metric.
The value reported for the metric.
', 'ViolationEvent$metricValue' => 'The value of the metric (the measurement).
', ], ], 'Minimum' => [ 'base' => NULL, 'refs' => [ 'Statistics$minimum' => 'The minimum aggregated field value.
', ], ], 'MinimumNumberOfExecutedThings' => [ 'base' => NULL, 'refs' => [ 'AbortCriteria$minNumberOfExecutedThings' => 'The minimum number of things which must receive job execution notifications before the job can be aborted.
', ], ], 'MissingContextValue' => [ 'base' => NULL, 'refs' => [ 'MissingContextValues$member' => NULL, ], ], 'MissingContextValues' => [ 'base' => NULL, 'refs' => [ 'AuthResult$missingContextValues' => 'Contains any missing context values found while evaluating policy.
', ], ], 'MitigationAction' => [ 'base' => 'Describes which changes should be applied as part of a mitigation action.
', 'refs' => [ 'MitigationActionList$member' => NULL, ], ], 'MitigationActionArn' => [ 'base' => NULL, 'refs' => [ 'CreateMitigationActionResponse$actionArn' => 'The ARN for the new mitigation action.
', 'DescribeMitigationActionResponse$actionArn' => 'The ARN that identifies this migration action.
', 'MitigationActionIdentifier$actionArn' => 'The IAM role ARN used to apply this mitigation action.
', 'UpdateMitigationActionResponse$actionArn' => 'The ARN for the new mitigation action.
', ], ], 'MitigationActionId' => [ 'base' => NULL, 'refs' => [ 'AuditMitigationActionExecutionMetadata$actionId' => 'The unique identifier for the mitigation action being applied by the task.
', 'CreateMitigationActionResponse$actionId' => 'A unique identifier for the new mitigation action.
', 'DescribeMitigationActionResponse$actionId' => 'A unique identifier for this action.
', 'MitigationAction$id' => 'A unique identifier for the mitigation action.
', 'UpdateMitigationActionResponse$actionId' => 'A unique identifier for the mitigation action.
', ], ], 'MitigationActionIdentifier' => [ 'base' => 'Information that identifies a mitigation action. This information is returned by ListMitigationActions.
', 'refs' => [ 'MitigationActionIdentifierList$member' => NULL, ], ], 'MitigationActionIdentifierList' => [ 'base' => NULL, 'refs' => [ 'ListMitigationActionsResponse$actionIdentifiers' => 'A set of actions that matched the specified filter criteria.
', ], ], 'MitigationActionList' => [ 'base' => NULL, 'refs' => [ 'DescribeAuditMitigationActionsTaskResponse$actionsDefinition' => 'Specifies the mitigation actions and their parameters that are applied as part of this task.
', 'DetectMitigationActionsTaskSummary$actionsDefinition' => 'The definition of the actions.
', ], ], 'MitigationActionName' => [ 'base' => NULL, 'refs' => [ 'AuditMitigationActionExecutionMetadata$actionName' => 'The friendly name of the mitigation action being applied by the task.
', 'CreateMitigationActionRequest$actionName' => 'A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).
The name of the mitigation action that you want to delete.
', 'DescribeMitigationActionRequest$actionName' => 'The friendly name that uniquely identifies the mitigation action.
', 'DescribeMitigationActionResponse$actionName' => 'The friendly name that uniquely identifies the mitigation action.
', 'DetectMitigationActionExecution$actionName' => 'The friendly name that uniquely identifies the mitigation action.
', 'DetectMitigationActionsToExecuteList$member' => NULL, 'MitigationAction$name' => 'A user-friendly name for the mitigation action.
', 'MitigationActionIdentifier$actionName' => 'The friendly name of the mitigation action.
', 'MitigationActionNameList$member' => NULL, 'UpdateMitigationActionRequest$actionName' => 'The friendly name for the mitigation action. You cannot change the name by using UpdateMitigationAction. Instead, you must delete and recreate the mitigation action with the new name.
The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).
', 'refs' => [ 'CreateMitigationActionRequest$actionParams' => 'Defines the type of action and the parameters for that action.
', 'DescribeMitigationActionResponse$actionParams' => 'Parameters that control how the mitigation action is applied, specific to the type of mitigation action.
', 'MitigationAction$actionParams' => 'The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
', 'UpdateMitigationActionRequest$actionParams' => 'Defines the type of action and the parameters for that action.
', ], ], 'MitigationActionType' => [ 'base' => NULL, 'refs' => [ 'DescribeMitigationActionResponse$actionType' => 'The type of mitigation action.
', 'ListMitigationActionsRequest$actionType' => 'Specify a value to limit the result to mitigation actions with a specific action type.
', ], ], 'MitigationActionsTaskId' => [ 'base' => NULL, 'refs' => [ 'AuditMitigationActionExecutionMetadata$taskId' => 'The unique identifier for the task that applies the mitigation action.
', 'AuditMitigationActionsTaskMetadata$taskId' => 'The unique identifier for the task.
', 'CancelAuditMitigationActionsTaskRequest$taskId' => 'The unique identifier for the task that you want to cancel.
', 'CancelDetectMitigationActionsTaskRequest$taskId' => 'The unique identifier of the task.
', 'DescribeAuditMitigationActionsTaskRequest$taskId' => 'The unique identifier for the audit mitigation task.
', 'DescribeDetectMitigationActionsTaskRequest$taskId' => 'The unique identifier of the task.
', 'DetectMitigationActionExecution$taskId' => 'The unique identifier of the task.
', 'DetectMitigationActionsTaskSummary$taskId' => 'The unique identifier of the task.
', 'ListAuditMitigationActionsExecutionsRequest$taskId' => 'Specify this filter to limit results to actions for a specific audit mitigation actions task.
', 'ListDetectMitigationActionsExecutionsRequest$taskId' => 'The unique identifier of the task.
', 'StartAuditMitigationActionsTaskRequest$taskId' => 'A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.
', 'StartAuditMitigationActionsTaskResponse$taskId' => 'The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.
The unique identifier of the task.
', 'StartDetectMitigationActionsTaskResponse$taskId' => 'The unique identifier of the task.
', ], ], 'ModelStatus' => [ 'base' => NULL, 'refs' => [ 'BehaviorModelTrainingSummary$modelStatus' => 'The status of the behavior model.
', ], ], 'MqttClientId' => [ 'base' => NULL, 'refs' => [ 'MqttContext$clientId' => 'The value of the clientId key in an MQTT authorization request.
Specifies the MQTT context to use for the test authorizer request
', 'refs' => [ 'TestInvokeAuthorizerRequest$mqttContext' => 'Specifies a test MQTT authorization request.
', ], ], 'MqttHeaders' => [ 'base' => 'Specifies MQTT Version 5.0 headers information. For more information, see MQTT from Amazon Web Services IoT Core Developer Guide.
', 'refs' => [ 'RepublishAction$headers' => 'MQTT Version 5.0 headers information. For more information, see MQTT from the Amazon Web Services IoT Core Developer Guide.
', ], ], 'MqttPassword' => [ 'base' => NULL, 'refs' => [ 'MqttContext$password' => 'The value of the password key in an MQTT authorization request.
The value of the username key in an MQTT authorization request.
Named shadow indexing mode. Valid values are:
ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.
OFF - Named shadow indexing is disabled.
For more information about Shadows, see IoT Device Shadow service.
', ], ], 'NamedShadowNamesFilter' => [ 'base' => NULL, 'refs' => [ 'IndexingFilter$namedShadowNames' => 'The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
', ], ], 'NamespaceId' => [ 'base' => NULL, 'refs' => [ 'AssociateTargetsWithJobRequest$namespaceId' => 'The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
The token for the next set of results.
', 'GetBehaviorModelTrainingSummariesResponse$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.
', '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.
', 'ListAuditMitigationActionsExecutionsResponse$nextToken' => 'The token for the next set of results.
', 'ListAuditMitigationActionsTasksRequest$nextToken' => 'The token for the next set of results.
', 'ListAuditMitigationActionsTasksResponse$nextToken' => 'The token for the next set of results.
', 'ListAuditSuppressionsRequest$nextToken' => 'The token for the next set of results.
', 'ListAuditSuppressionsResponse$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.
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional results.
', 'ListCustomMetricsRequest$nextToken' => 'The token for the next set of results.
', 'ListCustomMetricsResponse$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.
', 'ListDetectMitigationActionsExecutionsResponse$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.
', 'ListDetectMitigationActionsTasksResponse$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.
', 'ListDimensionsResponse$nextToken' => 'A token that can be used to retrieve the next set of results, or null if there are no additional results.
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token for the next set of results. Will not be returned if the operation has returned all results.
', 'ListIndicesRequest$nextToken' => 'The token used to get 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.
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.
', 'ListJobTemplatesRequest$nextToken' => 'The token to use to return the next set of results in the list.
', 'ListJobTemplatesResponse$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.
', 'ListManagedJobTemplatesRequest$nextToken' => 'The token to retrieve the next set of results.
', 'ListManagedJobTemplatesResponse$nextToken' => 'The token to retrieve the next set of results.
', 'ListMetricValuesRequest$nextToken' => 'The token for the next set of results.
', 'ListMetricValuesResponse$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.
', 'ListMitigationActionsResponse$nextToken' => 'The token for the next set of 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.
', 'ListPackageVersionsRequest$nextToken' => 'The token for the next set of results.
', 'ListPackageVersionsResponse$nextToken' => 'The token for the next set of results.
', 'ListPackagesRequest$nextToken' => 'The token for the next set of results.
', 'ListPackagesResponse$nextToken' => 'The token for the next set of results.
', 'ListPrincipalThingsRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional results.
', 'ListProvisioningTemplateVersionsRequest$nextToken' => 'A token to retrieve the next set of results.
', 'ListProvisioningTemplateVersionsResponse$nextToken' => 'A token to retrieve the next set of results.
', 'ListProvisioningTemplatesRequest$nextToken' => 'A token to retrieve the next set of results.
', 'ListProvisioningTemplatesResponse$nextToken' => 'A token to retrieve the next set of results.
', 'ListRelatedResourcesForAuditFindingRequest$nextToken' => 'A token that can be used to retrieve the next set of results, or null if there are no additional results.
A token that can be used to retrieve the next set of results, or null for the first API call.
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.
', 'ListTagsForResourceRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional 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.
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional results.
', 'ListThingGroupsRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results. Will not be returned if operation has returned all results.
', 'ListThingPrincipalsRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional results.
', 'ListThingRegistrationTaskReportsRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional results.
', 'ListThingRegistrationTasksRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional results.
', 'ListThingTypesRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token for the next set of results. Will not be returned if operation has returned all results.
', 'ListThingsInBillingGroupRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results. Will not be returned if operation has returned all results.
', 'ListThingsInThingGroupRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional results.
', 'ListThingsRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results. Will not be returned if operation has returned all results.
', 'ListTopicRuleDestinationsRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional results.
', 'ListTopicRulesRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get the next set of results, or null if there are no additional results.
', 'ListV2LoggingLevelsRequest$nextToken' => 'To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use 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.
The token used to get the next set of results, or null if there are no additional results.
The number of checks that found noncompliant resources.
', ], ], 'NonCompliantResource' => [ 'base' => 'Information about the resource that was noncompliant with the audit check.
', 'refs' => [ 'AuditFinding$nonCompliantResource' => 'The resource that was found to be noncompliant with the audit check.
', ], ], 'NonCompliantResourcesCount' => [ 'base' => NULL, 'refs' => [ 'AuditCheckDetails$nonCompliantResourcesCount' => 'The number of resources that were found noncompliant during the check.
', ], ], 'NotConfiguredException' => [ 'base' => 'The resource is not configured.
', 'refs' => [], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'AddThingsToThingGroupParams$overrideDynamicGroups' => 'Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.
', 'StartDetectMitigationActionsTaskRequest$includeOnlyActiveViolations' => 'Specifies to list only active violations.
', 'StartDetectMitigationActionsTaskRequest$includeSuppressedAlerts' => 'Specifies to include suppressed alerts.
', ], ], 'Number' => [ 'base' => NULL, 'refs' => [ 'MetricValue$number' => 'The numeral value of a metric.
', 'NumberList$member' => NULL, ], ], 'NumberList' => [ 'base' => NULL, 'refs' => [ 'MetricValue$numbers' => 'The numeral values of a metric.
', ], ], 'NumberOfRetries' => [ 'base' => NULL, 'refs' => [ 'RetryCriteria$numberOfRetries' => 'The number of retries allowed for a failure type for the job.
', ], ], 'NumberOfThings' => [ 'base' => NULL, 'refs' => [ 'RateIncreaseCriteria$numberOfNotifiedThings' => 'The threshold for number of notified things that will initiate the increase in rate of rollout.
', 'RateIncreaseCriteria$numberOfSucceededThings' => 'The threshold for number of succeeded things that will initiate the increase in rate of rollout.
', ], ], '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 ID of the OTA update 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.
', ], ], 'OpenSearchAction' => [ 'base' => 'Describes an action that writes data to an Amazon OpenSearch Service domain.
', 'refs' => [ 'Action$openSearch' => 'Write data to an Amazon OpenSearch Service domain.
', ], ], 'Optional' => [ 'base' => NULL, 'refs' => [ 'DocumentParameter$optional' => 'Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
', ], ], 'OptionalVersion' => [ 'base' => NULL, 'refs' => [ 'DeleteBillingGroupRequest$expectedVersion' => 'The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException.
The expected version of the dynamic thing group to delete.
', 'DeleteFleetMetricRequest$expectedVersion' => 'The expected version of the fleet metric to delete.
', '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 from 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 billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException.
The expected version of the dynamic thing group to update.
', 'UpdateFleetMetricRequest$expectedVersion' => 'The expected version of the fleet metric record in the registry.
', 'UpdateSecurityProfileRequest$expectedVersion' => 'The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
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.
', ], ], 'OverrideDynamicGroups' => [ 'base' => NULL, 'refs' => [ 'AddThingToThingGroupRequest$overrideDynamicGroups' => 'Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
', 'UpdateThingGroupsForThingRequest$overrideDynamicGroups' => 'Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
', ], ], 'PackageArn' => [ 'base' => NULL, 'refs' => [ 'CreatePackageResponse$packageArn' => 'The Amazon Resource Name (ARN) for the package.
', 'GetPackageResponse$packageArn' => 'The ARN for the package.
', ], ], 'PackageCatalogMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsRequest$maxResults' => 'The maximum number of results to return at one time.
', 'ListPackagesRequest$maxResults' => 'The maximum number of results returned at one time.
', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$packageName' => 'The name of the new package.
', 'CreatePackageResponse$packageName' => 'The name of the package.
', 'CreatePackageVersionRequest$packageName' => 'The name of the associated package.
', 'CreatePackageVersionResponse$packageName' => 'The name of the associated package.
', 'DeletePackageRequest$packageName' => 'The name of the target package.
', 'DeletePackageVersionRequest$packageName' => 'The name of the associated package.
', 'GetPackageRequest$packageName' => 'The name of the target package.
', 'GetPackageResponse$packageName' => 'The name of the package.
', 'GetPackageVersionRequest$packageName' => 'The name of the associated package.
', 'GetPackageVersionResponse$packageName' => 'The name of the package.
', 'ListPackageVersionsRequest$packageName' => 'The name of the target package.
', 'PackageSummary$packageName' => 'The name for the target package.
', 'PackageVersionSummary$packageName' => 'The name of the associated software package.
', 'UpdatePackageRequest$packageName' => 'The name of the target package.
', 'UpdatePackageVersionRequest$packageName' => 'The name of the associated software package.
', ], ], 'PackageSummary' => [ 'base' => 'A summary of information about a software package.
', 'refs' => [ 'PackageSummaryList$member' => NULL, ], ], 'PackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackagesResponse$packageSummaries' => 'The software package summary.
', ], ], 'PackageVersionAction' => [ 'base' => NULL, 'refs' => [ 'UpdatePackageVersionRequest$action' => 'The status that the package version should be assigned. For more information, see Package version lifecycle.
', ], ], 'PackageVersionArn' => [ 'base' => NULL, 'refs' => [ 'CreatePackageVersionResponse$packageVersionArn' => 'The Amazon Resource Name (ARN) for the package.
', 'DestinationPackageVersions$member' => NULL, 'GetPackageVersionResponse$packageVersionArn' => 'The ARN for the package version.
', ], ], 'PackageVersionErrorReason' => [ 'base' => NULL, 'refs' => [ 'CreatePackageVersionResponse$errorReason' => 'Error reason for a package version failure during creation or update.
', 'GetPackageVersionResponse$errorReason' => 'Error reason for a package version failure during creation or update.
', ], ], 'PackageVersionStatus' => [ 'base' => NULL, 'refs' => [ 'CreatePackageVersionResponse$status' => 'The status of the package version. For more information, see Package version lifecycle.
', 'GetPackageVersionResponse$status' => 'The status associated to the package version. For more information, see Package version lifecycle.
', 'ListPackageVersionsRequest$status' => 'The status of the package version. For more information, see Package version lifecycle.
', 'PackageVersionSummary$status' => 'The status of the package version. For more information, see Package version lifecycle.
', ], ], 'PackageVersionSummary' => [ 'base' => 'A summary of information about a package version.
', 'refs' => [ 'PackageVersionSummaryList$member' => NULL, ], ], 'PackageVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsResponse$packageVersionSummaries' => 'Lists the package versions associated to the package.
', ], ], '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.
', 'ListDomainConfigurationsRequest$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, ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'DocumentParameter$key' => 'Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
', 'ParameterMap$key' => NULL, ], ], 'ParameterMap' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$documentParameters' => 'Parameters of an Amazon Web Services managed template that you can specify to create the job document.
documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can\'t be used with custom job templates or to create jobs from them.
A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.
documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can\'t be used with custom job templates or to create jobs from them.
The parameters for provisioning a thing. See Provisioning Templates 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.
', ], ], 'PayloadFormatIndicator' => [ 'base' => NULL, 'refs' => [ 'MqttHeaders$payloadFormatIndicator' => 'An Enum string value that indicates whether the payload is formatted as UTF-8.
Valid values are UNSPECIFIED_BYTES and UTF8_DATA.
For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates.
', ], ], 'PayloadVersion' => [ 'base' => NULL, 'refs' => [ 'ProvisioningHook$payloadVersion' => 'The payload that was sent to the target function.
Note: Only Lambda functions are currently supported.
', ], ], 'Percent' => [ 'base' => NULL, 'refs' => [ 'PercentList$member' => NULL, 'PercentPair$percent' => 'The percentile.
', ], ], 'PercentList' => [ 'base' => NULL, 'refs' => [ 'GetPercentilesRequest$percents' => 'The percentile groups returned.
', ], ], 'PercentPair' => [ 'base' => 'Describes the percentile and percentile value.
', 'refs' => [ 'Percentiles$member' => NULL, ], ], 'PercentValue' => [ 'base' => NULL, 'refs' => [ 'PercentPair$value' => 'The value of the percentile.
', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'DescribeThingRegistrationTaskResponse$percentageProgress' => 'The progress of the bulk provisioning task expressed as a percentage.
', ], ], 'Percentiles' => [ 'base' => NULL, 'refs' => [ 'GetPercentilesResponse$percentiles' => 'The percentile values of the aggregated fields.
', ], ], '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 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. For example, a thing group or a certificate.
', 'DetachPolicyRequest$target' => 'The target from which the policy will be detached.
', 'ListAttachedPoliciesRequest$target' => 'The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
', 'PolicyTargets$member' => NULL, ], ], 'PolicyTargets' => [ 'base' => NULL, 'refs' => [ 'ListTargetsForPolicyResponse$targets' => 'The policy targets.
', ], ], 'PolicyTemplateName' => [ 'base' => NULL, 'refs' => [ 'ReplaceDefaultPolicyVersionParams$templateName' => 'The name of the template to be applied. The only supported value is BLANK_POLICY.
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.
', 'CreateJobTemplateRequest$presignedUrlConfig' => NULL, 'DescribeJobTemplateResponse$presignedUrlConfig' => NULL, 'Job$presignedUrlConfig' => 'Configuration for pre-signed S3 URLs.
', 'UpdateJobRequest$presignedUrlConfig' => 'Configuration information for pre-signed S3 URLs.
', ], ], 'PrimitiveBoolean' => [ 'base' => NULL, 'refs' => [ 'DetectMitigationActionsTaskSummary$onlyActiveViolationsIncluded' => 'Includes only active violations.
', 'DetectMitigationActionsTaskSummary$suppressedAlertsIncluded' => 'Includes suppressed alerts.
', ], ], '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, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
', 'DetachPrincipalPolicyRequest$principal' => 'The principal.
Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
', '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. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
', 'ListPrincipalPoliciesRequest$principal' => 'The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
', 'ListPrincipalThingsRequest$principal' => 'The principal.
', 'TestAuthorizationRequest$principal' => 'The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
', ], ], '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.
', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'Protocols$member' => NULL, ], ], 'Protocols' => [ 'base' => NULL, 'refs' => [ 'CreateOTAUpdateRequest$protocols' => 'The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
', 'OTAUpdateInfo$protocols' => 'The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
', ], ], 'ProvisioningHook' => [ 'base' => 'Structure that contains payloadVersion and targetArn.
Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.
Gets information about a pre-provisioned hook.
', 'UpdateProvisioningTemplateRequest$preProvisioningHook' => 'Updates the pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.
A list of provisioning templates
', ], ], 'ProvisioningTemplateSummary' => [ 'base' => 'A summary of information about a provisioning template.
', 'refs' => [ 'ProvisioningTemplateListing$member' => NULL, ], ], 'ProvisioningTemplateVersionListing' => [ 'base' => NULL, 'refs' => [ 'ListProvisioningTemplateVersionsResponse$versions' => 'The list of provisioning template versions.
', ], ], 'ProvisioningTemplateVersionSummary' => [ 'base' => 'A summary of information about a fleet provision template version.
', 'refs' => [ 'ProvisioningTemplateVersionListing$member' => NULL, ], ], '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.
', ], ], 'PublishFindingToSnsParams' => [ 'base' => 'Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.
', 'refs' => [ 'MitigationActionParams$publishFindingToSnsParams' => 'Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.
', ], ], 'PutAssetPropertyValueEntry' => [ 'base' => 'An asset property value entry containing the following information.
', 'refs' => [ 'PutAssetPropertyValueEntryList$member' => NULL, ], ], 'PutAssetPropertyValueEntryList' => [ 'base' => NULL, 'refs' => [ 'IotSiteWiseAction$putAssetPropertyValueEntries' => 'A list of asset property value entries.
', ], ], '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.
', ], ], 'PutVerificationStateOnViolationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVerificationStateOnViolationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Qos' => [ 'base' => NULL, 'refs' => [ 'RepublishAction$qos' => 'The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
', ], ], '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' => [ 'CreateDynamicThingGroupRequest$queryString' => 'The dynamic thing group search query string.
See Query Syntax for information about query string syntax.
', 'CreateDynamicThingGroupResponse$queryString' => 'The dynamic thing group search query string.
', 'CreateFleetMetricRequest$queryString' => 'The search query string.
', 'DescribeFleetMetricResponse$queryString' => 'The search query string.
', 'DescribeThingGroupResponse$queryString' => 'The dynamic thing group search query string.
', 'GetBucketsAggregationRequest$queryString' => 'The search query string.
', 'GetCardinalityRequest$queryString' => 'The search query string.
', 'GetPercentilesRequest$queryString' => 'The search query string.
', 'GetStatisticsRequest$queryString' => 'The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.
', 'SearchIndexRequest$queryString' => 'The search query string. For more information about the search query syntax, see Query syntax.
', 'UpdateDynamicThingGroupRequest$queryString' => 'The dynamic thing group search query string to update.
', 'UpdateFleetMetricRequest$queryString' => 'The search query string.
', ], ], 'QueryVersion' => [ 'base' => NULL, 'refs' => [ 'CreateDynamicThingGroupRequest$queryVersion' => 'The dynamic thing group query version.
Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
The dynamic thing group query version.
', 'CreateFleetMetricRequest$queryVersion' => 'The query version.
', 'DescribeFleetMetricResponse$queryVersion' => 'The query version.
', 'DescribeThingGroupResponse$queryVersion' => 'The dynamic thing group query version.
', 'GetBucketsAggregationRequest$queryVersion' => 'The version of the query.
', 'GetCardinalityRequest$queryVersion' => 'The query version.
', 'GetPercentilesRequest$queryVersion' => 'The query version.
', 'GetStatisticsRequest$queryVersion' => 'The version of the query used to search.
', 'SearchIndexRequest$queryVersion' => 'The query version.
', 'UpdateDynamicThingGroupRequest$queryVersion' => 'The dynamic thing group query version to update.
Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
The version of the query.
', ], ], '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.
', ], ], 'RateIncreaseCriteria' => [ 'base' => 'Allows you to define a criteria to initiate the increase in rate of rollout for a job.
', 'refs' => [ 'ExponentialRolloutRate$rateIncreaseCriteria' => 'The criteria to initiate the increase in rate of rollout for a job.
', ], ], 'ReasonCode' => [ 'base' => NULL, 'refs' => [ 'CancelJobRequest$reasonCode' => '(Optional)A reason code string that explains why the job was canceled.
', 'Job$reasonCode' => 'If the job was updated, provides the reason code for the update.
', ], ], 'ReasonForNonCompliance' => [ 'base' => NULL, 'refs' => [ 'AuditFinding$reasonForNonCompliance' => 'The reason the resource was noncompliant.
', ], ], 'ReasonForNonComplianceCode' => [ 'base' => NULL, 'refs' => [ 'AuditFinding$reasonForNonComplianceCode' => 'A code that indicates the reason that the resource was noncompliant.
', 'ReasonForNonComplianceCodes$member' => NULL, ], ], 'ReasonForNonComplianceCodes' => [ 'base' => NULL, 'refs' => [ 'AuditCheckToReasonCodeFilter$value' => NULL, ], ], 'Recursive' => [ 'base' => NULL, 'refs' => [ 'ListAttachedPoliciesRequest$recursive' => 'When true, recursively list attached policies.
', 'ListSecurityProfilesForTargetRequest$recursive' => 'If true, return child groups too.
', '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.
', ], ], 'Regex' => [ 'base' => NULL, 'refs' => [ 'DocumentParameter$regex' => 'A regular expression of the patterns that need to be replaced in a managed template job document schema.
', ], ], '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' => [], ], 'RegisterCertificateWithoutCARequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterCertificateWithoutCAResponse' => [ 'base' => NULL, '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' => [ 'ListBillingGroupsRequest$maxResults' => 'The maximum number of results to return per request.
', '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.
', 'ListThingPrincipalsRequest$maxResults' => 'The maximum number of results to return in this operation.
', '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.
', 'ListThingsInBillingGroupRequest$maxResults' => 'The maximum number of results to return per request.
', '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.
', 'ListRelatedResourcesForAuditFindingResponse$relatedResources' => 'The related resources.
', ], ], 'RemoveAuthorizerConfig' => [ 'base' => NULL, 'refs' => [ 'UpdateDomainConfigurationRequest$removeAuthorizerConfig' => 'Removes the authorization configuration from a domain.
', ], ], 'RemoveAutoRegistration' => [ 'base' => NULL, 'refs' => [ 'UpdateCACertificateRequest$removeAutoRegistration' => 'If true, removes auto registration.
', ], ], 'RemoveHook' => [ 'base' => NULL, 'refs' => [ 'UpdateProvisioningTemplateRequest$removePreProvisioningHook' => 'Removes pre-provisioning hook template.
', ], ], 'RemoveThingFromBillingGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveThingFromBillingGroupResponse' => [ 'base' => NULL, 'refs' => [], ], '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.
', ], ], 'ReplaceDefaultPolicyVersionParams' => [ 'base' => 'Parameters to define a mitigation action that adds a blank policy to restrict permissions.
', 'refs' => [ 'MitigationActionParams$replaceDefaultPolicyVersionParams' => 'Parameters to define a mitigation action that adds a blank policy to restrict permissions.
', ], ], '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.
', ], ], 'ReservedDomainConfigurationName' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainConfigurationRequest$domainConfigurationName' => 'The name of the domain configuration.
', 'DescribeDomainConfigurationResponse$domainConfigurationName' => 'The name of the domain configuration.
', 'DomainConfigurationSummary$domainConfigurationName' => 'The name of the domain configuration. This value must be unique to a region.
', 'UpdateDomainConfigurationRequest$domainConfigurationName' => 'The name of the domain configuration to be updated.
', 'UpdateDomainConfigurationResponse$domainConfigurationName' => 'The name of the domain configuration that was updated.
', ], ], 'Resource' => [ 'base' => NULL, 'refs' => [ 'Resources$member' => NULL, ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'The resource already exists.
', 'refs' => [], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$resourceArn' => 'The ARN of the resource.
', 'ResourceArns$value' => NULL, 'TagResourceRequest$resourceArn' => 'The ARN of the resource.
', 'UntagResourceRequest$resourceArn' => 'The ARN of the resource.
', ], ], 'ResourceArns' => [ 'base' => NULL, 'refs' => [ 'RegisterThingResponse$resourceArns' => 'ARNs for the generated resources.
', ], ], 'ResourceAttributeKey' => [ 'base' => NULL, 'refs' => [ 'ResourceAttributes$key' => NULL, ], ], 'ResourceAttributeValue' => [ 'base' => NULL, 'refs' => [ 'ResourceAttributes$value' => NULL, ], ], 'ResourceAttributes' => [ 'base' => NULL, 'refs' => [ 'CreatePackageVersionRequest$attributes' => 'Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.
The combined size of all the attributes on a package version is limited to 3KB.
', 'CreatePackageVersionResponse$attributes' => 'Metadata that were added to the package version that can be used to define a package version’s configuration.
', 'GetPackageVersionResponse$attributes' => 'Metadata that were added to the package version that can be used to define a package version’s configuration.
', 'UpdatePackageVersionRequest$attributes' => 'Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.
Note: Attributes can be updated only when the package version is in a draft state.
The combined size of all the attributes on a package version is limited to 3KB.
', ], ], 'ResourceDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$description' => 'A summary of the package being created. This can be used to outline the package\'s contents or purpose.
', 'CreatePackageResponse$description' => 'The package description.
', 'CreatePackageVersionRequest$description' => 'A summary of the package version being created. This can be used to outline the package\'s contents or purpose.
', 'CreatePackageVersionResponse$description' => 'The package version description.
', 'GetPackageResponse$description' => 'The package description.
', 'GetPackageVersionResponse$description' => 'The package version description.
', 'UpdatePackageRequest$description' => 'The package description.
', 'UpdatePackageVersionRequest$description' => 'The package version description.
', ], ], 'ResourceIdentifier' => [ 'base' => 'Information that identifies the noncompliant resource.
', 'refs' => [ 'AuditSuppression$resourceIdentifier' => NULL, 'CreateAuditSuppressionRequest$resourceIdentifier' => NULL, 'DeleteAuditSuppressionRequest$resourceIdentifier' => NULL, 'DescribeAuditSuppressionRequest$resourceIdentifier' => NULL, 'DescribeAuditSuppressionResponse$resourceIdentifier' => NULL, 'ListAuditFindingsRequest$resourceIdentifier' => 'Information identifying the noncompliant resource.
', 'ListAuditSuppressionsRequest$resourceIdentifier' => NULL, 'NonCompliantResource$resourceIdentifier' => 'Information that identifies the noncompliant resource.
', 'RelatedResource$resourceIdentifier' => 'Information that identifies the resource.
', 'UpdateAuditSuppressionRequest$resourceIdentifier' => NULL, ], ], '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 noncompliant 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.
', ], ], 'ResponseTopic' => [ 'base' => NULL, 'refs' => [ 'MqttHeaders$responseTopic' => 'A UTF-8 encoded string that\'s used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic from the MQTT Version 5.0 specification.
Supports substitution templates.
', ], ], 'RetryAttempt' => [ 'base' => NULL, 'refs' => [ 'JobExecutionSummary$retryAttempt' => 'The number that indicates how many retry attempts have been completed for this job on this device.
', ], ], 'RetryCriteria' => [ 'base' => 'The criteria that determines how many retries are allowed for each failure type for a job.
', 'refs' => [ 'RetryCriteriaList$member' => NULL, ], ], 'RetryCriteriaList' => [ 'base' => NULL, 'refs' => [ 'JobExecutionsRetryConfig$criteriaList' => 'The list of criteria that determines how many retries are allowed for each failure type for a job.
', ], ], 'RetryableFailureType' => [ 'base' => NULL, 'refs' => [ 'RetryCriteria$failureType' => 'The type of job execution failures that can initiate a job retry.
', ], ], '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.
', 'ResourceIdentifier$roleAliasArn' => 'The ARN of the role alias that has overly permissive actions.
', '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.
', 'CreateMitigationActionRequest$roleArn' => 'The ARN of the IAM role that is used to apply the mitigation action.
', 'CreateOTAUpdateRequest$roleArn' => 'The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
', 'CreateProvisioningTemplateRequest$provisioningRoleArn' => 'The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.
', 'CreateRoleAliasRequest$roleArn' => 'The role ARN.
', 'CreateStreamRequest$roleArn' => 'An IAM role that allows the IoT service principal to access your S3 files.
', 'DescribeAccountAuditConfigurationResponse$roleArn' => 'The ARN of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
On the first call to UpdateAccountAuditConfiguration, this parameter is required.
The ARN of the IAM role used to apply this action.
', 'DescribeProvisioningTemplateResponse$provisioningRoleArn' => 'The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
', 'DescribeThingRegistrationTaskResponse$roleArn' => 'The role ARN that grants access to the input file bucket.
', 'EnableIoTLoggingParams$roleArnForLogging' => 'The Amazon Resource Name (ARN) of the IAM role used for logging.
', 'MitigationAction$roleArn' => 'The IAM role ARN used to apply this mitigation action.
', 'PresignedUrlConfig$roleArn' => 'The ARN of an IAM role that 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.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.
The ARN of the role.
', 'ResourceIdentifier$iamRoleArn' => 'The ARN of the IAM role that has overly permissive actions.
', 'RoleAliasDescription$roleArn' => 'The role ARN.
', 'StartThingRegistrationTaskRequest$roleArn' => 'The IAM role ARN that grants permission the input file.
', 'StreamInfo$roleArn' => 'An IAM role IoT assumes to access your S3 files.
', 'UpdateAccountAuditConfigurationRequest$roleArn' => 'The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
', 'UpdateMitigationActionRequest$roleArn' => 'The ARN of the IAM role that is used to apply the mitigation action.
', 'UpdateProvisioningTemplateRequest$provisioningRoleArn' => 'The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
', 'UpdateRoleAliasRequest$roleArn' => 'The role ARN.
', 'UpdateStreamRequest$roleArn' => 'An IAM role that allows the IoT service principal assumes to access your S3 files.
', 'VersionUpdateByJobsConfig$roleArn' => 'The Amazon Resource Name (ARN) of the role that grants permission to the IoT jobs service to update the reserved named shadow when the job successfully completes.
', ], ], 'RolloutRatePerMinute' => [ 'base' => NULL, 'refs' => [ 'ExponentialRolloutRate$baseRatePerMinute' => 'The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
', ], ], '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 IoT SQL Reference in the 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)
', ], ], 'ScheduledJobRollout' => [ 'base' => 'Displays the next seven maintenance window occurrences and their start times.
', 'refs' => [ 'ScheduledJobRolloutList$member' => NULL, ], ], 'ScheduledJobRolloutList' => [ 'base' => NULL, 'refs' => [ 'Job$scheduledJobRollouts' => 'Displays the next seven maintenance window occurrences and their start times.
', ], ], 'SchedulingConfig' => [ 'base' => 'Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end behavior for each job execution when it reaches the scheduled end time.
', 'refs' => [ 'CreateJobRequest$schedulingConfig' => 'The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.
', 'Job$schedulingConfig' => 'The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.
', ], ], '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.
', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupList$member' => NULL, ], ], 'SecurityGroupList' => [ 'base' => NULL, 'refs' => [ 'VpcDestinationConfiguration$securityGroups' => 'The security groups of the VPC destination.
', 'VpcDestinationProperties$securityGroups' => 'The security groups of the VPC destination.
', 'VpcDestinationSummary$securityGroups' => 'The security groups of the VPC destination.
', ], ], 'SecurityPolicy' => [ 'base' => NULL, 'refs' => [ 'TlsConfig$securityPolicy' => 'The security policy for a domain configuration. For more information, see Security policies in the Amazon Web Services IoT Core developer guide.
', ], ], '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 with the behavior is in violation.
', 'AttachSecurityProfileRequest$securityProfileName' => 'The security profile that is attached.
', 'BehaviorModelTrainingSummary$securityProfileName' => 'The name of the security profile.
', '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.
', 'DetectMitigationActionsTaskTarget$securityProfileName' => 'The name of the security profile.
', 'GetBehaviorModelTrainingSummariesRequest$securityProfileName' => 'The name of the security profile.
', '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\'ve 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.
', ], ], 'ServerCertificateArns' => [ 'base' => NULL, 'refs' => [ 'CreateDomainConfigurationRequest$serverCertificateArns' => 'The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.
', ], ], 'ServerCertificateStatus' => [ 'base' => NULL, 'refs' => [ 'ServerCertificateSummary$serverCertificateStatus' => 'The status of the server certificate.
', ], ], 'ServerCertificateStatusDetail' => [ 'base' => NULL, 'refs' => [ 'ServerCertificateSummary$serverCertificateStatusDetail' => 'Details that explain the status of the server certificate.
', ], ], 'ServerCertificateSummary' => [ 'base' => 'An object that contains information about a server certificate.
', 'refs' => [ 'ServerCertificates$member' => NULL, ], ], 'ServerCertificates' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainConfigurationResponse$serverCertificates' => 'A list containing summary information about the server certificate included in the domain configuration.
', ], ], 'ServerName' => [ 'base' => NULL, 'refs' => [ 'TlsContext$serverName' => 'The value of the serverName key in a TLS authorization request.
The service name to use while signing with Sig V4.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'A limit has been exceeded.
', 'refs' => [], ], 'ServiceType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainConfigurationRequest$serviceType' => 'The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the DATA service type.
The type of service delivered by the endpoint.
', 'DomainConfigurationSummary$serviceType' => 'The type of service delivered by the endpoint.
', 'ListDomainConfigurationsRequest$serviceType' => 'The type of service delivered by the endpoint.
', ], ], '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.
Valid values: ACTIVE | INACTIVE
A boolean value that specifies if the certificate is set to active.
Valid values: ACTIVE | INACTIVE
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).
', 'CreateProvisioningTemplateVersionRequest$setAsDefault' => 'Sets a fleet provision template version as the default version.
', ], ], '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' => [], ], 'ShadowName' => [ 'base' => NULL, 'refs' => [ 'NamedShadowNamesFilter$member' => NULL, ], ], 'SigV4Authorization' => [ 'base' => 'For more information, see Signature Version 4 signing process.
', 'refs' => [ 'HttpAuthorization$sigv4' => 'Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process.
', ], ], '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. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses ECDSA or RSA, so you can pass either of them based on which was used for generating the signature.
The ID of the AWSSignerJob which was created to sign the file.
The code-signing profile name.
', ], ], 'SigningProfileParameter' => [ 'base' => 'Describes the code-signing profile.
', 'refs' => [ 'StartSigningJobParameter$signingProfileParameter' => 'Describes the code-signing profile.
', ], ], 'SigningRegion' => [ 'base' => NULL, 'refs' => [ 'SigV4Authorization$signingRegion' => 'The signing region.
', ], ], 'SkippedFindingsCount' => [ 'base' => NULL, 'refs' => [ 'TaskStatisticsForAuditCheck$skippedFindingsCount' => 'The number of findings skipped because of filter conditions provided in the parameters to the command.
', ], ], '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.
', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'PublishFindingToSnsParams$topicArn' => 'The ARN of the topic to which you want to publish the findings.
', ], ], '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.
', ], ], 'StartAuditMitigationActionsTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAuditMitigationActionsTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDetectMitigationActionsTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDetectMitigationActionsTaskResponse' => [ 'base' => NULL, 'refs' => [], ], '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.
', ], ], 'StatisticalThreshold' => [ 'base' => 'A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
', 'refs' => [ 'BehaviorCriteria$statisticalThreshold' => 'A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
', ], ], 'Statistics' => [ 'base' => 'A map of key-value pairs for all supported statistics. For issues with missing or unexpected values for this API, consult Fleet indexing troubleshooting guide.
', 'refs' => [ 'GetStatisticsResponse$statistics' => 'The statistics returned by the Fleet Indexing service based on the query and aggregation field.
', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'DescribeThingRegistrationTaskResponse$status' => 'The status of the bulk thing provisioning task.
', 'ListThingRegistrationTasksRequest$status' => 'The status of the bulk thing provisioning task.
', ], ], 'StdDeviation' => [ 'base' => NULL, 'refs' => [ 'Statistics$stdDeviation' => 'The standard deviation of the aggregated field values.
', ], ], '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' => [ 'ClientProperties$key' => NULL, 'ClientProperties$value' => NULL, '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.
', 'CreateTopicRuleRequest$tags' => 'Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
The Kafka topic for messages to be sent to the Kafka broker.
', 'KafkaAction$key' => 'The Kafka message key.
', 'KafkaAction$partition' => 'The Kafka message partition.
', 'LocationAction$trackerName' => 'The name of the tracker resource in Amazon Location in which the location is updated.
', 'LocationAction$deviceId' => 'The unique ID of the device providing the location data.
', 'LocationAction$latitude' => 'A string that evaluates to a double value that represents the latitude of the device\'s location.
', 'LocationAction$longitude' => 'A string that evaluates to a double value that represents the longitude of the device\'s location.
', 'LocationTimestamp$value' => 'An expression that returns a long epoch time value.
', 'LocationTimestamp$unit' => 'The precision of the timestamp value that results from the expression described in value.
Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The default is MILLISECONDS.
Additional details or reason why the topic rule destination is in the current status.
', 'TopicRuleDestinationSummary$statusReason' => 'The reason the topic rule destination is in the current status.
', ], ], 'StringDateTime' => [ 'base' => NULL, 'refs' => [ 'ScheduledJobRollout$startTime' => 'Displays the start times of the next seven maintenance window occurrences.
', 'SchedulingConfig$startTime' => 'The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for the time.
The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time.
The string values of a metric.
', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'NonCompliantResource$additionalInfo' => 'Other information about the noncompliant resource.
', 'RelatedResource$additionalInfo' => 'Other information about the resource.
', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIdList$member' => NULL, ], ], 'SubnetIdList' => [ 'base' => NULL, 'refs' => [ 'VpcDestinationConfiguration$subnetIds' => 'The subnet IDs of the VPC destination.
', 'VpcDestinationProperties$subnetIds' => 'The subnet IDs of the VPC destination.
', 'VpcDestinationSummary$subnetIds' => 'The subnet IDs of the VPC destination.
', ], ], 'SucceededFindingsCount' => [ 'base' => NULL, 'refs' => [ 'TaskStatisticsForAuditCheck$succeededFindingsCount' => 'The number of findings for which all mitigation actions succeeded when applied.
', ], ], 'SucceededThings' => [ 'base' => NULL, 'refs' => [ 'JobProcessDetails$numberOfSucceededThings' => 'The number of things which successfully completed the job.
', ], ], 'Sum' => [ 'base' => NULL, 'refs' => [ 'Statistics$sum' => 'The sum of the aggregated field values.
', ], ], 'SumOfSquares' => [ 'base' => NULL, 'refs' => [ 'Statistics$sumOfSquares' => 'The sum of the squares of the aggregated field values.
', ], ], 'SuppressAlerts' => [ 'base' => NULL, 'refs' => [ 'Behavior$suppressAlerts' => 'Suppresses alerts.
', ], ], 'SuppressIndefinitely' => [ 'base' => NULL, 'refs' => [ 'AuditSuppression$suppressIndefinitely' => 'Indicates whether a suppression should exist indefinitely or not.
', 'CreateAuditSuppressionRequest$suppressIndefinitely' => 'Indicates whether a suppression should exist indefinitely or not.
', 'DescribeAuditSuppressionResponse$suppressIndefinitely' => 'Indicates whether a suppression should exist indefinitely or not.
', 'UpdateAuditSuppressionRequest$suppressIndefinitely' => 'Indicates whether a suppression should exist indefinitely or not.
', ], ], 'SuppressedNonCompliantResourcesCount' => [ 'base' => NULL, 'refs' => [ 'AuditCheckDetails$suppressedNonCompliantResourcesCount' => 'Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.
', ], ], 'TableName' => [ 'base' => NULL, 'refs' => [ 'DynamoDBAction$tableName' => 'The name of the DynamoDB table.
', 'PutItemInput$tableName' => 'The table where the message data will be written.
', ], ], 'Tag' => [ 'base' => 'A set of key/value pairs that are used to manage the resource.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The tag\'s key.
', 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'A list of the keys of the tags to be removed from the resource.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateAuthorizerRequest$tags' => 'Metadata which can be used to manage the custom authorizer.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Metadata which can be used to manage the billing group.
', 'CreateCustomMetricRequest$tags' => 'Metadata that can be used to manage the custom metric.
', 'CreateDimensionRequest$tags' => 'Metadata that can be used to manage the dimension.
', 'CreateDomainConfigurationRequest$tags' => 'Metadata which can be used to manage the domain configuration.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Metadata which can be used to manage the dynamic thing group.
', 'CreateFleetMetricRequest$tags' => 'Metadata, which can be used to manage the fleet metric.
', 'CreateJobRequest$tags' => 'Metadata which can be used to manage the job.
', 'CreateJobTemplateRequest$tags' => 'Metadata that can be used to manage the job template.
', 'CreateMitigationActionRequest$tags' => 'Metadata that can be used to manage the mitigation action.
', 'CreateOTAUpdateRequest$tags' => 'Metadata which can be used to manage updates.
', 'CreatePolicyRequest$tags' => 'Metadata which can be used to manage the policy.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Metadata which can be used to manage the provisioning template.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Metadata which can be used to manage the role alias.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Metadata that can be used to manage the scheduled audit.
', 'CreateSecurityProfileRequest$tags' => 'Metadata that can be used to manage the security profile.
', 'CreateStreamRequest$tags' => 'Metadata which can be used to manage streams.
', 'CreateThingGroupRequest$tags' => 'Metadata which can be used to manage the thing group.
', 'CreateThingTypeRequest$tags' => 'Metadata which can be used to manage the thing type.
', 'ListTagsForResourceResponse$tags' => 'The list of tags assigned to the resource.
', 'RegisterCACertificateRequest$tags' => 'Metadata which can be used to manage the CA certificate.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
The new or modified tags for the resource.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$tags' => 'Metadata that can be used to manage the package.
', 'CreatePackageVersionRequest$tags' => 'Metadata that can be used to manage the package version.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The tag\'s value.
', 'TagMap$value' => NULL, ], ], '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, 'ProvisioningHook$targetArn' => 'The ARN of the target function.
Note: Only Lambda functions are currently supported.
', ], ], '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 use 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 use 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 use 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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
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.
', ], ], 'TargetViolationIdsForDetectMitigationActions' => [ 'base' => NULL, 'refs' => [ 'DetectMitigationActionsTaskTarget$violationIds' => 'The unique identifiers of the violations.
', ], ], 'Targets' => [ 'base' => NULL, 'refs' => [ 'CreateOTAUpdateRequest$targets' => 'The devices targeted to receive OTA updates.
', 'OTAUpdateInfo$targets' => 'The targets of the OTA update.
', ], ], 'TaskAlreadyExistsException' => [ 'base' => 'This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.
', 'refs' => [], ], '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.
', ], ], 'TaskStatisticsForAuditCheck' => [ 'base' => 'Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.
', 'refs' => [ 'AuditMitigationActionsTaskStatistics$value' => NULL, ], ], 'TemplateArn' => [ 'base' => NULL, 'refs' => [ 'CreateProvisioningTemplateResponse$templateArn' => 'The ARN that identifies the provisioning template.
', 'CreateProvisioningTemplateVersionResponse$templateArn' => 'The ARN that identifies the provisioning template.
', 'DescribeProvisioningTemplateResponse$templateArn' => 'The ARN of the provisioning template.
', 'ProvisioningTemplateSummary$templateArn' => 'The ARN of the provisioning template.
', ], ], 'TemplateBody' => [ 'base' => NULL, 'refs' => [ 'CreateProvisioningTemplateRequest$templateBody' => 'The JSON formatted contents of the provisioning template.
', 'CreateProvisioningTemplateVersionRequest$templateBody' => 'The JSON formatted contents of the provisioning template.
', 'DescribeProvisioningTemplateResponse$templateBody' => 'The JSON formatted contents of the provisioning template.
', 'DescribeProvisioningTemplateVersionResponse$templateBody' => 'The JSON formatted contents of the provisioning template version.
', 'DescribeThingRegistrationTaskResponse$templateBody' => 'The task\'s template.
', 'RegisterThingRequest$templateBody' => 'The provisioning template. See Provisioning Devices That Have Device Certificates for more information.
', 'RegistrationConfig$templateBody' => 'The template body.
', 'StartThingRegistrationTaskRequest$templateBody' => 'The provisioning template.
', ], ], 'TemplateDescription' => [ 'base' => NULL, 'refs' => [ 'CreateProvisioningTemplateRequest$description' => 'The description of the provisioning template.
', 'DescribeProvisioningTemplateResponse$description' => 'The description of the provisioning template.
', 'ProvisioningTemplateSummary$description' => 'The description of the provisioning template.
', 'UpdateProvisioningTemplateRequest$description' => 'The description of the provisioning template.
', ], ], 'TemplateName' => [ 'base' => NULL, 'refs' => [ 'CreateProvisioningClaimRequest$templateName' => 'The name of the provisioning template to use.
', 'CreateProvisioningTemplateRequest$templateName' => 'The name of the provisioning template.
', 'CreateProvisioningTemplateResponse$templateName' => 'The name of the provisioning template.
', 'CreateProvisioningTemplateVersionRequest$templateName' => 'The name of the provisioning template.
', 'CreateProvisioningTemplateVersionResponse$templateName' => 'The name of the provisioning template.
', 'DeleteProvisioningTemplateRequest$templateName' => 'The name of the fleet provision template to delete.
', 'DeleteProvisioningTemplateVersionRequest$templateName' => 'The name of the provisioning template version to delete.
', 'DescribeProvisioningTemplateRequest$templateName' => 'The name of the provisioning template.
', 'DescribeProvisioningTemplateResponse$templateName' => 'The name of the provisioning template.
', 'DescribeProvisioningTemplateVersionRequest$templateName' => 'The template name.
', 'ListCACertificatesRequest$templateName' => 'The name of the provisioning template.
', 'ListProvisioningTemplateVersionsRequest$templateName' => 'The name of the provisioning template.
', 'ProvisioningTemplateSummary$templateName' => 'The name of the provisioning template.
', 'RegistrationConfig$templateName' => 'The name of the provisioning template.
', 'UpdateProvisioningTemplateRequest$templateName' => 'The name of the provisioning template.
', ], ], 'TemplateType' => [ 'base' => NULL, 'refs' => [ 'CreateProvisioningTemplateRequest$type' => 'The type you define in a provisioning template. You can create a template with only one type. You can\'t change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.
The type you define in a provisioning template. You can create a template with only one type. You can\'t change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.
The type you define in a provisioning template. You can create a template with only one type. You can\'t change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.
The default version of the provisioning template.
', 'CreateProvisioningTemplateVersionResponse$versionId' => 'The version of the provisioning template.
', 'DeleteProvisioningTemplateVersionRequest$versionId' => 'The provisioning template version ID to delete.
', 'DescribeProvisioningTemplateResponse$defaultVersionId' => 'The default fleet template version ID.
', 'DescribeProvisioningTemplateVersionRequest$versionId' => 'The provisioning template version ID.
', 'DescribeProvisioningTemplateVersionResponse$versionId' => 'The provisioning template version ID.
', 'ProvisioningTemplateVersionSummary$versionId' => 'The ID of the fleet provisioning template version.
', 'UpdateProvisioningTemplateRequest$defaultVersionId' => 'The ID of the default provisioning template version.
', ], ], 'TermsAggregation' => [ 'base' => 'Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.
', 'refs' => [ 'BucketsAggregationType$termsAggregation' => 'Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.
', ], ], 'TestAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestAuthorizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'TestInvokeAuthorizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestInvokeAuthorizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'ThingArn' => [ 'base' => NULL, 'refs' => [ 'AddThingToBillingGroupRequest$thingArn' => 'The ARN of the thing to be added to the billing group.
', '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.
', 'RemoveThingFromBillingGroupRequest$thingArn' => 'The ARN of the thing to be removed from the billing group.
', '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.
', ], ], 'ThingConnectivity' => [ 'base' => 'The connectivity status of the thing.
', 'refs' => [ 'ThingDocument$connectivity' => 'Indicates whether the thing is connected to the Amazon Web Services IoT Core service.
', ], ], 'ThingConnectivityIndexingMode' => [ 'base' => NULL, 'refs' => [ 'ThingIndexingConfiguration$thingConnectivityIndexingMode' => 'Thing connectivity indexing mode. Valid values are:
STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.
OFF - Thing connectivity status indexing is disabled.
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.
', 'CreateDynamicThingGroupResponse$thingGroupArn' => 'The dynamic thing group ARN.
', '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' => [ 'CreateDynamicThingGroupResponse$thingGroupId' => 'The dynamic thing group ID.
', '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.
', 'CreateDynamicThingGroupRequest$thingGroupName' => 'The dynamic thing group name to create.
', 'CreateDynamicThingGroupResponse$thingGroupName' => 'The dynamic thing group name.
', 'CreateThingGroupRequest$thingGroupName' => 'The thing group name to create.
', 'CreateThingGroupRequest$parentGroupName' => 'The name of the parent thing group.
', 'CreateThingGroupResponse$thingGroupName' => 'The thing group name.
', 'DeleteDynamicThingGroupRequest$thingGroupName' => 'The name of the dynamic thing group to delete.
', '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, 'ThingGroupNames$member' => NULL, 'UpdateDynamicThingGroupRequest$thingGroupName' => 'The name of the dynamic thing group to update.
', '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.
', ], ], 'ThingGroupNames' => [ 'base' => NULL, 'refs' => [ 'AddThingsToThingGroupParams$thingGroupNames' => 'The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can\'t add a thing to more than one group in the same hierarchy.
', ], ], 'ThingGroupProperties' => [ 'base' => 'Thing group properties.
', 'refs' => [ 'CreateDynamicThingGroupRequest$thingGroupProperties' => 'The dynamic thing group properties.
', 'CreateThingGroupRequest$thingGroupProperties' => 'The thing group properties.
', 'DescribeThingGroupResponse$thingGroupProperties' => 'The thing group properties.
', 'UpdateDynamicThingGroupRequest$thingGroupProperties' => 'The dynamic thing group properties to update.
', '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' => 'The thing indexing configuration. For more information, see Managing Thing Indexing.
', '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 contains registry data only.
REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
OFF - Thing indexing is disabled.
The name of the thing to be added to the billing group.
', '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.
You can\'t change a thing\'s name after you create it. To change a thing\'s name, you must create a new thing, give it the new name, and then delete the old thing.
', '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.
', 'ListJobExecutionsForThingRequest$thingName' => 'The thing name.
', 'ListThingGroupsForThingRequest$thingName' => 'The thing name.
', 'ListThingPrincipalsRequest$thingName' => 'The name of the thing.
', 'RemoveThingFromBillingGroupRequest$thingName' => 'The name of the thing to be removed from the billing group.
', '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.
You can\'t change a thing\'s name. To change a thing\'s name, you must create a new thing, give it the new name, and then delete the old thing.
', ], ], 'ThingNameList' => [ 'base' => NULL, 'refs' => [ 'ListPrincipalThingsResponse$things' => 'The things.
', 'ListThingsInBillingGroupResponse$things' => 'A list of things in the billing group.
', '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' => [], ], 'TimedOutThings' => [ 'base' => NULL, 'refs' => [ 'JobProcessDetails$numberOfTimedOutThings' => 'The number of things whose job execution status is TIMED_OUT.
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.
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.
', 'AuditMitigationActionExecutionMetadata$startTime' => 'The date and time when the task was started.
', 'AuditMitigationActionExecutionMetadata$endTime' => 'The date and time when the task was completed or canceled. Blank if the task is still running.
', 'AuditMitigationActionsTaskMetadata$startTime' => 'The time at which the audit mitigation actions task was started.
', 'AuditSuppression$expirationDate' => 'The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.
', 'BehaviorModelTrainingSummary$trainingDataCollectionStartDate' => 'The date a training model started collecting data.
', 'BehaviorModelTrainingSummary$lastModelRefreshDate' => 'The date the model was last refreshed.
', 'CreateAuditSuppressionRequest$expirationDate' => 'The epoch timestamp in seconds at which this suppression expires.
', 'DescribeAuditMitigationActionsTaskResponse$startTime' => 'The date and time when the task was started.
', 'DescribeAuditMitigationActionsTaskResponse$endTime' => 'The date and time when the task was completed or canceled.
', 'DescribeAuditSuppressionResponse$expirationDate' => 'The epoch timestamp in seconds at which this suppression expires.
', 'DescribeAuditTaskResponse$taskStartTime' => 'The time the audit started.
', 'DescribeCustomMetricResponse$creationDate' => 'The creation date of the custom metric in milliseconds since epoch.
', 'DescribeCustomMetricResponse$lastModifiedDate' => 'The time the custom metric was last modified in milliseconds since epoch.
', 'DescribeDimensionResponse$creationDate' => 'The date the dimension was created.
', 'DescribeDimensionResponse$lastModifiedDate' => 'The date the dimension was last modified.
', 'DescribeMitigationActionResponse$creationDate' => 'The date and time when the mitigation action was added to your Amazon Web Services accounts.
', 'DescribeMitigationActionResponse$lastModifiedDate' => 'The date and time when the mitigation action was last changed.
', 'DescribeSecurityProfileResponse$creationDate' => 'The time the security profile was created.
', 'DescribeSecurityProfileResponse$lastModifiedDate' => 'The time the security profile was last modified.
', 'DetectMitigationActionExecution$executionStartDate' => 'The date a mitigation action was started.
', 'DetectMitigationActionExecution$executionEndDate' => 'The date a mitigation action ended.
', 'DetectMitigationActionsTaskSummary$taskStartTime' => 'The date the task started.
', 'DetectMitigationActionsTaskSummary$taskEndTime' => 'The date the task ended.
', '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.
', 'ListAuditMitigationActionsTasksRequest$startTime' => 'Specify this filter to limit results to tasks that began on or after a specific date and time.
', 'ListAuditMitigationActionsTasksRequest$endTime' => 'Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.
', 'ListAuditTasksRequest$startTime' => 'The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".
', 'ListAuditTasksRequest$endTime' => 'The end of the time period.
', 'ListDetectMitigationActionsExecutionsRequest$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.
', 'ListDetectMitigationActionsExecutionsRequest$endTime' => 'The end of the time period for which ML Detect mitigation actions executions are returned.
', 'ListDetectMitigationActionsTasksRequest$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.
', 'ListDetectMitigationActionsTasksRequest$endTime' => 'The end of the time period for which ML Detect mitigation actions tasks are returned.
', 'ListMetricValuesRequest$startTime' => 'The start of the time period for which metric values are returned.
', 'ListMetricValuesRequest$endTime' => 'The end of the time period for which metric values are returned.
', 'ListViolationEventsRequest$startTime' => 'The start time for the alerts to be listed.
', 'ListViolationEventsRequest$endTime' => 'The end time for the alerts to be listed.
', 'MetricDatum$timestamp' => 'The time the metric value was reported.
', 'MitigationActionIdentifier$creationDate' => 'The date when this mitigation action was created.
', 'UpdateAuditSuppressionRequest$expirationDate' => 'The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.
', 'UpdateCustomMetricResponse$creationDate' => 'The creation date of the custom metric in milliseconds since epoch.
', 'UpdateCustomMetricResponse$lastModifiedDate' => 'The time the custom metric was last modified in milliseconds since epoch.
', 'UpdateDimensionResponse$creationDate' => 'The date and time, in milliseconds since epoch, when the dimension was initially created.
', 'UpdateDimensionResponse$lastModifiedDate' => 'The date and time, in milliseconds since epoch, when the dimension was most recently updated.
', '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.
', 'ViolationEventOccurrenceRange$startTime' => 'The start date and time of a time period in which violation events occurred.
', 'ViolationEventOccurrenceRange$endTime' => 'The end date and time of a time period in which violation events occurred.
', ], ], 'TimestreamAction' => [ 'base' => 'The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.
', 'refs' => [ 'Action$timestream' => 'The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.
', ], ], 'TimestreamDatabaseName' => [ 'base' => NULL, 'refs' => [ 'TimestreamAction$databaseName' => 'The name of an Amazon Timestream database.
', ], ], 'TimestreamDimension' => [ 'base' => 'Metadata attributes of the time series that are written in each measure record.
', 'refs' => [ 'TimestreamDimensionList$member' => NULL, ], ], 'TimestreamDimensionList' => [ 'base' => NULL, 'refs' => [ 'TimestreamAction$dimensions' => 'Metadata attributes of the time series that are written in each measure record.
', ], ], 'TimestreamDimensionName' => [ 'base' => NULL, 'refs' => [ 'TimestreamDimension$name' => 'The metadata dimension name. This is the name of the column in the Amazon Timestream database table record.
Dimensions cannot be named: measure_name, measure_value, or time. These names are reserved. Dimension names cannot start with ts_ or measure_value and they cannot contain the colon (:) character.
The value to write in this column of the database record.
', ], ], 'TimestreamTableName' => [ 'base' => NULL, 'refs' => [ 'TimestreamAction$tableName' => 'The name of the database table into which to write the measure records.
', ], ], 'TimestreamTimestamp' => [ 'base' => 'Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
', 'refs' => [ 'TimestreamAction$timestamp' => 'Specifies an application-defined value to replace the default value assigned to the Timestream record\'s timestamp in the time column.
You can use this property to specify the value and the precision of the Timestream record\'s timestamp. You can specify a value from the message payload or a value computed by a substitution template.
If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it processed the rule.
', ], ], 'TimestreamTimestampUnit' => [ 'base' => NULL, 'refs' => [ 'TimestreamTimestamp$unit' => 'The precision of the timestamp value that results from the expression described in value.
Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The default is MILLISECONDS.
An expression that returns a long epoch time value.
', ], ], 'TinyMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetBehaviorModelTrainingSummariesRequest$maxResults' => 'The maximum number of results to return at one time. The default is 10.
', ], ], 'TlsConfig' => [ 'base' => 'An object that specifies the TLS configuration for a domain.
', 'refs' => [ 'CreateDomainConfigurationRequest$tlsConfig' => 'An object that specifies the TLS configuration for a domain.
', 'DescribeDomainConfigurationResponse$tlsConfig' => 'An object that specifies the TLS configuration for a domain.
', 'UpdateDomainConfigurationRequest$tlsConfig' => 'An object that specifies the TLS configuration for a domain.
', ], ], 'TlsContext' => [ 'base' => 'Specifies the TLS context to use for the test authorizer request.
', 'refs' => [ 'TestInvokeAuthorizerRequest$tlsContext' => 'Specifies a test TLS authorization request.
', ], ], '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. This value must be Base-64-encoded.
', ], ], '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.
', ], ], 'TopicRuleDestination' => [ 'base' => 'A topic rule destination.
', 'refs' => [ 'CreateTopicRuleDestinationResponse$topicRuleDestination' => 'The topic rule destination.
', 'GetTopicRuleDestinationResponse$topicRuleDestination' => 'The topic rule destination.
', ], ], 'TopicRuleDestinationConfiguration' => [ 'base' => 'Configuration of the topic rule destination.
', 'refs' => [ 'CreateTopicRuleDestinationRequest$destinationConfiguration' => 'The topic rule destination configuration.
', ], ], 'TopicRuleDestinationMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListTopicRuleDestinationsRequest$maxResults' => 'The maximum number of results to return at one time.
', ], ], 'TopicRuleDestinationStatus' => [ 'base' => NULL, 'refs' => [ 'TopicRuleDestination$status' => 'The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.
Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.
Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.
Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
Information about a topic rule destination.
', ], ], 'TopicRuleDestinationSummary' => [ 'base' => 'Information about the topic rule destination.
', 'refs' => [ 'TopicRuleDestinationSummaries$member' => NULL, ], ], 'TopicRuleList' => [ 'base' => NULL, 'refs' => [ 'ListTopicRulesResponse$rules' => 'The rules.
', ], ], 'TopicRuleListItem' => [ 'base' => 'Describes a rule.
', 'refs' => [ 'TopicRuleList$member' => NULL, ], ], 'TopicRuleMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListTopicRulesRequest$maxResults' => 'The maximum number of results to return.
', ], ], '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.
', ], ], 'TotalFindingsCount' => [ 'base' => NULL, 'refs' => [ 'TaskStatisticsForAuditCheck$totalFindingsCount' => 'The total number of findings to which a task is being applied.
', ], ], '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 Amazon Web Services 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.
', ], ], 'UnsetDefaultVersion' => [ 'base' => NULL, 'refs' => [ 'UpdatePackageRequest$unsetDefaultVersion' => 'Indicates whether you want to remove the named default package version from the software package. Set as true to remove the default package version.
Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true at the same time.
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
', 'refs' => [ 'MitigationActionParams$updateCACertificateParams' => 'Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
', ], ], 'UpdateCACertificateRequest' => [ 'base' => 'The input to the UpdateCACertificate operation.
', 'refs' => [], ], 'UpdateCertificateRequest' => [ 'base' => 'The input for the UpdateCertificate operation.
', 'refs' => [], ], 'UpdateCustomMetricRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCustomMetricResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceCertificateParams' => [ 'base' => 'Parameters to define a mitigation action that changes the state of the device certificate to inactive.
', 'refs' => [ 'MitigationActionParams$updateDeviceCertificateParams' => 'Parameters to define a mitigation action that changes the state of the device certificate to inactive.
', ], ], 'UpdateDimensionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDimensionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDynamicThingGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDynamicThingGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFleetMetricRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIndexingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIndexingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMitigationActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMitigationActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisioningTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisioningTemplateResponse' => [ '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' => [], ], 'UpdateTopicRuleDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicRuleDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'HttpAction$url' => 'The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.
The URL to which IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
', 'HttpUrlDestinationConfiguration$confirmationUrl' => 'The URL IoT uses to confirm ownership of or access to the topic rule destination URL.
', 'HttpUrlDestinationProperties$confirmationUrl' => 'The URL used to confirm the HTTP topic rule destination URL.
', 'HttpUrlDestinationSummary$confirmationUrl' => 'The URL used to confirm ownership of or access to the HTTP topic rule destination URL.
', ], ], 'UseBase64' => [ 'base' => NULL, 'refs' => [ 'SqsAction$useBase64' => 'Specifies whether to use Base64 encoding.
', ], ], 'UserProperties' => [ 'base' => NULL, 'refs' => [ 'MqttHeaders$userProperties' => 'An array of key-value pairs that you define in the MQTT5 header.
', ], ], 'UserProperty' => [ 'base' => 'A key-value pair that you define in the header. Both the key and the value are either literal strings or valid substitution templates.
', 'refs' => [ 'UserProperties$member' => NULL, ], ], 'UserPropertyKey' => [ 'base' => NULL, 'refs' => [ 'UserProperty$key' => 'A key to be specified in UserProperty.
A value to be specified in UserProperty.
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.
', ], ], 'ValidationException' => [ 'base' => 'The request is not valid.
', 'refs' => [], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'AdditionalParameterMap$value' => NULL, 'AttributesMap$value' => NULL, 'Parameters$value' => NULL, ], ], 'Variance' => [ 'base' => NULL, 'refs' => [ 'Statistics$variance' => 'The variance of the aggregated field values.
', ], ], 'VerificationState' => [ 'base' => NULL, 'refs' => [ 'ActiveViolation$verificationState' => 'The verification state of the violation (detect alarm).
', 'ListActiveViolationsRequest$verificationState' => 'The verification state of the violation (detect alarm).
', 'ListViolationEventsRequest$verificationState' => 'The verification state of the violation (detect alarm).
', 'PutVerificationStateOnViolationRequest$verificationState' => 'The verification state of the violation.
', 'ViolationEvent$verificationState' => 'The verification state of the violation (detect alarm).
', ], ], 'VerificationStateDescription' => [ 'base' => NULL, 'refs' => [ 'ActiveViolation$verificationStateDescription' => 'The description of the verification state of the violation.
', 'PutVerificationStateOnViolationRequest$verificationStateDescription' => 'The description of the verification state of the violation (detect alarm).
', 'ViolationEvent$verificationStateDescription' => 'The description of the verification state of the violation.
', ], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'DescribeBillingGroupResponse$version' => 'The version of the billing group.
', 'DescribeFleetMetricResponse$version' => 'The version of the fleet metric.
', '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.
', 'UpdateBillingGroupResponse$version' => 'The latest version of the billing group.
', 'UpdateDynamicThingGroupResponse$version' => 'The dynamic thing group version.
', '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 name of the new package version.
', 'CreatePackageVersionResponse$versionName' => 'The name of the new package version.
', 'DeletePackageVersionRequest$versionName' => 'The name of the target package version.
', 'GetPackageResponse$defaultVersionName' => 'The name of the default package version.
', 'GetPackageVersionRequest$versionName' => 'The name of the target package version.
', 'GetPackageVersionResponse$versionName' => 'The name of the package version.
', 'PackageSummary$defaultVersionName' => 'The name of the default package version.
', 'PackageVersionSummary$versionName' => 'The name of the target package version.
', 'UpdatePackageRequest$defaultVersionName' => 'The name of the default package version.
Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true at the same time.
The name of the target package version.
', ], ], 'VersionNumber' => [ 'base' => NULL, 'refs' => [ 'JobExecution$versionNumber' => 'The version of the job execution. Job execution versions are incremented each time they are updated by a device.
', ], ], 'VersionUpdateByJobsConfig' => [ 'base' => 'Configuration to manage IoT Job\'s package version reporting. If configured, Jobs updates the thing\'s reserved named shadow with the package version information up on successful job completion.
Note: For each job, the destinationPackageVersions attribute has to be set with the correct data for Jobs to report to the thing shadow.
', 'refs' => [ 'GetPackageConfigurationResponse$versionUpdateByJobsConfig' => 'The version that is associated to a specific job.
', 'UpdatePackageConfigurationRequest$versionUpdateByJobsConfig' => 'Configuration to manage job\'s package version reporting. This updates the thing\'s reserved named shadow that the job targets.
', ], ], '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, ], ], 'ViolationEventAdditionalInfo' => [ 'base' => 'The details of a violation event.
', 'refs' => [ 'ActiveViolation$violationEventAdditionalInfo' => 'The details of a violation event.
', 'ViolationEvent$violationEventAdditionalInfo' => 'The details of a violation event.
', ], ], 'ViolationEventOccurrenceRange' => [ 'base' => 'Specifies the time period of which violation events occurred between.
', 'refs' => [ 'DetectMitigationActionsTaskSummary$violationEventOccurrenceRange' => 'Specifies the time period of which violation events occurred between.
', 'StartDetectMitigationActionsTaskRequest$violationEventOccurrenceRange' => 'Specifies the time period of which violation events occurred between.
', ], ], '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 period, potentially filtered by security profile, behavior violated, or thing (device) violating.
', ], ], 'ViolationId' => [ 'base' => NULL, 'refs' => [ 'ActiveViolation$violationId' => 'The ID of the active violation.
', 'DetectMitigationActionExecution$violationId' => 'The unique identifier of the violation.
', 'ListDetectMitigationActionsExecutionsRequest$violationId' => 'The unique identifier of the violation.
', 'PutVerificationStateOnViolationRequest$violationId' => 'The violation ID.
', 'TargetViolationIdsForDetectMitigationActions$member' => NULL, 'ViolationEvent$violationId' => 'The ID of the violation event.
', ], ], 'VpcDestinationConfiguration' => [ 'base' => 'The configuration information for a virtual private cloud (VPC) destination.
', 'refs' => [ 'TopicRuleDestinationConfiguration$vpcConfiguration' => 'Configuration of the virtual private cloud (VPC) connection.
', ], ], 'VpcDestinationProperties' => [ 'base' => 'The properties of a virtual private cloud (VPC) destination.
', 'refs' => [ 'TopicRuleDestination$vpcProperties' => 'Properties of the virtual private cloud (VPC) connection.
', ], ], 'VpcDestinationSummary' => [ 'base' => 'The summary of a virtual private cloud (VPC) destination.
', 'refs' => [ 'TopicRuleDestinationSummary$vpcDestinationSummary' => 'Information about the virtual private cloud (VPC) connection.
', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'VpcDestinationConfiguration$vpcId' => 'The ID of the VPC.
', 'VpcDestinationProperties$vpcId' => 'The ID of the VPC.
', 'VpcDestinationSummary$vpcId' => 'The ID of the VPC.
', ], ], '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.
', 'ConflictException$message' => NULL, '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.
', 'InternalServerException$message' => NULL, 'InvalidAggregationException$message' => NULL, '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.
', 'ServiceQuotaExceededException$message' => NULL, 'ServiceUnavailableException$message' => 'The message for the exception.
', 'SqlParseException$message' => 'The message for the exception.
', 'TaskAlreadyExistsException$message' => NULL, '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.
', 'ValidationException$message' => NULL, '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' => [ 'ConflictException$resourceId' => 'A resource with the same name already exists.
', 'ResourceAlreadyExistsException$resourceId' => 'The ID of the resource that caused the exception.
', ], ], 'stringValue' => [ 'base' => NULL, 'refs' => [ 'StringList$member' => NULL, ], ], 'usePrefixAttributeValue' => [ 'base' => NULL, 'refs' => [ 'ListThingsRequest$usePrefixAttributeValue' => 'When true, the action returns the thing resources with attribute values that start with the attributeValue provided.
When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.