AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
License: Apache 2.0 License
Resources
Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
Request
Path
| Name | Data Type | Description |
|---|---|---|
certificateId
|
string Pattern: (0x)?[a-fA-F0-9]+Minimum: 64 Maximum: 64 |
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) |
Query
| Name | Data Type | Description |
|---|---|---|
setAsActive
|
boolean |
Specifies whether the certificate is active. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TransferAlreadyCompletedException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Lists the active violations for a given Device Defender security profile.
Request
Query
| Name | Data Type | Description |
|---|---|---|
thingName
|
string Minimum: 1 Maximum: 128 |
The name of the thing whose active violations are listed. |
securityProfileName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name of the Device Defender security profile for which violations are listed. |
nextToken
|
string |
The token for the next set of results. |
maxResults
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to return at one time. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListActiveViolationsResponse
|
object |
Properties
nextToken
|
NextToken |
A token that can be used to retrieve the next set of results, or |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
activeViolations
|
ActiveViolations |
The list of active violations. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Lists the policies attached to the specified thing group.
Request
Path
| Name | Data Type | Description |
|---|---|---|
target
|
string |
The group or principal for which the policies will be listed. |
Query
| Name | Data Type | Description |
|---|---|---|
recursive
|
boolean |
When true, recursively list attached policies. |
marker
|
string Pattern: [A-Za-z0-9+/]+={0,2}
|
The token to retrieve the next set of results. |
pageSize
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to be returned per request. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAttachedPoliciesResponse
|
object |
Properties
nextMarker
|
Marker |
The token to retrieve the next set of results, or |
|||||||||||||||||
|
|||||||||||||||||||
policies
|
Policies |
The policies. |
|||||||||||||||||
|
|||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
deleteScheduledAudits
|
boolean |
If true, all scheduled audits are deleted. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteAccountAuditConfigurationResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
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.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeAccountAuditConfigurationResponse
|
object |
Properties
auditCheckConfigurations
|
AuditCheckConfigurations |
Which audit checks are enabled and disabled for this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
AuditCheckConfiguration
Which audit checks are enabled and disabled for this account. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
auditNotificationTargetConfigurations
|
AuditNotificationTargetConfigurations |
Information about the targets to which audit notifications are sent for this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
AuditNotificationTarget
Information about the targets to which audit notifications are sent. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
roleArn
|
RoleArn |
The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit. On the first call to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
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.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
auditCheckConfigurations
|
object |
Specifies which audit checks are enabled and disabled for this account. Use Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted. You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself. On the first call to |
auditNotificationTargetConfigurations
|
object |
Information about the targets to which audit notifications are sent. |
roleArn
|
string Minimum: 20 Maximum: 2048 |
The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
UpdateAccountAuditConfigurationResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.
Request
Path
| Name | Data Type | Description |
|---|---|---|
findingId
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeAuditFindingResponse
|
object |
Properties
finding
|
AuditFinding | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
endTime
|
dateTime |
A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both. |
startTime
|
dateTime |
A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both. |
nextToken
|
string |
The token for the next set of results. |
maxResults
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to return at one time. The default is 25. |
resourceIdentifier
|
||
checkName
|
string |
An audit check name. Checks must be enabled for your account. (Use |
taskId
|
string Pattern: [a-zA-Z0-9\-]+Minimum: 1 Maximum: 40 |
A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAuditFindingsResponse
|
object |
Properties
nextToken
|
NextToken |
A token that can be used to retrieve the next set of results, or |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
findings
|
AuditFindings |
The findings (results) of the audit. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Gets the status of audit mitigation action tasks that were executed.
Request
Query
| Name | Data Type | Description |
|---|---|---|
taskId
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
Specify this filter to limit results to actions for a specific audit mitigation actions task. |
actionStatus
|
string Allowed values: - IN_PROGRESS- COMPLETED- FAILED- CANCELED- SKIPPED- PENDING |
Specify this filter to limit results to those with a specific status. |
findingId
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
Specify this filter to limit results to those that were applied to a specific audit finding. |
maxResults
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to return at one time. The default is 25. |
nextToken
|
string |
The token for the next set of results. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAuditMitigationActionsExecutionsResponse
|
object |
Properties
nextToken
|
NextToken |
The token for the next set of results. |
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
actionsExecutions
|
AuditMitigationActionExecutionMetadataList |
A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status. |
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Gets a list of audit mitigation action tasks that match the specified filters.
Request
Query
| Name | Data Type | Description |
|---|---|---|
auditTaskId
|
string Pattern: [a-zA-Z0-9\-]+Minimum: 1 Maximum: 40 |
Specify this filter to limit results to tasks that were applied to results for a specific audit. |
findingId
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
Specify this filter to limit results to tasks that were applied to a specific audit finding. |
taskStatus
|
string Allowed values: - IN_PROGRESS- COMPLETED- FAILED- CANCELED |
Specify this filter to limit results to tasks that are in a specific state. |
maxResults
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to return at one time. The default is 25. |
nextToken
|
string |
The token for the next set of results. |
startTime
|
dateTime |
Specify this filter to limit results to tasks that began on or after a specific date and time. |
endTime
|
dateTime |
Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAuditMitigationActionsTasksResponse
|
object |
Properties
nextToken
|
NextToken |
The token for the next set of results. |
||||||||||||||||||||
|
||||||||||||||||||||||
tasks
|
AuditMitigationActionsTaskMetadataList |
The collection of audit mitigation tasks that matched the filter criteria. |
||||||||||||||||||||
|
||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
Request
Path
| Name | Data Type | Description |
|---|---|---|
taskId
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
The unique identifier for the task that you want to cancel. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CancelAuditMitigationActionsTaskResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
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.
Request
Path
| Name | Data Type | Description |
|---|---|---|
taskId
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
The unique identifier for the audit mitigation task. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeAuditMitigationActionsTaskResponse
|
object |
Properties
actionsDefinition
|
MitigationActionList |
Specifies the mitigation actions and their parameters that are applied as part of this task. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
auditCheckToActionsMapping
|
AuditCheckToActionsMapping |
Specifies the mitigation actions that should be applied to specific audit checks. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
MitigationActionNameList
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target
|
AuditMitigationActionsTaskTarget |
Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taskStatistics
|
AuditMitigationActionsTaskStatistics |
Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
TaskStatisticsForAuditCheck
Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
endTime
|
Timestamp |
The date and time when the task was completed or canceled. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
startTime
|
Timestamp |
The date and time when the task was started. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taskStatus
|
AuditMitigationActionsTaskStatus |
The current status of the task. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Starts a task that applies a set of mitigation actions to the specified target.
Request
Path
| Name | Data Type | Description |
|---|---|---|
taskId
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
clientRequestToken
|
string Pattern: ^[a-zA-Z0-9-_]+$Minimum: 1 Maximum: 64 |
Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically. |
auditCheckToActionsMapping
|
object |
For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account. |
target
|
Responses
Body
| Name | Data Type | Description |
|---|---|---|
StartAuditMitigationActionsTaskResponse
|
object |
Properties
taskId
|
AuditMitigationActionsTaskId |
The unique identifier for the audit mitigation task. This matches the |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
TaskAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Deletes a scheduled audit.
Request
Path
| Name | Data Type | Description |
|---|---|---|
scheduledAuditName
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
The name of the scheduled audit you want to delete. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteScheduledAuditResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Gets information about a scheduled audit.
Request
Path
| Name | Data Type | Description |
|---|---|---|
scheduledAuditName
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
The name of the scheduled audit whose information you want to get. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeScheduledAuditResponse
|
object |
Properties
scheduledAuditArn
|
ScheduledAuditArn |
The ARN of the scheduled audit. |
|||||||||||
|
|||||||||||||
scheduledAuditName
|
ScheduledAuditName |
The name of the scheduled audit. |
|||||||||||
|
|||||||||||||
targetCheckNames
|
TargetAuditCheckNames |
Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use |
|||||||||||
|
|||||||||||||
dayOfWeek
|
DayOfWeek |
The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". |
|||||||||||
|
|||||||||||||
dayOfMonth
|
DayOfMonth |
The day of the month on which the scheduled audit takes place. Will be "1" through "31" or "LAST". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month. |
|||||||||||
|
|||||||||||||
frequency
|
AuditFrequency |
How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system. |
|||||||||||
|
|||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Request
Path
| Name | Data Type | Description |
|---|---|---|
scheduledAuditName
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
The name of the scheduled audit. (Max. 128 chars) |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
targetCheckNames
|
array [AuditCheckName] |
Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use |
||||
|
||||||
dayOfWeek
|
string Allowed values: - SUN- MON- TUE- WED- THU- FRI- SAT |
The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY". |
||||
dayOfMonth
|
string Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
|
The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month. |
||||
frequency
|
string Allowed values: - DAILY- WEEKLY- BIWEEKLY- MONTHLY |
How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system. |
||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
UpdateScheduledAuditResponse
|
object |
Properties
scheduledAuditArn
|
ScheduledAuditArn |
The ARN of the scheduled audit. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Creates a scheduled audit that is run at a specified time interval.
Request
Path
| Name | Data Type | Description |
|---|---|---|
scheduledAuditName
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
The name you want to give to the scheduled audit. (Max. 128 chars) |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
tags
|
array [Tag] |
Metadata that can be used to manage the scheduled audit. |
||||
targetCheckNames
|
array [AuditCheckName] |
Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use |
||||
|
||||||
dayOfWeek
|
string Allowed values: - SUN- MON- TUE- WED- THU- FRI- SAT |
The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY". |
||||
dayOfMonth
|
string Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
|
The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month. |
||||
frequency
|
string Allowed values: - DAILY- WEEKLY- BIWEEKLY- MONTHLY |
How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the system. |
||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateScheduledAuditResponse
|
object |
Properties
scheduledAuditArn
|
ScheduledAuditArn |
The ARN of the scheduled audit. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Lists all of your scheduled audits.
Request
Query
| Name | Data Type | Description |
|---|---|---|
nextToken
|
string |
The token for the next set of results. |
maxResults
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to return at one time. The default is 25. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListScheduledAuditsResponse
|
object |
Properties
nextToken
|
NextToken |
A token that can be used to retrieve the next set of results, or |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
scheduledAudits
|
ScheduledAuditMetadataList |
The list of scheduled audits. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Lists the Device Defender audits that have been performed during a given time period.
Request
Query
| Name | Data Type | Description |
|---|---|---|
startTime
|
dateTime |
The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException". |
endTime
|
dateTime |
The end of the time period. |
taskType
|
string Allowed values: - ON_DEMAND_AUDIT_TASK- SCHEDULED_AUDIT_TASK |
A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK". |
taskStatus
|
string Allowed values: - IN_PROGRESS- COMPLETED- FAILED- CANCELED |
A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED". |
nextToken
|
string |
The token for the next set of results. |
maxResults
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to return at one time. The default is 25. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAuditTasksResponse
|
object |
Properties
nextToken
|
NextToken |
A token that can be used to retrieve the next set of results, or |
||||||||||||||||||||
|
||||||||||||||||||||||
tasks
|
AuditTaskMetadataList |
The audits that were performed during the specified time period. |
||||||||||||||||||||
|
||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
Request
Path
| Name | Data Type | Description |
|---|---|---|
taskId
|
string Pattern: [a-zA-Z0-9\-]+Minimum: 1 Maximum: 40 |
The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS". |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CancelAuditTaskResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Gets information about a Device Defender audit.
Request
Path
| Name | Data Type | Description |
|---|---|---|
taskId
|
string Pattern: [a-zA-Z0-9\-]+Minimum: 1 Maximum: 40 |
The ID of the audit whose information you want to get. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeAuditTaskResponse
|
object |
Properties
auditDetails
|
AuditDetails |
Detailed information about each check performed during this audit. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
AuditCheckDetails
Information about the audit check. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
scheduledAuditName
|
ScheduledAuditName |
The name of the scheduled audit (only if the audit was a scheduled audit). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taskStatistics
|
TaskStatistics |
Statistical information about the audit. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taskStartTime
|
Timestamp |
The time the audit started. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taskType
|
AuditTaskType |
The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK". |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taskStatus
|
AuditTaskStatus |
The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED". |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Starts an on-demand Device Defender audit.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
targetCheckNames
|
array [AuditCheckName] |
Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
StartOnDemandAuditTaskResponse
|
object |
Properties
taskId
|
AuditTaskId |
The ID of the on-demand audit you started. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.
Request
Path
| Name | Data Type | Description |
|---|---|---|
authorizerName
|
string Pattern: [\w=,@-]+Minimum: 1 Maximum: 128 |
The custom authorizer name. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
tokenSignature
|
string Pattern: [A-Za-z0-9+/]+={0,2}Minimum: 1 Maximum: 2560 |
The signature made with the token and your custom authentication service's private key. |
token
|
string Minimum: 1 Maximum: 6144 |
The token returned by your custom authentication service. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
TestInvokeAuthorizerResponse
|
object |
Properties
disconnectAfterInSeconds
|
Seconds |
The number of seconds after which the connection is terminated. |
|||||||||||
|
|||||||||||||
refreshAfterInSeconds
|
Seconds |
The number of seconds after which the temporary credentials are refreshed. |
|||||||||||
|
|||||||||||||
policyDocuments
|
PolicyDocuments |
IAM policy documents. |
|||||||||||
|
|||||||||||||
principalId
|
PrincipalId |
The principal ID. |
|||||||||||
|
|||||||||||||
isAuthenticated
|
IsAuthenticated |
True if the token is authenticated, otherwise false. |
|||||||||||
|
|||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidResponseException
|
Deletes an authorizer.
Request
Path
| Name | Data Type | Description |
|---|---|---|
authorizerName
|
string Pattern: [\w=,@-]+Minimum: 1 Maximum: 128 |
The name of the authorizer to delete. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteAuthorizerResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Describes an authorizer.
Request
Path
| Name | Data Type | Description |
|---|---|---|
authorizerName
|
string Pattern: [\w=,@-]+Minimum: 1 Maximum: 128 |
The name of the authorizer to describe. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeAuthorizerResponse
|
object |
Properties
authorizerDescription
|
AuthorizerDescription |
The authorizer description. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Creates an authorizer.
Request
Path
| Name | Data Type | Description |
|---|---|---|
authorizerName
|
string Pattern: [\w=,@-]+Minimum: 1 Maximum: 128 |
The authorizer name. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
status
|
string Allowed values: - ACTIVE- INACTIVE |
The status of the create authorizer request. |
tokenSigningPublicKeys
|
object |
The public keys used to verify the digital signature returned by your custom authentication service. |
tokenKeyName
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
The name of the token key used to extract the token from the HTTP headers. |
authorizerFunctionArn
|
string |
The ARN of the authorizer's Lambda function. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateAuthorizerResponse
|
object |
Properties
authorizerArn
|
AuthorizerArn |
The authorizer ARN. |
||||
|
||||||
authorizerName
|
AuthorizerName |
The authorizer's name. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Updates an authorizer.
Request
Path
| Name | Data Type | Description |
|---|---|---|
authorizerName
|
string Pattern: [\w=,@-]+Minimum: 1 Maximum: 128 |
The authorizer name. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
status
|
string Allowed values: - ACTIVE- INACTIVE |
The status of the update authorizer request. |
tokenSigningPublicKeys
|
object |
The public keys used to verify the token signature. |
tokenKeyName
|
string Pattern: [a-zA-Z0-9_-]+Minimum: 1 Maximum: 128 |
The key used to extract the token from the HTTP headers. |
authorizerFunctionArn
|
string |
The ARN of the authorizer's Lambda function. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
UpdateAuthorizerResponse
|
object |
Properties
authorizerArn
|
AuthorizerArn |
The authorizer ARN. |
||||
|
||||||
authorizerName
|
AuthorizerName |
The authorizer name. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Lists the authorizers registered in your account.
Request
Query
| Name | Data Type | Description |
|---|---|---|
pageSize
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to return at one time. |
marker
|
string Pattern: [A-Za-z0-9+/]+={0,2}
|
A marker used to get the next set of results. |
isAscendingOrder
|
boolean |
Return the list of authorizers in ascending alphabetical order. |
status
|
string Allowed values: - ACTIVE- INACTIVE |
The status of the list authorizers request. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAuthorizersResponse
|
object |
Properties
nextMarker
|
Marker |
A marker used to get the next set of results. |
|||||||||||||||||
|
|||||||||||||||||||
authorizers
|
Authorizers |
The authorizers. |
|||||||||||||||||
|
|||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Adds a thing to a billing group.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
thingArn
|
string |
The ARN of the thing to be added to the billing group. |
thingName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name of the thing to be added to the billing group. |
billingGroupArn
|
string |
The ARN of the billing group. |
billingGroupName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name of the billing group. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AddThingToBillingGroupResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Removes the given thing from the billing group.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
thingArn
|
string |
The ARN of the thing to be removed from the billing group. |
thingName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name of the thing to be removed from the billing group. |
billingGroupArn
|
string |
The ARN of the billing group. |
billingGroupName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name of the billing group. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
RemoveThingFromBillingGroupResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Lists the things you have added to the given billing group.
Request
Path
| Name | Data Type | Description |
|---|---|---|
billingGroupName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name of the billing group. |
Query
| Name | Data Type | Description |
|---|---|---|
nextToken
|
string |
The token to retrieve the next set of results. |
maxResults
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to return per request. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListThingsInBillingGroupResponse
|
object |
Properties
nextToken
|
NextToken |
The token used to get the next set of results, or null if there are no additional results. |
|||||||||||
|
|||||||||||||
things
|
ThingNameList |
A list of things in the billing group. |
|||||||||||
|
|||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Deletes the billing group.
Request
Path
| Name | Data Type | Description |
|---|---|---|
billingGroupName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name of the billing group. |
Query
| Name | Data Type | Description |
|---|---|---|
expectedVersion
|
integer |
The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBillingGroupResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
VersionConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Returns information about a billing group.
Request
Path
| Name | Data Type | Description |
|---|---|---|
billingGroupName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name of the billing group. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeBillingGroupResponse
|
object |
Properties
billingGroupMetadata
|
BillingGroupMetadata |
Additional information about the billing group. |
||||||||||||||
Properties
|
||||||||||||||||
billingGroupProperties
|
BillingGroupProperties |
The properties of the billing group. |
||||||||||||||
Properties
|
||||||||||||||||
version
|
Version |
The version of the billing group. |
||||||||||||||
|
||||||||||||||||
billingGroupArn
|
BillingGroupArn |
The ARN of the billing group. |
||||||||||||||
|
||||||||||||||||
billingGroupId
|
BillingGroupId |
The ID of the billing group. |
||||||||||||||
|
||||||||||||||||
billingGroupName
|
BillingGroupName |
The name of the billing group. |
||||||||||||||
|
||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Updates information about the billing group.
Request
Path
| Name | Data Type | Description |
|---|---|---|
billingGroupName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name of the billing group. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
expectedVersion
|
integer |
The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the |
billingGroupProperties
|
Responses
Body
| Name | Data Type | Description |
|---|---|---|
UpdateBillingGroupResponse
|
object |
Properties
version
|
Version |
The latest version of the billing group. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
VersionConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Creates a billing group.
Request
Path
| Name | Data Type | Description |
|---|---|---|
billingGroupName
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
The name you wish to give to the billing group. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
tags
|
array [Tag] |
Metadata which can be used to manage the billing group. |
|
billingGroupProperties
|
|||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateBillingGroupResponse
|
object |
Properties
billingGroupId
|
BillingGroupId |
The ID of the billing group. |
||||
|
||||||
billingGroupArn
|
BillingGroupArn |
The ARN of the billing group. |
||||
|
||||||
billingGroupName
|
BillingGroupName |
The name you gave to the billing group. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Lists the billing groups you have created.
Request
Query
| Name | Data Type | Description |
|---|---|---|
nextToken
|
string |
The token to retrieve the next set of results. |
maxResults
|
integer Minimum: 1 Maximum: 250 |
The maximum number of results to return per request. |
namePrefixFilter
|
string Pattern: [a-zA-Z0-9:_-]+Minimum: 1 Maximum: 128 |
Limit the results to billing groups whose names have the given prefix. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListBillingGroupsResponse
|
object |
Properties
nextToken
|
NextToken |
The token used to get the next set of results, or null if there are no additional results. |
|||||||||||||||||
|
|||||||||||||||||||
billingGroups
|
BillingGroupNameAndArnList |
The list of billing groups. |
|||||||||||||||||
|
|||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Deletes a registered CA certificate.
Request
Path
| Name | Data Type | Description |
|---|---|---|
caCertificateId
|
string Pattern: (0x)?[a-fA-F0-9]+Minimum: 64 Maximum: 64 |
The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.) |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteCACertificateResponse
|
object |
The output for the DeleteCACertificate operation. |
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
CertificateStateException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Describes a registered CA certificate.
Request
Path
| Name | Data Type | Description |
|---|---|---|
caCertificateId
|
string Pattern: (0x)?[a-fA-F0-9]+Minimum: 64 Maximum: 64 |
The CA certificate identifier. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeCACertificateResponse
|
object |
The output from the DescribeCACertificate operation. |
Properties
registrationConfig
|
RegistrationConfig |
Information about the registration configuration. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
certificateDescription
|
CACertificateDescription |
The CA certificate description. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Updates a registered CA certificate.
Request
Path
| Name | Data Type | Description |
|---|---|---|
caCertificateId
|
string Pattern: (0x)?[a-fA-F0-9]+Minimum: 64 Maximum: 64 |
The CA certificate identifier. |
Query
| Name | Data Type | Description |
|---|---|---|
newStatus
|
string Allowed values: - ACTIVE- INACTIVE |
The updated status of the CA certificate. Note: The status value REGISTER_INACTIVE is deprecated and should not be used. |
newAutoRegistrationStatus
|
string Allowed values: - ENABLE- DISABLE |
The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE". |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
removeAutoRegistration
|
boolean |
If true, removes auto registration. |
registrationConfig
|
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ThrottlingException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalFailureException
|
Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
Request
Query
| Name | Data Type | Description |
|---|---|---|
setAsActive
|
boolean |
A boolean value that specifies if the CA certificate is set to active. |
allowAutoRegistration
|
boolean |
Allows this CA certificate to be used for auto registration of device certificates. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
registrationConfig
|
||
verificationCertificate
|
string Minimum: 1 Maximum: 65536 |
The PEM of a certificate. |
caCertificate
|
string Minimum: 1 Maximum: 65536 |
The PEM of a certificate. |