"documentation":"<p>Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.</p> <p>To check for pending certificate transfers, call <a>ListCertificates</a> to enumerate your certificates.</p>"
"documentation":"<p>Associates a group with a continuous job. The following criteria must be met: </p> <ul> <li> <p>The job must have been created with the <code>targetSelection</code> field set to \"CONTINUOUS\".</p> </li> <li> <p>The job status must currently be \"IN_PROGRESS\".</p> </li> <li> <p>The total number of targets associated with a job must not exceed 100.</p> </li> </ul>"
},
"AttachPolicy":{
"name":"AttachPolicy",
"http":{
"method":"PUT",
"requestUri":"/target-policies/{policyName}"
},
"input":{"shape":"AttachPolicyRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalFailureException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Attaches a policy to the specified target.</p>"
"documentation":"<p>Attaches the specified policy to the specified principal (certificate or other credential).</p> <p> <b>Note:</b> This API is deprecated. Please use <a>AttachPolicy</a> instead.</p>",
"documentation":"<p>Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.</p>"
"documentation":"<p>Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an \"InvalidRequestException\" occurs.</p>"
"documentation":"<p>Cancels a pending transfer for the specified certificate.</p> <p> <b>Note</b> Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use <a>RejectCertificateTransfer</a> instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.</p> <p>After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.</p>"
"documentation":"<p>Creates an X.509 certificate using the specified certificate signing request.</p> <p> <b>Note:</b> 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. </p> <p> <b>Note:</b> Reusing the same certificate signing request (CSR) results in a distinct certificate.</p> <p>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.</p> <p>Assuming a set of CSRs are located inside of the directory my-csr-directory:</p> <p>On Linux and OS X, the command is:</p> <p>$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.</p> <p>The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:</p> <p>$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}</p> <p>On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path\"</p>"
"documentation":"<p>Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.</p> <p> <b>Note</b> This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.</p>"
"documentation":"<p>Creates an AWS IoT policy.</p> <p>The created policy is the default version for the policy. This operation creates a policy version with a version identifier of <b>1</b> and sets <b>1</b> as the policy's default version.</p>"
"documentation":"<p>Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use <a>DeletePolicyVersion</a> to delete an existing version before you create a new one.</p> <p>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).</p>"
"documentation":"<p>Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.</p>"
"documentation":"<p>Creates a thing record in the registry.</p> <note> <p>This is a control plane operation. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
"documentation":"<p>Create a thing group.</p> <note> <p>This is a control plane operation. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
"documentation":"<p>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.</p>"
"documentation":"<p>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. </p>"
"documentation":"<p>Deletes the specified certificate.</p> <p>A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the <a>DetachPrincipalPolicy</a> API to detach all policies. Next, use the <a>UpdateCertificate</a> API to set the certificate to the INACTIVE status.</p>"
"documentation":"<p>Deletes a job and its related job executions.</p> <p>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.</p> <p>Only 10 jobs may have status \"DELETION_IN_PROGRESS\" at the same time, or a LimitExceededException will occur.</p>"
"documentation":"<p>Deletes the specified policy.</p> <p>A policy cannot be deleted if it has non-default versions or it is attached to any certificate.</p> <p>To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.</p> <p>When a policy is deleted using DeletePolicy, its default version is deleted with it.</p>"
"documentation":"<p>Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use ListPolicyVersions.</p>"
"documentation":"<p>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 <a>DeprecateThingType</a>, then remove any associated things by calling <a>UpdateThing</a> to change the thing type on any associated thing, and finally use <a>DeleteThingType</a> to delete the thing type.</p>"
"documentation":"<p>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.</p>"
},
"DescribeAuditTask":{
"name":"DescribeAuditTask",
"http":{
"method":"GET",
"requestUri":"/audit/tasks/{taskId}"
},
"input":{"shape":"DescribeAuditTaskRequest"},
"output":{"shape":"DescribeAuditTaskResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Gets information about a Device Defender audit.</p>"
"documentation":"<p>Removes the specified policy from the specified certificate.</p> <p> <b>Note:</b> This API is deprecated. Please use <a>DetachPolicy</a> instead.</p>",
"documentation":"<p>Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.</p>"
"documentation":"<p>Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)</p>"
},
"ListAuditTasks":{
"name":"ListAuditTasks",
"http":{
"method":"GET",
"requestUri":"/audit/tasks"
},
"input":{"shape":"ListAuditTasksRequest"},
"output":{"shape":"ListAuditTasksResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists the Device Defender audits that have been performed during a given time period.</p>"
"documentation":"<p>Lists the CA certificates registered for your AWS account.</p> <p>The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.</p>"
"documentation":"<p>Lists the certificates registered in your AWS account.</p> <p>The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.</p>"
"documentation":"<p>Lists the principals associated with the specified policy.</p> <p> <b>Note:</b> This API is deprecated. Please use <a>ListTargetsForPolicy</a> instead.</p>",
"documentation":"<p>Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in <a href=\"http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax\">AmazonCognito Identity format</a>.</p> <p> <b>Note:</b> This API is deprecated. Please use <a>ListAttachedPolicies</a> instead.</p>",
"documentation":"<p>Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.</p>"
"documentation":"<p>Lists your things. Use the <b>attributeName</b> and <b>attributeValue</b> parameters to filter your things. For example, calling <code>ListThings</code> with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute <b>Color</b> with the value <b>Red</b>. </p>"
"documentation":"<p>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).</p>"
"documentation":"<p>Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.</p>"
"documentation":"<p>Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.</p>"
"documentation":"<p>Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from <b>PENDING_TRANSFER</b> to <b>INACTIVE</b>.</p> <p>To check for pending certificate transfers, call <a>ListCertificates</a> to enumerate your certificates.</p> <p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.</p>"
"documentation":"<p>Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.</p>"
"documentation":"<p>Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.</p>"
"documentation":"<p>Transfers the specified certificate to the specified AWS account.</p> <p>You can cancel the transfer until it is acknowledged by the recipient.</p> <p>No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.</p> <p>The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.</p> <p>The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Updates the status of the specified certificate. This operation is idempotent.</p> <p>Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.</p> <p>The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>A JSON string containing up to three key-value pair in JSON format. For example:</p> <p> <code>{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}</code> </p>"
"documentation":"<p>Specifies whether the list of attributes provided in the <code>AttributePayload</code> is merged with the attributes stored in the registry, instead of overwriting them.</p> <p>To remove an attribute, call <code>UpdateThing</code> with an empty attribute value.</p> <note> <p>The <code>merge</code> attribute is only valid when calling <code>UpdateThing</code>.</p> </note>"
"documentation":"<p>True if this audit check is enabled for this account.</p>"
}
},
"documentation":"<p>Which audit checks are enabled and disabled for this account.</p>"
},
"AuditCheckConfigurations":{
"type":"map",
"key":{"shape":"AuditCheckName"},
"value":{"shape":"AuditCheckConfiguration"}
},
"AuditCheckDetails":{
"type":"structure",
"members":{
"checkRunStatus":{
"shape":"AuditCheckRunStatus",
"documentation":"<p>The completion status of this check, one of \"IN_PROGRESS\", \"WAITING_FOR_DATA_COLLECTION\", \"CANCELED\", \"COMPLETED_COMPLIANT\", \"COMPLETED_NON_COMPLIANT\", or \"FAILED\".</p>"
},
"checkCompliant":{
"shape":"CheckCompliant",
"documentation":"<p>True if the check completed and found all resources compliant.</p>"
},
"totalResourcesCount":{
"shape":"TotalResourcesCount",
"documentation":"<p>The number of resources on which the check was performed.</p>"
},
"nonCompliantResourcesCount":{
"shape":"NonCompliantResourcesCount",
"documentation":"<p>The number of resources that the check found non-compliant.</p>"
},
"errorCode":{
"shape":"ErrorCode",
"documentation":"<p>The code of any error encountered when performing this check during this audit. One of \"INSUFFICIENT_PERMISSIONS\", or \"AUDIT_CHECK_DISABLED\".</p>"
},
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The message associated with any error encountered when performing this check during this audit.</p>"
}
},
"documentation":"<p>Information about the audit check.</p>"
},
"AuditCheckName":{
"type":"string",
"documentation":"<p>An audit check name. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
},
"AuditCheckRunStatus":{
"type":"string",
"enum":[
"IN_PROGRESS",
"WAITING_FOR_DATA_COLLECTION",
"CANCELED",
"COMPLETED_COMPLIANT",
"COMPLETED_NON_COMPLIANT",
"FAILED"
]
},
"AuditDetails":{
"type":"map",
"key":{"shape":"AuditCheckName"},
"value":{"shape":"AuditCheckDetails"}
},
"AuditFinding":{
"type":"structure",
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>The ID of the audit that generated this result (finding)</p>"
},
"checkName":{
"shape":"AuditCheckName",
"documentation":"<p>The audit check that generated this result.</p>"
},
"taskStartTime":{
"shape":"Timestamp",
"documentation":"<p>The time the audit started.</p>"
},
"findingTime":{
"shape":"Timestamp",
"documentation":"<p>The time the result (finding) was discovered.</p>"
},
"severity":{
"shape":"AuditFindingSeverity",
"documentation":"<p>The severity of the result (finding).</p>"
},
"nonCompliantResource":{
"shape":"NonCompliantResource",
"documentation":"<p>The resource that was found to be non-compliant with the audit check.</p>"
},
"relatedResources":{
"shape":"RelatedResources",
"documentation":"<p>The list of related resources.</p>"
},
"reasonForNonCompliance":{
"shape":"ReasonForNonCompliance",
"documentation":"<p>The reason the resource was non-compliant.</p>"
},
"reasonForNonComplianceCode":{
"shape":"ReasonForNonComplianceCode",
"documentation":"<p>A code which indicates the reason that the resource was non-compliant.</p>"
}
},
"documentation":"<p>The findings (results) of the audit.</p>"
},
"AuditFindingSeverity":{
"type":"string",
"enum":[
"CRITICAL",
"HIGH",
"MEDIUM",
"LOW"
]
},
"AuditFindings":{
"type":"list",
"member":{"shape":"AuditFinding"}
},
"AuditFrequency":{
"type":"string",
"enum":[
"DAILY",
"WEEKLY",
"BIWEEKLY",
"MONTHLY"
]
},
"AuditNotificationTarget":{
"type":"structure",
"members":{
"targetArn":{
"shape":"TargetArn",
"documentation":"<p>The ARN of the target (SNS topic) to which audit notifications are sent.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The ARN of the role that grants permission to send notifications to the target.</p>"
},
"enabled":{
"shape":"Enabled",
"documentation":"<p>True if notifications to the target are enabled.</p>"
}
},
"documentation":"<p>Information about the targets to which audit notifications are sent.</p>"
},
"AuditNotificationTargetConfigurations":{
"type":"map",
"key":{"shape":"AuditNotificationType"},
"value":{"shape":"AuditNotificationTarget"}
},
"AuditNotificationType":{
"type":"string",
"enum":["SNS"]
},
"AuditTaskId":{
"type":"string",
"max":40,
"min":1,
"pattern":"[a-zA-Z0-9\\-]+"
},
"AuditTaskMetadata":{
"type":"structure",
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>The ID of this audit.</p>"
},
"taskStatus":{
"shape":"AuditTaskStatus",
"documentation":"<p>The status of this audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\" or \"CANCELED\".</p>"
},
"taskType":{
"shape":"AuditTaskType",
"documentation":"<p>The type of this audit: one of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".</p>"
}
},
"documentation":"<p>The audits that were performed.</p>"
"documentation":"<p>The policies and statements that allowed the specified action.</p>"
},
"denied":{
"shape":"Denied",
"documentation":"<p>The policies and statements that denied the specified action.</p>"
},
"authDecision":{
"shape":"AuthDecision",
"documentation":"<p>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.</p>"
},
"missingContextValues":{
"shape":"MissingContextValues",
"documentation":"<p>Contains any missing context values found while evaluating policy.</p>"
}
},
"documentation":"<p>The authorizer result.</p>"
},
"AuthResults":{
"type":"list",
"member":{"shape":"AuthResult"}
},
"AuthorizerArn":{"type":"string"},
"AuthorizerDescription":{
"type":"structure",
"members":{
"authorizerName":{
"shape":"AuthorizerName",
"documentation":"<p>The authorizer name.</p>"
},
"authorizerArn":{
"shape":"AuthorizerArn",
"documentation":"<p>The authorizer ARN.</p>"
},
"authorizerFunctionArn":{
"shape":"AuthorizerFunctionArn",
"documentation":"<p>The authorizer's Lambda function ARN.</p>"
},
"tokenKeyName":{
"shape":"TokenKeyName",
"documentation":"<p>The key used to extract the token from the HTTP headers.</p>"
},
"tokenSigningPublicKeys":{
"shape":"PublicKeyMap",
"documentation":"<p>The public keys used to validate the token signature returned by your custom authentication service.</p>"
},
"status":{
"shape":"AuthorizerStatus",
"documentation":"<p>The status of the authorizer.</p>"
},
"creationDate":{
"shape":"DateType",
"documentation":"<p>The UNIX timestamp of when the authorizer was created.</p>"
},
"lastModifiedDate":{
"shape":"DateType",
"documentation":"<p>The UNIX timestamp of when the authorizer was last updated.</p>"
"documentation":"<p>The operator that relates the thing measured (<code>metric</code>) to the criteria (<code>value</code>).</p>"
},
"value":{
"shape":"MetricValue",
"documentation":"<p>The value to be compared with the <code>metric</code>.</p>"
},
"durationSeconds":{
"shape":"DurationSeconds",
"documentation":"<p>Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, <code>NUM_MESSAGES_SENT</code>).</p>"
}
},
"documentation":"<p>The criteria by which the behavior is determined to be normal.</p>"
"documentation":"<p>The date the CA certificate was created.</p>"
}
},
"documentation":"<p>A CA certificate.</p>"
},
"CACertificateDescription":{
"type":"structure",
"members":{
"certificateArn":{
"shape":"CertificateArn",
"documentation":"<p>The CA certificate ARN.</p>"
},
"certificateId":{
"shape":"CertificateId",
"documentation":"<p>The CA certificate ID.</p>"
},
"status":{
"shape":"CACertificateStatus",
"documentation":"<p>The status of a CA certificate.</p>"
},
"certificatePem":{
"shape":"CertificatePem",
"documentation":"<p>The CA certificate data, in PEM format.</p>"
},
"ownedBy":{
"shape":"AwsAccountId",
"documentation":"<p>The owner of the CA certificate.</p>"
},
"creationDate":{
"shape":"DateType",
"documentation":"<p>The date the CA certificate was created.</p>"
},
"autoRegistrationStatus":{
"shape":"AutoRegistrationStatus",
"documentation":"<p>Whether the CA certificate configured for auto registration of device certificates. Valid values are \"ENABLE\" and \"DISABLE\"</p>"
"documentation":"<p>The ID of the job to be canceled.</p>",
"location":"uri",
"locationName":"jobId"
},
"thingName":{
"shape":"ThingName",
"documentation":"<p>The name of the thing whose execution of the job will be canceled.</p>",
"location":"uri",
"locationName":"thingName"
},
"force":{
"shape":"ForceFlag",
"documentation":"<p>(Optional) If <code>true</code> 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 <code>force</code> to <code>true</code>, then an <code>InvalidStateTransitionException</code> will be thrown. The default is <code>false</code>.</p> <p>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.</p>",
"location":"querystring",
"locationName":"force"
},
"expectedVersion":{
"shape":"ExpectedVersion",
"documentation":"<p>(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.)</p>"
},
"statusDetails":{
"shape":"DetailsMap",
"documentation":"<p>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.</p>"
"documentation":"<p>(Optional) If <code>true</code> job executions with status \"IN_PROGRESS\" and \"QUEUED\" are canceled, otherwise only job executions with status \"QUEUED\" are canceled. The default is <code>false</code>.</p> <p>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.</p>",
"documentation":"<p>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.</p>",
"documentation":"<p>Specifies whether the certificate is active.</p>",
"location":"querystring",
"locationName":"setAsActive"
}
},
"documentation":"<p>The input for the CreateCertificateFromCsr operation.</p>"
},
"CreateCertificateFromCsrResponse":{
"type":"structure",
"members":{
"certificateArn":{
"shape":"CertificateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.</p>"
},
"certificateId":{
"shape":"CertificateId",
"documentation":"<p>The ID of the certificate. Certificate management operations only take a certificateId.</p>"
},
"certificatePem":{
"shape":"CertificatePem",
"documentation":"<p>The certificate data, in PEM format.</p>"
}
},
"documentation":"<p>The output from the CreateCertificateFromCsr operation.</p>"
},
"CreateJobRequest":{
"type":"structure",
"required":[
"jobId",
"targets"
],
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, \"-\" and \"_\" are valid for use here.</p>",
"location":"uri",
"locationName":"jobId"
},
"targets":{
"shape":"JobTargets",
"documentation":"<p>A list of things and thing groups to which the job should be sent.</p>"
},
"documentSource":{
"shape":"JobDocumentSource",
"documentation":"<p>An S3 link to the job document.</p>"
},
"document":{
"shape":"JobDocument",
"documentation":"<p>The job document.</p>"
},
"description":{
"shape":"JobDescription",
"documentation":"<p>A short text description of the job.</p>"
},
"presignedUrlConfig":{
"shape":"PresignedUrlConfig",
"documentation":"<p>Configuration information for pre-signed S3 URLs.</p>"
},
"targetSelection":{
"shape":"TargetSelection",
"documentation":"<p>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.</p>"
},
"jobExecutionsRolloutConfig":{
"shape":"JobExecutionsRolloutConfig",
"documentation":"<p>Allows you to create a staged rollout of the job.</p>"
}
}
},
"CreateJobResponse":{
"type":"structure",
"members":{
"jobArn":{
"shape":"JobArn",
"documentation":"<p>The job ARN.</p>"
},
"jobId":{
"shape":"JobId",
"documentation":"<p>The unique identifier you assigned to this job.</p>"
},
"description":{
"shape":"JobDescription",
"documentation":"<p>The job description.</p>"
}
}
},
"CreateKeysAndCertificateRequest":{
"type":"structure",
"members":{
"setAsActive":{
"shape":"SetAsActive",
"documentation":"<p>Specifies whether the certificate is active.</p>",
"location":"querystring",
"locationName":"setAsActive"
}
},
"documentation":"<p>The input for the CreateKeysAndCertificate operation.</p>"
},
"CreateKeysAndCertificateResponse":{
"type":"structure",
"members":{
"certificateArn":{
"shape":"CertificateArn",
"documentation":"<p>The ARN of the certificate.</p>"
"documentation":"<p>The ID of the OTA update to be created.</p>",
"location":"uri",
"locationName":"otaUpdateId"
},
"description":{
"shape":"OTAUpdateDescription",
"documentation":"<p>The description of the OTA update.</p>"
},
"targets":{
"shape":"Targets",
"documentation":"<p>The targeted devices to receive OTA updates.</p>"
},
"targetSelection":{
"shape":"TargetSelection",
"documentation":"<p>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.</p>"
},
"files":{
"shape":"OTAUpdateFiles",
"documentation":"<p>The files to be streamed by the OTA update.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The IAM role that allows access to the AWS IoT Jobs service.</p>"
},
"additionalParameters":{
"shape":"AdditionalParameterMap",
"documentation":"<p>A list of additional OTA update parameters which are name-value pairs.</p>"
}
}
},
"CreateOTAUpdateResponse":{
"type":"structure",
"members":{
"otaUpdateId":{
"shape":"OTAUpdateId",
"documentation":"<p>The OTA update ID.</p>"
},
"awsIotJobId":{
"shape":"AwsIotJobId",
"documentation":"<p>The AWS IoT job ID associated with the OTA update.</p>"
},
"otaUpdateArn":{
"shape":"OTAUpdateArn",
"documentation":"<p>The OTA update ARN.</p>"
},
"awsIotJobArn":{
"shape":"AwsIotJobArn",
"documentation":"<p>The AWS IoT job ARN associated with the OTA update.</p>"
"documentation":"<p>The JSON document that describes the policy. <b>policyDocument</b> must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.</p>"
"documentation":"<p>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).</p>",
"documentation":"<p>How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.</p>"
},
"dayOfMonth":{
"shape":"DayOfMonth",
"documentation":"<p>The day of the month on which the scheduled audit takes place. Can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to \"MONTHLY\". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.</p>"
},
"dayOfWeek":{
"shape":"DayOfWeek",
"documentation":"<p>The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".</p>"
},
"targetCheckNames":{
"shape":"TargetAuditCheckNames",
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
},
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name you want to give to the scheduled audit. (Max. 128 chars)</p>",
"location":"uri",
"locationName":"scheduledAuditName"
}
}
},
"CreateScheduledAuditResponse":{
"type":"structure",
"members":{
"scheduledAuditArn":{
"shape":"ScheduledAuditArn",
"documentation":"<p>The ARN of the scheduled audit.</p>"
}
}
},
"CreateSecurityProfileRequest":{
"type":"structure",
"required":[
"securityProfileName",
"behaviors"
],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name you are giving to the security profile.</p>",
"location":"uri",
"locationName":"securityProfileName"
},
"securityProfileDescription":{
"shape":"SecurityProfileDescription",
"documentation":"<p>A description of the security profile.</p>"
},
"behaviors":{
"shape":"Behaviors",
"documentation":"<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"
},
"alertTargets":{
"shape":"AlertTargets",
"documentation":"<p>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.</p>"
}
}
},
"CreateSecurityProfileResponse":{
"type":"structure",
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name you gave to the security profile.</p>"
},
"securityProfileArn":{
"shape":"SecurityProfileArn",
"documentation":"<p>The ARN of the security profile.</p>"
"documentation":"<p>The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:</p> <p> <code>{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}</code> </p>"
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>The input for the CreateThingType operation.</p>"
},
"CreateThingTypeResponse":{
"type":"structure",
"members":{
"thingTypeName":{
"shape":"ThingTypeName",
"documentation":"<p>The name of the thing type.</p>"
},
"thingTypeArn":{
"shape":"ThingTypeArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the thing type.</p>"
"documentation":"<p>The ID of the job whose execution on a particular device will be deleted.</p>",
"location":"uri",
"locationName":"jobId"
},
"thingName":{
"shape":"ThingName",
"documentation":"<p>The name of the thing whose job execution will be deleted.</p>",
"location":"uri",
"locationName":"thingName"
},
"executionNumber":{
"shape":"ExecutionNumber",
"documentation":"<p>The ID of the job execution to be deleted. The <code>executionNumber</code> refers to the execution of a particular job on a particular device.</p> <p>Note that once a job execution is deleted, the <code>executionNumber</code> may be reused by IoT, so be sure you get and use the correct value here.</p>",
"location":"uri",
"locationName":"executionNumber"
},
"force":{
"shape":"ForceFlag",
"documentation":"<p>(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.</p> <note> <p>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.</p> </note>",
"location":"querystring",
"locationName":"force"
}
}
},
"DeleteJobRequest":{
"type":"structure",
"required":["jobId"],
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The ID of the job to be deleted.</p> <p>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.</p>",
"location":"uri",
"locationName":"jobId"
},
"force":{
"shape":"ForceFlag",
"documentation":"<p>(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.</p> <note> <p>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.</p> </note>",
"documentation":"<p>The name of the scheduled audit you want to delete.</p>",
"location":"uri",
"locationName":"scheduledAuditName"
}
}
},
"DeleteScheduledAuditResponse":{
"type":"structure",
"members":{
}
},
"DeleteScheduledAudits":{"type":"boolean"},
"DeleteSecurityProfileRequest":{
"type":"structure",
"required":["securityProfileName"],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile to be deleted.</p>",
"location":"uri",
"locationName":"securityProfileName"
},
"expectedVersion":{
"shape":"OptionalVersion",
"documentation":"<p>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a <code>VersionConflictException</code> is thrown.</p>",
"documentation":"<p>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 <code>DeleteThing</code> request is rejected with a <code>VersionConflictException</code>.</p>",
"documentation":"<p>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.</p>"
},
"explicitDeny":{
"shape":"ExplicitDeny",
"documentation":"<p>Information that explicitly denies the authorization. </p>"
}
},
"documentation":"<p>Contains information that denied the authorization.</p>"
"documentation":"<p>Whether to undeprecate a deprecated thing type. If <b>true</b>, the thing type will not be deprecated anymore and you can associate it with things.</p>"
}
},
"documentation":"<p>The input for the DeprecateThingType operation.</p>"
},
"DeprecateThingTypeResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>The output for the DeprecateThingType operation.</p>"
"documentation":"<p>The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.</p> <p>On the first call to <code>UpdateAccountAuditConfiguration</code> this parameter is required.</p>"
},
"auditNotificationTargetConfigurations":{
"shape":"AuditNotificationTargetConfigurations",
"documentation":"<p>Information about the targets to which audit notifications are sent for this account.</p>"
},
"auditCheckConfigurations":{
"shape":"AuditCheckConfigurations",
"documentation":"<p>Which audit checks are enabled and disabled for this account.</p>"
}
}
},
"DescribeAuditTaskRequest":{
"type":"structure",
"required":["taskId"],
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>The ID of the audit whose information you want to get.</p>",
"location":"uri",
"locationName":"taskId"
}
}
},
"DescribeAuditTaskResponse":{
"type":"structure",
"members":{
"taskStatus":{
"shape":"AuditTaskStatus",
"documentation":"<p>The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".</p>"
},
"taskType":{
"shape":"AuditTaskType",
"documentation":"<p>The type of audit: \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".</p>"
},
"taskStartTime":{
"shape":"Timestamp",
"documentation":"<p>The time the audit started.</p>"
},
"taskStatistics":{
"shape":"TaskStatistics",
"documentation":"<p>Statistical information about the audit.</p>"
},
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name of the scheduled audit (only if the audit was a scheduled audit).</p>"
},
"auditDetails":{
"shape":"AuditDetails",
"documentation":"<p>Detailed information about each check performed during this audit.</p>"
"documentation":"<p>The creation date of the event configuration.</p>"
},
"lastModifiedDate":{
"shape":"LastModifiedDate",
"documentation":"<p>The date the event configurations were last modified.</p>"
}
}
},
"DescribeIndexRequest":{
"type":"structure",
"required":["indexName"],
"members":{
"indexName":{
"shape":"IndexName",
"documentation":"<p>The index name.</p>",
"location":"uri",
"locationName":"indexName"
}
}
},
"DescribeIndexResponse":{
"type":"structure",
"members":{
"indexName":{
"shape":"IndexName",
"documentation":"<p>The index name.</p>"
},
"indexStatus":{
"shape":"IndexStatus",
"documentation":"<p>The index status.</p>"
},
"schema":{
"shape":"IndexSchema",
"documentation":"<p>Contains a value that specifies the type of indexing performed. Valid values are:</p> <ol> <li> <p>REGISTRY – Your thing index will contain only registry data.</p> </li> <li> <p>REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.</p> </li> </ol>"
}
}
},
"DescribeJobExecutionRequest":{
"type":"structure",
"required":[
"jobId",
"thingName"
],
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The unique identifier you assigned to this job when it was created.</p>",
"location":"uri",
"locationName":"jobId"
},
"thingName":{
"shape":"ThingName",
"documentation":"<p>The name of the thing on which the job execution is running.</p>",
"location":"uri",
"locationName":"thingName"
},
"executionNumber":{
"shape":"ExecutionNumber",
"documentation":"<p>A string (consisting of the digits \"0\" through \"9\" which is used to specify a particular job execution on a particular device.</p>",
"location":"querystring",
"locationName":"executionNumber"
}
}
},
"DescribeJobExecutionResponse":{
"type":"structure",
"members":{
"execution":{
"shape":"JobExecution",
"documentation":"<p>Information about the job execution.</p>"
}
}
},
"DescribeJobRequest":{
"type":"structure",
"required":["jobId"],
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The unique identifier you assigned to this job when it was created.</p>",
"location":"uri",
"locationName":"jobId"
}
}
},
"DescribeJobResponse":{
"type":"structure",
"members":{
"documentSource":{
"shape":"JobDocumentSource",
"documentation":"<p>An S3 link to the job document.</p>"
},
"job":{
"shape":"Job",
"documentation":"<p>Information about the job.</p>"
}
}
},
"DescribeRoleAliasRequest":{
"type":"structure",
"required":["roleAlias"],
"members":{
"roleAlias":{
"shape":"RoleAlias",
"documentation":"<p>The role alias to describe.</p>",
"location":"uri",
"locationName":"roleAlias"
}
}
},
"DescribeRoleAliasResponse":{
"type":"structure",
"members":{
"roleAliasDescription":{
"shape":"RoleAliasDescription",
"documentation":"<p>The role alias description.</p>"
"documentation":"<p>The name of the scheduled audit whose information you want to get.</p>",
"location":"uri",
"locationName":"scheduledAuditName"
}
}
},
"DescribeScheduledAuditResponse":{
"type":"structure",
"members":{
"frequency":{
"shape":"AuditFrequency",
"documentation":"<p>How often the scheduled audit takes place. One of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.</p>"
},
"dayOfMonth":{
"shape":"DayOfMonth",
"documentation":"<p>The day of the month on which the scheduled audit takes place. Will be \"1\" through \"31\" or \"LAST\". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.</p>"
},
"dayOfWeek":{
"shape":"DayOfWeek",
"documentation":"<p>The day of the week on which the scheduled audit takes place. One of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\".</p>"
},
"targetCheckNames":{
"shape":"TargetAuditCheckNames",
"documentation":"<p>Which checks are performed during the scheduled audit. (Note that checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
},
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name of the scheduled audit.</p>"
},
"scheduledAuditArn":{
"shape":"ScheduledAuditArn",
"documentation":"<p>The ARN of the scheduled audit.</p>"
}
}
},
"DescribeSecurityProfileRequest":{
"type":"structure",
"required":["securityProfileName"],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile whose information you want to get.</p>",
"location":"uri",
"locationName":"securityProfileName"
}
}
},
"DescribeSecurityProfileResponse":{
"type":"structure",
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile.</p>"
},
"securityProfileArn":{
"shape":"SecurityProfileArn",
"documentation":"<p>The ARN of the security profile.</p>"
},
"securityProfileDescription":{
"shape":"SecurityProfileDescription",
"documentation":"<p>A description of the security profile (associated with the security profile when it was created or updated).</p>"
},
"behaviors":{
"shape":"Behaviors",
"documentation":"<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"
},
"alertTargets":{
"shape":"AlertTargets",
"documentation":"<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"
},
"version":{
"shape":"Version",
"documentation":"<p>The version of the security profile. A new version is generated whenever the security profile is updated.</p>"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"<p>The time the security profile was created.</p>"
},
"lastModifiedDate":{
"shape":"Timestamp",
"documentation":"<p>The time the security profile was last modified.</p>"
"documentation":"<p>The current version of the thing record in the registry.</p> <note> <p>To avoid unintentional changes to the information in the registry, you can pass the version information in the <code>expectedVersion</code> parameter of the <code>UpdateThing</code> and <code>DeleteThing</code> calls.</p> </note>"
"documentation":"<p>The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The principal.</p> <p>If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.</p>",
"documentation":"<p>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.</p>",
"documentation":"<p>The type of operation to be performed. This follows the substitution template, so it can be <code>${operation}</code>, but the substitution must result in one of the following: <code>INSERT</code>, <code>UPDATE</code>, or <code>DELETE</code>.</p>"
"documentation":"<p>Describes an action to write to a DynamoDB table.</p> <p>The <code>tableName</code>, <code>hashKeyField</code>, and <code>rangeKeyField</code> values must match the values used when you created the table.</p> <p>The <code>hashKeyValue</code> and <code>rangeKeyvalue</code> fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${<i>sql-expression</i>}.</p> <p>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:</p> <p> <code>\"hashKeyValue\": \"${topic(3)}\"</code> </p> <p>The following field uses the timestamp:</p> <p> <code>\"rangeKeyValue\": \"${timestamp()}\"</code> </p>"
"documentation":"<p>Specifies the DynamoDB table to which the message data will be written. For example:</p> <p> <code>{ \"dynamoDBv2\": { \"roleArn\": \"aws:iam:12341251:my-role\" \"putItem\": { \"tableName\": \"my-table\" } } }</code> </p> <p>Each attribute in the message payload will be written to a separate column in the DynamoDB database.</p>"
"documentation":"<p>Describes an action to write to a DynamoDB table.</p> <p>This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.</p>"
"documentation":"<p>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).</p>"
"documentation":"<p>The IAM role ARN AWS IoT uses to write to your CloudWatch logs.</p>"
},
"defaultLogLevel":{
"shape":"LogLevel",
"documentation":"<p>The default log level.</p>"
},
"disableAllLogs":{
"shape":"DisableAllLogs",
"documentation":"<p>Disables all logs.</p>"
}
}
},
"GroupNameAndArn":{
"type":"structure",
"members":{
"groupName":{
"shape":"ThingGroupName",
"documentation":"<p>The group name.</p>"
},
"groupArn":{
"shape":"ThingGroupArn",
"documentation":"<p>The group ARN.</p>"
}
},
"documentation":"<p>The name and ARN of a group.</p>"
},
"HashAlgorithm":{"type":"string"},
"HashKeyField":{"type":"string"},
"HashKeyValue":{"type":"string"},
"ImplicitDeny":{
"type":"structure",
"members":{
"policies":{
"shape":"Policies",
"documentation":"<p>Policies that don't contain a matching allow or deny statement for the specified action on the specified resource. </p>"
}
},
"documentation":"<p>Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.</p>"
"documentation":"<p>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 <code>force</code> parameter.</p>",
"documentation":"<p>The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).</p>"
"documentation":"<p>An ARN identifying the job with format \"arn:aws:iot:region:account:job/jobId\".</p>"
},
"jobId":{
"shape":"JobId",
"documentation":"<p>The unique identifier you assigned to this job when it was created.</p>"
},
"targetSelection":{
"shape":"TargetSelection",
"documentation":"<p>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. </p>"
},
"status":{
"shape":"JobStatus",
"documentation":"<p>The status of the job, one of <code>IN_PROGRESS</code>, <code>CANCELED</code>, or <code>COMPLETED</code>. </p>"
"documentation":"<p>Will be <code>true</code> if the job execution was canceled with the optional <code>force</code> parameter set to <code>true</code>.</p>"
"documentation":"<p>A collection of name/value pairs that describe the status of the job execution.</p>"
},
"thingArn":{
"shape":"ThingArn",
"documentation":"<p>The ARN of the thing on which the job execution is running.</p>"
},
"queuedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution was queued.</p>"
},
"startedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution started.</p>"
},
"lastUpdatedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution was last updated.</p>"
},
"executionNumber":{
"shape":"ExecutionNumber",
"documentation":"<p>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. </p>"
"documentation":"<p>Details of the job execution status.</p>"
},
"JobExecutionSummary":{
"type":"structure",
"members":{
"status":{
"shape":"JobExecutionStatus",
"documentation":"<p>The status of the job execution.</p>"
},
"queuedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution was queued.</p>"
},
"startedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution started.</p>"
},
"lastUpdatedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution was last updated.</p>"
},
"executionNumber":{
"shape":"ExecutionNumber",
"documentation":"<p>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.</p>"
"documentation":"<p>The ARN of the thing on which the job execution is running.</p>"
},
"jobExecutionSummary":{
"shape":"JobExecutionSummary",
"documentation":"<p>Contains a subset of information about a job execution.</p>"
}
},
"documentation":"<p>Contains a summary of information about job executions for a specific job.</p>"
},
"JobExecutionSummaryForJobList":{
"type":"list",
"member":{"shape":"JobExecutionSummaryForJob"}
},
"JobExecutionSummaryForThing":{
"type":"structure",
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The unique identifier you assigned to this job when it was created.</p>"
},
"jobExecutionSummary":{
"shape":"JobExecutionSummary",
"documentation":"<p>Contains a subset of information about a job execution.</p>"
}
},
"documentation":"<p>The job execution summary for a thing.</p>"
},
"JobExecutionSummaryForThingList":{
"type":"list",
"member":{"shape":"JobExecutionSummaryForThing"}
},
"JobExecutionsRolloutConfig":{
"type":"structure",
"members":{
"maximumPerMinute":{
"shape":"MaxJobExecutionsPerMin",
"documentation":"<p>The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.</p>"
}
},
"documentation":"<p>Allows you to create a staged rollout of a job.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The number of things that cancelled the job.</p>"
},
"numberOfSucceededThings":{
"shape":"SucceededThings",
"documentation":"<p>The number of things which successfully completed the job.</p>"
},
"numberOfFailedThings":{
"shape":"FailedThings",
"documentation":"<p>The number of things that failed executing the job.</p>"
},
"numberOfRejectedThings":{
"shape":"RejectedThings",
"documentation":"<p>The number of things that rejected the job.</p>"
},
"numberOfQueuedThings":{
"shape":"QueuedThings",
"documentation":"<p>The number of things that are awaiting execution of the job.</p>"
},
"numberOfInProgressThings":{
"shape":"InProgressThings",
"documentation":"<p>The number of things currently executing the job.</p>"
},
"numberOfRemovedThings":{
"shape":"RemovedThings",
"documentation":"<p>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.</p>"
"documentation":"<p>The unique identifier you assigned to this job when it was created.</p>"
},
"thingGroupId":{
"shape":"ThingGroupId",
"documentation":"<p>The ID of the thing group.</p>"
},
"targetSelection":{
"shape":"TargetSelection",
"documentation":"<p>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.</p>"
},
"status":{
"shape":"JobStatus",
"documentation":"<p>The job summary status.</p>"
},
"createdAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job was created.</p>"
},
"lastUpdatedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job was last updated.</p>"
},
"completedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job completed.</p>"
"documentation":"<p>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.</p>"
},
"checkName":{
"shape":"AuditCheckName",
"documentation":"<p>A filter to limit results to the findings for the specified audit check.</p>"
},
"resourceIdentifier":{
"shape":"ResourceIdentifier",
"documentation":"<p>Information identifying the non-compliant resource.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time. The default is 25.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>"
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>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.</p>"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>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.</p>"
}
}
},
"ListAuditFindingsResponse":{
"type":"structure",
"members":{
"findings":{
"shape":"AuditFindings",
"documentation":"<p>The findings (results) of the audit.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"ListAuditTasksRequest":{
"type":"structure",
"required":[
"startTime",
"endTime"
],
"members":{
"startTime":{
"shape":"Timestamp",
"documentation":"<p>The beginning of the time period. Note that audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an \"InvalidRequestException\".</p>",
"location":"querystring",
"locationName":"startTime"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>The end of the time period.</p>",
"location":"querystring",
"locationName":"endTime"
},
"taskType":{
"shape":"AuditTaskType",
"documentation":"<p>A filter to limit the output to the specified type of audit: can be one of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".</p>",
"location":"querystring",
"locationName":"taskType"
},
"taskStatus":{
"shape":"AuditTaskStatus",
"documentation":"<p>A filter to limit the output to audits with the specified completion status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\" or \"CANCELED\".</p>",
"location":"querystring",
"locationName":"taskStatus"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time. The default is 25.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListAuditTasksResponse":{
"type":"structure",
"members":{
"tasks":{
"shape":"AuditTaskMetadataList",
"documentation":"<p>The audits that were performed during the specified time period.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
"documentation":"<p>A marker used to get the next set of results.</p>"
}
}
},
"ListCACertificatesRequest":{
"type":"structure",
"members":{
"pageSize":{
"shape":"PageSize",
"documentation":"<p>The result page size.</p>",
"location":"querystring",
"locationName":"pageSize"
},
"marker":{
"shape":"Marker",
"documentation":"<p>The marker for the next set of results.</p>",
"location":"querystring",
"locationName":"marker"
},
"ascendingOrder":{
"shape":"AscendingOrder",
"documentation":"<p>Determines the order of the results.</p>",
"location":"querystring",
"locationName":"isAscendingOrder"
}
},
"documentation":"<p>Input for the ListCACertificates operation.</p>"
},
"ListCACertificatesResponse":{
"type":"structure",
"members":{
"certificates":{
"shape":"CACertificates",
"documentation":"<p>The CA certificates registered in your AWS account.</p>"
},
"nextMarker":{
"shape":"Marker",
"documentation":"<p>The current position within the list of CA certificates.</p>"
}
},
"documentation":"<p>The output from the ListCACertificates operation.</p>"
},
"ListCertificatesByCARequest":{
"type":"structure",
"required":["caCertificateId"],
"members":{
"caCertificateId":{
"shape":"CertificateId",
"documentation":"<p>The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.</p>",
"location":"uri",
"locationName":"caCertificateId"
},
"pageSize":{
"shape":"PageSize",
"documentation":"<p>The result page size.</p>",
"location":"querystring",
"locationName":"pageSize"
},
"marker":{
"shape":"Marker",
"documentation":"<p>The marker for the next set of results.</p>",
"location":"querystring",
"locationName":"marker"
},
"ascendingOrder":{
"shape":"AscendingOrder",
"documentation":"<p>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</p>",
"location":"querystring",
"locationName":"isAscendingOrder"
}
},
"documentation":"<p>The input to the ListCertificatesByCA operation.</p>"
"documentation":"<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"QueryMaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListIndicesResponse":{
"type":"structure",
"members":{
"indexNames":{
"shape":"IndexNamesList",
"documentation":"<p>The index names.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>"
}
}
},
"ListJobExecutionsForJobRequest":{
"type":"structure",
"required":["jobId"],
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The unique identifier you assigned to this job when it was created.</p>",
"location":"uri",
"locationName":"jobId"
},
"status":{
"shape":"JobExecutionStatus",
"documentation":"<p>The status of the job.</p>",
"location":"querystring",
"locationName":"status"
},
"maxResults":{
"shape":"LaserMaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListJobExecutionsForJobResponse":{
"type":"structure",
"members":{
"executionSummaries":{
"shape":"JobExecutionSummaryForJobList",
"documentation":"<p>A list of job execution summaries.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>"
}
}
},
"ListJobExecutionsForThingRequest":{
"type":"structure",
"required":["thingName"],
"members":{
"thingName":{
"shape":"ThingName",
"documentation":"<p>The thing name.</p>",
"location":"uri",
"locationName":"thingName"
},
"status":{
"shape":"JobExecutionStatus",
"documentation":"<p>An optional filter that lets you search for jobs that have the specified status.</p>",
"location":"querystring",
"locationName":"status"
},
"maxResults":{
"shape":"LaserMaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListJobExecutionsForThingResponse":{
"type":"structure",
"members":{
"executionSummaries":{
"shape":"JobExecutionSummaryForThingList",
"documentation":"<p>A list of job execution summaries.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>"
}
}
},
"ListJobsRequest":{
"type":"structure",
"members":{
"status":{
"shape":"JobStatus",
"documentation":"<p>An optional filter that lets you search for jobs that have the specified status.</p>",
"location":"querystring",
"locationName":"status"
},
"targetSelection":{
"shape":"TargetSelection",
"documentation":"<p>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. </p>",
"location":"querystring",
"locationName":"targetSelection"
},
"maxResults":{
"shape":"LaserMaxResults",
"documentation":"<p>The maximum number of results to return per request.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"thingGroupName":{
"shape":"ThingGroupName",
"documentation":"<p>A filter that limits the returned jobs to those for the specified group.</p>",
"location":"querystring",
"locationName":"thingGroupName"
},
"thingGroupId":{
"shape":"ThingGroupId",
"documentation":"<p>A filter that limits the returned jobs to those for the specified group.</p>",
"location":"querystring",
"locationName":"thingGroupId"
}
}
},
"ListJobsResponse":{
"type":"structure",
"members":{
"jobs":{
"shape":"JobSummaryList",
"documentation":"<p>A list of jobs.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>"
}
}
},
"ListOTAUpdatesRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"documentation":"<p>The start time for the alerts to be listed.</p>",
"location":"querystring",
"locationName":"startTime"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>The end time for the alerts to be listed.</p>",
"location":"querystring",
"locationName":"endTime"
},
"thingName":{
"shape":"ThingName",
"documentation":"<p>A filter to limit results to those alerts caused by the specified thing.</p>",
"location":"querystring",
"locationName":"thingName"
},
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>A filter to limit results to those alerts generated by the specified security profile.</p>",
"location":"querystring",
"locationName":"securityProfileName"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListViolationEventsResponse":{
"type":"structure",
"members":{
"violationEvents":{
"shape":"ViolationEvents",
"documentation":"<p>The security profile violation alerts issued for this account during the given time frame, potentially filtered by security profile, behavior violated, or thing (device) violating.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
"documentation":"<p>If the <code>comparisonOperator</code> calls for a numeric value, use this to specify that numeric value to be compared with the <code>metric</code>.</p>"
},
"cidrs":{
"shape":"Cidrs",
"documentation":"<p>If the <code>comparisonOperator</code> calls for a set of CIDRs, use this to specify that set to be compared with the <code>metric</code>.</p>"
},
"ports":{
"shape":"Ports",
"documentation":"<p>If the <code>comparisonOperator</code> calls for a set of ports, use this to specify that set to be compared with the <code>metric</code>.</p>"
}
},
"documentation":"<p>The value to be compared with the <code>metric</code>.</p>"
"documentation":"<p>The resource is not configured.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"OTAUpdateArn":{"type":"string"},
"OTAUpdateDescription":{
"type":"string",
"max":2028,
"pattern":"[^\\p{C}]+"
},
"OTAUpdateErrorMessage":{"type":"string"},
"OTAUpdateFile":{
"type":"structure",
"members":{
"fileName":{
"shape":"FileName",
"documentation":"<p>The name of the file.</p>"
},
"fileVersion":{
"shape":"OTAUpdateFileVersion",
"documentation":"<p>The file version.</p>"
},
"fileSource":{
"shape":"Stream",
"documentation":"<p>The source of the file.</p>"
},
"codeSigning":{
"shape":"CodeSigning",
"documentation":"<p>The code signing method of the file.</p>"
},
"attributes":{
"shape":"AttributesMap",
"documentation":"<p>A list of name/attribute pairs.</p>"
}
},
"documentation":"<p>Describes a file to be associated with an OTA update.</p>"
},
"OTAUpdateFileVersion":{"type":"string"},
"OTAUpdateFiles":{
"type":"list",
"member":{"shape":"OTAUpdateFile"},
"max":10,
"min":1
},
"OTAUpdateId":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9_-]+"
},
"OTAUpdateInfo":{
"type":"structure",
"members":{
"otaUpdateId":{
"shape":"OTAUpdateId",
"documentation":"<p>The OTA update ID.</p>"
},
"otaUpdateArn":{
"shape":"OTAUpdateArn",
"documentation":"<p>The OTA update ARN.</p>"
},
"creationDate":{
"shape":"DateType",
"documentation":"<p>The date when the OTA update was created.</p>"
},
"lastModifiedDate":{
"shape":"DateType",
"documentation":"<p>The date when the OTA update was last updated.</p>"
},
"description":{
"shape":"OTAUpdateDescription",
"documentation":"<p>A description of the OTA update.</p>"
},
"targets":{
"shape":"Targets",
"documentation":"<p>The targets of the OTA update.</p>"
},
"targetSelection":{
"shape":"TargetSelection",
"documentation":"<p>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. </p>"
},
"otaUpdateFiles":{
"shape":"OTAUpdateFiles",
"documentation":"<p>A list of files associated with the OTA update.</p>"
},
"otaUpdateStatus":{
"shape":"OTAUpdateStatus",
"documentation":"<p>The status of the OTA update.</p>"
},
"awsIotJobId":{
"shape":"AwsIotJobId",
"documentation":"<p>The AWS IoT job ID associated with the OTA update.</p>"
},
"awsIotJobArn":{
"shape":"AwsIotJobArn",
"documentation":"<p>The AWS IoT job ARN associated with the OTA update.</p>"
},
"errorInfo":{
"shape":"ErrorInfo",
"documentation":"<p>Error information associated with the OTA update.</p>"
},
"additionalParameters":{
"shape":"AdditionalParameterMap",
"documentation":"<p>A collection of name/value pairs</p>"
}
},
"documentation":"<p>Information about an OTA update.</p>"
},
"OTAUpdateStatus":{
"type":"string",
"enum":[
"CREATE_PENDING",
"CREATE_IN_PROGRESS",
"CREATE_COMPLETE",
"CREATE_FAILED"
]
},
"OTAUpdateSummary":{
"type":"structure",
"members":{
"otaUpdateId":{
"shape":"OTAUpdateId",
"documentation":"<p>The OTA update ID.</p>"
},
"otaUpdateArn":{
"shape":"OTAUpdateArn",
"documentation":"<p>The OTA update ARN.</p>"
},
"creationDate":{
"shape":"DateType",
"documentation":"<p>The date when the OTA update was created.</p>"
"documentation":"<p>The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.</p>"
},
"expiresInSec":{
"shape":"ExpiresInSec",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>Configuration for pre-signed S3 URLs.</p>"
"documentation":"<p>The provisioning template. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html\">Programmatic Provisioning</a> for more information.</p>"
"documentation":"<p>The parameters for provisioning a thing. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html\">Programmatic Provisioning</a> for more information.</p>"
"documentation":"<p>The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl\">S3 canned ACLs</a>.</p>"
"documentation":"<p>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.</p>"
},
"url":{
"shape":"SalesforceEndpoint",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>Describes an action to write a message to a Salesforce IoT Cloud Input Stream.</p>"
"documentation":"<p>The name of the scheduled audit.</p>"
},
"scheduledAuditArn":{
"shape":"ScheduledAuditArn",
"documentation":"<p>The ARN of the scheduled audit.</p>"
},
"frequency":{
"shape":"AuditFrequency",
"documentation":"<p>How often the scheduled audit takes place.</p>"
},
"dayOfMonth":{
"shape":"DayOfMonth",
"documentation":"<p>The day of the month on which the scheduled audit is run (if the <code>frequency</code> 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.</p>"
},
"dayOfWeek":{
"shape":"DayOfWeek",
"documentation":"<p>The day of the week on which the scheduled audit is run (if the <code>frequency</code> is \"WEEKLY\" or \"BIWEEKLY\").</p>"
}
},
"documentation":"<p>Information about the scheduled audit.</p>"
"documentation":"<p>(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 <a href=\"http://docs.aws.amazon.com/sns/latest/dg/json-formats.html\">http://docs.aws.amazon.com/sns/latest/dg/json-formats.html</a> refer to their official documentation.</p>"
"documentation":"<p>Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.</p>"
}
}
},
"StartOnDemandAuditTaskResponse":{
"type":"structure",
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>The ID of the on-demand audit you started.</p>"
"documentation":"<p>The S3 bucket that contains the input file.</p>"
},
"inputFileKey":{
"shape":"RegistryS3KeyName",
"documentation":"<p>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).</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The IAM role ARN that grants permission the input file.</p>"
"documentation":"<p>(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.</p>"
},
"stateMachineName":{
"shape":"StateMachineName",
"documentation":"<p>The name of the Step Functions state machine whose execution will be started.</p>"
},
"roleArn":{
"shape":"AwsArn",
"documentation":"<p>The ARN of the role that grants IoT permission to start execution of a state machine (\"Action\":\"states:StartExecution\").</p>"
}
},
"documentation":"<p>Starts execution of a Step Functions state machine.</p>"
"documentation":"<p>The Cognito identity pool ID.</p>"
},
"authInfos":{
"shape":"AuthInfos",
"documentation":"<p>A list of authorization info objects. Simulating authorization will create a response for each <code>authInfo</code> object in the list.</p>"
},
"clientId":{
"shape":"ClientId",
"documentation":"<p>The MQTT client ID.</p>",
"location":"querystring",
"locationName":"clientId"
},
"policyNamesToAdd":{
"shape":"PolicyNames",
"documentation":"<p>When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.</p>"
},
"policyNamesToSkip":{
"shape":"PolicyNames",
"documentation":"<p>When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.</p>"
"documentation":"<p>The UNIX timestamp of when the thing group was created.</p>"
}
},
"documentation":"<p>Thing group metadata.</p>"
},
"ThingGroupName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9:_-]+"
},
"ThingGroupNameAndArnList":{
"type":"list",
"member":{"shape":"GroupNameAndArn"}
},
"ThingGroupNameList":{
"type":"list",
"member":{"shape":"ThingGroupName"}
},
"ThingGroupProperties":{
"type":"structure",
"members":{
"thingGroupDescription":{
"shape":"ThingGroupDescription",
"documentation":"<p>The thing group description.</p>"
},
"attributePayload":{
"shape":"AttributePayload",
"documentation":"<p>The thing group attributes in JSON format.</p>"
}
},
"documentation":"<p>Thing group properties.</p>"
},
"ThingId":{"type":"string"},
"ThingIndexingConfiguration":{
"type":"structure",
"members":{
"thingIndexingMode":{
"shape":"ThingIndexingMode",
"documentation":"<p>Thing indexing mode. Valid values are: </p> <ul> <li> <p>REGISTRY – Your thing index will contain only registry data.</p> </li> <li> <p>REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.</p> </li> <li> <p>OFF - Thing indexing is disabled.</p> </li> </ul>"
"documentation":"<p>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.</p>"
"documentation":"<p>Whether the thing type is deprecated. If <b>true</b>, no new things could be associated with this type.</p>"
},
"deprecationDate":{
"shape":"DeprecationDate",
"documentation":"<p>The date and time when the thing type was deprecated.</p>"
},
"creationDate":{
"shape":"CreationDate",
"documentation":"<p>The date and time when the thing type was created.</p>"
}
},
"documentation":"<p>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.</p>"
"documentation":"<p>The description of the thing type.</p>"
},
"searchableAttributes":{
"shape":"SearchableAttributes",
"documentation":"<p>A list of searchable thing attribute names.</p>"
}
},
"documentation":"<p>The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.</p>"
"documentation":"<p>The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.</p>"
"documentation":"<p>The pattern for the topic names that apply.</p>"
},
"createdAt":{
"shape":"CreatedAtDate",
"documentation":"<p>The date and time the rule was created.</p>"
},
"ruleDisabled":{
"shape":"IsDisabled",
"documentation":"<p>Specifies whether the rule is disabled.</p>"
}
},
"documentation":"<p>Describes a rule.</p>"
},
"TopicRulePayload":{
"type":"structure",
"required":[
"sql",
"actions"
],
"members":{
"sql":{
"shape":"SQL",
"documentation":"<p>The SQL statement used to query the topic. For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference\">AWS IoT SQL Reference</a> in the <i>AWS IoT Developer Guide</i>.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>The description of the rule.</p>"
},
"actions":{
"shape":"ActionList",
"documentation":"<p>The actions associated with the rule.</p>"
},
"ruleDisabled":{
"shape":"IsDisabled",
"documentation":"<p>Specifies whether the rule is disabled.</p>"
"documentation":"<p>The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.</p>"
},
"auditNotificationTargetConfigurations":{
"shape":"AuditNotificationTargetConfigurations",
"documentation":"<p>Information about the targets to which audit notifications are sent.</p>"
},
"auditCheckConfigurations":{
"shape":"AuditCheckConfigurations",
"documentation":"<p>Specifies which audit checks are enabled and disabled for this account. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are currently enabled.</p> <p>Note that some data collection may begin immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.</p> <p>You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.</p> <p>On the first call to <code>UpdateAccountAuditConfiguration</code> this parameter is required and must specify at least one enabled check.</p>"
"documentation":"<p>The updated status of the CA certificate.</p> <p> <b>Note:</b> The status value REGISTER_INACTIVE is deprecated and should not be used.</p>",
"documentation":"<p>The new status.</p> <p> <b>Note:</b> Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.</p> <p> <b>Note:</b> The status value REGISTER_INACTIVE is deprecated and should not be used.</p>",
"documentation":"<p>How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.</p>"
},
"dayOfMonth":{
"shape":"DayOfMonth",
"documentation":"<p>The day of the month on which the scheduled audit takes place. Can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to \"MONTHLY\". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.</p>"
},
"dayOfWeek":{
"shape":"DayOfWeek",
"documentation":"<p>The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".</p>"
},
"targetCheckNames":{
"shape":"TargetAuditCheckNames",
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
},
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name of the scheduled audit. (Max. 128 chars)</p>",
"location":"uri",
"locationName":"scheduledAuditName"
}
}
},
"UpdateScheduledAuditResponse":{
"type":"structure",
"members":{
"scheduledAuditArn":{
"shape":"ScheduledAuditArn",
"documentation":"<p>The ARN of the scheduled audit.</p>"
}
}
},
"UpdateSecurityProfileRequest":{
"type":"structure",
"required":["securityProfileName"],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile you want to update.</p>",
"location":"uri",
"locationName":"securityProfileName"
},
"securityProfileDescription":{
"shape":"SecurityProfileDescription",
"documentation":"<p>A description of the security profile.</p>"
},
"behaviors":{
"shape":"Behaviors",
"documentation":"<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"
},
"alertTargets":{
"shape":"AlertTargets",
"documentation":"<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"
},
"expectedVersion":{
"shape":"OptionalVersion",
"documentation":"<p>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a <code>VersionConflictException</code> is thrown.</p>",
"location":"querystring",
"locationName":"expectedVersion"
}
}
},
"UpdateSecurityProfileResponse":{
"type":"structure",
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile that was updated.</p>"
},
"securityProfileArn":{
"shape":"SecurityProfileArn",
"documentation":"<p>The ARN of the security profile that was updated.</p>"
},
"securityProfileDescription":{
"shape":"SecurityProfileDescription",
"documentation":"<p>The description of the security profile.</p>"
},
"behaviors":{
"shape":"Behaviors",
"documentation":"<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"
},
"alertTargets":{
"shape":"AlertTargets",
"documentation":"<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"
},
"version":{
"shape":"Version",
"documentation":"<p>The updated version of the security profile.</p>"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"<p>The time the security profile was created.</p>"
},
"lastModifiedDate":{
"shape":"Timestamp",
"documentation":"<p>The time the security profile was last modified.</p>"
"documentation":"<p>The description of the stream.</p>"
},
"files":{
"shape":"StreamFiles",
"documentation":"<p>The files associated with the stream.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>An IAM role that allows the IoT service principal assumes to access your S3 files.</p>"
}
}
},
"UpdateStreamResponse":{
"type":"structure",
"members":{
"streamId":{
"shape":"StreamId",
"documentation":"<p>The stream ID.</p>"
},
"streamArn":{
"shape":"StreamArn",
"documentation":"<p>The stream ARN.</p>"
},
"description":{
"shape":"StreamDescription",
"documentation":"<p>A description of the stream.</p>"
},
"streamVersion":{
"shape":"StreamVersion",
"documentation":"<p>The stream version.</p>"
}
}
},
"UpdateThingGroupRequest":{
"type":"structure",
"required":[
"thingGroupName",
"thingGroupProperties"
],
"members":{
"thingGroupName":{
"shape":"ThingGroupName",
"documentation":"<p>The thing group to update.</p>",
"location":"uri",
"locationName":"thingGroupName"
},
"thingGroupProperties":{
"shape":"ThingGroupProperties",
"documentation":"<p>The thing group properties.</p>"
},
"expectedVersion":{
"shape":"OptionalVersion",
"documentation":"<p>The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.</p>"
}
}
},
"UpdateThingGroupResponse":{
"type":"structure",
"members":{
"version":{
"shape":"Version",
"documentation":"<p>The version of the updated thing group.</p>"
}
}
},
"UpdateThingGroupsForThingRequest":{
"type":"structure",
"members":{
"thingName":{
"shape":"ThingName",
"documentation":"<p>The thing whose group memberships will be updated.</p>"
},
"thingGroupsToAdd":{
"shape":"ThingGroupList",
"documentation":"<p>The groups to which the thing will be added.</p>"
},
"thingGroupsToRemove":{
"shape":"ThingGroupList",
"documentation":"<p>The groups from which the thing will be removed.</p>"
"documentation":"<p>A list of thing attributes, a JSON string containing name-value pairs. For example:</p> <p> <code>{\\\"attributes\\\":{\\\"name1\\\":\\\"value2\\\"}}</code> </p> <p>This data is used to add new attributes or update existing attributes.</p>"
"documentation":"<p>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 <code>UpdateThing</code> request is rejected with a <code>VersionConflictException</code>.</p>"
"documentation":"<p>An exception thrown when the version of an entity specified with the <code>expectedVersion</code> parameter does not match the latest version in the system.</p>",
"documentation":"<fullname>AWS IoT</fullname> <p>AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.</p> <p>For more information about how AWS IoT works, see the <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html\">Developer Guide</a>.</p> <p>For information about how to use the credentials provider for AWS IoT, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html\">Authorizing Direct Calls to AWS Services</a>.</p>"