{ "opencollection": "1.0.0", "info": { "name": "AWS IoT Accept Certificate Transfer Audit API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Audit", "type": "folder" }, "items": [ { "info": { "name": "Amazon IoT Device Defender Cancel Audit Mitigation Actions Task", "type": "http" }, "http": { "method": "PUT", "url": "http://iot.{region}.amazonaws.com/audit/mitigationactions/tasks/:taskId/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": "taskId", "value": "", "type": "path", "description": "The unique identifier for the task that you want to cancel. " } ] }, "docs": "
Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
Requires permission to access the CancelAuditMitigationActionsTask action.
" }, { "info": { "name": "Amazon IoT Device Defender Cancel Audit Task", "type": "http" }, "http": { "method": "PUT", "url": "http://iot.{region}.amazonaws.com/audit/tasks/:taskId/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": "taskId", "value": "", "type": "path", "description": "The ID of the audit you want to cancel. You can only cancel an audit that is \"IN_PROGRESS\"." } ] }, "docs": "Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an \"InvalidRequestException\" occurs.
Requires permission to access the CancelAuditTask action.
" }, { "info": { "name": "Amazon IoT Device Defender Create Audit Suppression", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/audit/suppressions/create", "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": "Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
" }, { "info": { "name": "Amazon IoT Device Defender Describe Scheduled Audit", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/audit/scheduledaudits/:scheduledAuditName", "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": "scheduledAuditName", "value": "", "type": "path", "description": "The name of the scheduled audit whose information you want to get." } ] }, "docs": "Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
" }, { "info": { "name": "Amazon IoT Device Defender Create Scheduled Audit", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/audit/scheduledaudits/:scheduledAuditName", "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": "scheduledAuditName", "value": "", "type": "path", "description": "The name you want to give to the scheduled audit. (Max. 128 chars)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
" }, { "info": { "name": "Amazon IoT Device Defender Update Scheduled Audit", "type": "http" }, "http": { "method": "PATCH", "url": "http://iot.{region}.amazonaws.com/audit/scheduledaudits/:scheduledAuditName", "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": "scheduledAuditName", "value": "", "type": "path", "description": "The name of the scheduled audit. (Max. 128 chars)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Requires permission to access the UpdateScheduledAudit action.
" }, { "info": { "name": "Amazon IoT Device Defender Delete Scheduled Audit", "type": "http" }, "http": { "method": "DELETE", "url": "http://iot.{region}.amazonaws.com/audit/scheduledaudits/:scheduledAuditName", "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": "scheduledAuditName", "value": "", "type": "path", "description": "The name of the scheduled audit you want to delete." } ] }, "docs": "Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
" }, { "info": { "name": "Amazon IoT Device Defender Describe Account Audit Configuration", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/audit/configuration", "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": "" } ] }, "docs": "Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the DescribeAccountAuditConfiguration action.
" }, { "info": { "name": "Amazon IoT Device Defender Update Account Audit Configuration", "type": "http" }, "http": { "method": "PATCH", "url": "http://iot.{region}.amazonaws.com/audit/configuration", "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": "Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the UpdateAccountAuditConfiguration action.
" }, { "info": { "name": "Amazon IoT Device Defender Delete Account Audit Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "http://iot.{region}.amazonaws.com/audit/configuration", "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": "deleteScheduledAudits", "value": "", "type": "query", "description": "If true, all scheduled audits are deleted." } ] }, "docs": "Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
Requires permission to access the DeleteAccountAuditConfiguration action.
" }, { "info": { "name": "Amazon IoT Device Defender Delete Audit Suppression", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/audit/suppressions/delete", "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": "Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
" }, { "info": { "name": "Amazon IoT Device Defender Describe Audit Finding", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/audit/findings/:findingId", "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": "findingId", "value": "", "type": "path", "description": "A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding." } ] }, "docs": "Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
Requires permission to access the DescribeAuditFinding action.
" }, { "info": { "name": "Amazon IoT Device Defender Describe Audit Mitigation Actions Task", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/audit/mitigationactions/tasks/:taskId", "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": "taskId", "value": "", "type": "path", "description": "The unique identifier for the audit mitigation task." } ] }, "docs": "Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics." }, { "info": { "name": "Amazon IoT Device Defender Start Audit Mitigation Actions Task", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/audit/mitigationactions/tasks/:taskId", "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": "taskId", "value": "", "type": "path", "description": "A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
" }, { "info": { "name": "Amazon IoT Device Defender Describe Audit Suppression", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/audit/suppressions/describe", "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": " Gets information about a Device Defender audit suppression. " }, { "info": { "name": "Amazon IoT Device Defender Describe Audit Task", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/audit/tasks/:taskId", "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": "taskId", "value": "", "type": "path", "description": "The ID of the audit whose information you want to get." } ] }, "docs": "Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
" }, { "info": { "name": "Amazon IoT Device Defender List Audit Findings", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/audit/findings", "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": "maxResults", "value": "", "type": "query", "description": "Pagination limit" }, { "name": "nextToken", "value": "", "type": "query", "description": "Pagination token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)
Requires permission to access the ListAuditFindings action.
" }, { "info": { "name": "Amazon IoT Device Defender List Audit Mitigation Actions Executions", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/audit/mitigationactions/executions#taskId&findingId", "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": "taskId", "value": "", "type": "query", "description": "Specify this filter to limit results to actions for a specific audit mitigation actions task." }, { "name": "actionStatus", "value": "", "type": "query", "description": "Specify this filter to limit results to those with a specific status." }, { "name": "findingId", "value": "", "type": "query", "description": "Specify this filter to limit results to those that were applied to a specific audit finding." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of results to return at one time. The default is 25." }, { "name": "nextToken", "value": "", "type": "query", "description": "The token for the next set of results." } ] }, "docs": "Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
" }, { "info": { "name": "Amazon IoT Device Defender List Audit Mitigation Actions Tasks", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/audit/mitigationactions/tasks#startTime&endTime", "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": "auditTaskId", "value": "", "type": "query", "description": "Specify this filter to limit results to tasks that were applied to results for a specific audit." }, { "name": "findingId", "value": "", "type": "query", "description": "Specify this filter to limit results to tasks that were applied to a specific audit finding." }, { "name": "taskStatus", "value": "", "type": "query", "description": "Specify this filter to limit results to tasks that are in a specific state." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of results to return at one time. The default is 25." }, { "name": "nextToken", "value": "", "type": "query", "description": "The token for the next set of results." }, { "name": "startTime", "value": "", "type": "query", "description": "Specify this filter to limit results to tasks that began on or after a specific date and time." }, { "name": "endTime", "value": "", "type": "query", "description": "Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time." } ] }, "docs": "Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
" }, { "info": { "name": "Amazon IoT Device Defender List Audit Suppressions", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/audit/suppressions/list", "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": "maxResults", "value": "", "type": "query", "description": "Pagination limit" }, { "name": "nextToken", "value": "", "type": "query", "description": "Pagination token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
" }, { "info": { "name": "Amazon IoT Device Defender List Audit Tasks", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/audit/tasks#startTime&endTime", "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": "startTime", "value": "", "type": "query", "description": "The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an \"InvalidRequestException\"." }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time period." }, { "name": "taskType", "value": "", "type": "query", "description": "A filter to limit the output to the specified type of audit: can be one of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\"." }, { "name": "taskStatus", "value": "", "type": "query", "description": "A filter to limit the output to audits with the specified completion status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\"." }, { "name": "nextToken", "value": "", "type": "query", "description": "The token for the next set of results." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of results to return at one time. The default is 25." } ] }, "docs": "Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
" }, { "info": { "name": "Amazon IoT Device Defender List Related Resources for Audit Finding", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/audit/relatedResources#findingId", "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": "findingId", "value": "", "type": "query", "description": "The finding Id." }, { "name": "nextToken", "value": "", "type": "query", "description": "A token that can be used to retrieve the next set of results, ornull if there are no additional results."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of results to return at one time."
}
]
},
"docs": "The related resources of an Audit finding. The following resources can be returned from calling this API:
DEVICE_CERTIFICATE
CA_CERTIFICATE
IOT_POLICY
COGNITO_IDENTITY_POOL
CLIENT_ID
ACCOUNT_SETTINGS
ROLE_ALIAS
IAM_ROLE
ISSUER_CERTIFICATE
This API is similar to DescribeAuditFinding's Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
" }, { "info": { "name": "Amazon IoT Device Defender Start on Demand Audit Task", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/audit/tasks", "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": "Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
" }, { "info": { "name": "Amazon IoT Device Defender Update Audit Suppression", "type": "http" }, "http": { "method": "PATCH", "url": "http://iot.{region}.amazonaws.com/audit/suppressions/update", "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": " Updates a Device Defender audit suppression. " } ] } ], "bundled": true }