| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652 |
- {
- "version": "2.0",
- "operations": {
- "AcceptCertificateTransfer": "<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": "<p>Attaches the specified policy to the specified principal (certificate or other credential).</p>",
- "AttachThingPrincipal": "<p>Attaches the specified principal to the specified thing.</p>",
- "CancelCertificateTransfer": "<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>",
- "CreateCertificateFromCsr": "<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>",
- "CreateKeysAndCertificate": "<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>",
- "CreatePolicy": "<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": "<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>",
- "CreateThing": "<p>Creates a thing record in the thing registry.</p>",
- "CreateThingType": "<p>Creates a new thing type.</p>",
- "CreateTopicRule": "<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": "<p>Deletes a registered CA certificate.</p>",
- "DeleteCertificate": "<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": "<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>",
- "DeletePolicyVersion": "<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": "<p>Deletes a CA certificate registration code.</p>",
- "DeleteThing": "<p>Deletes the specified thing.</p>",
- "DeleteThingType": "<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": "<p>Deletes the specified rule.</p>",
- "DeprecateThingType": "<p>Deprecates a thing type. You can not associate new things with deprecated thing type.</p>",
- "DescribeCACertificate": "<p>Describes a registered CA certificate.</p>",
- "DescribeCertificate": "<p>Gets information about the specified certificate.</p>",
- "DescribeEndpoint": "<p>Returns a unique endpoint specific to the AWS account making the call.</p>",
- "DescribeThing": "<p>Gets information about the specified thing.</p>",
- "DescribeThingType": "<p>Gets information about the specified thing type.</p>",
- "DetachPrincipalPolicy": "<p>Removes the specified policy from the specified certificate.</p>",
- "DetachThingPrincipal": "<p>Detaches the specified principal from the specified thing.</p>",
- "DisableTopicRule": "<p>Disables the specified rule.</p>",
- "EnableTopicRule": "<p>Enables the specified rule.</p>",
- "GetLoggingOptions": "<p>Gets the logging options.</p>",
- "GetPolicy": "<p>Gets information about the specified policy with the policy document of the default version.</p>",
- "GetPolicyVersion": "<p>Gets information about the specified policy version.</p>",
- "GetRegistrationCode": "<p>Gets a registration code used to register a CA certificate with AWS IoT.</p>",
- "GetTopicRule": "<p>Gets information about the specified rule.</p>",
- "ListCACertificates": "<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>",
- "ListCertificates": "<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>",
- "ListCertificatesByCA": "<p>List the device certificates signed by the specified CA certificate.</p>",
- "ListOutgoingCertificates": "<p>Lists certificates that are being transfered but not yet accepted.</p>",
- "ListPolicies": "<p>Lists your policies.</p>",
- "ListPolicyPrincipals": "<p>Lists the principals associated with the specified policy.</p>",
- "ListPolicyVersions": "<p>Lists the versions of the specified policy and identifies the default version.</p>",
- "ListPrincipalPolicies": "<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>",
- "ListPrincipalThings": "<p>Lists the things associated with the specified principal.</p>",
- "ListThingPrincipals": "<p>Lists the principals associated with the specified thing.</p>",
- "ListThingTypes": "<p>Lists the existing thing types.</p>",
- "ListThings": "<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>",
- "ListTopicRules": "<p>Lists the rules for the specific topic.</p>",
- "RegisterCACertificate": "<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>",
- "RegisterCertificate": "<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>",
- "RejectCertificateTransfer": "<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>",
- "ReplaceTopicRule": "<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>",
- "SetDefaultPolicyVersion": "<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>",
- "SetLoggingOptions": "<p>Sets the logging options.</p>",
- "TransferCertificate": "<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": "<p>Updates a registered CA certificate.</p>",
- "UpdateCertificate": "<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>",
- "UpdateThing": "<p>Updates the data for a thing.</p>"
- },
- "service": "<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>",
- "shapes": {
- "AcceptCertificateTransferRequest": {
- "base": "<p>The input for the AcceptCertificateTransfer operation.</p>",
- "refs": {
- }
- },
- "Action": {
- "base": "<p>Describes the actions associated with a rule.</p>",
- "refs": {
- "ActionList$member": null
- }
- },
- "ActionList": {
- "base": null,
- "refs": {
- "TopicRule$actions": "<p>The actions associated with the rule.</p>",
- "TopicRulePayload$actions": "<p>The actions associated with the rule.</p>"
- }
- },
- "AlarmName": {
- "base": null,
- "refs": {
- "CloudwatchAlarmAction$alarmName": "<p>The CloudWatch alarm name.</p>"
- }
- },
- "AllowAutoRegistration": {
- "base": null,
- "refs": {
- "RegisterCACertificateRequest$allowAutoRegistration": "<p>Allows this CA certificate to be used for auto registration of device certificates.</p>"
- }
- },
- "AscendingOrder": {
- "base": null,
- "refs": {
- "ListCACertificatesRequest$ascendingOrder": "<p>Determines the order of the results.</p>",
- "ListCertificatesByCARequest$ascendingOrder": "<p>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</p>",
- "ListCertificatesRequest$ascendingOrder": "<p>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</p>",
- "ListOutgoingCertificatesRequest$ascendingOrder": "<p>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</p>",
- "ListPoliciesRequest$ascendingOrder": "<p>Specifies the order for results. If true, the results are returned in ascending creation order.</p>",
- "ListPolicyPrincipalsRequest$ascendingOrder": "<p>Specifies the order for results. If true, the results are returned in ascending creation order.</p>",
- "ListPrincipalPoliciesRequest$ascendingOrder": "<p>Specifies the order for results. If true, results are returned in ascending creation order.</p>"
- }
- },
- "AttachPrincipalPolicyRequest": {
- "base": "<p>The input for the AttachPrincipalPolicy operation.</p>",
- "refs": {
- }
- },
- "AttachThingPrincipalRequest": {
- "base": "<p>The input for the AttachThingPrincipal operation.</p>",
- "refs": {
- }
- },
- "AttachThingPrincipalResponse": {
- "base": "<p>The output from the AttachThingPrincipal operation.</p>",
- "refs": {
- }
- },
- "AttributeName": {
- "base": null,
- "refs": {
- "Attributes$key": null,
- "ListThingsRequest$attributeName": "<p>The attribute name used to search for things.</p>",
- "SearchableAttributes$member": null
- }
- },
- "AttributePayload": {
- "base": "<p>The attribute payload.</p>",
- "refs": {
- "CreateThingRequest$attributePayload": "<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>",
- "UpdateThingRequest$attributePayload": "<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>"
- }
- },
- "AttributeValue": {
- "base": "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.",
- "refs": {
- "Attributes$value": null,
- "ListThingsRequest$attributeValue": "<p>The attribute value used to search for things.</p>"
- }
- },
- "Attributes": {
- "base": null,
- "refs": {
- "AttributePayload$attributes": "<p>A JSON string containing up to three key-value pair in JSON format. For example:</p> <p><code>{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}})</code></p>",
- "DescribeThingResponse$attributes": "<p>The thing attributes.</p>",
- "ThingAttribute$attributes": "<p>A list of thing attributes which are name-value pairs.</p>"
- }
- },
- "AutoRegistrationStatus": {
- "base": null,
- "refs": {
- "CACertificateDescription$autoRegistrationStatus": "<p>Whether the CA certificate configured for auto registration of device certificates. Valid values are \"ENABLE\" and \"DISABLE\"</p>",
- "UpdateCACertificateRequest$newAutoRegistrationStatus": "<p>The new value for the auto registration status. Valid values are: \"ENABLE\" or \"DISABLE\".</p>"
- }
- },
- "AwsAccountId": {
- "base": null,
- "refs": {
- "CACertificateDescription$ownedBy": "<p>The owner of the CA certificate.</p>",
- "CertificateDescription$ownedBy": "<p>The ID of the AWS account that owns the certificate.</p>",
- "CertificateDescription$previousOwnedBy": "<p>The ID of the AWS account of the previous owner of the certificate.</p>",
- "OutgoingCertificate$transferredTo": "<p>The AWS account to which the transfer was made.</p>",
- "TransferCertificateRequest$targetAwsAccount": "<p>The AWS account.</p>"
- }
- },
- "AwsArn": {
- "base": null,
- "refs": {
- "CloudwatchAlarmAction$roleArn": "<p>The IAM role that allows access to the CloudWatch alarm.</p>",
- "CloudwatchMetricAction$roleArn": "<p>The IAM role that allows access to the CloudWatch metric.</p>",
- "DynamoDBAction$roleArn": "<p>The ARN of the IAM role that grants access to the DynamoDB table.</p>",
- "ElasticsearchAction$roleArn": "<p>The IAM role ARN that has access to Elasticsearch.</p>",
- "FirehoseAction$roleArn": "<p>The IAM role that grants access to the Amazon Kinesis Firehost stream.</p>",
- "GetLoggingOptionsResponse$roleArn": "<p>The ARN of the IAM role that grants access.</p>",
- "KinesisAction$roleArn": "<p>The ARN of the IAM role that grants access to the Amazon Kinesis stream.</p>",
- "LoggingOptionsPayload$roleArn": "<p>The ARN of the IAM role that grants access.</p>",
- "RepublishAction$roleArn": "<p>The ARN of the IAM role that grants access.</p>",
- "S3Action$roleArn": "<p>The ARN of the IAM role that grants access.</p>",
- "SnsAction$targetArn": "<p>The ARN of the SNS topic.</p>",
- "SnsAction$roleArn": "<p>The ARN of the IAM role that grants access.</p>",
- "SqsAction$roleArn": "<p>The ARN of the IAM role that grants access.</p>"
- }
- },
- "AwsIotSqlVersion": {
- "base": null,
- "refs": {
- "TopicRule$awsIotSqlVersion": "<p>The version of the SQL rules engine to use when evaluating the rule.</p>",
- "TopicRulePayload$awsIotSqlVersion": "<p>The version of the SQL rules engine to use when evaluating the rule.</p>"
- }
- },
- "Boolean": {
- "base": null,
- "refs": {
- "ThingTypeMetadata$deprecated": "<p>Whether the thing type is deprecated. If <b>true</b>, no new things could be associated with this type.</p>"
- }
- },
- "BucketName": {
- "base": null,
- "refs": {
- "S3Action$bucketName": "<p>The Amazon S3 bucket.</p>"
- }
- },
- "CACertificate": {
- "base": "<p>A CA certificate.</p>",
- "refs": {
- "CACertificates$member": null
- }
- },
- "CACertificateDescription": {
- "base": "<p>Describes a CA certificate.</p>",
- "refs": {
- "DescribeCACertificateResponse$certificateDescription": "<p>The CA certificate description.</p>"
- }
- },
- "CACertificateStatus": {
- "base": null,
- "refs": {
- "CACertificate$status": "<p>The status of the CA certificate. </p> <p>The status value REGISTER_INACTIVE is deprecated and should not be used.</p>",
- "CACertificateDescription$status": "<p>The status of a CA certificate.</p>",
- "UpdateCACertificateRequest$newStatus": "<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>"
- }
- },
- "CACertificates": {
- "base": null,
- "refs": {
- "ListCACertificatesResponse$certificates": "<p>The CA certificates registered in your AWS account.</p>"
- }
- },
- "CancelCertificateTransferRequest": {
- "base": "<p>The input for the CancelCertificateTransfer operation.</p>",
- "refs": {
- }
- },
- "Certificate": {
- "base": "<p>Information about a certificate.</p>",
- "refs": {
- "Certificates$member": null
- }
- },
- "CertificateArn": {
- "base": null,
- "refs": {
- "CACertificate$certificateArn": "<p>The ARN of the CA certificate.</p>",
- "CACertificateDescription$certificateArn": "<p>The CA certificate ARN.</p>",
- "Certificate$certificateArn": "<p>The ARN of the certificate.</p>",
- "CertificateDescription$certificateArn": "<p>The ARN of the certificate.</p>",
- "CreateCertificateFromCsrResponse$certificateArn": "<p>The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.</p>",
- "CreateKeysAndCertificateResponse$certificateArn": "<p>The ARN of the certificate.</p>",
- "OutgoingCertificate$certificateArn": "<p>The certificate ARN.</p>",
- "RegisterCACertificateResponse$certificateArn": "<p>The CA certificate ARN.</p>",
- "RegisterCertificateResponse$certificateArn": "<p>The certificate ARN.</p>",
- "TransferCertificateResponse$transferredCertificateArn": "<p>The ARN of the certificate.</p>"
- }
- },
- "CertificateConflictException": {
- "base": "<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>",
- "refs": {
- }
- },
- "CertificateDescription": {
- "base": "<p>Describes a certificate.</p>",
- "refs": {
- "DescribeCertificateResponse$certificateDescription": "<p>The description of the certificate.</p>"
- }
- },
- "CertificateId": {
- "base": null,
- "refs": {
- "AcceptCertificateTransferRequest$certificateId": "<p>The ID of the certificate.</p>",
- "CACertificate$certificateId": "<p>The ID of the CA certificate.</p>",
- "CACertificateDescription$certificateId": "<p>The CA certificate ID.</p>",
- "CancelCertificateTransferRequest$certificateId": "<p>The ID of the certificate.</p>",
- "Certificate$certificateId": "<p>The ID of the certificate.</p>",
- "CertificateDescription$certificateId": "<p>The ID of the certificate.</p>",
- "CertificateDescription$caCertificateId": "<p>The certificate ID of the CA certificate used to sign this certificate.</p>",
- "CreateCertificateFromCsrResponse$certificateId": "<p>The ID of the certificate. Certificate management operations only take a certificateId.</p>",
- "CreateKeysAndCertificateResponse$certificateId": "<p>The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).</p>",
- "DeleteCACertificateRequest$certificateId": "<p>The ID of the certificate to delete.</p>",
- "DeleteCertificateRequest$certificateId": "<p>The ID of the certificate.</p>",
- "DescribeCACertificateRequest$certificateId": "<p>The CA certificate identifier.</p>",
- "DescribeCertificateRequest$certificateId": "<p>The ID of the certificate.</p>",
- "ListCertificatesByCARequest$caCertificateId": "<p>The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate. </p>",
- "OutgoingCertificate$certificateId": "<p>The certificate ID.</p>",
- "RegisterCACertificateResponse$certificateId": "<p>The CA certificate identifier.</p>",
- "RegisterCertificateResponse$certificateId": "<p>The certificate identifier.</p>",
- "RejectCertificateTransferRequest$certificateId": "<p>The ID of the certificate.</p>",
- "TransferCertificateRequest$certificateId": "<p>The ID of the certificate.</p>",
- "UpdateCACertificateRequest$certificateId": "<p>The CA certificate identifier.</p>",
- "UpdateCertificateRequest$certificateId": "<p>The ID of the certificate.</p>"
- }
- },
- "CertificatePem": {
- "base": null,
- "refs": {
- "CACertificateDescription$certificatePem": "<p>The CA certificate data, in PEM format.</p>",
- "CertificateDescription$certificatePem": "<p>The certificate data, in PEM format.</p>",
- "CreateCertificateFromCsrResponse$certificatePem": "<p>The certificate data, in PEM format.</p>",
- "CreateKeysAndCertificateResponse$certificatePem": "<p>The certificate data, in PEM format.</p>",
- "RegisterCACertificateRequest$caCertificate": "<p>The CA certificate.</p>",
- "RegisterCACertificateRequest$verificationCertificate": "<p>The private key verification certificate.</p>",
- "RegisterCertificateRequest$certificatePem": "<p>The certificate data, in PEM format.</p>",
- "RegisterCertificateRequest$caCertificatePem": "<p>The CA certificate used to sign the device certificate being registered.</p>"
- }
- },
- "CertificateSigningRequest": {
- "base": null,
- "refs": {
- "CreateCertificateFromCsrRequest$certificateSigningRequest": "<p>The certificate signing request (CSR).</p>"
- }
- },
- "CertificateStateException": {
- "base": "<p>The certificate operation is not allowed.</p>",
- "refs": {
- }
- },
- "CertificateStatus": {
- "base": null,
- "refs": {
- "Certificate$status": "<p>The status of the certificate.</p> <p>The status value REGISTER_INACTIVE is deprecated and should not be used.</p>",
- "CertificateDescription$status": "<p>The status of the certificate.</p>",
- "UpdateCertificateRequest$newStatus": "<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>"
- }
- },
- "CertificateValidationException": {
- "base": "<p>The certificate is invalid.</p>",
- "refs": {
- }
- },
- "Certificates": {
- "base": null,
- "refs": {
- "ListCertificatesByCAResponse$certificates": "<p>The device certificates signed by the specified CA certificate.</p>",
- "ListCertificatesResponse$certificates": "<p>The descriptions of the certificates.</p>"
- }
- },
- "ClientId": {
- "base": null,
- "refs": {
- "DescribeThingResponse$defaultClientId": "<p>The default client ID.</p>"
- }
- },
- "CloudwatchAlarmAction": {
- "base": "<p>Describes an action that updates a CloudWatch alarm.</p>",
- "refs": {
- "Action$cloudwatchAlarm": "<p>Change the state of a CloudWatch alarm.</p>"
- }
- },
- "CloudwatchMetricAction": {
- "base": "<p>Describes an action that captures a CloudWatch metric.</p>",
- "refs": {
- "Action$cloudwatchMetric": "<p>Capture a CloudWatch metric.</p>"
- }
- },
- "CreateCertificateFromCsrRequest": {
- "base": "<p>The input for the CreateCertificateFromCsr operation.</p>",
- "refs": {
- }
- },
- "CreateCertificateFromCsrResponse": {
- "base": "<p>The output from the CreateCertificateFromCsr operation.</p>",
- "refs": {
- }
- },
- "CreateKeysAndCertificateRequest": {
- "base": "<p>The input for the CreateKeysAndCertificate operation.</p>",
- "refs": {
- }
- },
- "CreateKeysAndCertificateResponse": {
- "base": "<p>The output of the CreateKeysAndCertificate operation.</p>",
- "refs": {
- }
- },
- "CreatePolicyRequest": {
- "base": "<p>The input for the CreatePolicy operation.</p>",
- "refs": {
- }
- },
- "CreatePolicyResponse": {
- "base": "<p>The output from the CreatePolicy operation.</p>",
- "refs": {
- }
- },
- "CreatePolicyVersionRequest": {
- "base": "<p>The input for the CreatePolicyVersion operation.</p>",
- "refs": {
- }
- },
- "CreatePolicyVersionResponse": {
- "base": "<p>The output of the CreatePolicyVersion operation.</p>",
- "refs": {
- }
- },
- "CreateThingRequest": {
- "base": "<p>The input for the CreateThing operation.</p>",
- "refs": {
- }
- },
- "CreateThingResponse": {
- "base": "<p>The output of the CreateThing operation.</p>",
- "refs": {
- }
- },
- "CreateThingTypeRequest": {
- "base": "<p>The input for the CreateThingType operation.</p>",
- "refs": {
- }
- },
- "CreateThingTypeResponse": {
- "base": "<p>The output of the CreateThingType operation.</p>",
- "refs": {
- }
- },
- "CreateTopicRuleRequest": {
- "base": "<p>The input for the CreateTopicRule operation.</p>",
- "refs": {
- }
- },
- "CreatedAtDate": {
- "base": null,
- "refs": {
- "TopicRule$createdAt": "<p>The date and time the rule was created.</p>",
- "TopicRuleListItem$createdAt": "<p>The date and time the rule was created.</p>"
- }
- },
- "CreationDate": {
- "base": null,
- "refs": {
- "ThingTypeMetadata$creationDate": "<p>The date and time when the thing type was created.</p>"
- }
- },
- "DateType": {
- "base": null,
- "refs": {
- "CACertificate$creationDate": "<p>The date the CA certificate was created.</p>",
- "CACertificateDescription$creationDate": "<p>The date the CA certificate was created.</p>",
- "Certificate$creationDate": "<p>The date and time the certificate was created.</p>",
- "CertificateDescription$creationDate": "<p>The date and time the certificate was created.</p>",
- "CertificateDescription$lastModifiedDate": "<p>The date and time the certificate was last modified.</p>",
- "OutgoingCertificate$transferDate": "<p>The date the transfer was initiated.</p>",
- "OutgoingCertificate$creationDate": "<p>The certificate creation date.</p>",
- "PolicyVersion$createDate": "<p>The date and time the policy was created.</p>",
- "TransferData$transferDate": "<p>The date the transfer took place.</p>",
- "TransferData$acceptDate": "<p>The date the transfer was accepted.</p>",
- "TransferData$rejectDate": "<p>The date the transfer was rejected.</p>"
- }
- },
- "DeleteCACertificateRequest": {
- "base": "<p>Input for the DeleteCACertificate operation.</p>",
- "refs": {
- }
- },
- "DeleteCACertificateResponse": {
- "base": "<p>The output for the DeleteCACertificate operation.</p>",
- "refs": {
- }
- },
- "DeleteCertificateRequest": {
- "base": "<p>The input for the DeleteCertificate operation.</p>",
- "refs": {
- }
- },
- "DeleteConflictException": {
- "base": "<p>You can't delete the resource because it is attached to one or more resources.</p>",
- "refs": {
- }
- },
- "DeletePolicyRequest": {
- "base": "<p>The input for the DeletePolicy operation.</p>",
- "refs": {
- }
- },
- "DeletePolicyVersionRequest": {
- "base": "<p>The input for the DeletePolicyVersion operation.</p>",
- "refs": {
- }
- },
- "DeleteRegistrationCodeRequest": {
- "base": "<p>The input for the DeleteRegistrationCode operation.</p>",
- "refs": {
- }
- },
- "DeleteRegistrationCodeResponse": {
- "base": "<p>The output for the DeleteRegistrationCode operation. </p>",
- "refs": {
- }
- },
- "DeleteThingRequest": {
- "base": "<p>The input for the DeleteThing operation.</p>",
- "refs": {
- }
- },
- "DeleteThingResponse": {
- "base": "<p>The output of the DeleteThing operation.</p>",
- "refs": {
- }
- },
- "DeleteThingTypeRequest": {
- "base": "<p>The input for the DeleteThingType operation.</p>",
- "refs": {
- }
- },
- "DeleteThingTypeResponse": {
- "base": "<p>The output for the DeleteThingType operation.</p>",
- "refs": {
- }
- },
- "DeleteTopicRuleRequest": {
- "base": "<p>The input for the DeleteTopicRule operation.</p>",
- "refs": {
- }
- },
- "DeliveryStreamName": {
- "base": null,
- "refs": {
- "FirehoseAction$deliveryStreamName": "<p>The delivery stream name.</p>"
- }
- },
- "DeprecateThingTypeRequest": {
- "base": "<p>The input for the DeprecateThingType operation.</p>",
- "refs": {
- }
- },
- "DeprecateThingTypeResponse": {
- "base": "<p>The output for the DeprecateThingType operation.</p>",
- "refs": {
- }
- },
- "DeprecationDate": {
- "base": null,
- "refs": {
- "ThingTypeMetadata$deprecationDate": "<p>The date and time when the thing type was deprecated.</p>"
- }
- },
- "DescribeCACertificateRequest": {
- "base": "<p>The input for the DescribeCACertificate operation.</p>",
- "refs": {
- }
- },
- "DescribeCACertificateResponse": {
- "base": "<p>The output from the DescribeCACertificate operation.</p>",
- "refs": {
- }
- },
- "DescribeCertificateRequest": {
- "base": "<p>The input for the DescribeCertificate operation.</p>",
- "refs": {
- }
- },
- "DescribeCertificateResponse": {
- "base": "<p>The output of the DescribeCertificate operation.</p>",
- "refs": {
- }
- },
- "DescribeEndpointRequest": {
- "base": "<p>The input for the DescribeEndpoint operation.</p>",
- "refs": {
- }
- },
- "DescribeEndpointResponse": {
- "base": "<p>The output from the DescribeEndpoint operation.</p>",
- "refs": {
- }
- },
- "DescribeThingRequest": {
- "base": "<p>The input for the DescribeThing operation.</p>",
- "refs": {
- }
- },
- "DescribeThingResponse": {
- "base": "<p>The output from the DescribeThing operation.</p>",
- "refs": {
- }
- },
- "DescribeThingTypeRequest": {
- "base": "<p>The input for the DescribeThingType operation.</p>",
- "refs": {
- }
- },
- "DescribeThingTypeResponse": {
- "base": "<p>The output for the DescribeThingType operation.</p>",
- "refs": {
- }
- },
- "Description": {
- "base": null,
- "refs": {
- "TopicRule$description": "<p>The description of the rule.</p>",
- "TopicRulePayload$description": "<p>The description of the rule.</p>"
- }
- },
- "DetachPrincipalPolicyRequest": {
- "base": "<p>The input for the DetachPrincipalPolicy operation.</p>",
- "refs": {
- }
- },
- "DetachThingPrincipalRequest": {
- "base": "<p>The input for the DetachThingPrincipal operation.</p>",
- "refs": {
- }
- },
- "DetachThingPrincipalResponse": {
- "base": "<p>The output from the DetachThingPrincipal operation.</p>",
- "refs": {
- }
- },
- "DisableTopicRuleRequest": {
- "base": "<p>The input for the DisableTopicRuleRequest operation.</p>",
- "refs": {
- }
- },
- "DynamoDBAction": {
- "base": "<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>",
- "refs": {
- "Action$dynamoDB": "<p>Write to a DynamoDB table.</p>"
- }
- },
- "DynamoKeyType": {
- "base": null,
- "refs": {
- "DynamoDBAction$hashKeyType": "<p>The hash key type. Valid values are \"STRING\" or \"NUMBER\"</p>",
- "DynamoDBAction$rangeKeyType": "<p>The range key type. Valid values are \"STRING\" or \"NUMBER\"</p>"
- }
- },
- "DynamoOperation": {
- "base": null,
- "refs": {
- "DynamoDBAction$operation": "<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>"
- }
- },
- "ElasticsearchAction": {
- "base": "<p>Describes an action that writes data to an Amazon Elasticsearch Service; domain.</p>",
- "refs": {
- "Action$elasticsearch": "<p>Write data to an Amazon Elasticsearch Service; domain.</p>"
- }
- },
- "ElasticsearchEndpoint": {
- "base": null,
- "refs": {
- "ElasticsearchAction$endpoint": "<p>The endpoint of your Elasticsearch domain.</p>"
- }
- },
- "ElasticsearchId": {
- "base": null,
- "refs": {
- "ElasticsearchAction$id": "<p>The unique identifier for the document you are storing.</p>"
- }
- },
- "ElasticsearchIndex": {
- "base": null,
- "refs": {
- "ElasticsearchAction$index": "<p>The Elasticsearch index where you want to store your data.</p>"
- }
- },
- "ElasticsearchType": {
- "base": null,
- "refs": {
- "ElasticsearchAction$type": "<p>The type of document you are storing.</p>"
- }
- },
- "EnableTopicRuleRequest": {
- "base": "<p>The input for the EnableTopicRuleRequest operation.</p>",
- "refs": {
- }
- },
- "EndpointAddress": {
- "base": null,
- "refs": {
- "DescribeEndpointResponse$endpointAddress": "<p>The endpoint. The format of the endpoint is as follows: <i>identifier</i>.iot.<i>region</i>.amazonaws.com.</p>"
- }
- },
- "FirehoseAction": {
- "base": "<p>Describes an action that writes data to an Amazon Kinesis Firehose stream.</p>",
- "refs": {
- "Action$firehose": "<p>Write to an Amazon Kinesis Firehose stream.</p>"
- }
- },
- "FirehoseSeparator": {
- "base": null,
- "refs": {
- "FirehoseAction$separator": "<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>"
- }
- },
- "Flag": {
- "base": null,
- "refs": {
- "AttributePayload$merge": "<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>"
- }
- },
- "FunctionArn": {
- "base": null,
- "refs": {
- "LambdaAction$functionArn": "<p>The ARN of the Lambda function.</p>"
- }
- },
- "GetLoggingOptionsRequest": {
- "base": "<p>The input for the GetLoggingOptions operation.</p>",
- "refs": {
- }
- },
- "GetLoggingOptionsResponse": {
- "base": "<p>The output from the GetLoggingOptions operation.</p>",
- "refs": {
- }
- },
- "GetPolicyRequest": {
- "base": "<p>The input for the GetPolicy operation.</p>",
- "refs": {
- }
- },
- "GetPolicyResponse": {
- "base": "<p>The output from the GetPolicy operation.</p>",
- "refs": {
- }
- },
- "GetPolicyVersionRequest": {
- "base": "<p>The input for the GetPolicyVersion operation.</p>",
- "refs": {
- }
- },
- "GetPolicyVersionResponse": {
- "base": "<p>The output from the GetPolicyVersion operation.</p>",
- "refs": {
- }
- },
- "GetRegistrationCodeRequest": {
- "base": "<p>The input to the GetRegistrationCode operation.</p>",
- "refs": {
- }
- },
- "GetRegistrationCodeResponse": {
- "base": "<p>The output from the GetRegistrationCode operation.</p>",
- "refs": {
- }
- },
- "GetTopicRuleRequest": {
- "base": "<p>The input for the GetTopicRule operation.</p>",
- "refs": {
- }
- },
- "GetTopicRuleResponse": {
- "base": "<p>The output from the GetTopicRule operation.</p>",
- "refs": {
- }
- },
- "HashKeyField": {
- "base": null,
- "refs": {
- "DynamoDBAction$hashKeyField": "<p>The hash key name.</p>"
- }
- },
- "HashKeyValue": {
- "base": null,
- "refs": {
- "DynamoDBAction$hashKeyValue": "<p>The hash key value.</p>"
- }
- },
- "InternalException": {
- "base": "<p>An unexpected error has occurred.</p>",
- "refs": {
- }
- },
- "InternalFailureException": {
- "base": "<p>An unexpected error has occurred.</p>",
- "refs": {
- }
- },
- "InvalidRequestException": {
- "base": "<p>The request is not valid.</p>",
- "refs": {
- }
- },
- "IsDefaultVersion": {
- "base": null,
- "refs": {
- "CreatePolicyVersionResponse$isDefaultVersion": "<p>Specifies whether the policy version is the default.</p>",
- "GetPolicyVersionResponse$isDefaultVersion": "<p>Specifies whether the policy version is the default.</p>",
- "PolicyVersion$isDefaultVersion": "<p>Specifies whether the policy version is the default.</p>"
- }
- },
- "IsDisabled": {
- "base": null,
- "refs": {
- "ListTopicRulesRequest$ruleDisabled": "<p>Specifies whether the rule is disabled.</p>",
- "TopicRule$ruleDisabled": "<p>Specifies whether the rule is disabled.</p>",
- "TopicRuleListItem$ruleDisabled": "<p>Specifies whether the rule is disabled.</p>",
- "TopicRulePayload$ruleDisabled": "<p>Specifies whether the rule is disabled.</p>"
- }
- },
- "Key": {
- "base": null,
- "refs": {
- "S3Action$key": "<p>The object key.</p>"
- }
- },
- "KeyPair": {
- "base": "<p>Describes a key pair.</p>",
- "refs": {
- "CreateKeysAndCertificateResponse$keyPair": "<p>The generated key pair.</p>"
- }
- },
- "KinesisAction": {
- "base": "<p>Describes an action to write data to an Amazon Kinesis stream.</p>",
- "refs": {
- "Action$kinesis": "<p>Write data to an Amazon Kinesis stream.</p>"
- }
- },
- "LambdaAction": {
- "base": "<p>Describes an action to invoke a Lambda function.</p>",
- "refs": {
- "Action$lambda": "<p>Invoke a Lambda function.</p>"
- }
- },
- "LimitExceededException": {
- "base": "<p>The number of attached entities exceeds the limit.</p>",
- "refs": {
- }
- },
- "ListCACertificatesRequest": {
- "base": "<p>Input for the ListCACertificates operation.</p>",
- "refs": {
- }
- },
- "ListCACertificatesResponse": {
- "base": "<p>The output from the ListCACertificates operation.</p>",
- "refs": {
- }
- },
- "ListCertificatesByCARequest": {
- "base": "<p>The input to the ListCertificatesByCA operation.</p>",
- "refs": {
- }
- },
- "ListCertificatesByCAResponse": {
- "base": "<p>The output of the ListCertificatesByCA operation.</p>",
- "refs": {
- }
- },
- "ListCertificatesRequest": {
- "base": "<p>The input for the ListCertificates operation.</p>",
- "refs": {
- }
- },
- "ListCertificatesResponse": {
- "base": "<p>The output of the ListCertificates operation.</p>",
- "refs": {
- }
- },
- "ListOutgoingCertificatesRequest": {
- "base": "<p>The input to the ListOutgoingCertificates operation.</p>",
- "refs": {
- }
- },
- "ListOutgoingCertificatesResponse": {
- "base": "<p>The output from the ListOutgoingCertificates operation.</p>",
- "refs": {
- }
- },
- "ListPoliciesRequest": {
- "base": "<p>The input for the ListPolicies operation.</p>",
- "refs": {
- }
- },
- "ListPoliciesResponse": {
- "base": "<p>The output from the ListPolicies operation.</p>",
- "refs": {
- }
- },
- "ListPolicyPrincipalsRequest": {
- "base": "<p>The input for the ListPolicyPrincipals operation.</p>",
- "refs": {
- }
- },
- "ListPolicyPrincipalsResponse": {
- "base": "<p>The output from the ListPolicyPrincipals operation.</p>",
- "refs": {
- }
- },
- "ListPolicyVersionsRequest": {
- "base": "<p>The input for the ListPolicyVersions operation.</p>",
- "refs": {
- }
- },
- "ListPolicyVersionsResponse": {
- "base": "<p>The output from the ListPolicyVersions operation.</p>",
- "refs": {
- }
- },
- "ListPrincipalPoliciesRequest": {
- "base": "<p>The input for the ListPrincipalPolicies operation.</p>",
- "refs": {
- }
- },
- "ListPrincipalPoliciesResponse": {
- "base": "<p>The output from the ListPrincipalPolicies operation.</p>",
- "refs": {
- }
- },
- "ListPrincipalThingsRequest": {
- "base": "<p>The input for the ListPrincipalThings operation.</p>",
- "refs": {
- }
- },
- "ListPrincipalThingsResponse": {
- "base": "<p>The output from the ListPrincipalThings operation.</p>",
- "refs": {
- }
- },
- "ListThingPrincipalsRequest": {
- "base": "<p>The input for the ListThingPrincipal operation.</p>",
- "refs": {
- }
- },
- "ListThingPrincipalsResponse": {
- "base": "<p>The output from the ListThingPrincipals operation.</p>",
- "refs": {
- }
- },
- "ListThingTypesRequest": {
- "base": "<p>The input for the ListThingTypes operation.</p>",
- "refs": {
- }
- },
- "ListThingTypesResponse": {
- "base": "<p>The output for the ListThingTypes operation.</p>",
- "refs": {
- }
- },
- "ListThingsRequest": {
- "base": "<p>The input for the ListThings operation.</p>",
- "refs": {
- }
- },
- "ListThingsResponse": {
- "base": "<p>The output from the ListThings operation.</p>",
- "refs": {
- }
- },
- "ListTopicRulesRequest": {
- "base": "<p>The input for the ListTopicRules operation.</p>",
- "refs": {
- }
- },
- "ListTopicRulesResponse": {
- "base": "<p>The output from the ListTopicRules operation.</p>",
- "refs": {
- }
- },
- "LogLevel": {
- "base": null,
- "refs": {
- "GetLoggingOptionsResponse$logLevel": "<p>The logging level.</p>",
- "LoggingOptionsPayload$logLevel": "<p>The logging level.</p>"
- }
- },
- "LoggingOptionsPayload": {
- "base": "<p>Describes the logging options payload.</p>",
- "refs": {
- "SetLoggingOptionsRequest$loggingOptionsPayload": "<p>The logging options payload.</p>"
- }
- },
- "MalformedPolicyException": {
- "base": "<p>The policy documentation is not valid.</p>",
- "refs": {
- }
- },
- "Marker": {
- "base": null,
- "refs": {
- "ListCACertificatesRequest$marker": "<p>The marker for the next set of results.</p>",
- "ListCACertificatesResponse$nextMarker": "<p>The current position within the list of CA certificates.</p>",
- "ListCertificatesByCARequest$marker": "<p>The marker for the next set of results.</p>",
- "ListCertificatesByCAResponse$nextMarker": "<p>The marker for the next set of results, or null if there are no additional results.</p>",
- "ListCertificatesRequest$marker": "<p>The marker for the next set of results.</p>",
- "ListCertificatesResponse$nextMarker": "<p>The marker for the next set of results, or null if there are no additional results.</p>",
- "ListOutgoingCertificatesRequest$marker": "<p>The marker for the next set of results.</p>",
- "ListOutgoingCertificatesResponse$nextMarker": "<p>The marker for the next set of results.</p>",
- "ListPoliciesRequest$marker": "<p>The marker for the next set of results.</p>",
- "ListPoliciesResponse$nextMarker": "<p>The marker for the next set of results, or null if there are no additional results.</p>",
- "ListPolicyPrincipalsRequest$marker": "<p>The marker for the next set of results.</p>",
- "ListPolicyPrincipalsResponse$nextMarker": "<p>The marker for the next set of results, or null if there are no additional results.</p>",
- "ListPrincipalPoliciesRequest$marker": "<p>The marker for the next set of results.</p>",
- "ListPrincipalPoliciesResponse$nextMarker": "<p>The marker for the next set of results, or null if there are no additional results.</p>"
- }
- },
- "MaxResults": {
- "base": null,
- "refs": {
- "ListPrincipalThingsRequest$maxResults": "<p>The maximum number of results to return in this operation.</p>",
- "ListThingTypesRequest$maxResults": "<p>The maximum number of results to return in this operation.</p>",
- "ListThingsRequest$maxResults": "<p>The maximum number of results to return in this operation.</p>",
- "ListTopicRulesRequest$maxResults": "<p>The maximum number of results to return.</p>"
- }
- },
- "Message": {
- "base": null,
- "refs": {
- "OutgoingCertificate$transferMessage": "<p>The transfer message.</p>",
- "RejectCertificateTransferRequest$rejectReason": "<p>The reason the certificate transfer was rejected.</p>",
- "TransferCertificateRequest$transferMessage": "<p>The transfer message.</p>",
- "TransferData$transferMessage": "<p>The transfer message.</p>",
- "TransferData$rejectReason": "<p>The reason why the transfer was rejected.</p>"
- }
- },
- "MessageFormat": {
- "base": null,
- "refs": {
- "SnsAction$messageFormat": "<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>"
- }
- },
- "MetricName": {
- "base": null,
- "refs": {
- "CloudwatchMetricAction$metricName": "<p>The CloudWatch metric name.</p>"
- }
- },
- "MetricNamespace": {
- "base": null,
- "refs": {
- "CloudwatchMetricAction$metricNamespace": "<p>The CloudWatch metric namespace name.</p>"
- }
- },
- "MetricTimestamp": {
- "base": null,
- "refs": {
- "CloudwatchMetricAction$metricTimestamp": "<p>An optional <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp\">Unix timestamp</a>.</p>"
- }
- },
- "MetricUnit": {
- "base": null,
- "refs": {
- "CloudwatchMetricAction$metricUnit": "<p>The <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit\">metric unit</a> supported by CloudWatch.</p>"
- }
- },
- "MetricValue": {
- "base": null,
- "refs": {
- "CloudwatchMetricAction$metricValue": "<p>The CloudWatch metric value.</p>"
- }
- },
- "NextToken": {
- "base": null,
- "refs": {
- "ListPrincipalThingsRequest$nextToken": "<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>",
- "ListPrincipalThingsResponse$nextToken": "<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>",
- "ListThingTypesRequest$nextToken": "<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>",
- "ListThingTypesResponse$nextToken": "<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>",
- "ListThingsRequest$nextToken": "<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>",
- "ListThingsResponse$nextToken": "<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>",
- "ListTopicRulesRequest$nextToken": "<p>A token used to retrieve the next value.</p>",
- "ListTopicRulesResponse$nextToken": "<p>A token used to retrieve the next value.</p>"
- }
- },
- "OptionalVersion": {
- "base": null,
- "refs": {
- "DeleteThingRequest$expectedVersion": "<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>",
- "UpdateThingRequest$expectedVersion": "<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>"
- }
- },
- "OutgoingCertificate": {
- "base": "<p>A certificate that has been transfered but not yet accepted.</p>",
- "refs": {
- "OutgoingCertificates$member": null
- }
- },
- "OutgoingCertificates": {
- "base": null,
- "refs": {
- "ListOutgoingCertificatesResponse$outgoingCertificates": "<p>The certificates that are being transfered but not yet accepted.</p>"
- }
- },
- "PageSize": {
- "base": null,
- "refs": {
- "ListCACertificatesRequest$pageSize": "<p>The result page size.</p>",
- "ListCertificatesByCARequest$pageSize": "<p>The result page size.</p>",
- "ListCertificatesRequest$pageSize": "<p>The result page size.</p>",
- "ListOutgoingCertificatesRequest$pageSize": "<p>The result page size.</p>",
- "ListPoliciesRequest$pageSize": "<p>The result page size.</p>",
- "ListPolicyPrincipalsRequest$pageSize": "<p>The result page size.</p>",
- "ListPrincipalPoliciesRequest$pageSize": "<p>The result page size.</p>"
- }
- },
- "PartitionKey": {
- "base": null,
- "refs": {
- "KinesisAction$partitionKey": "<p>The partition key.</p>"
- }
- },
- "PayloadField": {
- "base": null,
- "refs": {
- "DynamoDBAction$payloadField": "<p>The action payload. This name can be customized.</p>"
- }
- },
- "Policies": {
- "base": null,
- "refs": {
- "ListPoliciesResponse$policies": "<p>The descriptions of the policies.</p>",
- "ListPrincipalPoliciesResponse$policies": "<p>The policies.</p>"
- }
- },
- "Policy": {
- "base": "<p>Describes an AWS IoT policy.</p>",
- "refs": {
- "Policies$member": null
- }
- },
- "PolicyArn": {
- "base": null,
- "refs": {
- "CreatePolicyResponse$policyArn": "<p>The policy ARN.</p>",
- "CreatePolicyVersionResponse$policyArn": "<p>The policy ARN.</p>",
- "GetPolicyResponse$policyArn": "<p>The policy ARN.</p>",
- "GetPolicyVersionResponse$policyArn": "<p>The policy ARN.</p>",
- "Policy$policyArn": "<p>The policy ARN.</p>"
- }
- },
- "PolicyDocument": {
- "base": null,
- "refs": {
- "CreatePolicyRequest$policyDocument": "<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>",
- "CreatePolicyResponse$policyDocument": "<p>The JSON document that describes the policy.</p>",
- "CreatePolicyVersionRequest$policyDocument": "<p>The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespaces</p>",
- "CreatePolicyVersionResponse$policyDocument": "<p>The JSON document that describes the policy.</p>",
- "GetPolicyResponse$policyDocument": "<p>The JSON document that describes the policy.</p>",
- "GetPolicyVersionResponse$policyDocument": "<p>The JSON document that describes the policy.</p>"
- }
- },
- "PolicyName": {
- "base": null,
- "refs": {
- "AttachPrincipalPolicyRequest$policyName": "<p>The policy name.</p>",
- "CreatePolicyRequest$policyName": "<p>The policy name.</p>",
- "CreatePolicyResponse$policyName": "<p>The policy name.</p>",
- "CreatePolicyVersionRequest$policyName": "<p>The policy name.</p>",
- "DeletePolicyRequest$policyName": "<p>The name of the policy to delete.</p>",
- "DeletePolicyVersionRequest$policyName": "<p>The name of the policy.</p>",
- "DetachPrincipalPolicyRequest$policyName": "<p>The name of the policy to detach.</p>",
- "GetPolicyRequest$policyName": "<p>The name of the policy.</p>",
- "GetPolicyResponse$policyName": "<p>The policy name.</p>",
- "GetPolicyVersionRequest$policyName": "<p>The name of the policy.</p>",
- "GetPolicyVersionResponse$policyName": "<p>The policy name.</p>",
- "ListPolicyPrincipalsRequest$policyName": "<p>The policy name.</p>",
- "ListPolicyVersionsRequest$policyName": "<p>The policy name.</p>",
- "Policy$policyName": "<p>The policy name.</p>",
- "SetDefaultPolicyVersionRequest$policyName": "<p>The policy name.</p>"
- }
- },
- "PolicyVersion": {
- "base": "<p>Describes a policy version.</p>",
- "refs": {
- "PolicyVersions$member": null
- }
- },
- "PolicyVersionId": {
- "base": null,
- "refs": {
- "CreatePolicyResponse$policyVersionId": "<p>The policy version ID.</p>",
- "CreatePolicyVersionResponse$policyVersionId": "<p>The policy version ID.</p>",
- "DeletePolicyVersionRequest$policyVersionId": "<p>The policy version ID.</p>",
- "GetPolicyResponse$defaultVersionId": "<p>The default policy version ID.</p>",
- "GetPolicyVersionRequest$policyVersionId": "<p>The policy version ID.</p>",
- "GetPolicyVersionResponse$policyVersionId": "<p>The policy version ID.</p>",
- "PolicyVersion$versionId": "<p>The policy version ID.</p>",
- "SetDefaultPolicyVersionRequest$policyVersionId": "<p>The policy version ID.</p>"
- }
- },
- "PolicyVersions": {
- "base": null,
- "refs": {
- "ListPolicyVersionsResponse$policyVersions": "<p>The policy versions.</p>"
- }
- },
- "Principal": {
- "base": null,
- "refs": {
- "AttachPrincipalPolicyRequest$principal": "<p>The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.</p>",
- "AttachThingPrincipalRequest$principal": "<p>The principal, such as a certificate or other credential.</p>",
- "DetachPrincipalPolicyRequest$principal": "<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>",
- "DetachThingPrincipalRequest$principal": "<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>",
- "ListPrincipalPoliciesRequest$principal": "<p>The principal.</p>",
- "ListPrincipalThingsRequest$principal": "<p>The principal.</p>"
- }
- },
- "PrincipalArn": {
- "base": null,
- "refs": {
- "Principals$member": null
- }
- },
- "Principals": {
- "base": null,
- "refs": {
- "ListPolicyPrincipalsResponse$principals": "<p>The descriptions of the principals.</p>",
- "ListThingPrincipalsResponse$principals": "<p>The principals associated with the thing.</p>"
- }
- },
- "PrivateKey": {
- "base": null,
- "refs": {
- "KeyPair$PrivateKey": "<p>The private key.</p>"
- }
- },
- "PublicKey": {
- "base": null,
- "refs": {
- "KeyPair$PublicKey": "<p>The public key.</p>"
- }
- },
- "QueueUrl": {
- "base": null,
- "refs": {
- "SqsAction$queueUrl": "<p>The URL of the Amazon SQS queue.</p>"
- }
- },
- "RangeKeyField": {
- "base": null,
- "refs": {
- "DynamoDBAction$rangeKeyField": "<p>The range key name.</p>"
- }
- },
- "RangeKeyValue": {
- "base": null,
- "refs": {
- "DynamoDBAction$rangeKeyValue": "<p>The range key value.</p>"
- }
- },
- "RegisterCACertificateRequest": {
- "base": "<p>The input to the RegisterCACertificate operation.</p>",
- "refs": {
- }
- },
- "RegisterCACertificateResponse": {
- "base": "<p>The output from the RegisterCACertificateResponse operation.</p>",
- "refs": {
- }
- },
- "RegisterCertificateRequest": {
- "base": "<p>The input to the RegisterCertificate operation.</p>",
- "refs": {
- }
- },
- "RegisterCertificateResponse": {
- "base": "<p>The output from the RegisterCertificate operation.</p>",
- "refs": {
- }
- },
- "RegistrationCode": {
- "base": null,
- "refs": {
- "GetRegistrationCodeResponse$registrationCode": "<p>The CA certificate registration code.</p>"
- }
- },
- "RegistrationCodeValidationException": {
- "base": "<p>The registration code is invalid.</p>",
- "refs": {
- }
- },
- "RejectCertificateTransferRequest": {
- "base": "<p>The input for the RejectCertificateTransfer operation.</p>",
- "refs": {
- }
- },
- "RemoveThingType": {
- "base": null,
- "refs": {
- "UpdateThingRequest$removeThingType": "<p>Remove a thing type association. If <b>true</b>, the assocation is removed.</p>"
- }
- },
- "ReplaceTopicRuleRequest": {
- "base": "<p>The input for the ReplaceTopicRule operation.</p>",
- "refs": {
- }
- },
- "RepublishAction": {
- "base": "<p>Describes an action to republish to another topic.</p>",
- "refs": {
- "Action$republish": "<p>Publish to another MQTT topic.</p>"
- }
- },
- "ResourceAlreadyExistsException": {
- "base": "<p>The resource already exists.</p>",
- "refs": {
- }
- },
- "ResourceNotFoundException": {
- "base": "<p>The specified resource does not exist.</p>",
- "refs": {
- }
- },
- "RuleArn": {
- "base": null,
- "refs": {
- "GetTopicRuleResponse$ruleArn": "<p>The rule ARN.</p>",
- "TopicRuleListItem$ruleArn": "<p>The rule ARN.</p>"
- }
- },
- "RuleName": {
- "base": null,
- "refs": {
- "CreateTopicRuleRequest$ruleName": "<p>The name of the rule.</p>",
- "DeleteTopicRuleRequest$ruleName": "<p>The name of the rule.</p>",
- "DisableTopicRuleRequest$ruleName": "<p>The name of the rule to disable.</p>",
- "EnableTopicRuleRequest$ruleName": "<p>The name of the topic rule to enable.</p>",
- "GetTopicRuleRequest$ruleName": "<p>The name of the rule.</p>",
- "ReplaceTopicRuleRequest$ruleName": "<p>The name of the rule.</p>",
- "TopicRule$ruleName": "<p>The name of the rule.</p>",
- "TopicRuleListItem$ruleName": "<p>The name of the rule.</p>"
- }
- },
- "S3Action": {
- "base": "<p>Describes an action to write data to an Amazon S3 bucket.</p>",
- "refs": {
- "Action$s3": "<p>Write to an Amazon S3 bucket.</p>"
- }
- },
- "SQL": {
- "base": null,
- "refs": {
- "TopicRule$sql": "<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>",
- "TopicRulePayload$sql": "<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>"
- }
- },
- "SearchableAttributes": {
- "base": null,
- "refs": {
- "ThingTypeProperties$searchableAttributes": "<p>A list of searchable thing attribute names.</p>"
- }
- },
- "ServiceUnavailableException": {
- "base": "<p>The service is temporarily unavailable.</p>",
- "refs": {
- }
- },
- "SetAsActive": {
- "base": null,
- "refs": {
- "AcceptCertificateTransferRequest$setAsActive": "<p>Specifies whether the certificate is active.</p>",
- "CreateCertificateFromCsrRequest$setAsActive": "<p>Specifies whether the certificate is active.</p>",
- "CreateKeysAndCertificateRequest$setAsActive": "<p>Specifies whether the certificate is active.</p>",
- "RegisterCACertificateRequest$setAsActive": "<p>A boolean value that specifies if the CA certificate is set to active.</p>",
- "RegisterCertificateRequest$setAsActive": "<p>A boolean value that specifies if the CA certificate is set to active.</p>"
- }
- },
- "SetAsDefault": {
- "base": null,
- "refs": {
- "CreatePolicyVersionRequest$setAsDefault": "<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>"
- }
- },
- "SetDefaultPolicyVersionRequest": {
- "base": "<p>The input for the SetDefaultPolicyVersion operation.</p>",
- "refs": {
- }
- },
- "SetLoggingOptionsRequest": {
- "base": "<p>The input for the SetLoggingOptions operation.</p>",
- "refs": {
- }
- },
- "SnsAction": {
- "base": "<p>Describes an action to publish to an Amazon SNS topic.</p>",
- "refs": {
- "Action$sns": "<p>Publish to an Amazon SNS topic.</p>"
- }
- },
- "SqlParseException": {
- "base": "<p>The Rule-SQL expression can't be parsed correctly.</p>",
- "refs": {
- }
- },
- "SqsAction": {
- "base": "<p>Describes an action to publish data to an Amazon SQS queue.</p>",
- "refs": {
- "Action$sqs": "<p>Publish to an Amazon SQS queue.</p>"
- }
- },
- "StateReason": {
- "base": null,
- "refs": {
- "CloudwatchAlarmAction$stateReason": "<p>The reason for the alarm change.</p>"
- }
- },
- "StateValue": {
- "base": null,
- "refs": {
- "CloudwatchAlarmAction$stateValue": "<p>The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.</p>"
- }
- },
- "StreamName": {
- "base": null,
- "refs": {
- "KinesisAction$streamName": "<p>The name of the Amazon Kinesis stream.</p>"
- }
- },
- "TableName": {
- "base": null,
- "refs": {
- "DynamoDBAction$tableName": "<p>The name of the DynamoDB table.</p>"
- }
- },
- "ThingArn": {
- "base": null,
- "refs": {
- "CreateThingResponse$thingArn": "<p>The ARN of the new thing.</p>"
- }
- },
- "ThingAttribute": {
- "base": "<p>The properties of the thing, including thing name, thing type name, and a list of thing attributes.</p>",
- "refs": {
- "ThingAttributeList$member": null
- }
- },
- "ThingAttributeList": {
- "base": null,
- "refs": {
- "ListThingsResponse$things": "<p>The things.</p>"
- }
- },
- "ThingName": {
- "base": null,
- "refs": {
- "AttachThingPrincipalRequest$thingName": "<p>The name of the thing.</p>",
- "CreateThingRequest$thingName": "<p>The name of the thing to create.</p>",
- "CreateThingResponse$thingName": "<p>The name of the new thing.</p>",
- "DeleteThingRequest$thingName": "<p>The name of the thing to delete.</p>",
- "DescribeThingRequest$thingName": "<p>The name of the thing.</p>",
- "DescribeThingResponse$thingName": "<p>The name of the thing.</p>",
- "DetachThingPrincipalRequest$thingName": "<p>The name of the thing.</p>",
- "ListThingPrincipalsRequest$thingName": "<p>The name of the thing.</p>",
- "ThingAttribute$thingName": "<p>The name of the thing.</p>",
- "ThingNameList$member": null,
- "UpdateThingRequest$thingName": "<p>The name of the thing to update.</p>"
- }
- },
- "ThingNameList": {
- "base": null,
- "refs": {
- "ListPrincipalThingsResponse$things": "<p>The things.</p>"
- }
- },
- "ThingTypeArn": {
- "base": null,
- "refs": {
- "CreateThingTypeResponse$thingTypeArn": "<p>The Amazon Resource Name (ARN) of the thing type.</p>"
- }
- },
- "ThingTypeDefinition": {
- "base": "<p>The definition of the thing type, including thing type name and description.</p>",
- "refs": {
- "ThingTypeList$member": null
- }
- },
- "ThingTypeDescription": {
- "base": null,
- "refs": {
- "ThingTypeProperties$thingTypeDescription": "<p>The description of the thing type.</p>"
- }
- },
- "ThingTypeList": {
- "base": null,
- "refs": {
- "ListThingTypesResponse$thingTypes": "<p>The thing types.</p>"
- }
- },
- "ThingTypeMetadata": {
- "base": "<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>",
- "refs": {
- "DescribeThingTypeResponse$thingTypeMetadata": null,
- "ThingTypeDefinition$thingTypeMetadata": null
- }
- },
- "ThingTypeName": {
- "base": null,
- "refs": {
- "CreateThingRequest$thingTypeName": "<p>The name of the thing type associated with the new thing.</p>",
- "CreateThingTypeRequest$thingTypeName": "<p>The name of the thing type.</p>",
- "CreateThingTypeResponse$thingTypeName": "<p>The name of the thing type.</p>",
- "DeleteThingTypeRequest$thingTypeName": "<p>The name of the thing type.</p>",
- "DeprecateThingTypeRequest$thingTypeName": "<p>The name of the thing type to deprecate.</p>",
- "DescribeThingResponse$thingTypeName": "<p>The thing type name.</p>",
- "DescribeThingTypeRequest$thingTypeName": "<p>The name of the thing type.</p>",
- "DescribeThingTypeResponse$thingTypeName": "<p>The name of the thing type.</p>",
- "ListThingTypesRequest$thingTypeName": "<p>The name of the thing type.</p>",
- "ListThingsRequest$thingTypeName": "<p>The name of the thing type used to search for things.</p>",
- "ThingAttribute$thingTypeName": "<p>The name of the thing type, if the thing has been associated with a type.</p>",
- "ThingTypeDefinition$thingTypeName": "<p>The name of the thing type.</p>",
- "UpdateThingRequest$thingTypeName": "<p>The name of the thing type.</p>"
- }
- },
- "ThingTypeProperties": {
- "base": "<p>The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.</p>",
- "refs": {
- "CreateThingTypeRequest$thingTypeProperties": "<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>",
- "DescribeThingTypeResponse$thingTypeProperties": "<p>The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.</p>",
- "ThingTypeDefinition$thingTypeProperties": "<p>The ThingTypeProperties for the thing type.</p>"
- }
- },
- "ThrottlingException": {
- "base": "<p>The rate exceeds the limit.</p>",
- "refs": {
- }
- },
- "Topic": {
- "base": null,
- "refs": {
- "ListTopicRulesRequest$topic": "<p>The topic.</p>"
- }
- },
- "TopicPattern": {
- "base": null,
- "refs": {
- "RepublishAction$topic": "<p>The name of the MQTT topic.</p>",
- "TopicRuleListItem$topicPattern": "<p>The pattern for the topic names that apply.</p>"
- }
- },
- "TopicRule": {
- "base": "<p>Describes a rule.</p>",
- "refs": {
- "GetTopicRuleResponse$rule": "<p>The rule.</p>"
- }
- },
- "TopicRuleList": {
- "base": null,
- "refs": {
- "ListTopicRulesResponse$rules": "<p>The rules.</p>"
- }
- },
- "TopicRuleListItem": {
- "base": "<p>Describes a rule.</p>",
- "refs": {
- "TopicRuleList$member": null
- }
- },
- "TopicRulePayload": {
- "base": "<p>Describes a rule.</p>",
- "refs": {
- "CreateTopicRuleRequest$topicRulePayload": "<p>The rule payload.</p>",
- "ReplaceTopicRuleRequest$topicRulePayload": "<p>The rule payload.</p>"
- }
- },
- "TransferAlreadyCompletedException": {
- "base": "<p>You can't revert the certificate transfer because the transfer is already complete.</p>",
- "refs": {
- }
- },
- "TransferCertificateRequest": {
- "base": "<p>The input for the TransferCertificate operation.</p>",
- "refs": {
- }
- },
- "TransferCertificateResponse": {
- "base": "<p>The output from the TransferCertificate operation.</p>",
- "refs": {
- }
- },
- "TransferConflictException": {
- "base": "<p>You can't transfer the certificate because authorization policies are still attached.</p>",
- "refs": {
- }
- },
- "TransferData": {
- "base": "<p>Data used to transfer a certificate to an AWS account.</p>",
- "refs": {
- "CertificateDescription$transferData": "<p>The transfer data.</p>"
- }
- },
- "UnauthorizedException": {
- "base": "<p>You are not authorized to perform this operation.</p>",
- "refs": {
- }
- },
- "UndoDeprecate": {
- "base": null,
- "refs": {
- "DeprecateThingTypeRequest$undoDeprecate": "<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>"
- }
- },
- "UpdateCACertificateRequest": {
- "base": "<p>The input to the UpdateCACertificate operation.</p>",
- "refs": {
- }
- },
- "UpdateCertificateRequest": {
- "base": "<p>The input for the UpdateCertificate operation.</p>",
- "refs": {
- }
- },
- "UpdateThingRequest": {
- "base": "<p>The input for the UpdateThing operation.</p>",
- "refs": {
- }
- },
- "UpdateThingResponse": {
- "base": "<p>The output from the UpdateThing operation.</p>",
- "refs": {
- }
- },
- "UseBase64": {
- "base": null,
- "refs": {
- "SqsAction$useBase64": "<p>Specifies whether to use Base64 encoding.</p>"
- }
- },
- "Version": {
- "base": null,
- "refs": {
- "DescribeThingResponse$version": "<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>",
- "ThingAttribute$version": "<p>The version of the thing record in the registry.</p>"
- }
- },
- "VersionConflictException": {
- "base": "<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>",
- "refs": {
- }
- },
- "VersionsLimitExceededException": {
- "base": "<p>The number of policy versions exceeds the limit.</p>",
- "refs": {
- }
- },
- "errorMessage": {
- "base": null,
- "refs": {
- "CertificateConflictException$message": "<p>The message for the exception.</p>",
- "CertificateStateException$message": "<p>The message for the exception.</p>",
- "CertificateValidationException$message": "<p>Additional information about the exception.</p>",
- "DeleteConflictException$message": "<p>The message for the exception.</p>",
- "InternalException$message": "<p>The message for the exception.</p>",
- "InternalFailureException$message": "<p>The message for the exception.</p>",
- "InvalidRequestException$message": "<p>The message for the exception.</p>",
- "LimitExceededException$message": "<p>The message for the exception.</p>",
- "MalformedPolicyException$message": "<p>The message for the exception.</p>",
- "RegistrationCodeValidationException$message": "<p>Additional information about the exception.</p>",
- "ResourceAlreadyExistsException$message": "<p>The message for the exception.</p>",
- "ResourceNotFoundException$message": "<p>The message for the exception.</p>",
- "ServiceUnavailableException$message": "<p>The message for the exception.</p>",
- "SqlParseException$message": "<p>The message for the exception.</p>",
- "ThrottlingException$message": "<p>The message for the exception.</p>",
- "TransferAlreadyCompletedException$message": "<p>The message for the exception.</p>",
- "TransferConflictException$message": "<p>The message for the exception.</p>",
- "UnauthorizedException$message": "<p>The message for the exception.</p>",
- "VersionConflictException$message": "<p>The message for the exception.</p>",
- "VersionsLimitExceededException$message": "<p>The message for the exception.</p>"
- }
- }
- }
- }
|