Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities.
Requires permission to access the AttachThingPrincipal action.
" }, { "info": { "name": "Amazon IoT Device Defender Detach Thing Principal", "type": "http" }, "http": { "method": "DELETE", "url": "http://iot.{region}.amazonaws.com/things/:thingName/principals#x-amzn-principal", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" }, { "name": "x-amzn-principal", "value": "" } ], "params": [ { "name": "thingName", "value": "", "type": "path", "description": "The name of the thing." } ] }, "docs": "Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This call is asynchronous. It might take several seconds for the detachment to propagate.
Requires permission to access the DetachThingPrincipal action.
" }, { "info": { "name": "Amazon IoT Device Defender Cancel Job Execution", "type": "http" }, "http": { "method": "PUT", "url": "http://iot.{region}.amazonaws.com/things/:thingName/jobs/:jobId/cancel", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job to be canceled." }, { "name": "thingName", "value": "", "type": "path", "description": "The name of the thing whose execution of the job will be canceled." }, { "name": "force", "value": "", "type": "query", "description": "(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.
Canceling a job execution which is \"IN_PROGRESS\", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
" }, { "info": { "name": "Amazon IoT Device Defender Describe Thing", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/things/:thingName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "thingName", "value": "", "type": "path", "description": "The name of the thing." } ] }, "docs": "Gets information about the specified thing.
Requires permission to access the DescribeThing action.
" }, { "info": { "name": "Amazon IoT Device Defender Create Thing", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/things/:thingName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "thingName", "value": "", "type": "path", "description": "The name of the thing to create.
You can't change a thing's name after you create it. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.
" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
The name of the thing to update.You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.
" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the data for a thing.
Requires permission to access the UpdateThing action.
" }, { "info": { "name": "Amazon IoT Device Defender Delete Thing", "type": "http" }, "http": { "method": "DELETE", "url": "http://iot.{region}.amazonaws.com/things/:thingName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "thingName", "value": "", "type": "path", "description": "The name of the thing to delete." }, { "name": "expectedVersion", "value": "", "type": "query", "description": "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, theDeleteThing request is rejected with a VersionConflictException."
}
]
},
"docs": "Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
Requires permission to access the DeleteThing action.
" }, { "info": { "name": "Amazon IoT Device Defender Delete Job Execution", "type": "http" }, "http": { "method": "DELETE", "url": "http://iot.{region}.amazonaws.com/things/:thingName/jobs/:jobId/executionNumber/:executionNumber", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job whose execution on a particular device will be deleted." }, { "name": "thingName", "value": "", "type": "path", "description": "The name of the thing whose job execution will be deleted." }, { "name": "executionNumber", "value": "", "type": "path", "description": "The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.
Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.
(Optional) When true, you can delete a job execution which is \"IN_PROGRESS\". Otherwise, you can only delete a job execution which is in a terminal state (\"SUCCEEDED\", \"FAILED\", \"REJECTED\", \"REMOVED\" or \"CANCELED\") or an exception will occur. The default is false.
Deleting a job execution which is \"IN_PROGRESS\", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
" }, { "info": { "name": "Amazon IoT Device Defender Describe Job Execution", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/things/:thingName/jobs/:jobId", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The unique identifier you assigned to this job when it was created." }, { "name": "thingName", "value": "", "type": "path", "description": "The name of the thing on which the job execution is running." }, { "name": "executionNumber", "value": "", "type": "query", "description": "A string (consisting of the digits \"0\" through \"9\" which is used to specify a particular job execution on a particular device." } ] }, "docs": "Describes a job execution.
Requires permission to access the DescribeJobExecution action.
" }, { "info": { "name": "Amazon IoT Device Defender List Job Executions for Thing", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/things/:thingName/jobs", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "thingName", "value": "", "type": "path", "description": "The thing name." }, { "name": "status", "value": "", "type": "query", "description": "An optional filter that lets you search for jobs that have the specified status." }, { "name": "namespaceId", "value": "", "type": "query", "description": "The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
" }, { "info": { "name": "Amazon IoT Device Defender List Thing Groups for Thing", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/things/:thingName/thing-groups", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "thingName", "value": "", "type": "path", "description": "The thing name." }, { "name": "nextToken", "value": "", "type": "query", "description": "To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of results to return at one time."
}
]
},
"docs": "List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
" }, { "info": { "name": "Amazon IoT Device Defender List Thing Principals", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/things/:thingName/principals", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "nextToken", "value": "", "type": "query", "description": "To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of results to return in this operation."
},
{
"name": "thingName",
"value": "",
"type": "path",
"description": "The name of the thing."
}
]
},
"docs": "Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListThingPrincipals action.
" }, { "info": { "name": "Amazon IoT Device Defender List Things", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/things", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "nextToken", "value": "", "type": "query", "description": "To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of results to return in this operation."
},
{
"name": "attributeName",
"value": "",
"type": "query",
"description": "The attribute name used to search for things."
},
{
"name": "attributeValue",
"value": "",
"type": "query",
"description": "The attribute value used to search for things."
},
{
"name": "thingTypeName",
"value": "",
"type": "query",
"description": "The name of the thing type used to search for things."
},
{
"name": "usePrefixAttributeValue",
"value": "",
"type": "query",
"description": "When true, the action returns the thing resources with attribute values that start with the attributeValue provided.
When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.
Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. For more information, see List Things from the Amazon Web Services IoT Core Developer Guid"
},
{
"info": {
"name": "Amazon IoT Device Defender Register Thing",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://iot.{region}.amazonaws.com/things",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.
Requires permission to access the