"documentation":"<fullname>AWS IoT</fullname> <p>AWS IoT provides secure, bi-directional communication between Internet-connected things (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 thing (Thing Registry), configure logging, and create and manage policies and credentials to authenticate things.</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>",
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</p>"
}
],
"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>"
},
"AttachPrincipalPolicy":{
"name":"AttachPrincipalPolicy",
"http":{
"method":"PUT",
"requestUri":"/principal-policies/{policyName}"
},
"input":{
"shape":"AttachPrincipalPolicyRequest",
"documentation":"<p>The input for the AttachPrincipalPolicy operation.</p>"
},
"errors":[
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</p>"
},
{
"shape":"LimitExceededException",
"error":{"httpStatusCode":410},
"exception":true,
"documentation":"<p>The number of attached entities exceeds the limit.</p>"
}
],
"documentation":"<p>Attaches the specified policy to the specified principal (certificate or other credential).</p>"
},
"AttachThingPrincipal":{
"name":"AttachThingPrincipal",
"http":{
"method":"PUT",
"requestUri":"/things/{thingName}/principals"
},
"input":{
"shape":"AttachThingPrincipalRequest",
"documentation":"<p>The input for the AttachThingPrincipal operation.</p>"
},
"output":{
"shape":"AttachThingPrincipalResponse",
"documentation":"<p>The output from the AttachThingPrincipal operation.</p>"
},
"errors":[
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</p>"
}
],
"documentation":"<p>Attaches the specified principal to the specified thing.</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> 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>The policy documentation is not valid.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</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>"
},
"CreatePolicyVersion":{
"name":"CreatePolicyVersion",
"http":{
"method":"POST",
"requestUri":"/policies/{policyName}/version"
},
"input":{
"shape":"CreatePolicyVersionRequest",
"documentation":"<p>The input for the CreatePolicyVersion operation.</p>"
},
"output":{
"shape":"CreatePolicyVersionResponse",
"documentation":"<p>The output of the CreatePolicyVersion operation.</p>"
},
"errors":[
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
},
{
"shape":"MalformedPolicyException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The policy documentation is not valid.</p>"
},
{
"shape":"VersionsLimitExceededException",
"error":{"httpStatusCode":409},
"exception":true,
"documentation":"<p>The number of policy versions exceeds the limit.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</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 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>"
},
"DeleteCACertificate":{
"name":"DeleteCACertificate",
"http":{
"method":"DELETE",
"requestUri":"/cacertificate/{caCertificateId}"
},
"input":{
"shape":"DeleteCACertificateRequest",
"documentation":"<p>Input for the DeleteCACertificate operation.</p>"
},
"output":{
"shape":"DeleteCACertificateResponse",
"documentation":"<p>The output for the DeleteCACertificate operation.</p>"
},
"errors":[
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"CertificateStateException",
"error":{"httpStatusCode":406},
"exception":true,
"documentation":"<p>The certificate operation is not allowed.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</p>"
},
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
}
],
"documentation":"<p>Deletes a registered CA certificate.</p>"
"documentation":"<p>The certificate operation is not allowed.</p>"
},
{
"shape":"DeleteConflictException",
"error":{"httpStatusCode":409},
"exception":true,
"documentation":"<p>You can't delete the resource because it is attached to one or more resources.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</p>"
},
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</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>"
},
"DeletePolicy":{
"name":"DeletePolicy",
"http":{
"method":"DELETE",
"requestUri":"/policies/{policyName}"
},
"input":{
"shape":"DeletePolicyRequest",
"documentation":"<p>The input for the DeletePolicy operation.</p>"
},
"errors":[
{
"shape":"DeleteConflictException",
"error":{"httpStatusCode":409},
"exception":true,
"documentation":"<p>You can't delete the resource because it is attached to one or more resources.</p>"
},
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</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>The input for the DeletePolicyVersion operation.</p>"
},
"errors":[
{
"shape":"DeleteConflictException",
"error":{"httpStatusCode":409},
"exception":true,
"documentation":"<p>You can't delete the resource because it is attached to one or more resources.</p>"
},
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</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>"
},
"DeleteRegistrationCode":{
"name":"DeleteRegistrationCode",
"http":{
"method":"DELETE",
"requestUri":"/registrationcode"
},
"input":{
"shape":"DeleteRegistrationCodeRequest",
"documentation":"<p>The input for the DeleteRegistrationCode operation.</p>"
},
"output":{
"shape":"DeleteRegistrationCodeResponse",
"documentation":"<p>The output for the DeleteRegistrationCode operation. </p>"
},
"errors":[
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</p>"
}
],
"documentation":"<p>Deletes a CA certificate registration code.</p>"
},
"DeleteThing":{
"name":"DeleteThing",
"http":{
"method":"DELETE",
"requestUri":"/things/{thingName}"
},
"input":{
"shape":"DeleteThingRequest",
"documentation":"<p>The input for the DeleteThing operation.</p>"
},
"output":{
"shape":"DeleteThingResponse",
"documentation":"<p>The output of the DeleteThing operation.</p>"
},
"errors":[
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
},
{
"shape":"VersionConflictException",
"error":{"httpStatusCode":409},
"exception":true,
"documentation":"<p>An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter. </p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</p>"
}
],
"documentation":"<p>Deletes the specified thing.</p>"
},
"DeleteThingType":{
"name":"DeleteThingType",
"http":{
"method":"DELETE",
"requestUri":"/thing-types/{thingTypeName}"
},
"input":{
"shape":"DeleteThingTypeRequest",
"documentation":"<p>The input for the DeleteThingType operation.</p>"
},
"output":{
"shape":"DeleteThingTypeResponse",
"documentation":"<p>The output for the DeleteThingType operation.</p>"
},
"errors":[
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</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>"
},
"DeleteTopicRule":{
"name":"DeleteTopicRule",
"http":{
"method":"DELETE",
"requestUri":"/rules/{ruleName}"
},
"input":{
"shape":"DeleteTopicRuleRequest",
"documentation":"<p>The input for the DeleteTopicRule operation.</p>"
},
"errors":[
{
"shape":"InternalException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
}
],
"documentation":"<p>Deletes the specified rule.</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 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>"
"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>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 and public key. 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>The certificate is invalid.</p>"
},
{
"shape":"CertificateStateException",
"error":{"httpStatusCode":406},
"exception":true,
"documentation":"<p>The certificate operation is not allowed.</p>"
},
{
"shape":"CertificateConflictException",
"error":{"httpStatusCode":409},
"exception":true,
"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>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</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 specified 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>You can't transfer the certificate because authorization policies are still attached.</p>"
},
{
"shape":"ThrottlingException",
"error":{"httpStatusCode":429},
"exception":true,
"documentation":"<p>The rate exceeds the limit.</p>"
},
{
"shape":"UnauthorizedException",
"error":{"httpStatusCode":401},
"exception":true,
"documentation":"<p>You are not authorized to perform this operation.</p>"
},
{
"shape":"ServiceUnavailableException",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"documentation":"<p>The service is temporarily unavailable.</p>"
},
{
"shape":"InternalFailureException",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"documentation":"<p>An unexpected error has occurred.</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>"
},
"UpdateCACertificate":{
"name":"UpdateCACertificate",
"http":{
"method":"PUT",
"requestUri":"/cacertificate/{caCertificateId}"
},
"input":{
"shape":"UpdateCACertificateRequest",
"documentation":"<p>The input to the UpdateCACertificate operation.</p>"
},
"errors":[
{
"shape":"ResourceNotFoundException",
"error":{"httpStatusCode":404},
"exception":true,
"documentation":"<p>The specified resource does not exist.</p>"
},
{
"shape":"InvalidRequestException",
"error":{"httpStatusCode":400},
"exception":true,
"documentation":"<p>The request is not valid.</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>An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter. </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>"
},
"merge":{
"shape":"Flag",
"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":"An attribute value for an Thing. An empty or null value in Update means that existing value for that attribute should be deleted. Empty and null values in create are ignored."
"documentation":"<p>The ARN of the CA certificate.</p>"
},
"certificateId":{
"shape":"CertificateId",
"documentation":"<p>The ID of the CA certificate.</p>"
},
"status":{
"shape":"CACertificateStatus",
"documentation":"<p>The status of the CA certificate. </p> <p>The status value REGISTER_INACTIVE is deprecated and should not be used.</p>"
},
"creationDate":{
"shape":"DateType",
"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>Describes a CA certificate.</p>"
"documentation":"<p>The message for the exception.</p>"
}
},
"error":{"httpStatusCode":409},
"exception":true,
"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>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>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 name of the thing type.</p>"
},
"thingTypeProperties":{
"shape":"ThingTypeProperties",
"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 output of the CreateThingType operation.</p>"
"documentation":"<p>The name of the thing to delete.</p>"
},
"expectedVersion":{
"shape":"OptionalVersion",
"location":"querystring",
"locationName":"expectedVersion",
"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>The name of the thing type to deprecate.</p>"
},
"undoDeprecate":{
"shape":"UndoDeprecate",
"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>"
},
"DeprecationDate":{"type":"timestamp"},
"DescribeCACertificateRequest":{
"type":"structure",
"required":["certificateId"],
"members":{
"certificateId":{
"shape":"CertificateId",
"location":"uri",
"locationName":"caCertificateId",
"documentation":"<p>The CA certificate identifier.</p>"
}
},
"documentation":"<p>The input for the DescribeCACertificate operation.</p>"
},
"DescribeCACertificateResponse":{
"type":"structure",
"members":{
"certificateDescription":{
"shape":"CACertificateDescription",
"documentation":"<p>The CA certificate description.</p>"
}
},
"documentation":"<p>The output from the DescribeCACertificate operation.</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 name of the thing type.</p>"
}
},
"documentation":"<p>The input for the DescribeThingType operation.</p>"
},
"DescribeThingTypeResponse":{
"type":"structure",
"members":{
"thingTypeName":{
"shape":"ThingTypeName",
"documentation":"<p>The name of the thing type.</p>"
},
"thingTypeProperties":{
"shape":"ThingTypeProperties",
"documentation":"<p>The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.</p>"
},
"thingTypeMetadata":{"shape":"ThingTypeMetadata"}
},
"documentation":"<p>The output for the DescribeThingType operation.</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>The action payload. This name can be customized.</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>The ARN of the IAM role that grants access to the DynamoDB table.</p>"
},
"putItem":{
"shape":"PutItemInput",
"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 marker for the next set of results.</p>"
},
"ascendingOrder":{
"shape":"AscendingOrder",
"location":"querystring",
"locationName":"isAscendingOrder",
"documentation":"<p>Determines the order of the results.</p>"
}
},
"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",
"location":"uri",
"locationName":"caCertificateId",
"documentation":"<p>The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate. </p>"
},
"pageSize":{
"shape":"PageSize",
"location":"querystring",
"locationName":"pageSize",
"documentation":"<p>The result page size.</p>"
},
"marker":{
"shape":"Marker",
"location":"querystring",
"locationName":"marker",
"documentation":"<p>The marker for the next set of results.</p>"
},
"ascendingOrder":{
"shape":"AscendingOrder",
"location":"querystring",
"locationName":"isAscendingOrder",
"documentation":"<p>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</p>"
}
},
"documentation":"<p>The input to the ListCertificatesByCA operation.</p>"
},
"ListCertificatesByCAResponse":{
"type":"structure",
"members":{
"certificates":{
"shape":"Certificates",
"documentation":"<p>The device certificates signed by the specified CA certificate.</p>"
},
"nextMarker":{
"shape":"Marker",
"documentation":"<p>The marker for the next set of results, or null if there are no additional results.</p>"
}
},
"documentation":"<p>The output of the ListCertificatesByCA operation.</p>"
},
"ListCertificatesRequest":{
"type":"structure",
"members":{
"pageSize":{
"shape":"PageSize",
"location":"querystring",
"locationName":"pageSize",
"documentation":"<p>The result page size.</p>"
},
"marker":{
"shape":"Marker",
"location":"querystring",
"locationName":"marker",
"documentation":"<p>The marker for the next set of results.</p>"
},
"ascendingOrder":{
"shape":"AscendingOrder",
"location":"querystring",
"locationName":"isAscendingOrder",
"documentation":"<p>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</p>"
}
},
"documentation":"<p>The input for the ListCertificates operation.</p>"
},
"ListCertificatesResponse":{
"type":"structure",
"members":{
"certificates":{
"shape":"Certificates",
"documentation":"<p>The descriptions of the certificates.</p>"
},
"nextMarker":{
"shape":"Marker",
"documentation":"<p>The marker for the next set of results, or null if there are no additional results.</p>"
}
},
"documentation":"<p>The output of the ListCertificates operation.</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 message format of the message to publish. Optional. 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\"></a> refer to their official documentation.</p>"
"documentation":"<p>The name of the thing type.</p>"
},
"thingTypeProperties":{
"shape":"ThingTypeProperties",
"documentation":"<p>The ThingTypeProperties for the thing type.</p>"
},
"thingTypeMetadata":{"shape":"ThingTypeMetadata"}
},
"documentation":"<p>The definition of the thing type, including thing type name and description.</p>"
},
"ThingTypeDescription":{
"type":"string",
"max":2028,
"pattern":"[\\p{Graph}\\x20]*"
},
"ThingTypeList":{
"type":"list",
"member":{"shape":"ThingTypeDefinition"}
},
"ThingTypeMetadata":{
"type":"structure",
"members":{
"deprecated":{
"shape":"Boolean",
"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>"
},
"ThingTypeName":{
"type":"string",
"min":1,
"max":128,
"pattern":"[a-zA-Z0-9:_-]+"
},
"ThingTypeProperties":{
"type":"structure",
"members":{
"thingTypeDescription":{
"shape":"ThingTypeDescription",
"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 CA certificate identifier.</p>"
},
"newStatus":{
"shape":"CACertificateStatus",
"location":"querystring",
"locationName":"newStatus",
"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>"
},
"newAutoRegistrationStatus":{
"shape":"AutoRegistrationStatus",
"location":"querystring",
"locationName":"newAutoRegistrationStatus",
"documentation":"<p>The new value for the auto registration status. Valid values are: \"ENABLE\" or \"DISABLE\".</p>"
}
},
"documentation":"<p>The input to the UpdateCACertificate operation.</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>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>"
},
"expectedVersion":{
"shape":"OptionalVersion",
"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>"
},
"removeThingType":{
"shape":"RemoveThingType",
"documentation":"<p>Remove a thing type association. If <b>true</b>, the assocation is removed.</p>"
"documentation":"<p>The message for the exception.</p>"
}
},
"error":{"httpStatusCode":409},
"exception":true,
"documentation":"<p>An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter. </p>"