null if there are no
additional results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: audit-scheduledaudits
path: /audit/scheduledaudits
operations:
- name: listscheduledaudits
method: GET
description: Amazon IoT Device Management List Scheduled Audits
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time. The default is 25.
- name: audit-scheduledaudits-scheduledAuditName
path: /audit/scheduledaudits/{scheduledAuditName}
operations:
- name: createscheduledaudit
method: POST
description: Amazon IoT Device Management Create Scheduled Audit
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: scheduledAuditName
in: path
type: string
description: The name you want to give to the scheduled audit. (Max. 128 chars)
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletescheduledaudit
method: DELETE
description: Amazon IoT Device Management Delete Scheduled Audit
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: scheduledAuditName
in: path
type: string
description: The name of the scheduled audit you want to delete.
required: true
- name: describescheduledaudit
method: GET
description: Amazon IoT Device Management Describe Scheduled Audit
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: scheduledAuditName
in: path
type: string
description: The name of the scheduled audit whose information you want to get.
required: true
- name: updatescheduledaudit
method: PATCH
description: Amazon IoT Device Management Update Scheduled Audit
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: scheduledAuditName
in: path
type: string
description: The name of the scheduled audit. (Max. 128 chars)
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: audit-suppressions-create
path: /audit/suppressions/create
operations:
- name: createauditsuppression
method: POST
description: Amazon IoT Device Management Create Audit Suppression
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: audit-suppressions-delete
path: /audit/suppressions/delete
operations:
- name: deleteauditsuppression
method: POST
description: Amazon IoT Device Management Delete Audit Suppression
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: audit-suppressions-describe
path: /audit/suppressions/describe
operations:
- name: describeauditsuppression
method: POST
description: Amazon IoT Device Management Describe Audit Suppression
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: audit-suppressions-list
path: /audit/suppressions/list
operations:
- name: listauditsuppressions
method: POST
description: Amazon IoT Device Management List Audit Suppressions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: maxResults
in: query
type: string
description: Pagination limit
- name: nextToken
in: query
type: string
description: Pagination token
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: audit-suppressions-update
path: /audit/suppressions/update
operations:
- name: updateauditsuppression
method: PATCH
description: Amazon IoT Device Management Update Audit Suppression
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: audit-tasks
path: /audit/tasks
operations:
- name: startondemandaudittask
method: POST
description: Amazon IoT Device Management Start on Demand Audit Task
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: audit-tasks#startTime&endTime
path: /audit/tasks#startTime&endTime
operations:
- name: listaudittasks
method: GET
description: Amazon IoT Device Management List Audit Tasks
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: startTime
in: query
type: string
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 "I
required: true
- name: endTime
in: query
type: string
description: The end of the time period.
required: true
- name: taskType
in: query
type: string
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
in: query
type: string
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
in: query
type: string
description: The token for the next set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time. The default is 25.
- name: audit-tasks-taskId
path: /audit/tasks/{taskId}
operations:
- name: describeaudittask
method: GET
description: Amazon IoT Device Management Describe Audit Task
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: taskId
in: path
type: string
description: The ID of the audit whose information you want to get.
required: true
- name: audit-tasks-taskId-cancel
path: /audit/tasks/{taskId}/cancel
operations:
- name: cancelaudittask
method: PUT
description: Amazon IoT Device Management Cancel Audit Task
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: taskId
in: path
type: string
description: The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".
required: true
- name: authorizer-authorizerName
path: /authorizer/{authorizerName}
operations:
- name: createauthorizer
method: POST
description: Amazon IoT Device Management Create Authorizer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: authorizerName
in: path
type: string
description: The authorizer name.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deleteauthorizer
method: DELETE
description: Amazon IoT Device Management Delete Authorizer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: authorizerName
in: path
type: string
description: The name of the authorizer to delete.
required: true
- name: describeauthorizer
method: GET
description: Amazon IoT Device Management Describe Authorizer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: authorizerName
in: path
type: string
description: The name of the authorizer to describe.
required: true
- name: updateauthorizer
method: PUT
description: Amazon IoT Device Management Update Authorizer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: authorizerName
in: path
type: string
description: The authorizer name.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: authorizer-authorizerName-test
path: /authorizer/{authorizerName}/test
operations:
- name: testinvokeauthorizer
method: POST
description: Amazon IoT Device Management Test Invoke Authorizer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: authorizerName
in: path
type: string
description: The custom authorizer name.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: authorizers
path: /authorizers/
operations:
- name: listauthorizers
method: GET
description: Amazon IoT Device Management List Authorizers
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The maximum number of results to return at one time.
- name: marker
in: query
type: string
description: A marker used to get the next set of results.
- name: isAscendingOrder
in: query
type: boolean
description: Return the list of authorizers in ascending alphabetical order.
- name: status
in: query
type: string
description: The status of the list authorizers request.
- name: behavior-model-training-summaries
path: /behavior-model-training/summaries
operations:
- name: getbehaviormodeltrainingsummaries
method: GET
description: Amazon IoT Device Management Get Behavior Model Training Summaries
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: securityProfileName
in: query
type: string
description: The name of the security profile.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time. The default is 10.
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: billing-groups
path: /billing-groups
operations:
- name: listbillinggroups
method: GET
description: Amazon IoT Device Management List Billing Groups
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return per request.
- name: namePrefixFilter
in: query
type: string
description: Limit the results to billing groups whose names have the given prefix.
- name: billing-groups-addThingToBillingGroup
path: /billing-groups/addThingToBillingGroup
operations:
- name: addthingtobillinggroup
method: PUT
description: Amazon IoT Device Management Add Thing to Billing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: billing-groups-removeThingFromBillingGroup
path: /billing-groups/removeThingFromBillingGroup
operations:
- name: removethingfrombillinggroup
method: PUT
description: Amazon IoT Device Management Remove Thing from Billing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: billing-groups-billingGroupName
path: /billing-groups/{billingGroupName}
operations:
- name: createbillinggroup
method: POST
description: Amazon IoT Device Management Create Billing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: billingGroupName
in: path
type: string
description: The name you wish to give to the billing group.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletebillinggroup
method: DELETE
description: Amazon IoT Device Management Delete Billing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: billingGroupName
in: path
type: string
description: The name of the billing group.
required: true
- name: expectedVersion
in: query
type: integer
description: 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 DeleteBil
- name: describebillinggroup
method: GET
description: Amazon IoT Device Management Describe Billing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: billingGroupName
in: path
type: string
description: The name of the billing group.
required: true
- name: updatebillinggroup
method: PATCH
description: Amazon IoT Device Management Update Billing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: billingGroupName
in: path
type: string
description: The name of the billing group.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: billing-groups-billingGroupName-things
path: /billing-groups/{billingGroupName}/things
operations:
- name: listthingsinbillinggroup
method: GET
description: Amazon IoT Device Management List Things in Billing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: billingGroupName
in: path
type: string
description: The name of the billing group.
required: true
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return per request.
- name: cacertificate
path: /cacertificate
operations:
- name: registercacertificate
method: POST
description: Amazon IoT Device Management Register C a Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: setAsActive
in: query
type: boolean
description: 'A boolean value that specifies if the CA certificate is set to active.
Valid values: ACTIVE
| INACTIVE
'
- name: allowAutoRegistration
in: query
type: boolean
description: Allows this CA certificate to be used for auto registration of device certificates.
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: cacertificate-caCertificateId
path: /cacertificate/{caCertificateId}
operations:
- name: deletecacertificate
method: DELETE
description: Amazon IoT Device Management Delete C a Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: caCertificateId
in: path
type: string
description: The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate
ID.)
required: true
- name: describecacertificate
method: GET
description: Amazon IoT Device Management Describe C a Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: caCertificateId
in: path
type: string
description: The CA certificate identifier.
required: true
- name: updatecacertificate
method: PUT
description: Amazon IoT Device Management Update C a Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: caCertificateId
in: path
type: string
description: The CA certificate identifier.
required: true
- name: newStatus
in: query
type: string
description: The updated status of the CA certificate.
Note: The status value REGISTER_INACTIVE
is deprecated and should not be used.
- name: newAutoRegistrationStatus
in: query
type: string
description: 'The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".'
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: cacertificates
path: /cacertificates
operations:
- name: listcacertificates
method: GET
description: Amazon IoT Device Management List C a Certificates
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The result page size.
- name: marker
in: query
type: string
description: The marker for the next set of results.
- name: isAscendingOrder
in: query
type: boolean
description: Determines the order of the results.
- name: templateName
in: query
type: string
description: The name of the provisioning template.
- name: cancel-certificate-transfer-certificateId
path: /cancel-certificate-transfer/{certificateId}
operations:
- name: cancelcertificatetransfer
method: PATCH
description: Amazon IoT Device Management Cancel Certificate Transfer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: certificateId
in: path
type: string
description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
required: true
- name: certificate-register
path: /certificate/register
operations:
- name: registercertificate
method: POST
description: Amazon IoT Device Management Register Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: setAsActive
in: query
type: boolean
description: 'A boolean value that specifies if the certificate is set to active.
Valid values: ACTIVE
| INACTIVE
'
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: certificate-register-no-ca
path: /certificate/register-no-ca
operations:
- name: registercertificatewithoutca
method: POST
description: Amazon IoT Device Management Register Certificate Without C a
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: certificates
path: /certificates
operations:
- name: createcertificatefromcsr
method: POST
description: Amazon IoT Device Management Create Certificate from Csr
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: setAsActive
in: query
type: boolean
description: Specifies whether the certificate is active.
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: listcertificates
method: GET
description: Amazon IoT Device Management List Certificates
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The result page size.
- name: marker
in: query
type: string
description: The marker for the next set of results.
- name: isAscendingOrder
in: query
type: boolean
description: Specifies the order for results. If True, the results are returned in ascending order, based on the
creation date.
- name: certificates-by-ca-caCertificateId
path: /certificates-by-ca/{caCertificateId}
operations:
- name: listcertificatesbyca
method: GET
description: Amazon IoT Device Management List Certificates by C a
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: caCertificateId
in: path
type: string
description: The ID of the CA certificate. This operation will list all registered device certificate that were
signed by this CA certificate.
required: true
- name: pageSize
in: query
type: integer
description: The result page size.
- name: marker
in: query
type: string
description: The marker for the next set of results.
- name: isAscendingOrder
in: query
type: boolean
description: Specifies the order for results. If True, the results are returned in ascending order, based on the
creation date.
- name: certificates-out-going
path: /certificates-out-going
operations:
- name: listoutgoingcertificates
method: GET
description: Amazon IoT Device Management List Outgoing Certificates
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The result page size.
- name: marker
in: query
type: string
description: The marker for the next set of results.
- name: isAscendingOrder
in: query
type: boolean
description: Specifies the order for results. If True, the results are returned in ascending order, based on the
creation date.
- name: certificates-certificateId
path: /certificates/{certificateId}
operations:
- name: deletecertificate
method: DELETE
description: Amazon IoT Device Management Delete Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: certificateId
in: path
type: string
description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
required: true
- name: forceDelete
in: query
type: boolean
description: Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.
- name: describecertificate
method: GET
description: Amazon IoT Device Management Describe Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: certificateId
in: path
type: string
description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
required: true
- name: certificates-certificateId}#newStatus
path: /certificates/{certificateId}#newStatus
operations:
- name: updatecertificate
method: PUT
description: Amazon IoT Device Management Update Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: certificateId
in: path
type: string
description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
required: true
- name: newStatus
in: query
type: string
description: 'The new status.
Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION
will result in an exception being thrown. PENDING_TRANSFER '
required: true
- name: confirmdestination-confirmationToken
path: /confirmdestination/{confirmationToken}
operations:
- name: confirmtopicruledestination
method: GET
description: Amazon IoT Device Management Confirm Topic Rule Destination
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: confirmationToken
in: path
type: string
description: The token used to confirm ownership or access to the topic rule confirmation URL.
required: true
- name: custom-metric-metricName
path: /custom-metric/{metricName}
operations:
- name: createcustommetric
method: POST
description: Amazon IoT Device Management Create Custom Metric
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: metricName
in: path
type: string
description: The name of the custom metric. This will be used in the metric report submitted from the device/thing.
The name can't begin with aws:. You can't ch
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletecustommetric
method: DELETE
description: Amazon IoT Device Management Delete Custom Metric
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: metricName
in: path
type: string
description: The name of the custom metric.
required: true
- name: describecustommetric
method: GET
description: Amazon IoT Device Management Describe Custom Metric
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: metricName
in: path
type: string
description: The name of the custom metric.
required: true
- name: updatecustommetric
method: PATCH
description: Amazon IoT Device Management Update Custom Metric
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: metricName
in: path
type: string
description: The name of the custom metric. Cannot be updated.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: custom-metrics
path: /custom-metrics
operations:
- name: listcustommetrics
method: GET
description: Amazon IoT Device Management List Custom Metrics
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time. The default is 25.
- name: default-authorizer
path: /default-authorizer
operations:
- name: cleardefaultauthorizer
method: DELETE
description: Amazon IoT Device Management Clear Default Authorizer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: describedefaultauthorizer
method: GET
description: Amazon IoT Device Management Describe Default Authorizer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: setdefaultauthorizer
method: POST
description: Amazon IoT Device Management Set Default Authorizer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: destinations
path: /destinations
operations:
- name: createtopicruledestination
method: POST
description: Amazon IoT Device Management Create Topic Rule Destination
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: listtopicruledestinations
method: GET
description: Amazon IoT Device Management List Topic Rule Destinations
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: updatetopicruledestination
method: PATCH
description: Amazon IoT Device Management Update Topic Rule Destination
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: destinations-arn
path: /destinations/{arn}
operations:
- name: deletetopicruledestination
method: DELETE
description: Amazon IoT Device Management Delete Topic Rule Destination
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: arn
in: path
type: string
description: The ARN of the topic rule destination to delete.
required: true
- name: gettopicruledestination
method: GET
description: Amazon IoT Device Management Get Topic Rule Destination
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: arn
in: path
type: string
description: The ARN of the topic rule destination.
required: true
- name: detect-mitigationactions-executions
path: /detect/mitigationactions/executions
operations:
- name: listdetectmitigationactionsexecutions
method: GET
description: Amazon IoT Device Management List Detect Mitigation Actions Executions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: taskId
in: query
type: string
description: The unique identifier of the task.
- name: violationId
in: query
type: string
description: The unique identifier of the violation.
- name: thingName
in: query
type: string
description: The name of the thing whose mitigation actions are listed.
- name: startTime
in: query
type: string
description: 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.
- name: endTime
in: query
type: string
description: The end of the time period for which ML Detect mitigation actions executions are returned.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time. The default is 25.
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: detect-mitigationactions-tasks#startTime&endTime
path: /detect/mitigationactions/tasks#startTime&endTime
operations:
- name: listdetectmitigationactionstasks
method: GET
description: Amazon IoT Device Management List Detect Mitigation Actions Tasks
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time. The default is 25.
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: startTime
in: query
type: string
description: 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.
required: true
- name: endTime
in: query
type: string
description: The end of the time period for which ML Detect mitigation actions tasks are returned.
required: true
- name: detect-mitigationactions-tasks-taskId
path: /detect/mitigationactions/tasks/{taskId}
operations:
- name: describedetectmitigationactionstask
method: GET
description: Amazon IoT Device Management Describe Detect Mitigation Actions Task
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: taskId
in: path
type: string
description: The unique identifier of the task.
required: true
- name: startdetectmitigationactionstask
method: PUT
description: Amazon IoT Device Management Start Detect Mitigation Actions Task
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: taskId
in: path
type: string
description: The unique identifier of the task.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: detect-mitigationactions-tasks-taskId-cancel
path: /detect/mitigationactions/tasks/{taskId}/cancel
operations:
- name: canceldetectmitigationactionstask
method: PUT
description: Amazon IoT Device Management Cancel Detect Mitigation Actions Task
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: taskId
in: path
type: string
description: The unique identifier of the task.
required: true
- name: dimensions
path: /dimensions
operations:
- name: listdimensions
method: GET
description: Amazon IoT Device Management List Dimensions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to retrieve at one time.
- name: dimensions-name
path: /dimensions/{name}
operations:
- name: createdimension
method: POST
description: Amazon IoT Device Management Create Dimension
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: A unique identifier for the dimension. Choose something that describes the type and value to make it
easy to remember what it does.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletedimension
method: DELETE
description: Amazon IoT Device Management Delete Dimension
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: The unique identifier for the dimension that you want to delete.
required: true
- name: describedimension
method: GET
description: Amazon IoT Device Management Describe Dimension
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: The unique identifier for the dimension.
required: true
- name: updatedimension
method: PATCH
description: Amazon IoT Device Management Update Dimension
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: A unique identifier for the dimension. Choose something that describes the type and value to make it
easy to remember what it does.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: domainConfigurations
path: /domainConfigurations
operations:
- name: listdomainconfigurations
method: GET
description: Amazon IoT Device Management List Domain Configurations
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: marker
in: query
type: string
description: The marker for the next set of results.
- name: pageSize
in: query
type: integer
description: The result page size.
- name: serviceType
in: query
type: string
description: The type of service delivered by the endpoint.
- name: domainConfigurations-domainConfigurationName
path: /domainConfigurations/{domainConfigurationName}
operations:
- name: createdomainconfiguration
method: POST
description: Amazon IoT Device Management Create Domain Configuration
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: domainConfigurationName
in: path
type: string
description: The name of the domain configuration. This value must be unique to a region.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletedomainconfiguration
method: DELETE
description: Amazon IoT Device Management Delete Domain Configuration
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: domainConfigurationName
in: path
type: string
description: The name of the domain configuration to be deleted.
required: true
- name: describedomainconfiguration
method: GET
description: Amazon IoT Device Management Describe Domain Configuration
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: domainConfigurationName
in: path
type: string
description: The name of the domain configuration.
required: true
- name: updatedomainconfiguration
method: PUT
description: Amazon IoT Device Management Update Domain Configuration
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: domainConfigurationName
in: path
type: string
description: The name of the domain configuration to be updated.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: dynamic-thing-groups-thingGroupName
path: /dynamic-thing-groups/{thingGroupName}
operations:
- name: createdynamicthinggroup
method: POST
description: Amazon IoT Device Management Create Dynamic Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingGroupName
in: path
type: string
description: The dynamic thing group name to create.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletedynamicthinggroup
method: DELETE
description: Amazon IoT Device Management Delete Dynamic Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingGroupName
in: path
type: string
description: The name of the dynamic thing group to delete.
required: true
- name: expectedVersion
in: query
type: integer
description: The expected version of the dynamic thing group to delete.
- name: updatedynamicthinggroup
method: PATCH
description: Amazon IoT Device Management Update Dynamic Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingGroupName
in: path
type: string
description: The name of the dynamic thing group to update.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: effective-policies
path: /effective-policies
operations:
- name: geteffectivepolicies
method: POST
description: Amazon IoT Device Management Get Effective Policies
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingName
in: query
type: string
description: The thing name.
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: endpoint
path: /endpoint
operations:
- name: describeendpoint
method: GET
description: Amazon IoT Device Management Describe Endpoint
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: endpointType
in: query
type: string
description:
The endpoint type. Valid endpoint types include:
-
iot:Data - Returns
a VeriSign signed data endpoint.
-
- name: event-configurations
path: /event-configurations
operations:
- name: describeeventconfigurations
method: GET
description: Amazon IoT Device Management Describe Event Configurations
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updateeventconfigurations
method: PATCH
description: Amazon IoT Device Management Update Event Configurations
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: fleet-metric-metricName
path: /fleet-metric/{metricName}
operations:
- name: createfleetmetric
method: PUT
description: Amazon IoT Device Management Create Fleet Metric
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: metricName
in: path
type: string
description: The name of the fleet metric to create.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletefleetmetric
method: DELETE
description: Amazon IoT Device Management Delete Fleet Metric
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: metricName
in: path
type: string
description: The name of the fleet metric to delete.
required: true
- name: expectedVersion
in: query
type: integer
description: The expected version of the fleet metric to delete.
- name: describefleetmetric
method: GET
description: Amazon IoT Device Management Describe Fleet Metric
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: metricName
in: path
type: string
description: The name of the fleet metric to describe.
required: true
- name: updatefleetmetric
method: PATCH
description: Amazon IoT Device Management Update Fleet Metric
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: metricName
in: path
type: string
description: The name of the fleet metric to update.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: fleet-metrics
path: /fleet-metrics
operations:
- name: listfleetmetrics
method: GET
description: Amazon IoT Device Management List Fleet Metrics
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the
nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return in this operation.
- name: indexing-config
path: /indexing/config
operations:
- name: getindexingconfiguration
method: GET
description: Amazon IoT Device Management Get Indexing Configuration
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updateindexingconfiguration
method: POST
description: Amazon IoT Device Management Update Indexing Configuration
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: indices
path: /indices
operations:
- name: listindices
method: GET
description: Amazon IoT Device Management List Indices
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: The token used to get the next set of results, or null if there are no additional results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: indices-buckets
path: /indices/buckets
operations:
- name: getbucketsaggregation
method: POST
description: Amazon IoT Device Management Get Buckets Aggregation
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: indices-cardinality
path: /indices/cardinality
operations:
- name: getcardinality
method: POST
description: Amazon IoT Device Management Get Cardinality
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: indices-percentiles
path: /indices/percentiles
operations:
- name: getpercentiles
method: POST
description: Amazon IoT Device Management Get Percentiles
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: indices-search
path: /indices/search
operations:
- name: searchindex
method: POST
description: Amazon IoT Device Management Search Index
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: indices-statistics
path: /indices/statistics
operations:
- name: getstatistics
method: POST
description: Amazon IoT Device Management Get Statistics
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: indices-indexName
path: /indices/{indexName}
operations:
- name: describeindex
method: GET
description: Amazon IoT Device Management Describe Index
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: indexName
in: path
type: string
description: The index name.
required: true
- name: job-templates
path: /job-templates
operations:
- name: listjobtemplates
method: GET
description: Amazon IoT Device Management List Job Templates
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: maxResults
in: query
type: integer
description: The maximum number of results to return in the list.
- name: nextToken
in: query
type: string
description: The token to use to return the next set of results in the list.
- name: job-templates-jobTemplateId
path: /job-templates/{jobTemplateId}
operations:
- name: createjobtemplate
method: PUT
description: Amazon IoT Device Management Create Job Template
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobTemplateId
in: path
type: string
description: A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-",
and "_" are valid for use here.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletejobtemplate
method: DELETE
description: Amazon IoT Device Management Delete Job Template
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobTemplateId
in: path
type: string
description: The unique identifier of the job template to delete.
required: true
- name: describejobtemplate
method: GET
description: Amazon IoT Device Management Describe Job Template
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobTemplateId
in: path
type: string
description: The unique identifier of the job template.
required: true
- name: jobs
path: /jobs
operations:
- name: listjobs
method: GET
description: Amazon IoT Device Management List Jobs
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: status
in: query
type: string
description: An optional filter that lets you search for jobs that have the specified status.
- name: targetSelection
in: query
type: string
description: Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those
things specified as targets have completed the job (SNAPSHOT
- name: maxResults
in: query
type: integer
description: The maximum number of results to return per request.
- name: nextToken
in: query
type: string
description: The token to retrieve the next set of results.
- name: thingGroupName
in: query
type: string
description: A filter that limits the returned jobs to those for the specified group.
- name: thingGroupId
in: query
type: string
description: A filter that limits the returned jobs to those for the specified group.
- name: namespaceId
in: query
type: string
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 j
- name: jobs-jobId
path: /jobs/{jobId}
operations:
- name: createjob
method: PUT
description: Amazon IoT Device Management Create Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID.
Alpha-numeric characters, "-" and "_" are valid for use h
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletejob
method: DELETE
description: Amazon IoT Device Management Delete Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description:
The ID of the job to be deleted.
After a job deletion is completed, you may reuse this jobId
when you create a new job. However, this is not recommend
required: true
- name: force
in: query
type: boolean
description:
(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete
a job which is in a terminal state ("COMPLETED" or "CANCELE
- name: namespaceId
in: query
type: string
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 j
- name: describejob
method: GET
description: Amazon IoT Device Management Describe Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: The unique identifier you assigned to this job when it was created.
required: true
- name: updatejob
method: PATCH
description: Amazon IoT Device Management Update Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: The ID of the job to be updated.
required: true
- name: namespaceId
in: query
type: string
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 j
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: jobs-jobId-cancel
path: /jobs/{jobId}/cancel
operations:
- name: canceljob
method: PUT
description: Amazon IoT Device Management Cancel Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: The unique identifier you assigned to this job when it was created.
required: true
- name: force
in: query
type: boolean
description:
(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled,
otherwise only job executions with status "QUEUED" are ca
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: jobs-jobId-job-document
path: /jobs/{jobId}/job-document
operations:
- name: getjobdocument
method: GET
description: Amazon IoT Device Management Get Job Document
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: The unique identifier you assigned to this job when it was created.
required: true
- name: jobs-jobId-targets
path: /jobs/{jobId}/targets
operations:
- name: associatetargetswithjob
method: POST
description: Amazon IoT Device Management Associate Targets with Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: The unique identifier you assigned to this job when it was created.
required: true
- name: namespaceId
in: query
type: string
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 j
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: jobs-jobId-things
path: /jobs/{jobId}/things
operations:
- name: listjobexecutionsforjob
method: GET
description: Amazon IoT Device Management List Job Executions for Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: The unique identifier you assigned to this job when it was created.
required: true
- name: status
in: query
type: string
description: The status of the job.
- name: maxResults
in: query
type: integer
description: The maximum number of results to be returned per request.
- name: nextToken
in: query
type: string
description: The token to retrieve the next set of results.
- name: keys-and-certificate
path: /keys-and-certificate
operations:
- name: createkeysandcertificate
method: POST
description: Amazon IoT Device Management Create Keys and Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: setAsActive
in: query
type: boolean
description: Specifies whether the certificate is active.
- name: loggingOptions
path: /loggingOptions
operations:
- name: getloggingoptions
method: GET
description: Amazon IoT Device Management Get Logging Options
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: setloggingoptions
method: POST
description: Amazon IoT Device Management Set Logging Options
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: managed-job-templates
path: /managed-job-templates
operations:
- name: listmanagedjobtemplates
method: GET
description: Amazon IoT Device Management List Managed Job Templates
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: query
type: string
description: An optional parameter for template name. If specified, only the versions of the managed job templates
that have the specified template name will be returned.
- name: maxResults
in: query
type: integer
description: Maximum number of entries that can be returned.
- name: nextToken
in: query
type: string
description: The token to retrieve the next set of results.
- name: managed-job-templates-templateName
path: /managed-job-templates/{templateName}
operations:
- name: describemanagedjobtemplate
method: GET
description: Amazon IoT Device Management Describe Managed Job Template
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: path
type: string
description: The unique name of a managed job template, which is required.
required: true
- name: templateVersion
in: query
type: string
description: An optional parameter to specify version of a managed template. If not specified, the pre-defined default
version is returned.
- name: metric-values#thingName&metricName&startTime&endTime
path: /metric-values#thingName&metricName&startTime&endTime
operations:
- name: listmetricvalues
method: GET
description: Amazon IoT Device Management List Metric Values
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingName
in: query
type: string
description: The name of the thing for which security profile metric values are returned.
required: true
- name: metricName
in: query
type: string
description: The name of the security profile metric for which values are returned.
required: true
- name: dimensionName
in: query
type: string
description: The dimension name.
- name: dimensionValueOperator
in: query
type: string
description: The dimension value operator.
- name: startTime
in: query
type: string
description: The start of the time period for which metric values are returned.
required: true
- name: endTime
in: query
type: string
description: The end of the time period for which metric values are returned.
required: true
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: mitigationactions-actions
path: /mitigationactions/actions
operations:
- name: listmitigationactions
method: GET
description: Amazon IoT Device Management List Mitigation Actions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: actionType
in: query
type: string
description: Specify a value to limit the result to mitigation actions with a specific action type.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time. The default is 25.
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: mitigationactions-actions-actionName
path: /mitigationactions/actions/{actionName}
operations:
- name: createmitigationaction
method: POST
description: Amazon IoT Device Management Create Mitigation Action
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: actionName
in: path
type: string
description: A friendly name for the action. Choose a friendly name that accurately describes the action (for example,
EnableLoggingAction).
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletemitigationaction
method: DELETE
description: Amazon IoT Device Management Delete Mitigation Action
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: actionName
in: path
type: string
description: The name of the mitigation action that you want to delete.
required: true
- name: describemitigationaction
method: GET
description: Amazon IoT Device Management Describe Mitigation Action
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: actionName
in: path
type: string
description: The friendly name that uniquely identifies the mitigation action.
required: true
- name: updatemitigationaction
method: PATCH
description: Amazon IoT Device Management Update Mitigation Action
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: actionName
in: path
type: string
description: 'The friendly name for the mitigation action. You cannot change the name by using UpdateMitigationAction.
Instead, you must delete and recreate the '
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: otaUpdates
path: /otaUpdates
operations:
- name: listotaupdates
method: GET
description: Amazon IoT Device Management List O T a Updates
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: nextToken
in: query
type: string
description: A token used to retrieve the next set of results.
- name: otaUpdateStatus
in: query
type: string
description: The OTA update job status.
- name: otaUpdates-otaUpdateId
path: /otaUpdates/{otaUpdateId}
operations:
- name: createotaupdate
method: POST
description: Amazon IoT Device Management Create O T a Update
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: otaUpdateId
in: path
type: string
description: The ID of the OTA update to be created.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deleteotaupdate
method: DELETE
description: Amazon IoT Device Management Delete O T a Update
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: otaUpdateId
in: path
type: string
description: The ID of the OTA update to delete.
required: true
- name: deleteStream
in: query
type: boolean
description: When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored
if the stream specified in the OTAUpdate is supplied b
- name: forceDeleteAWSJob
in: query
type: boolean
description: When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise,
if the job is not in a terminal state ("COMPLETED" or "C
- name: getotaupdate
method: GET
description: Amazon IoT Device Management Get O T a Update
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: otaUpdateId
in: path
type: string
description: The OTA update ID.
required: true
- name: policies
path: /policies
operations:
- name: listpolicies
method: GET
description: Amazon IoT Device Management List Policies
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: marker
in: query
type: string
description: The marker for the next set of results.
- name: pageSize
in: query
type: integer
description: The result page size.
- name: isAscendingOrder
in: query
type: boolean
description: Specifies the order for results. If true, the results are returned in ascending creation order.
- name: policies-policyName
path: /policies/{policyName}
operations:
- name: createpolicy
method: POST
description: Amazon IoT Device Management Create Policy
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The policy name.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletepolicy
method: DELETE
description: Amazon IoT Device Management Delete Policy
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The name of the policy to delete.
required: true
- name: getpolicy
method: GET
description: Amazon IoT Device Management Get Policy
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The name of the policy.
required: true
- name: policies-policyName-version
path: /policies/{policyName}/version
operations:
- name: createpolicyversion
method: POST
description: Amazon IoT Device Management Create Policy Version
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The policy name.
required: true
- name: setAsDefault
in: query
type: boolean
description: Specifies whether the policy version is set as the default. When this parameter is true, the new policy
version becomes the operative version (that is, the vers
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: listpolicyversions
method: GET
description: Amazon IoT Device Management List Policy Versions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The policy name.
required: true
- name: policies-policyName-version-policyVersionId
path: /policies/{policyName}/version/{policyVersionId}
operations:
- name: deletepolicyversion
method: DELETE
description: Amazon IoT Device Management Delete Policy Version
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The name of the policy.
required: true
- name: policyVersionId
in: path
type: string
description: The policy version ID.
required: true
- name: getpolicyversion
method: GET
description: Amazon IoT Device Management Get Policy Version
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The name of the policy.
required: true
- name: policyVersionId
in: path
type: string
description: The policy version ID.
required: true
- name: setdefaultpolicyversion
method: PATCH
description: Amazon IoT Device Management Set Default Policy Version
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The policy name.
required: true
- name: policyVersionId
in: path
type: string
description: The policy version ID.
required: true
- name: policy-principals#x-amzn-iot-policy
path: /policy-principals#x-amzn-iot-policy
operations:
- name: listpolicyprincipals
method: GET
description: Amazon IoT Device Management List Policy Principals
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: x-amzn-iot-policy
in: header
type: string
description: The policy name.
required: true
- name: marker
in: query
type: string
description: The marker for the next set of results.
- name: pageSize
in: query
type: integer
description: The result page size.
- name: isAscendingOrder
in: query
type: boolean
description: Specifies the order for results. If true, the results are returned in ascending creation order.
- name: policy-targets-policyName
path: /policy-targets/{policyName}
operations:
- name: listtargetsforpolicy
method: POST
description: Amazon IoT Device Management List Targets for Policy
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The policy name.
required: true
- name: marker
in: query
type: string
description: A marker used to get the next set of results.
- name: pageSize
in: query
type: integer
description: The maximum number of results to return at one time.
- name: principal-policies#x-amzn-iot-principal
path: /principal-policies#x-amzn-iot-principal
operations:
- name: listprincipalpolicies
method: GET
description: Amazon IoT Device Management List Principal Policies
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: x-amzn-iot-principal
in: header
type: string
description: The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId),
thingGroupArn (arn:aws:iot:region<
required: true
- name: marker
in: query
type: string
description: The marker for the next set of results.
- name: pageSize
in: query
type: integer
description: The result page size.
- name: isAscendingOrder
in: query
type: boolean
description: Specifies the order for results. If true, results are returned in ascending creation order.
- name: principal-policies-policyName}#x-amzn-iot-principal
path: /principal-policies/{policyName}#x-amzn-iot-principal
operations:
- name: attachprincipalpolicy
method: PUT
description: Amazon IoT Device Management Attach Principal Policy
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The policy name.
required: true
- name: x-amzn-iot-principal
in: header
type: string
description: The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or
an Amazon Cognito ID.
required: true
- name: detachprincipalpolicy
method: DELETE
description: Amazon IoT Device Management Detach Principal Policy
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The name of the policy to detach.
required: true
- name: x-amzn-iot-principal
in: header
type: string
description: '
The principal.
Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId),
thingGroupArn (arn:aws:iot:'
required: true
- name: principals-things#x-amzn-principal
path: /principals/things#x-amzn-principal
operations:
- name: listprincipalthings
method: GET
description: Amazon IoT Device Management List Principal Things
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return in this operation.
- name: x-amzn-principal
in: header
type: string
description: The principal.
required: true
- name: provisioning-templates
path: /provisioning-templates
operations:
- name: createprovisioningtemplate
method: POST
description: Amazon IoT Device Management Create Provisioning Template
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: listprovisioningtemplates
method: GET
description: Amazon IoT Device Management List Provisioning Templates
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: nextToken
in: query
type: string
description: A token to retrieve the next set of results.
- name: provisioning-templates-templateName
path: /provisioning-templates/{templateName}
operations:
- name: deleteprovisioningtemplate
method: DELETE
description: Amazon IoT Device Management Delete Provisioning Template
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: path
type: string
description: The name of the fleet provision template to delete.
required: true
- name: describeprovisioningtemplate
method: GET
description: Amazon IoT Device Management Describe Provisioning Template
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: path
type: string
description: The name of the provisioning template.
required: true
- name: updateprovisioningtemplate
method: PATCH
description: Amazon IoT Device Management Update Provisioning Template
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: path
type: string
description: The name of the provisioning template.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: provisioning-templates-templateName-provisioning-claim
path: /provisioning-templates/{templateName}/provisioning-claim
operations:
- name: createprovisioningclaim
method: POST
description: Amazon IoT Device Management Create Provisioning Claim
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: path
type: string
description: The name of the provisioning template to use.
required: true
- name: provisioning-templates-templateName-versions
path: /provisioning-templates/{templateName}/versions
operations:
- name: createprovisioningtemplateversion
method: POST
description: Amazon IoT Device Management Create Provisioning Template Version
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: path
type: string
description: The name of the provisioning template.
required: true
- name: setAsDefault
in: query
type: boolean
description: Sets a fleet provision template version as the default version.
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: listprovisioningtemplateversions
method: GET
description: Amazon IoT Device Management List Provisioning Template Versions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: path
type: string
description: The name of the provisioning template.
required: true
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: nextToken
in: query
type: string
description: A token to retrieve the next set of results.
- name: provisioning-templates-templateName-versions-versionId
path: /provisioning-templates/{templateName}/versions/{versionId}
operations:
- name: deleteprovisioningtemplateversion
method: DELETE
description: Amazon IoT Device Management Delete Provisioning Template Version
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: path
type: string
description: The name of the provisioning template version to delete.
required: true
- name: versionId
in: path
type: integer
description: The provisioning template version ID to delete.
required: true
- name: describeprovisioningtemplateversion
method: GET
description: Amazon IoT Device Management Describe Provisioning Template Version
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateName
in: path
type: string
description: The template name.
required: true
- name: versionId
in: path
type: integer
description: The provisioning template version ID.
required: true
- name: registrationcode
path: /registrationcode
operations:
- name: deleteregistrationcode
method: DELETE
description: Amazon IoT Device Management Delete Registration Code
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: getregistrationcode
method: GET
description: Amazon IoT Device Management Get Registration Code
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: reject-certificate-transfer-certificateId
path: /reject-certificate-transfer/{certificateId}
operations:
- name: rejectcertificatetransfer
method: PATCH
description: Amazon IoT Device Management Reject Certificate Transfer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: certificateId
in: path
type: string
description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: role-aliases
path: /role-aliases
operations:
- name: listrolealiases
method: GET
description: Amazon IoT Device Management List Role Aliases
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The maximum number of results to return at one time.
- name: marker
in: query
type: string
description: A marker used to get the next set of results.
- name: isAscendingOrder
in: query
type: boolean
description: Return the list of role aliases in ascending alphabetical order.
- name: role-aliases-roleAlias
path: /role-aliases/{roleAlias}
operations:
- name: createrolealias
method: POST
description: Amazon IoT Device Management Create Role Alias
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: roleAlias
in: path
type: string
description: The role alias that points to a role ARN. This allows you to change the role without having to update
the device.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deleterolealias
method: DELETE
description: Amazon IoT Device Management Delete Role Alias
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: roleAlias
in: path
type: string
description: The role alias to delete.
required: true
- name: describerolealias
method: GET
description: Amazon IoT Device Management Describe Role Alias
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: roleAlias
in: path
type: string
description: The role alias to describe.
required: true
- name: updaterolealias
method: PUT
description: Amazon IoT Device Management Update Role Alias
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: roleAlias
in: path
type: string
description: The role alias to update.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rules
path: /rules
operations:
- name: listtopicrules
method: GET
description: Amazon IoT Device Management List Topic Rules
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: topic
in: query
type: string
description: The topic.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return.
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: ruleDisabled
in: query
type: boolean
description: Specifies whether the rule is disabled.
- name: rules-ruleName
path: /rules/{ruleName}
operations:
- name: createtopicrule
method: POST
description: Amazon IoT Device Management Create Topic Rule
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: ruleName
in: path
type: string
description: The name of the rule.
required: true
- name: x-amz-tagging
in: header
type: string
description: '
Metadata which can be used to manage the topic rule.
For URI Request parameters use
format: ...key1=value1&key2=value2...
For the CL'
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletetopicrule
method: DELETE
description: Amazon IoT Device Management Delete Topic Rule
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: ruleName
in: path
type: string
description: The name of the rule.
required: true
- name: gettopicrule
method: GET
description: Amazon IoT Device Management Get Topic Rule
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: ruleName
in: path
type: string
description: The name of the rule.
required: true
- name: replacetopicrule
method: PATCH
description: Amazon IoT Device Management Replace Topic Rule
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: ruleName
in: path
type: string
description: The name of the rule.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rules-ruleName-disable
path: /rules/{ruleName}/disable
operations:
- name: disabletopicrule
method: POST
description: Amazon IoT Device Management Disable Topic Rule
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: ruleName
in: path
type: string
description: The name of the rule to disable.
required: true
- name: rules-ruleName-enable
path: /rules/{ruleName}/enable
operations:
- name: enabletopicrule
method: POST
description: Amazon IoT Device Management Enable Topic Rule
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: ruleName
in: path
type: string
description: The name of the topic rule to enable.
required: true
- name: security-profile-behaviors-validate
path: /security-profile-behaviors/validate
operations:
- name: validatesecurityprofilebehaviors
method: POST
description: Amazon IoT Device Management Validate Security Profile Behaviors
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: security-profiles
path: /security-profiles
operations:
- name: listsecurityprofiles
method: GET
description: Amazon IoT Device Management List Security Profiles
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: dimensionName
in: query
type: string
description: A filter to limit results to the security profiles that use the defined dimension. Cannot be used with
metricName
- name: metricName
in: query
type: string
description: The name of the custom metric. Cannot be used with dimensionName.
- name: security-profiles-for-target#securityProfileTargetArn
path: /security-profiles-for-target#securityProfileTargetArn
operations:
- name: listsecurityprofilesfortarget
method: GET
description: Amazon IoT Device Management List Security Profiles for Target
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: recursive
in: query
type: boolean
description: If true, return child groups too.
- name: securityProfileTargetArn
in: query
type: string
description: The ARN of the target (thing group) whose attached security profiles you want to get.
required: true
- name: security-profiles-securityProfileName
path: /security-profiles/{securityProfileName}
operations:
- name: createsecurityprofile
method: POST
description: Amazon IoT Device Management Create Security Profile
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: securityProfileName
in: path
type: string
description: The name you are giving to the security profile.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletesecurityprofile
method: DELETE
description: Amazon IoT Device Management Delete Security Profile
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: securityProfileName
in: path
type: string
description: The name of the security profile to be deleted.
required: true
- name: expectedVersion
in: query
type: integer
description: The expected version of the security profile. A new version is generated whenever the security profile
is updated. If you specify a value that is different from
- name: describesecurityprofile
method: GET
description: Amazon IoT Device Management Describe Security Profile
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: securityProfileName
in: path
type: string
description: The name of the security profile whose information you want to get.
required: true
- name: updatesecurityprofile
method: PATCH
description: Amazon IoT Device Management Update Security Profile
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: securityProfileName
in: path
type: string
description: The name of the security profile you want to update.
required: true
- name: expectedVersion
in: query
type: integer
description: The expected version of the security profile. A new version is generated whenever the security profile
is updated. If you specify a value that is different from
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: security-profiles-securityProfileName-targets
path: /security-profiles/{securityProfileName}/targets
operations:
- name: listtargetsforsecurityprofile
method: GET
description: Amazon IoT Device Management List Targets for Security Profile
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: securityProfileName
in: path
type: string
description: The security profile.
required: true
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: security-profiles-securityProfileName-targets#securityProfileTargetArn
path: /security-profiles/{securityProfileName}/targets#securityProfileTargetArn
operations:
- name: attachsecurityprofile
method: PUT
description: Amazon IoT Device Management Attach Security Profile
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: securityProfileName
in: path
type: string
description: The security profile that is attached.
required: true
- name: securityProfileTargetArn
in: query
type: string
description: The ARN of the target (thing group) to which the security profile is attached.
required: true
- name: detachsecurityprofile
method: DELETE
description: Amazon IoT Device Management Detach Security Profile
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: securityProfileName
in: path
type: string
description: The security profile that is detached.
required: true
- name: securityProfileTargetArn
in: query
type: string
description: The ARN of the thing group from which the security profile is detached.
required: true
- name: streams
path: /streams
operations:
- name: liststreams
method: GET
description: Amazon IoT Device Management List Streams
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at a time.
- name: nextToken
in: query
type: string
description: A token used to get the next set of results.
- name: isAscendingOrder
in: query
type: boolean
description: Set to true to return the list of streams in ascending order.
- name: streams-streamId
path: /streams/{streamId}
operations:
- name: createstream
method: POST
description: Amazon IoT Device Management Create Stream
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: streamId
in: path
type: string
description: The stream ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletestream
method: DELETE
description: Amazon IoT Device Management Delete Stream
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: streamId
in: path
type: string
description: The stream ID.
required: true
- name: describestream
method: GET
description: Amazon IoT Device Management Describe Stream
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: streamId
in: path
type: string
description: The stream ID.
required: true
- name: updatestream
method: PUT
description: Amazon IoT Device Management Update Stream
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: streamId
in: path
type: string
description: The stream ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: tags
path: /tags
operations:
- name: tagresource
method: POST
description: Amazon IoT Device Management Tag Resource
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: tags#resourceArn
path: /tags#resourceArn
operations:
- name: listtagsforresource
method: GET
description: Amazon IoT Device Management List Tags for Resource
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: resourceArn
in: query
type: string
description: The ARN of the resource.
required: true
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: target-policies-policyName
path: /target-policies/{policyName}
operations:
- name: attachpolicy
method: PUT
description: Amazon IoT Device Management Attach Policy
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The name of the policy to attach.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: detachpolicy
method: POST
description: Amazon IoT Device Management Detach Policy
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: policyName
in: path
type: string
description: The policy to detach.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: test-authorization
path: /test-authorization
operations:
- name: testauthorization
method: POST
description: Amazon IoT Device Management Test Authorization
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: clientId
in: query
type: string
description: The MQTT client ID.
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: thing-groups
path: /thing-groups
operations:
- name: listthinggroups
method: GET
description: Amazon IoT Device Management List Thing Groups
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: parentGroup
in: query
type: string
description: A filter that limits the results to those with the specified parent group.
- name: namePrefixFilter
in: query
type: string
description: A filter that limits the results to those with the specified name prefix.
- name: recursive
in: query
type: boolean
description: If true, return child groups as well.
- name: thing-groups-addThingToThingGroup
path: /thing-groups/addThingToThingGroup
operations:
- name: addthingtothinggroup
method: PUT
description: Amazon IoT Device Management Add Thing to Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: thing-groups-removeThingFromThingGroup
path: /thing-groups/removeThingFromThingGroup
operations:
- name: removethingfromthinggroup
method: PUT
description: Amazon IoT Device Management Remove Thing from Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: thing-groups-updateThingGroupsForThing
path: /thing-groups/updateThingGroupsForThing
operations:
- name: updatethinggroupsforthing
method: PUT
description: Amazon IoT Device Management Update Thing Groups for Thing
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: thing-groups-thingGroupName
path: /thing-groups/{thingGroupName}
operations:
- name: createthinggroup
method: POST
description: Amazon IoT Device Management Create Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingGroupName
in: path
type: string
description: The thing group name to create.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletethinggroup
method: DELETE
description: Amazon IoT Device Management Delete Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingGroupName
in: path
type: string
description: The name of the thing group to delete.
required: true
- name: expectedVersion
in: query
type: integer
description: The expected version of the thing group to delete.
- name: describethinggroup
method: GET
description: Amazon IoT Device Management Describe Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingGroupName
in: path
type: string
description: The name of the thing group.
required: true
- name: updatethinggroup
method: PATCH
description: Amazon IoT Device Management Update Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingGroupName
in: path
type: string
description: The thing group to update.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: thing-groups-thingGroupName-things
path: /thing-groups/{thingGroupName}/things
operations:
- name: listthingsinthinggroup
method: GET
description: Amazon IoT Device Management List Things in Thing Group
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingGroupName
in: path
type: string
description: The thing group name.
required: true
- name: recursive
in: query
type: boolean
description: When true, list things in this thing group and in all child groups as well.
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: thing-registration-tasks
path: /thing-registration-tasks
operations:
- name: listthingregistrationtasks
method: GET
description: Amazon IoT Device Management List Thing Registration Tasks
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: status
in: query
type: string
description: The status of the bulk thing provisioning task.
- name: startthingregistrationtask
method: POST
description: Amazon IoT Device Management Start Thing Registration Task
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: thing-registration-tasks-taskId
path: /thing-registration-tasks/{taskId}
operations:
- name: describethingregistrationtask
method: GET
description: Amazon IoT Device Management Describe Thing Registration Task
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: taskId
in: path
type: string
description: The task ID.
required: true
- name: thing-registration-tasks-taskId-cancel
path: /thing-registration-tasks/{taskId}/cancel
operations:
- name: stopthingregistrationtask
method: PUT
description: Amazon IoT Device Management Stop Thing Registration Task
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: taskId
in: path
type: string
description: The bulk thing provisioning task ID.
required: true
- name: thing-registration-tasks-taskId-reports#reportType
path: /thing-registration-tasks/{taskId}/reports#reportType
operations:
- name: listthingregistrationtaskreports
method: GET
description: Amazon IoT Device Management List Thing Registration Task Reports
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: taskId
in: path
type: string
description: The id of the task.
required: true
- name: reportType
in: query
type: string
description: The type of task report.
required: true
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return per request.
- name: thing-types
path: /thing-types
operations:
- name: listthingtypes
method: GET
description: Amazon IoT Device Management List Thing Types
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return in this operation.
- name: thingTypeName
in: query
type: string
description: The name of the thing type.
- name: thing-types-thingTypeName
path: /thing-types/{thingTypeName}
operations:
- name: createthingtype
method: POST
description: Amazon IoT Device Management Create Thing Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingTypeName
in: path
type: string
description: The name of the thing type.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletethingtype
method: DELETE
description: Amazon IoT Device Management Delete Thing Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingTypeName
in: path
type: string
description: The name of the thing type.
required: true
- name: describethingtype
method: GET
description: Amazon IoT Device Management Describe Thing Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingTypeName
in: path
type: string
description: The name of the thing type.
required: true
- name: thing-types-thingTypeName-deprecate
path: /thing-types/{thingTypeName}/deprecate
operations:
- name: deprecatethingtype
method: POST
description: Amazon IoT Device Management Deprecate Thing Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingTypeName
in: path
type: string
description: The name of the thing type to deprecate.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: things
path: /things
operations:
- name: listthings
method: GET
description: Amazon IoT Device Management List Things
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return in this operation.
- name: attributeName
in: query
type: string
description: The attribute name used to search for things.
- name: attributeValue
in: query
type: string
description: The attribute value used to search for things.
- name: thingTypeName
in: query
type: string
description: The name of the thing type used to search for things.
- name: usePrefixAttributeValue
in: query
type: boolean
description:
When true, the action returns the thing resources with attribute values that start
with the attributeValue provided.
When 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 t
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletething
method: DELETE
description: Amazon IoT Device Management Delete Thing
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingName
in: path
type: string
description: The name of the thing to delete.
required: true
- name: expectedVersion
in: query
type: integer
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 requ
- name: describething
method: GET
description: Amazon IoT Device Management Describe Thing
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingName
in: path
type: string
description: The name of the thing.
required: true
- name: updatething
method: PATCH
description: Amazon IoT Device Management Update Thing
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingName
in: path
type: string
description:
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 the
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: things-thingName-jobs
path: /things/{thingName}/jobs
operations:
- name: listjobexecutionsforthing
method: GET
description: Amazon IoT Device Management List Job Executions for Thing
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingName
in: path
type: string
description: The thing name.
required: true
- name: status
in: query
type: string
description: An optional filter that lets you search for jobs that have the specified status.
- name: namespaceId
in: query
type: string
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 j
- name: maxResults
in: query
type: integer
description: The maximum number of results to be returned per request.
- name: nextToken
in: query
type: string
description: The token to retrieve the next set of results.
- name: jobId
in: query
type: string
description: The unique identifier you assigned to this job when it was created.
- name: things-thingName-jobs-jobId
path: /things/{thingName}/jobs/{jobId}
operations:
- name: describejobexecution
method: GET
description: Amazon IoT Device Management Describe Job Execution
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: The unique identifier you assigned to this job when it was created.
required: true
- name: thingName
in: path
type: string
description: The name of the thing on which the job execution is running.
required: true
- name: executionNumber
in: query
type: integer
description: A string (consisting of the digits "0" through "9" which is used to specify a particular job execution
on a particular device.
- name: things-thingName-jobs-jobId-cancel
path: /things/{thingName}/jobs/{jobId}/cancel
operations:
- name: canceljobexecution
method: PUT
description: Amazon IoT Device Management Cancel Job Execution
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: The ID of the job to be canceled.
required: true
- name: thingName
in: path
type: string
description: The name of the thing whose execution of the job will be canceled.
required: true
- name: force
in: query
type: boolean
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 '
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: things-thingName-jobs-jobId-executionNumber-executionNumber
path: /things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}
operations:
- name: deletejobexecution
method: DELETE
description: Amazon IoT Device Management Delete Job Execution
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: jobId
in: path
type: string
description: The ID of the job whose execution on a particular device will be deleted.
required: true
- name: thingName
in: path
type: string
description: The name of the thing whose job execution will be deleted.
required: true
- name: executionNumber
in: path
type: integer
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 t
required: true
- name: force
in: query
type: boolean
description:
(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 ("SU
- name: namespaceId
in: query
type: string
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 j
- name: things-thingName-principals
path: /things/{thingName}/principals
operations:
- name: listthingprincipals
method: GET
description: Amazon IoT Device Management List Thing Principals
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return in this operation.
- name: thingName
in: path
type: string
description: The name of the thing.
required: true
- name: things-thingName-principals#x-amzn-principal
path: /things/{thingName}/principals#x-amzn-principal
operations:
- name: attachthingprincipal
method: PUT
description: Amazon IoT Device Management Attach Thing Principal
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingName
in: path
type: string
description: The name of the thing.
required: true
- name: x-amzn-principal
in: header
type: string
description: The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or
an Amazon Cognito ID.
required: true
- name: detachthingprincipal
method: DELETE
description: Amazon IoT Device Management Detach Thing Principal
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingName
in: path
type: string
description: The name of the thing.
required: true
- name: x-amzn-principal
in: header
type: string
description: If the principal is a certificate, this value must be ARN of the certificate. If the principal is an
Amazon Cognito identity, this value must be the ID of the A
required: true
- name: things-thingName-thing-groups
path: /things/{thingName}/thing-groups
operations:
- name: listthinggroupsforthing
method: GET
description: Amazon IoT Device Management List Thing Groups for Thing
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: thingName
in: path
type: string
description: The thing name.
required: true
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: transfer-certificate-certificateId}#targetAwsAccount
path: /transfer-certificate/{certificateId}#targetAwsAccount
operations:
- name: transfercertificate
method: PATCH
description: Amazon IoT Device Management Transfer Certificate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: certificateId
in: path
type: string
description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
required: true
- name: targetAwsAccount
in: query
type: string
description: The Amazon Web Services account.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: untag
path: /untag
operations:
- name: untagresource
method: POST
description: Amazon IoT Device Management Untag Resource
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v2LoggingLevel
path: /v2LoggingLevel
operations:
- name: listv2logginglevels
method: GET
description: Amazon IoT Device Management List V2 Logging Levels
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: targetType
in: query
type: string
description: The type of resource for which you are configuring logging. Must be THING_Group.
- name: nextToken
in: query
type: string
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: setv2logginglevel
method: POST
description: Amazon IoT Device Management Set V2 Logging Level
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v2LoggingLevel#targetType&targetName
path: /v2LoggingLevel#targetType&targetName
operations:
- name: deletev2logginglevel
method: DELETE
description: Amazon IoT Device Management Delete V2 Logging Level
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: targetType
in: query
type: string
description: The type of resource for which you are configuring logging. Must be THING_Group.
required: true
- name: targetName
in: query
type: string
description: The name of the resource for which you are configuring logging.
required: true
- name: v2LoggingOptions
path: /v2LoggingOptions
operations:
- name: getv2loggingoptions
method: GET
description: Amazon IoT Device Management Get V2 Logging Options
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: setv2loggingoptions
method: POST
description: Amazon IoT Device Management Set V2 Logging Options
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: violation-events#startTime&endTime
path: /violation-events#startTime&endTime
operations:
- name: listviolationevents
method: GET
description: Amazon IoT Device Management List Violation Events
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: startTime
in: query
type: string
description: The start time for the alerts to be listed.
required: true
- name: endTime
in: query
type: string
description: The end time for the alerts to be listed.
required: true
- name: thingName
in: query
type: string
description: A filter to limit results to those alerts caused by the specified thing.
- name: securityProfileName
in: query
type: string
description: A filter to limit results to those alerts generated by the specified security profile.
- name: behaviorCriteriaType
in: query
type: string
description: The criteria for a behavior.
- name: listSuppressedAlerts
in: query
type: boolean
description: A list of all suppressed alerts.
- name: verificationState
in: query
type: string
description: The verification state of the violation (detect alarm).
- name: nextToken
in: query
type: string
description: The token for the next set of results.
- name: maxResults
in: query
type: integer
description: The maximum number of results to return at one time.
- name: violations-verification-state-violationId
path: /violations/verification-state/{violationId}
operations:
- name: putverificationstateonviolation
method: POST
description: Amazon IoT Device Management Put Verification State on Violation
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: violationId
in: path
type: string
description: The violation ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
authentication:
type: apikey
key: Authorization
value: '{{env.AMAZON_IOT_DEVICE_MANAGEMENT_API_KEY}}'
placement: header
exposes:
- type: rest
namespace: amazon-iot-device-management-rest
port: 8080
description: REST adapter for AWS IoT. One Spectral-compliant resource per consumed operation, prefixed with /v1.
resources:
- path: /v1/accept-certificate-transfer/{certificateid}
name: accept-certificate-transfer-certificateid
description: REST surface for accept-certificate-transfer-certificateId.
operations:
- method: PATCH
name: acceptcertificatetransfer
description: Amazon IoT Device Management Accept Certificate Transfer
call: amazon-iot-device-management.acceptcertificatetransfer
with:
certificateId: rest.certificateId
setAsActive: rest.setAsActive
outputParameters:
- type: object
mapping: $.
- path: /v1/active-violations
name: active-violations
description: REST surface for active-violations.
operations:
- method: GET
name: listactiveviolations
description: Amazon IoT Device Management List Active Violations
call: amazon-iot-device-management.listactiveviolations
with:
thingName: rest.thingName
securityProfileName: rest.securityProfileName
behaviorCriteriaType: rest.behaviorCriteriaType
listSuppressedAlerts: rest.listSuppressedAlerts
verificationState: rest.verificationState
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/attached-policies/{target}
name: attached-policies-target
description: REST surface for attached-policies-target.
operations:
- method: POST
name: listattachedpolicies
description: Amazon IoT Device Management List Attached Policies
call: amazon-iot-device-management.listattachedpolicies
with:
target: rest.target
recursive: rest.recursive
marker: rest.marker
pageSize: rest.pageSize
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/configuration
name: audit-configuration
description: REST surface for audit-configuration.
operations:
- method: DELETE
name: deleteaccountauditconfiguration
description: Amazon IoT Device Management Delete Account Audit Configuration
call: amazon-iot-device-management.deleteaccountauditconfiguration
with:
deleteScheduledAudits: rest.deleteScheduledAudits
outputParameters:
- type: object
mapping: $.
- method: GET
name: describeaccountauditconfiguration
description: Amazon IoT Device Management Describe Account Audit Configuration
call: amazon-iot-device-management.describeaccountauditconfiguration
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updateaccountauditconfiguration
description: Amazon IoT Device Management Update Account Audit Configuration
call: amazon-iot-device-management.updateaccountauditconfiguration
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/findings
name: audit-findings
description: REST surface for audit-findings.
operations:
- method: POST
name: listauditfindings
description: Amazon IoT Device Management List Audit Findings
call: amazon-iot-device-management.listauditfindings
with:
maxResults: rest.maxResults
nextToken: rest.nextToken
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/findings/{findingid}
name: audit-findings-findingid
description: REST surface for audit-findings-findingId.
operations:
- method: GET
name: describeauditfinding
description: Amazon IoT Device Management Describe Audit Finding
call: amazon-iot-device-management.describeauditfinding
with:
findingId: rest.findingId
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/mitigationactions/executions-taskid-findingid
name: audit-mitigationactions-executions-taskid-findingid
description: REST surface for audit-mitigationactions-executions#taskId&findingId.
operations:
- method: GET
name: listauditmitigationactionsexecutions
description: Amazon IoT Device Management List Audit Mitigation Actions Executions
call: amazon-iot-device-management.listauditmitigationactionsexecutions
with:
taskId: rest.taskId
actionStatus: rest.actionStatus
findingId: rest.findingId
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/mitigationactions/tasks-starttime-endtime
name: audit-mitigationactions-tasks-starttime-endtime
description: REST surface for audit-mitigationactions-tasks#startTime&endTime.
operations:
- method: GET
name: listauditmitigationactionstasks
description: Amazon IoT Device Management List Audit Mitigation Actions Tasks
call: amazon-iot-device-management.listauditmitigationactionstasks
with:
auditTaskId: rest.auditTaskId
findingId: rest.findingId
taskStatus: rest.taskStatus
maxResults: rest.maxResults
nextToken: rest.nextToken
startTime: rest.startTime
endTime: rest.endTime
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/mitigationactions/tasks/{taskid}
name: audit-mitigationactions-tasks-taskid
description: REST surface for audit-mitigationactions-tasks-taskId.
operations:
- method: GET
name: describeauditmitigationactionstask
description: Amazon IoT Device Management Describe Audit Mitigation Actions Task
call: amazon-iot-device-management.describeauditmitigationactionstask
with:
taskId: rest.taskId
outputParameters:
- type: object
mapping: $.
- method: POST
name: startauditmitigationactionstask
description: Amazon IoT Device Management Start Audit Mitigation Actions Task
call: amazon-iot-device-management.startauditmitigationactionstask
with:
taskId: rest.taskId
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/mitigationactions/tasks/{taskid}/cancel
name: audit-mitigationactions-tasks-taskid-cancel
description: REST surface for audit-mitigationactions-tasks-taskId-cancel.
operations:
- method: PUT
name: cancelauditmitigationactionstask
description: Amazon IoT Device Management Cancel Audit Mitigation Actions Task
call: amazon-iot-device-management.cancelauditmitigationactionstask
with:
taskId: rest.taskId
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/relatedresources-findingid
name: audit-relatedresources-findingid
description: REST surface for audit-relatedResources#findingId.
operations:
- method: GET
name: listrelatedresourcesforauditfinding
description: Amazon IoT Device Management List Related Resources for Audit Finding
call: amazon-iot-device-management.listrelatedresourcesforauditfinding
with:
findingId: rest.findingId
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/scheduledaudits
name: audit-scheduledaudits
description: REST surface for audit-scheduledaudits.
operations:
- method: GET
name: listscheduledaudits
description: Amazon IoT Device Management List Scheduled Audits
call: amazon-iot-device-management.listscheduledaudits
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/scheduledaudits/{scheduledauditname}
name: audit-scheduledaudits-scheduledauditname
description: REST surface for audit-scheduledaudits-scheduledAuditName.
operations:
- method: POST
name: createscheduledaudit
description: Amazon IoT Device Management Create Scheduled Audit
call: amazon-iot-device-management.createscheduledaudit
with:
scheduledAuditName: rest.scheduledAuditName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletescheduledaudit
description: Amazon IoT Device Management Delete Scheduled Audit
call: amazon-iot-device-management.deletescheduledaudit
with:
scheduledAuditName: rest.scheduledAuditName
outputParameters:
- type: object
mapping: $.
- method: GET
name: describescheduledaudit
description: Amazon IoT Device Management Describe Scheduled Audit
call: amazon-iot-device-management.describescheduledaudit
with:
scheduledAuditName: rest.scheduledAuditName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatescheduledaudit
description: Amazon IoT Device Management Update Scheduled Audit
call: amazon-iot-device-management.updatescheduledaudit
with:
scheduledAuditName: rest.scheduledAuditName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/suppressions/create
name: audit-suppressions-create
description: REST surface for audit-suppressions-create.
operations:
- method: POST
name: createauditsuppression
description: Amazon IoT Device Management Create Audit Suppression
call: amazon-iot-device-management.createauditsuppression
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/suppressions/delete
name: audit-suppressions-delete
description: REST surface for audit-suppressions-delete.
operations:
- method: POST
name: deleteauditsuppression
description: Amazon IoT Device Management Delete Audit Suppression
call: amazon-iot-device-management.deleteauditsuppression
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/suppressions/describe
name: audit-suppressions-describe
description: REST surface for audit-suppressions-describe.
operations:
- method: POST
name: describeauditsuppression
description: Amazon IoT Device Management Describe Audit Suppression
call: amazon-iot-device-management.describeauditsuppression
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/suppressions/list
name: audit-suppressions-list
description: REST surface for audit-suppressions-list.
operations:
- method: POST
name: listauditsuppressions
description: Amazon IoT Device Management List Audit Suppressions
call: amazon-iot-device-management.listauditsuppressions
with:
maxResults: rest.maxResults
nextToken: rest.nextToken
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/suppressions/update
name: audit-suppressions-update
description: REST surface for audit-suppressions-update.
operations:
- method: PATCH
name: updateauditsuppression
description: Amazon IoT Device Management Update Audit Suppression
call: amazon-iot-device-management.updateauditsuppression
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/tasks
name: audit-tasks
description: REST surface for audit-tasks.
operations:
- method: POST
name: startondemandaudittask
description: Amazon IoT Device Management Start on Demand Audit Task
call: amazon-iot-device-management.startondemandaudittask
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/tasks-starttime-endtime
name: audit-tasks-starttime-endtime
description: REST surface for audit-tasks#startTime&endTime.
operations:
- method: GET
name: listaudittasks
description: Amazon IoT Device Management List Audit Tasks
call: amazon-iot-device-management.listaudittasks
with:
startTime: rest.startTime
endTime: rest.endTime
taskType: rest.taskType
taskStatus: rest.taskStatus
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/tasks/{taskid}
name: audit-tasks-taskid
description: REST surface for audit-tasks-taskId.
operations:
- method: GET
name: describeaudittask
description: Amazon IoT Device Management Describe Audit Task
call: amazon-iot-device-management.describeaudittask
with:
taskId: rest.taskId
outputParameters:
- type: object
mapping: $.
- path: /v1/audit/tasks/{taskid}/cancel
name: audit-tasks-taskid-cancel
description: REST surface for audit-tasks-taskId-cancel.
operations:
- method: PUT
name: cancelaudittask
description: Amazon IoT Device Management Cancel Audit Task
call: amazon-iot-device-management.cancelaudittask
with:
taskId: rest.taskId
outputParameters:
- type: object
mapping: $.
- path: /v1/authorizer/{authorizername}
name: authorizer-authorizername
description: REST surface for authorizer-authorizerName.
operations:
- method: POST
name: createauthorizer
description: Amazon IoT Device Management Create Authorizer
call: amazon-iot-device-management.createauthorizer
with:
authorizerName: rest.authorizerName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deleteauthorizer
description: Amazon IoT Device Management Delete Authorizer
call: amazon-iot-device-management.deleteauthorizer
with:
authorizerName: rest.authorizerName
outputParameters:
- type: object
mapping: $.
- method: GET
name: describeauthorizer
description: Amazon IoT Device Management Describe Authorizer
call: amazon-iot-device-management.describeauthorizer
with:
authorizerName: rest.authorizerName
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updateauthorizer
description: Amazon IoT Device Management Update Authorizer
call: amazon-iot-device-management.updateauthorizer
with:
authorizerName: rest.authorizerName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/authorizer/{authorizername}/test
name: authorizer-authorizername-test
description: REST surface for authorizer-authorizerName-test.
operations:
- method: POST
name: testinvokeauthorizer
description: Amazon IoT Device Management Test Invoke Authorizer
call: amazon-iot-device-management.testinvokeauthorizer
with:
authorizerName: rest.authorizerName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/authorizers
name: authorizers
description: REST surface for authorizers.
operations:
- method: GET
name: listauthorizers
description: Amazon IoT Device Management List Authorizers
call: amazon-iot-device-management.listauthorizers
with:
pageSize: rest.pageSize
marker: rest.marker
isAscendingOrder: rest.isAscendingOrder
status: rest.status
outputParameters:
- type: object
mapping: $.
- path: /v1/behavior-model-training/summaries
name: behavior-model-training-summaries
description: REST surface for behavior-model-training-summaries.
operations:
- method: GET
name: getbehaviormodeltrainingsummaries
description: Amazon IoT Device Management Get Behavior Model Training Summaries
call: amazon-iot-device-management.getbehaviormodeltrainingsummaries
with:
securityProfileName: rest.securityProfileName
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/billing-groups
name: billing-groups
description: REST surface for billing-groups.
operations:
- method: GET
name: listbillinggroups
description: Amazon IoT Device Management List Billing Groups
call: amazon-iot-device-management.listbillinggroups
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
namePrefixFilter: rest.namePrefixFilter
outputParameters:
- type: object
mapping: $.
- path: /v1/billing-groups/addthingtobillinggroup
name: billing-groups-addthingtobillinggroup
description: REST surface for billing-groups-addThingToBillingGroup.
operations:
- method: PUT
name: addthingtobillinggroup
description: Amazon IoT Device Management Add Thing to Billing Group
call: amazon-iot-device-management.addthingtobillinggroup
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/billing-groups/removethingfrombillinggroup
name: billing-groups-removethingfrombillinggroup
description: REST surface for billing-groups-removeThingFromBillingGroup.
operations:
- method: PUT
name: removethingfrombillinggroup
description: Amazon IoT Device Management Remove Thing from Billing Group
call: amazon-iot-device-management.removethingfrombillinggroup
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/billing-groups/{billinggroupname}
name: billing-groups-billinggroupname
description: REST surface for billing-groups-billingGroupName.
operations:
- method: POST
name: createbillinggroup
description: Amazon IoT Device Management Create Billing Group
call: amazon-iot-device-management.createbillinggroup
with:
billingGroupName: rest.billingGroupName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletebillinggroup
description: Amazon IoT Device Management Delete Billing Group
call: amazon-iot-device-management.deletebillinggroup
with:
billingGroupName: rest.billingGroupName
expectedVersion: rest.expectedVersion
outputParameters:
- type: object
mapping: $.
- method: GET
name: describebillinggroup
description: Amazon IoT Device Management Describe Billing Group
call: amazon-iot-device-management.describebillinggroup
with:
billingGroupName: rest.billingGroupName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatebillinggroup
description: Amazon IoT Device Management Update Billing Group
call: amazon-iot-device-management.updatebillinggroup
with:
billingGroupName: rest.billingGroupName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/billing-groups/{billinggroupname}/things
name: billing-groups-billinggroupname-things
description: REST surface for billing-groups-billingGroupName-things.
operations:
- method: GET
name: listthingsinbillinggroup
description: Amazon IoT Device Management List Things in Billing Group
call: amazon-iot-device-management.listthingsinbillinggroup
with:
billingGroupName: rest.billingGroupName
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/cacertificate
name: cacertificate
description: REST surface for cacertificate.
operations:
- method: POST
name: registercacertificate
description: Amazon IoT Device Management Register C a Certificate
call: amazon-iot-device-management.registercacertificate
with:
setAsActive: rest.setAsActive
allowAutoRegistration: rest.allowAutoRegistration
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/cacertificate/{cacertificateid}
name: cacertificate-cacertificateid
description: REST surface for cacertificate-caCertificateId.
operations:
- method: DELETE
name: deletecacertificate
description: Amazon IoT Device Management Delete C a Certificate
call: amazon-iot-device-management.deletecacertificate
with:
caCertificateId: rest.caCertificateId
outputParameters:
- type: object
mapping: $.
- method: GET
name: describecacertificate
description: Amazon IoT Device Management Describe C a Certificate
call: amazon-iot-device-management.describecacertificate
with:
caCertificateId: rest.caCertificateId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updatecacertificate
description: Amazon IoT Device Management Update C a Certificate
call: amazon-iot-device-management.updatecacertificate
with:
caCertificateId: rest.caCertificateId
newStatus: rest.newStatus
newAutoRegistrationStatus: rest.newAutoRegistrationStatus
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/cacertificates
name: cacertificates
description: REST surface for cacertificates.
operations:
- method: GET
name: listcacertificates
description: Amazon IoT Device Management List C a Certificates
call: amazon-iot-device-management.listcacertificates
with:
pageSize: rest.pageSize
marker: rest.marker
isAscendingOrder: rest.isAscendingOrder
templateName: rest.templateName
outputParameters:
- type: object
mapping: $.
- path: /v1/cancel-certificate-transfer/{certificateid}
name: cancel-certificate-transfer-certificateid
description: REST surface for cancel-certificate-transfer-certificateId.
operations:
- method: PATCH
name: cancelcertificatetransfer
description: Amazon IoT Device Management Cancel Certificate Transfer
call: amazon-iot-device-management.cancelcertificatetransfer
with:
certificateId: rest.certificateId
outputParameters:
- type: object
mapping: $.
- path: /v1/certificate/register
name: certificate-register
description: REST surface for certificate-register.
operations:
- method: POST
name: registercertificate
description: Amazon IoT Device Management Register Certificate
call: amazon-iot-device-management.registercertificate
with:
setAsActive: rest.setAsActive
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/certificate/register-no-ca
name: certificate-register-no-ca
description: REST surface for certificate-register-no-ca.
operations:
- method: POST
name: registercertificatewithoutca
description: Amazon IoT Device Management Register Certificate Without C a
call: amazon-iot-device-management.registercertificatewithoutca
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/certificates
name: certificates
description: REST surface for certificates.
operations:
- method: POST
name: createcertificatefromcsr
description: Amazon IoT Device Management Create Certificate from Csr
call: amazon-iot-device-management.createcertificatefromcsr
with:
setAsActive: rest.setAsActive
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: GET
name: listcertificates
description: Amazon IoT Device Management List Certificates
call: amazon-iot-device-management.listcertificates
with:
pageSize: rest.pageSize
marker: rest.marker
isAscendingOrder: rest.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- path: /v1/certificates-by-ca/{cacertificateid}
name: certificates-by-ca-cacertificateid
description: REST surface for certificates-by-ca-caCertificateId.
operations:
- method: GET
name: listcertificatesbyca
description: Amazon IoT Device Management List Certificates by C a
call: amazon-iot-device-management.listcertificatesbyca
with:
caCertificateId: rest.caCertificateId
pageSize: rest.pageSize
marker: rest.marker
isAscendingOrder: rest.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- path: /v1/certificates-out-going
name: certificates-out-going
description: REST surface for certificates-out-going.
operations:
- method: GET
name: listoutgoingcertificates
description: Amazon IoT Device Management List Outgoing Certificates
call: amazon-iot-device-management.listoutgoingcertificates
with:
pageSize: rest.pageSize
marker: rest.marker
isAscendingOrder: rest.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- path: /v1/certificates/{certificateid}
name: certificates-certificateid
description: REST surface for certificates-certificateId.
operations:
- method: DELETE
name: deletecertificate
description: Amazon IoT Device Management Delete Certificate
call: amazon-iot-device-management.deletecertificate
with:
certificateId: rest.certificateId
forceDelete: rest.forceDelete
outputParameters:
- type: object
mapping: $.
- method: GET
name: describecertificate
description: Amazon IoT Device Management Describe Certificate
call: amazon-iot-device-management.describecertificate
with:
certificateId: rest.certificateId
outputParameters:
- type: object
mapping: $.
- path: /v1/certificates/certificateid-newstatus
name: certificates-certificateid-newstatus
description: REST surface for certificates-certificateId}#newStatus.
operations:
- method: PUT
name: updatecertificate
description: Amazon IoT Device Management Update Certificate
call: amazon-iot-device-management.updatecertificate
with:
certificateId: rest.certificateId
newStatus: rest.newStatus
outputParameters:
- type: object
mapping: $.
- path: /v1/confirmdestination/{confirmationtoken}
name: confirmdestination-confirmationtoken
description: REST surface for confirmdestination-confirmationToken.
operations:
- method: GET
name: confirmtopicruledestination
description: Amazon IoT Device Management Confirm Topic Rule Destination
call: amazon-iot-device-management.confirmtopicruledestination
with:
confirmationToken: rest.confirmationToken
outputParameters:
- type: object
mapping: $.
- path: /v1/custom-metric/{metricname}
name: custom-metric-metricname
description: REST surface for custom-metric-metricName.
operations:
- method: POST
name: createcustommetric
description: Amazon IoT Device Management Create Custom Metric
call: amazon-iot-device-management.createcustommetric
with:
metricName: rest.metricName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletecustommetric
description: Amazon IoT Device Management Delete Custom Metric
call: amazon-iot-device-management.deletecustommetric
with:
metricName: rest.metricName
outputParameters:
- type: object
mapping: $.
- method: GET
name: describecustommetric
description: Amazon IoT Device Management Describe Custom Metric
call: amazon-iot-device-management.describecustommetric
with:
metricName: rest.metricName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatecustommetric
description: Amazon IoT Device Management Update Custom Metric
call: amazon-iot-device-management.updatecustommetric
with:
metricName: rest.metricName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/custom-metrics
name: custom-metrics
description: REST surface for custom-metrics.
operations:
- method: GET
name: listcustommetrics
description: Amazon IoT Device Management List Custom Metrics
call: amazon-iot-device-management.listcustommetrics
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/default-authorizer
name: default-authorizer
description: REST surface for default-authorizer.
operations:
- method: DELETE
name: cleardefaultauthorizer
description: Amazon IoT Device Management Clear Default Authorizer
call: amazon-iot-device-management.cleardefaultauthorizer
outputParameters:
- type: object
mapping: $.
- method: GET
name: describedefaultauthorizer
description: Amazon IoT Device Management Describe Default Authorizer
call: amazon-iot-device-management.describedefaultauthorizer
outputParameters:
- type: object
mapping: $.
- method: POST
name: setdefaultauthorizer
description: Amazon IoT Device Management Set Default Authorizer
call: amazon-iot-device-management.setdefaultauthorizer
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/destinations
name: destinations
description: REST surface for destinations.
operations:
- method: POST
name: createtopicruledestination
description: Amazon IoT Device Management Create Topic Rule Destination
call: amazon-iot-device-management.createtopicruledestination
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: GET
name: listtopicruledestinations
description: Amazon IoT Device Management List Topic Rule Destinations
call: amazon-iot-device-management.listtopicruledestinations
with:
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatetopicruledestination
description: Amazon IoT Device Management Update Topic Rule Destination
call: amazon-iot-device-management.updatetopicruledestination
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/destinations/{arn}
name: destinations-arn
description: REST surface for destinations-arn.
operations:
- method: DELETE
name: deletetopicruledestination
description: Amazon IoT Device Management Delete Topic Rule Destination
call: amazon-iot-device-management.deletetopicruledestination
with:
arn: rest.arn
outputParameters:
- type: object
mapping: $.
- method: GET
name: gettopicruledestination
description: Amazon IoT Device Management Get Topic Rule Destination
call: amazon-iot-device-management.gettopicruledestination
with:
arn: rest.arn
outputParameters:
- type: object
mapping: $.
- path: /v1/detect/mitigationactions/executions
name: detect-mitigationactions-executions
description: REST surface for detect-mitigationactions-executions.
operations:
- method: GET
name: listdetectmitigationactionsexecutions
description: Amazon IoT Device Management List Detect Mitigation Actions Executions
call: amazon-iot-device-management.listdetectmitigationactionsexecutions
with:
taskId: rest.taskId
violationId: rest.violationId
thingName: rest.thingName
startTime: rest.startTime
endTime: rest.endTime
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/detect/mitigationactions/tasks-starttime-endtime
name: detect-mitigationactions-tasks-starttime-endtime
description: REST surface for detect-mitigationactions-tasks#startTime&endTime.
operations:
- method: GET
name: listdetectmitigationactionstasks
description: Amazon IoT Device Management List Detect Mitigation Actions Tasks
call: amazon-iot-device-management.listdetectmitigationactionstasks
with:
maxResults: rest.maxResults
nextToken: rest.nextToken
startTime: rest.startTime
endTime: rest.endTime
outputParameters:
- type: object
mapping: $.
- path: /v1/detect/mitigationactions/tasks/{taskid}
name: detect-mitigationactions-tasks-taskid
description: REST surface for detect-mitigationactions-tasks-taskId.
operations:
- method: GET
name: describedetectmitigationactionstask
description: Amazon IoT Device Management Describe Detect Mitigation Actions Task
call: amazon-iot-device-management.describedetectmitigationactionstask
with:
taskId: rest.taskId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: startdetectmitigationactionstask
description: Amazon IoT Device Management Start Detect Mitigation Actions Task
call: amazon-iot-device-management.startdetectmitigationactionstask
with:
taskId: rest.taskId
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/detect/mitigationactions/tasks/{taskid}/cancel
name: detect-mitigationactions-tasks-taskid-cancel
description: REST surface for detect-mitigationactions-tasks-taskId-cancel.
operations:
- method: PUT
name: canceldetectmitigationactionstask
description: Amazon IoT Device Management Cancel Detect Mitigation Actions Task
call: amazon-iot-device-management.canceldetectmitigationactionstask
with:
taskId: rest.taskId
outputParameters:
- type: object
mapping: $.
- path: /v1/dimensions
name: dimensions
description: REST surface for dimensions.
operations:
- method: GET
name: listdimensions
description: Amazon IoT Device Management List Dimensions
call: amazon-iot-device-management.listdimensions
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/dimensions/{name}
name: dimensions-name
description: REST surface for dimensions-name.
operations:
- method: POST
name: createdimension
description: Amazon IoT Device Management Create Dimension
call: amazon-iot-device-management.createdimension
with:
name: rest.name
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletedimension
description: Amazon IoT Device Management Delete Dimension
call: amazon-iot-device-management.deletedimension
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- method: GET
name: describedimension
description: Amazon IoT Device Management Describe Dimension
call: amazon-iot-device-management.describedimension
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatedimension
description: Amazon IoT Device Management Update Dimension
call: amazon-iot-device-management.updatedimension
with:
name: rest.name
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/domainconfigurations
name: domainconfigurations
description: REST surface for domainConfigurations.
operations:
- method: GET
name: listdomainconfigurations
description: Amazon IoT Device Management List Domain Configurations
call: amazon-iot-device-management.listdomainconfigurations
with:
marker: rest.marker
pageSize: rest.pageSize
serviceType: rest.serviceType
outputParameters:
- type: object
mapping: $.
- path: /v1/domainconfigurations/{domainconfigurationname}
name: domainconfigurations-domainconfigurationname
description: REST surface for domainConfigurations-domainConfigurationName.
operations:
- method: POST
name: createdomainconfiguration
description: Amazon IoT Device Management Create Domain Configuration
call: amazon-iot-device-management.createdomainconfiguration
with:
domainConfigurationName: rest.domainConfigurationName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletedomainconfiguration
description: Amazon IoT Device Management Delete Domain Configuration
call: amazon-iot-device-management.deletedomainconfiguration
with:
domainConfigurationName: rest.domainConfigurationName
outputParameters:
- type: object
mapping: $.
- method: GET
name: describedomainconfiguration
description: Amazon IoT Device Management Describe Domain Configuration
call: amazon-iot-device-management.describedomainconfiguration
with:
domainConfigurationName: rest.domainConfigurationName
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updatedomainconfiguration
description: Amazon IoT Device Management Update Domain Configuration
call: amazon-iot-device-management.updatedomainconfiguration
with:
domainConfigurationName: rest.domainConfigurationName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/dynamic-thing-groups/{thinggroupname}
name: dynamic-thing-groups-thinggroupname
description: REST surface for dynamic-thing-groups-thingGroupName.
operations:
- method: POST
name: createdynamicthinggroup
description: Amazon IoT Device Management Create Dynamic Thing Group
call: amazon-iot-device-management.createdynamicthinggroup
with:
thingGroupName: rest.thingGroupName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletedynamicthinggroup
description: Amazon IoT Device Management Delete Dynamic Thing Group
call: amazon-iot-device-management.deletedynamicthinggroup
with:
thingGroupName: rest.thingGroupName
expectedVersion: rest.expectedVersion
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatedynamicthinggroup
description: Amazon IoT Device Management Update Dynamic Thing Group
call: amazon-iot-device-management.updatedynamicthinggroup
with:
thingGroupName: rest.thingGroupName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/effective-policies
name: effective-policies
description: REST surface for effective-policies.
operations:
- method: POST
name: geteffectivepolicies
description: Amazon IoT Device Management Get Effective Policies
call: amazon-iot-device-management.geteffectivepolicies
with:
thingName: rest.thingName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/endpoint
name: endpoint
description: REST surface for endpoint.
operations:
- method: GET
name: describeendpoint
description: Amazon IoT Device Management Describe Endpoint
call: amazon-iot-device-management.describeendpoint
with:
endpointType: rest.endpointType
outputParameters:
- type: object
mapping: $.
- path: /v1/event-configurations
name: event-configurations
description: REST surface for event-configurations.
operations:
- method: GET
name: describeeventconfigurations
description: Amazon IoT Device Management Describe Event Configurations
call: amazon-iot-device-management.describeeventconfigurations
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updateeventconfigurations
description: Amazon IoT Device Management Update Event Configurations
call: amazon-iot-device-management.updateeventconfigurations
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/fleet-metric/{metricname}
name: fleet-metric-metricname
description: REST surface for fleet-metric-metricName.
operations:
- method: PUT
name: createfleetmetric
description: Amazon IoT Device Management Create Fleet Metric
call: amazon-iot-device-management.createfleetmetric
with:
metricName: rest.metricName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletefleetmetric
description: Amazon IoT Device Management Delete Fleet Metric
call: amazon-iot-device-management.deletefleetmetric
with:
metricName: rest.metricName
expectedVersion: rest.expectedVersion
outputParameters:
- type: object
mapping: $.
- method: GET
name: describefleetmetric
description: Amazon IoT Device Management Describe Fleet Metric
call: amazon-iot-device-management.describefleetmetric
with:
metricName: rest.metricName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatefleetmetric
description: Amazon IoT Device Management Update Fleet Metric
call: amazon-iot-device-management.updatefleetmetric
with:
metricName: rest.metricName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/fleet-metrics
name: fleet-metrics
description: REST surface for fleet-metrics.
operations:
- method: GET
name: listfleetmetrics
description: Amazon IoT Device Management List Fleet Metrics
call: amazon-iot-device-management.listfleetmetrics
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/indexing/config
name: indexing-config
description: REST surface for indexing-config.
operations:
- method: GET
name: getindexingconfiguration
description: Amazon IoT Device Management Get Indexing Configuration
call: amazon-iot-device-management.getindexingconfiguration
outputParameters:
- type: object
mapping: $.
- method: POST
name: updateindexingconfiguration
description: Amazon IoT Device Management Update Indexing Configuration
call: amazon-iot-device-management.updateindexingconfiguration
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/indices
name: indices
description: REST surface for indices.
operations:
- method: GET
name: listindices
description: Amazon IoT Device Management List Indices
call: amazon-iot-device-management.listindices
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/indices/buckets
name: indices-buckets
description: REST surface for indices-buckets.
operations:
- method: POST
name: getbucketsaggregation
description: Amazon IoT Device Management Get Buckets Aggregation
call: amazon-iot-device-management.getbucketsaggregation
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/indices/cardinality
name: indices-cardinality
description: REST surface for indices-cardinality.
operations:
- method: POST
name: getcardinality
description: Amazon IoT Device Management Get Cardinality
call: amazon-iot-device-management.getcardinality
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/indices/percentiles
name: indices-percentiles
description: REST surface for indices-percentiles.
operations:
- method: POST
name: getpercentiles
description: Amazon IoT Device Management Get Percentiles
call: amazon-iot-device-management.getpercentiles
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/indices/search
name: indices-search
description: REST surface for indices-search.
operations:
- method: POST
name: searchindex
description: Amazon IoT Device Management Search Index
call: amazon-iot-device-management.searchindex
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/indices/statistics
name: indices-statistics
description: REST surface for indices-statistics.
operations:
- method: POST
name: getstatistics
description: Amazon IoT Device Management Get Statistics
call: amazon-iot-device-management.getstatistics
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/indices/{indexname}
name: indices-indexname
description: REST surface for indices-indexName.
operations:
- method: GET
name: describeindex
description: Amazon IoT Device Management Describe Index
call: amazon-iot-device-management.describeindex
with:
indexName: rest.indexName
outputParameters:
- type: object
mapping: $.
- path: /v1/job-templates
name: job-templates
description: REST surface for job-templates.
operations:
- method: GET
name: listjobtemplates
description: Amazon IoT Device Management List Job Templates
call: amazon-iot-device-management.listjobtemplates
with:
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/job-templates/{jobtemplateid}
name: job-templates-jobtemplateid
description: REST surface for job-templates-jobTemplateId.
operations:
- method: PUT
name: createjobtemplate
description: Amazon IoT Device Management Create Job Template
call: amazon-iot-device-management.createjobtemplate
with:
jobTemplateId: rest.jobTemplateId
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletejobtemplate
description: Amazon IoT Device Management Delete Job Template
call: amazon-iot-device-management.deletejobtemplate
with:
jobTemplateId: rest.jobTemplateId
outputParameters:
- type: object
mapping: $.
- method: GET
name: describejobtemplate
description: Amazon IoT Device Management Describe Job Template
call: amazon-iot-device-management.describejobtemplate
with:
jobTemplateId: rest.jobTemplateId
outputParameters:
- type: object
mapping: $.
- path: /v1/jobs
name: jobs
description: REST surface for jobs.
operations:
- method: GET
name: listjobs
description: Amazon IoT Device Management List Jobs
call: amazon-iot-device-management.listjobs
with:
status: rest.status
targetSelection: rest.targetSelection
maxResults: rest.maxResults
nextToken: rest.nextToken
thingGroupName: rest.thingGroupName
thingGroupId: rest.thingGroupId
namespaceId: rest.namespaceId
outputParameters:
- type: object
mapping: $.
- path: /v1/jobs/{jobid}
name: jobs-jobid
description: REST surface for jobs-jobId.
operations:
- method: PUT
name: createjob
description: Amazon IoT Device Management Create Job
call: amazon-iot-device-management.createjob
with:
jobId: rest.jobId
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletejob
description: Amazon IoT Device Management Delete Job
call: amazon-iot-device-management.deletejob
with:
jobId: rest.jobId
force: rest.force
namespaceId: rest.namespaceId
outputParameters:
- type: object
mapping: $.
- method: GET
name: describejob
description: Amazon IoT Device Management Describe Job
call: amazon-iot-device-management.describejob
with:
jobId: rest.jobId
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatejob
description: Amazon IoT Device Management Update Job
call: amazon-iot-device-management.updatejob
with:
jobId: rest.jobId
namespaceId: rest.namespaceId
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/jobs/{jobid}/cancel
name: jobs-jobid-cancel
description: REST surface for jobs-jobId-cancel.
operations:
- method: PUT
name: canceljob
description: Amazon IoT Device Management Cancel Job
call: amazon-iot-device-management.canceljob
with:
jobId: rest.jobId
force: rest.force
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/jobs/{jobid}/job-document
name: jobs-jobid-job-document
description: REST surface for jobs-jobId-job-document.
operations:
- method: GET
name: getjobdocument
description: Amazon IoT Device Management Get Job Document
call: amazon-iot-device-management.getjobdocument
with:
jobId: rest.jobId
outputParameters:
- type: object
mapping: $.
- path: /v1/jobs/{jobid}/targets
name: jobs-jobid-targets
description: REST surface for jobs-jobId-targets.
operations:
- method: POST
name: associatetargetswithjob
description: Amazon IoT Device Management Associate Targets with Job
call: amazon-iot-device-management.associatetargetswithjob
with:
jobId: rest.jobId
namespaceId: rest.namespaceId
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/jobs/{jobid}/things
name: jobs-jobid-things
description: REST surface for jobs-jobId-things.
operations:
- method: GET
name: listjobexecutionsforjob
description: Amazon IoT Device Management List Job Executions for Job
call: amazon-iot-device-management.listjobexecutionsforjob
with:
jobId: rest.jobId
status: rest.status
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/keys-and-certificate
name: keys-and-certificate
description: REST surface for keys-and-certificate.
operations:
- method: POST
name: createkeysandcertificate
description: Amazon IoT Device Management Create Keys and Certificate
call: amazon-iot-device-management.createkeysandcertificate
with:
setAsActive: rest.setAsActive
outputParameters:
- type: object
mapping: $.
- path: /v1/loggingoptions
name: loggingoptions
description: REST surface for loggingOptions.
operations:
- method: GET
name: getloggingoptions
description: Amazon IoT Device Management Get Logging Options
call: amazon-iot-device-management.getloggingoptions
outputParameters:
- type: object
mapping: $.
- method: POST
name: setloggingoptions
description: Amazon IoT Device Management Set Logging Options
call: amazon-iot-device-management.setloggingoptions
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/managed-job-templates
name: managed-job-templates
description: REST surface for managed-job-templates.
operations:
- method: GET
name: listmanagedjobtemplates
description: Amazon IoT Device Management List Managed Job Templates
call: amazon-iot-device-management.listmanagedjobtemplates
with:
templateName: rest.templateName
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/managed-job-templates/{templatename}
name: managed-job-templates-templatename
description: REST surface for managed-job-templates-templateName.
operations:
- method: GET
name: describemanagedjobtemplate
description: Amazon IoT Device Management Describe Managed Job Template
call: amazon-iot-device-management.describemanagedjobtemplate
with:
templateName: rest.templateName
templateVersion: rest.templateVersion
outputParameters:
- type: object
mapping: $.
- path: /v1/metric-values-thingname-metricname-starttime-endtime
name: metric-values-thingname-metricname-starttime-endtime
description: REST surface for metric-values#thingName&metricName&startTime&endTime.
operations:
- method: GET
name: listmetricvalues
description: Amazon IoT Device Management List Metric Values
call: amazon-iot-device-management.listmetricvalues
with:
thingName: rest.thingName
metricName: rest.metricName
dimensionName: rest.dimensionName
dimensionValueOperator: rest.dimensionValueOperator
startTime: rest.startTime
endTime: rest.endTime
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/mitigationactions/actions
name: mitigationactions-actions
description: REST surface for mitigationactions-actions.
operations:
- method: GET
name: listmitigationactions
description: Amazon IoT Device Management List Mitigation Actions
call: amazon-iot-device-management.listmitigationactions
with:
actionType: rest.actionType
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/mitigationactions/actions/{actionname}
name: mitigationactions-actions-actionname
description: REST surface for mitigationactions-actions-actionName.
operations:
- method: POST
name: createmitigationaction
description: Amazon IoT Device Management Create Mitigation Action
call: amazon-iot-device-management.createmitigationaction
with:
actionName: rest.actionName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletemitigationaction
description: Amazon IoT Device Management Delete Mitigation Action
call: amazon-iot-device-management.deletemitigationaction
with:
actionName: rest.actionName
outputParameters:
- type: object
mapping: $.
- method: GET
name: describemitigationaction
description: Amazon IoT Device Management Describe Mitigation Action
call: amazon-iot-device-management.describemitigationaction
with:
actionName: rest.actionName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatemitigationaction
description: Amazon IoT Device Management Update Mitigation Action
call: amazon-iot-device-management.updatemitigationaction
with:
actionName: rest.actionName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/otaupdates
name: otaupdates
description: REST surface for otaUpdates.
operations:
- method: GET
name: listotaupdates
description: Amazon IoT Device Management List O T a Updates
call: amazon-iot-device-management.listotaupdates
with:
maxResults: rest.maxResults
nextToken: rest.nextToken
otaUpdateStatus: rest.otaUpdateStatus
outputParameters:
- type: object
mapping: $.
- path: /v1/otaupdates/{otaupdateid}
name: otaupdates-otaupdateid
description: REST surface for otaUpdates-otaUpdateId.
operations:
- method: POST
name: createotaupdate
description: Amazon IoT Device Management Create O T a Update
call: amazon-iot-device-management.createotaupdate
with:
otaUpdateId: rest.otaUpdateId
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deleteotaupdate
description: Amazon IoT Device Management Delete O T a Update
call: amazon-iot-device-management.deleteotaupdate
with:
otaUpdateId: rest.otaUpdateId
deleteStream: rest.deleteStream
forceDeleteAWSJob: rest.forceDeleteAWSJob
outputParameters:
- type: object
mapping: $.
- method: GET
name: getotaupdate
description: Amazon IoT Device Management Get O T a Update
call: amazon-iot-device-management.getotaupdate
with:
otaUpdateId: rest.otaUpdateId
outputParameters:
- type: object
mapping: $.
- path: /v1/policies
name: policies
description: REST surface for policies.
operations:
- method: GET
name: listpolicies
description: Amazon IoT Device Management List Policies
call: amazon-iot-device-management.listpolicies
with:
marker: rest.marker
pageSize: rest.pageSize
isAscendingOrder: rest.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- path: /v1/policies/{policyname}
name: policies-policyname
description: REST surface for policies-policyName.
operations:
- method: POST
name: createpolicy
description: Amazon IoT Device Management Create Policy
call: amazon-iot-device-management.createpolicy
with:
policyName: rest.policyName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletepolicy
description: Amazon IoT Device Management Delete Policy
call: amazon-iot-device-management.deletepolicy
with:
policyName: rest.policyName
outputParameters:
- type: object
mapping: $.
- method: GET
name: getpolicy
description: Amazon IoT Device Management Get Policy
call: amazon-iot-device-management.getpolicy
with:
policyName: rest.policyName
outputParameters:
- type: object
mapping: $.
- path: /v1/policies/{policyname}/version
name: policies-policyname-version
description: REST surface for policies-policyName-version.
operations:
- method: POST
name: createpolicyversion
description: Amazon IoT Device Management Create Policy Version
call: amazon-iot-device-management.createpolicyversion
with:
policyName: rest.policyName
setAsDefault: rest.setAsDefault
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: GET
name: listpolicyversions
description: Amazon IoT Device Management List Policy Versions
call: amazon-iot-device-management.listpolicyversions
with:
policyName: rest.policyName
outputParameters:
- type: object
mapping: $.
- path: /v1/policies/{policyname}/version/{policyversionid}
name: policies-policyname-version-policyversionid
description: REST surface for policies-policyName-version-policyVersionId.
operations:
- method: DELETE
name: deletepolicyversion
description: Amazon IoT Device Management Delete Policy Version
call: amazon-iot-device-management.deletepolicyversion
with:
policyName: rest.policyName
policyVersionId: rest.policyVersionId
outputParameters:
- type: object
mapping: $.
- method: GET
name: getpolicyversion
description: Amazon IoT Device Management Get Policy Version
call: amazon-iot-device-management.getpolicyversion
with:
policyName: rest.policyName
policyVersionId: rest.policyVersionId
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: setdefaultpolicyversion
description: Amazon IoT Device Management Set Default Policy Version
call: amazon-iot-device-management.setdefaultpolicyversion
with:
policyName: rest.policyName
policyVersionId: rest.policyVersionId
outputParameters:
- type: object
mapping: $.
- path: /v1/policy-principals-x-amzn-iot-policy
name: policy-principals-x-amzn-iot-policy
description: REST surface for policy-principals#x-amzn-iot-policy.
operations:
- method: GET
name: listpolicyprincipals
description: Amazon IoT Device Management List Policy Principals
call: amazon-iot-device-management.listpolicyprincipals
with:
x-amzn-iot-policy: rest.x-amzn-iot-policy
marker: rest.marker
pageSize: rest.pageSize
isAscendingOrder: rest.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- path: /v1/policy-targets/{policyname}
name: policy-targets-policyname
description: REST surface for policy-targets-policyName.
operations:
- method: POST
name: listtargetsforpolicy
description: Amazon IoT Device Management List Targets for Policy
call: amazon-iot-device-management.listtargetsforpolicy
with:
policyName: rest.policyName
marker: rest.marker
pageSize: rest.pageSize
outputParameters:
- type: object
mapping: $.
- path: /v1/principal-policies-x-amzn-iot-principal
name: principal-policies-x-amzn-iot-principal
description: REST surface for principal-policies#x-amzn-iot-principal.
operations:
- method: GET
name: listprincipalpolicies
description: Amazon IoT Device Management List Principal Policies
call: amazon-iot-device-management.listprincipalpolicies
with:
x-amzn-iot-principal: rest.x-amzn-iot-principal
marker: rest.marker
pageSize: rest.pageSize
isAscendingOrder: rest.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- path: /v1/principal-policies/policyname-x-amzn-iot-principal
name: principal-policies-policyname-x-amzn-iot-principal
description: REST surface for principal-policies-policyName}#x-amzn-iot-principal.
operations:
- method: PUT
name: attachprincipalpolicy
description: Amazon IoT Device Management Attach Principal Policy
call: amazon-iot-device-management.attachprincipalpolicy
with:
policyName: rest.policyName
x-amzn-iot-principal: rest.x-amzn-iot-principal
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: detachprincipalpolicy
description: Amazon IoT Device Management Detach Principal Policy
call: amazon-iot-device-management.detachprincipalpolicy
with:
policyName: rest.policyName
x-amzn-iot-principal: rest.x-amzn-iot-principal
outputParameters:
- type: object
mapping: $.
- path: /v1/principals/things-x-amzn-principal
name: principals-things-x-amzn-principal
description: REST surface for principals-things#x-amzn-principal.
operations:
- method: GET
name: listprincipalthings
description: Amazon IoT Device Management List Principal Things
call: amazon-iot-device-management.listprincipalthings
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
x-amzn-principal: rest.x-amzn-principal
outputParameters:
- type: object
mapping: $.
- path: /v1/provisioning-templates
name: provisioning-templates
description: REST surface for provisioning-templates.
operations:
- method: POST
name: createprovisioningtemplate
description: Amazon IoT Device Management Create Provisioning Template
call: amazon-iot-device-management.createprovisioningtemplate
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: GET
name: listprovisioningtemplates
description: Amazon IoT Device Management List Provisioning Templates
call: amazon-iot-device-management.listprovisioningtemplates
with:
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/provisioning-templates/{templatename}
name: provisioning-templates-templatename
description: REST surface for provisioning-templates-templateName.
operations:
- method: DELETE
name: deleteprovisioningtemplate
description: Amazon IoT Device Management Delete Provisioning Template
call: amazon-iot-device-management.deleteprovisioningtemplate
with:
templateName: rest.templateName
outputParameters:
- type: object
mapping: $.
- method: GET
name: describeprovisioningtemplate
description: Amazon IoT Device Management Describe Provisioning Template
call: amazon-iot-device-management.describeprovisioningtemplate
with:
templateName: rest.templateName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updateprovisioningtemplate
description: Amazon IoT Device Management Update Provisioning Template
call: amazon-iot-device-management.updateprovisioningtemplate
with:
templateName: rest.templateName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/provisioning-templates/{templatename}/provisioning-claim
name: provisioning-templates-templatename-provisioning-claim
description: REST surface for provisioning-templates-templateName-provisioning-claim.
operations:
- method: POST
name: createprovisioningclaim
description: Amazon IoT Device Management Create Provisioning Claim
call: amazon-iot-device-management.createprovisioningclaim
with:
templateName: rest.templateName
outputParameters:
- type: object
mapping: $.
- path: /v1/provisioning-templates/{templatename}/versions
name: provisioning-templates-templatename-versions
description: REST surface for provisioning-templates-templateName-versions.
operations:
- method: POST
name: createprovisioningtemplateversion
description: Amazon IoT Device Management Create Provisioning Template Version
call: amazon-iot-device-management.createprovisioningtemplateversion
with:
templateName: rest.templateName
setAsDefault: rest.setAsDefault
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: GET
name: listprovisioningtemplateversions
description: Amazon IoT Device Management List Provisioning Template Versions
call: amazon-iot-device-management.listprovisioningtemplateversions
with:
templateName: rest.templateName
maxResults: rest.maxResults
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/provisioning-templates/{templatename}/versions/{versionid}
name: provisioning-templates-templatename-versions-versionid
description: REST surface for provisioning-templates-templateName-versions-versionId.
operations:
- method: DELETE
name: deleteprovisioningtemplateversion
description: Amazon IoT Device Management Delete Provisioning Template Version
call: amazon-iot-device-management.deleteprovisioningtemplateversion
with:
templateName: rest.templateName
versionId: rest.versionId
outputParameters:
- type: object
mapping: $.
- method: GET
name: describeprovisioningtemplateversion
description: Amazon IoT Device Management Describe Provisioning Template Version
call: amazon-iot-device-management.describeprovisioningtemplateversion
with:
templateName: rest.templateName
versionId: rest.versionId
outputParameters:
- type: object
mapping: $.
- path: /v1/registrationcode
name: registrationcode
description: REST surface for registrationcode.
operations:
- method: DELETE
name: deleteregistrationcode
description: Amazon IoT Device Management Delete Registration Code
call: amazon-iot-device-management.deleteregistrationcode
outputParameters:
- type: object
mapping: $.
- method: GET
name: getregistrationcode
description: Amazon IoT Device Management Get Registration Code
call: amazon-iot-device-management.getregistrationcode
outputParameters:
- type: object
mapping: $.
- path: /v1/reject-certificate-transfer/{certificateid}
name: reject-certificate-transfer-certificateid
description: REST surface for reject-certificate-transfer-certificateId.
operations:
- method: PATCH
name: rejectcertificatetransfer
description: Amazon IoT Device Management Reject Certificate Transfer
call: amazon-iot-device-management.rejectcertificatetransfer
with:
certificateId: rest.certificateId
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/role-aliases
name: role-aliases
description: REST surface for role-aliases.
operations:
- method: GET
name: listrolealiases
description: Amazon IoT Device Management List Role Aliases
call: amazon-iot-device-management.listrolealiases
with:
pageSize: rest.pageSize
marker: rest.marker
isAscendingOrder: rest.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- path: /v1/role-aliases/{rolealias}
name: role-aliases-rolealias
description: REST surface for role-aliases-roleAlias.
operations:
- method: POST
name: createrolealias
description: Amazon IoT Device Management Create Role Alias
call: amazon-iot-device-management.createrolealias
with:
roleAlias: rest.roleAlias
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deleterolealias
description: Amazon IoT Device Management Delete Role Alias
call: amazon-iot-device-management.deleterolealias
with:
roleAlias: rest.roleAlias
outputParameters:
- type: object
mapping: $.
- method: GET
name: describerolealias
description: Amazon IoT Device Management Describe Role Alias
call: amazon-iot-device-management.describerolealias
with:
roleAlias: rest.roleAlias
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updaterolealias
description: Amazon IoT Device Management Update Role Alias
call: amazon-iot-device-management.updaterolealias
with:
roleAlias: rest.roleAlias
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/rules
name: rules
description: REST surface for rules.
operations:
- method: GET
name: listtopicrules
description: Amazon IoT Device Management List Topic Rules
call: amazon-iot-device-management.listtopicrules
with:
topic: rest.topic
maxResults: rest.maxResults
nextToken: rest.nextToken
ruleDisabled: rest.ruleDisabled
outputParameters:
- type: object
mapping: $.
- path: /v1/rules/{rulename}
name: rules-rulename
description: REST surface for rules-ruleName.
operations:
- method: POST
name: createtopicrule
description: Amazon IoT Device Management Create Topic Rule
call: amazon-iot-device-management.createtopicrule
with:
ruleName: rest.ruleName
x-amz-tagging: rest.x-amz-tagging
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletetopicrule
description: Amazon IoT Device Management Delete Topic Rule
call: amazon-iot-device-management.deletetopicrule
with:
ruleName: rest.ruleName
outputParameters:
- type: object
mapping: $.
- method: GET
name: gettopicrule
description: Amazon IoT Device Management Get Topic Rule
call: amazon-iot-device-management.gettopicrule
with:
ruleName: rest.ruleName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: replacetopicrule
description: Amazon IoT Device Management Replace Topic Rule
call: amazon-iot-device-management.replacetopicrule
with:
ruleName: rest.ruleName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/rules/{rulename}/disable
name: rules-rulename-disable
description: REST surface for rules-ruleName-disable.
operations:
- method: POST
name: disabletopicrule
description: Amazon IoT Device Management Disable Topic Rule
call: amazon-iot-device-management.disabletopicrule
with:
ruleName: rest.ruleName
outputParameters:
- type: object
mapping: $.
- path: /v1/rules/{rulename}/enable
name: rules-rulename-enable
description: REST surface for rules-ruleName-enable.
operations:
- method: POST
name: enabletopicrule
description: Amazon IoT Device Management Enable Topic Rule
call: amazon-iot-device-management.enabletopicrule
with:
ruleName: rest.ruleName
outputParameters:
- type: object
mapping: $.
- path: /v1/security-profile-behaviors/validate
name: security-profile-behaviors-validate
description: REST surface for security-profile-behaviors-validate.
operations:
- method: POST
name: validatesecurityprofilebehaviors
description: Amazon IoT Device Management Validate Security Profile Behaviors
call: amazon-iot-device-management.validatesecurityprofilebehaviors
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/security-profiles
name: security-profiles
description: REST surface for security-profiles.
operations:
- method: GET
name: listsecurityprofiles
description: Amazon IoT Device Management List Security Profiles
call: amazon-iot-device-management.listsecurityprofiles
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
dimensionName: rest.dimensionName
metricName: rest.metricName
outputParameters:
- type: object
mapping: $.
- path: /v1/security-profiles-for-target-securityprofiletargetarn
name: security-profiles-for-target-securityprofiletargetarn
description: REST surface for security-profiles-for-target#securityProfileTargetArn.
operations:
- method: GET
name: listsecurityprofilesfortarget
description: Amazon IoT Device Management List Security Profiles for Target
call: amazon-iot-device-management.listsecurityprofilesfortarget
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
recursive: rest.recursive
securityProfileTargetArn: rest.securityProfileTargetArn
outputParameters:
- type: object
mapping: $.
- path: /v1/security-profiles/{securityprofilename}
name: security-profiles-securityprofilename
description: REST surface for security-profiles-securityProfileName.
operations:
- method: POST
name: createsecurityprofile
description: Amazon IoT Device Management Create Security Profile
call: amazon-iot-device-management.createsecurityprofile
with:
securityProfileName: rest.securityProfileName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletesecurityprofile
description: Amazon IoT Device Management Delete Security Profile
call: amazon-iot-device-management.deletesecurityprofile
with:
securityProfileName: rest.securityProfileName
expectedVersion: rest.expectedVersion
outputParameters:
- type: object
mapping: $.
- method: GET
name: describesecurityprofile
description: Amazon IoT Device Management Describe Security Profile
call: amazon-iot-device-management.describesecurityprofile
with:
securityProfileName: rest.securityProfileName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatesecurityprofile
description: Amazon IoT Device Management Update Security Profile
call: amazon-iot-device-management.updatesecurityprofile
with:
securityProfileName: rest.securityProfileName
expectedVersion: rest.expectedVersion
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/security-profiles/{securityprofilename}/targets
name: security-profiles-securityprofilename-targets
description: REST surface for security-profiles-securityProfileName-targets.
operations:
- method: GET
name: listtargetsforsecurityprofile
description: Amazon IoT Device Management List Targets for Security Profile
call: amazon-iot-device-management.listtargetsforsecurityprofile
with:
securityProfileName: rest.securityProfileName
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/security-profiles/{securityprofilename}/targets-securityprofiletargetarn
name: security-profiles-securityprofilename-targets-securityprofiletargetarn
description: REST surface for security-profiles-securityProfileName-targets#securityProfileTargetArn.
operations:
- method: PUT
name: attachsecurityprofile
description: Amazon IoT Device Management Attach Security Profile
call: amazon-iot-device-management.attachsecurityprofile
with:
securityProfileName: rest.securityProfileName
securityProfileTargetArn: rest.securityProfileTargetArn
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: detachsecurityprofile
description: Amazon IoT Device Management Detach Security Profile
call: amazon-iot-device-management.detachsecurityprofile
with:
securityProfileName: rest.securityProfileName
securityProfileTargetArn: rest.securityProfileTargetArn
outputParameters:
- type: object
mapping: $.
- path: /v1/streams
name: streams
description: REST surface for streams.
operations:
- method: GET
name: liststreams
description: Amazon IoT Device Management List Streams
call: amazon-iot-device-management.liststreams
with:
maxResults: rest.maxResults
nextToken: rest.nextToken
isAscendingOrder: rest.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- path: /v1/streams/{streamid}
name: streams-streamid
description: REST surface for streams-streamId.
operations:
- method: POST
name: createstream
description: Amazon IoT Device Management Create Stream
call: amazon-iot-device-management.createstream
with:
streamId: rest.streamId
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletestream
description: Amazon IoT Device Management Delete Stream
call: amazon-iot-device-management.deletestream
with:
streamId: rest.streamId
outputParameters:
- type: object
mapping: $.
- method: GET
name: describestream
description: Amazon IoT Device Management Describe Stream
call: amazon-iot-device-management.describestream
with:
streamId: rest.streamId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updatestream
description: Amazon IoT Device Management Update Stream
call: amazon-iot-device-management.updatestream
with:
streamId: rest.streamId
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/tags
name: tags
description: REST surface for tags.
operations:
- method: POST
name: tagresource
description: Amazon IoT Device Management Tag Resource
call: amazon-iot-device-management.tagresource
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/tags-resourcearn
name: tags-resourcearn
description: REST surface for tags#resourceArn.
operations:
- method: GET
name: listtagsforresource
description: Amazon IoT Device Management List Tags for Resource
call: amazon-iot-device-management.listtagsforresource
with:
resourceArn: rest.resourceArn
nextToken: rest.nextToken
outputParameters:
- type: object
mapping: $.
- path: /v1/target-policies/{policyname}
name: target-policies-policyname
description: REST surface for target-policies-policyName.
operations:
- method: PUT
name: attachpolicy
description: Amazon IoT Device Management Attach Policy
call: amazon-iot-device-management.attachpolicy
with:
policyName: rest.policyName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: POST
name: detachpolicy
description: Amazon IoT Device Management Detach Policy
call: amazon-iot-device-management.detachpolicy
with:
policyName: rest.policyName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/test-authorization
name: test-authorization
description: REST surface for test-authorization.
operations:
- method: POST
name: testauthorization
description: Amazon IoT Device Management Test Authorization
call: amazon-iot-device-management.testauthorization
with:
clientId: rest.clientId
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-groups
name: thing-groups
description: REST surface for thing-groups.
operations:
- method: GET
name: listthinggroups
description: Amazon IoT Device Management List Thing Groups
call: amazon-iot-device-management.listthinggroups
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
parentGroup: rest.parentGroup
namePrefixFilter: rest.namePrefixFilter
recursive: rest.recursive
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-groups/addthingtothinggroup
name: thing-groups-addthingtothinggroup
description: REST surface for thing-groups-addThingToThingGroup.
operations:
- method: PUT
name: addthingtothinggroup
description: Amazon IoT Device Management Add Thing to Thing Group
call: amazon-iot-device-management.addthingtothinggroup
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-groups/removethingfromthinggroup
name: thing-groups-removethingfromthinggroup
description: REST surface for thing-groups-removeThingFromThingGroup.
operations:
- method: PUT
name: removethingfromthinggroup
description: Amazon IoT Device Management Remove Thing from Thing Group
call: amazon-iot-device-management.removethingfromthinggroup
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-groups/updatethinggroupsforthing
name: thing-groups-updatethinggroupsforthing
description: REST surface for thing-groups-updateThingGroupsForThing.
operations:
- method: PUT
name: updatethinggroupsforthing
description: Amazon IoT Device Management Update Thing Groups for Thing
call: amazon-iot-device-management.updatethinggroupsforthing
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-groups/{thinggroupname}
name: thing-groups-thinggroupname
description: REST surface for thing-groups-thingGroupName.
operations:
- method: POST
name: createthinggroup
description: Amazon IoT Device Management Create Thing Group
call: amazon-iot-device-management.createthinggroup
with:
thingGroupName: rest.thingGroupName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletethinggroup
description: Amazon IoT Device Management Delete Thing Group
call: amazon-iot-device-management.deletethinggroup
with:
thingGroupName: rest.thingGroupName
expectedVersion: rest.expectedVersion
outputParameters:
- type: object
mapping: $.
- method: GET
name: describethinggroup
description: Amazon IoT Device Management Describe Thing Group
call: amazon-iot-device-management.describethinggroup
with:
thingGroupName: rest.thingGroupName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatethinggroup
description: Amazon IoT Device Management Update Thing Group
call: amazon-iot-device-management.updatethinggroup
with:
thingGroupName: rest.thingGroupName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-groups/{thinggroupname}/things
name: thing-groups-thinggroupname-things
description: REST surface for thing-groups-thingGroupName-things.
operations:
- method: GET
name: listthingsinthinggroup
description: Amazon IoT Device Management List Things in Thing Group
call: amazon-iot-device-management.listthingsinthinggroup
with:
thingGroupName: rest.thingGroupName
recursive: rest.recursive
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-registration-tasks
name: thing-registration-tasks
description: REST surface for thing-registration-tasks.
operations:
- method: GET
name: listthingregistrationtasks
description: Amazon IoT Device Management List Thing Registration Tasks
call: amazon-iot-device-management.listthingregistrationtasks
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
status: rest.status
outputParameters:
- type: object
mapping: $.
- method: POST
name: startthingregistrationtask
description: Amazon IoT Device Management Start Thing Registration Task
call: amazon-iot-device-management.startthingregistrationtask
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-registration-tasks/{taskid}
name: thing-registration-tasks-taskid
description: REST surface for thing-registration-tasks-taskId.
operations:
- method: GET
name: describethingregistrationtask
description: Amazon IoT Device Management Describe Thing Registration Task
call: amazon-iot-device-management.describethingregistrationtask
with:
taskId: rest.taskId
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-registration-tasks/{taskid}/cancel
name: thing-registration-tasks-taskid-cancel
description: REST surface for thing-registration-tasks-taskId-cancel.
operations:
- method: PUT
name: stopthingregistrationtask
description: Amazon IoT Device Management Stop Thing Registration Task
call: amazon-iot-device-management.stopthingregistrationtask
with:
taskId: rest.taskId
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-registration-tasks/{taskid}/reports-reporttype
name: thing-registration-tasks-taskid-reports-reporttype
description: REST surface for thing-registration-tasks-taskId-reports#reportType.
operations:
- method: GET
name: listthingregistrationtaskreports
description: Amazon IoT Device Management List Thing Registration Task Reports
call: amazon-iot-device-management.listthingregistrationtaskreports
with:
taskId: rest.taskId
reportType: rest.reportType
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-types
name: thing-types
description: REST surface for thing-types.
operations:
- method: GET
name: listthingtypes
description: Amazon IoT Device Management List Thing Types
call: amazon-iot-device-management.listthingtypes
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
thingTypeName: rest.thingTypeName
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-types/{thingtypename}
name: thing-types-thingtypename
description: REST surface for thing-types-thingTypeName.
operations:
- method: POST
name: createthingtype
description: Amazon IoT Device Management Create Thing Type
call: amazon-iot-device-management.createthingtype
with:
thingTypeName: rest.thingTypeName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletethingtype
description: Amazon IoT Device Management Delete Thing Type
call: amazon-iot-device-management.deletethingtype
with:
thingTypeName: rest.thingTypeName
outputParameters:
- type: object
mapping: $.
- method: GET
name: describethingtype
description: Amazon IoT Device Management Describe Thing Type
call: amazon-iot-device-management.describethingtype
with:
thingTypeName: rest.thingTypeName
outputParameters:
- type: object
mapping: $.
- path: /v1/thing-types/{thingtypename}/deprecate
name: thing-types-thingtypename-deprecate
description: REST surface for thing-types-thingTypeName-deprecate.
operations:
- method: POST
name: deprecatethingtype
description: Amazon IoT Device Management Deprecate Thing Type
call: amazon-iot-device-management.deprecatethingtype
with:
thingTypeName: rest.thingTypeName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/things
name: things
description: REST surface for things.
operations:
- method: GET
name: listthings
description: Amazon IoT Device Management List Things
call: amazon-iot-device-management.listthings
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
attributeName: rest.attributeName
attributeValue: rest.attributeValue
thingTypeName: rest.thingTypeName
usePrefixAttributeValue: rest.usePrefixAttributeValue
outputParameters:
- type: object
mapping: $.
- method: POST
name: registerthing
description: Amazon IoT Device Management Register Thing
call: amazon-iot-device-management.registerthing
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/things/{thingname}
name: things-thingname
description: REST surface for things-thingName.
operations:
- method: POST
name: creatething
description: Amazon IoT Device Management Create Thing
call: amazon-iot-device-management.creatething
with:
thingName: rest.thingName
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletething
description: Amazon IoT Device Management Delete Thing
call: amazon-iot-device-management.deletething
with:
thingName: rest.thingName
expectedVersion: rest.expectedVersion
outputParameters:
- type: object
mapping: $.
- method: GET
name: describething
description: Amazon IoT Device Management Describe Thing
call: amazon-iot-device-management.describething
with:
thingName: rest.thingName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updatething
description: Amazon IoT Device Management Update Thing
call: amazon-iot-device-management.updatething
with:
thingName: rest.thingName
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/things/{thingname}/jobs
name: things-thingname-jobs
description: REST surface for things-thingName-jobs.
operations:
- method: GET
name: listjobexecutionsforthing
description: Amazon IoT Device Management List Job Executions for Thing
call: amazon-iot-device-management.listjobexecutionsforthing
with:
thingName: rest.thingName
status: rest.status
namespaceId: rest.namespaceId
maxResults: rest.maxResults
nextToken: rest.nextToken
jobId: rest.jobId
outputParameters:
- type: object
mapping: $.
- path: /v1/things/{thingname}/jobs/{jobid}
name: things-thingname-jobs-jobid
description: REST surface for things-thingName-jobs-jobId.
operations:
- method: GET
name: describejobexecution
description: Amazon IoT Device Management Describe Job Execution
call: amazon-iot-device-management.describejobexecution
with:
jobId: rest.jobId
thingName: rest.thingName
executionNumber: rest.executionNumber
outputParameters:
- type: object
mapping: $.
- path: /v1/things/{thingname}/jobs/{jobid}/cancel
name: things-thingname-jobs-jobid-cancel
description: REST surface for things-thingName-jobs-jobId-cancel.
operations:
- method: PUT
name: canceljobexecution
description: Amazon IoT Device Management Cancel Job Execution
call: amazon-iot-device-management.canceljobexecution
with:
jobId: rest.jobId
thingName: rest.thingName
force: rest.force
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/things/{thingname}/jobs/{jobid}/executionnumber/{executionnumber}
name: things-thingname-jobs-jobid-executionnumber-executionnumber
description: REST surface for things-thingName-jobs-jobId-executionNumber-executionNumber.
operations:
- method: DELETE
name: deletejobexecution
description: Amazon IoT Device Management Delete Job Execution
call: amazon-iot-device-management.deletejobexecution
with:
jobId: rest.jobId
thingName: rest.thingName
executionNumber: rest.executionNumber
force: rest.force
namespaceId: rest.namespaceId
outputParameters:
- type: object
mapping: $.
- path: /v1/things/{thingname}/principals
name: things-thingname-principals
description: REST surface for things-thingName-principals.
operations:
- method: GET
name: listthingprincipals
description: Amazon IoT Device Management List Thing Principals
call: amazon-iot-device-management.listthingprincipals
with:
nextToken: rest.nextToken
maxResults: rest.maxResults
thingName: rest.thingName
outputParameters:
- type: object
mapping: $.
- path: /v1/things/{thingname}/principals-x-amzn-principal
name: things-thingname-principals-x-amzn-principal
description: REST surface for things-thingName-principals#x-amzn-principal.
operations:
- method: PUT
name: attachthingprincipal
description: Amazon IoT Device Management Attach Thing Principal
call: amazon-iot-device-management.attachthingprincipal
with:
thingName: rest.thingName
x-amzn-principal: rest.x-amzn-principal
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: detachthingprincipal
description: Amazon IoT Device Management Detach Thing Principal
call: amazon-iot-device-management.detachthingprincipal
with:
thingName: rest.thingName
x-amzn-principal: rest.x-amzn-principal
outputParameters:
- type: object
mapping: $.
- path: /v1/things/{thingname}/thing-groups
name: things-thingname-thing-groups
description: REST surface for things-thingName-thing-groups.
operations:
- method: GET
name: listthinggroupsforthing
description: Amazon IoT Device Management List Thing Groups for Thing
call: amazon-iot-device-management.listthinggroupsforthing
with:
thingName: rest.thingName
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/transfer-certificate/certificateid-targetawsaccount
name: transfer-certificate-certificateid-targetawsaccount
description: REST surface for transfer-certificate-certificateId}#targetAwsAccount.
operations:
- method: PATCH
name: transfercertificate
description: Amazon IoT Device Management Transfer Certificate
call: amazon-iot-device-management.transfercertificate
with:
certificateId: rest.certificateId
targetAwsAccount: rest.targetAwsAccount
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/untag
name: untag
description: REST surface for untag.
operations:
- method: POST
name: untagresource
description: Amazon IoT Device Management Untag Resource
call: amazon-iot-device-management.untagresource
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/v2logginglevel
name: v2logginglevel
description: REST surface for v2LoggingLevel.
operations:
- method: GET
name: listv2logginglevels
description: Amazon IoT Device Management List V2 Logging Levels
call: amazon-iot-device-management.listv2logginglevels
with:
targetType: rest.targetType
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- method: POST
name: setv2logginglevel
description: Amazon IoT Device Management Set V2 Logging Level
call: amazon-iot-device-management.setv2logginglevel
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/v2logginglevel-targettype-targetname
name: v2logginglevel-targettype-targetname
description: REST surface for v2LoggingLevel#targetType&targetName.
operations:
- method: DELETE
name: deletev2logginglevel
description: Amazon IoT Device Management Delete V2 Logging Level
call: amazon-iot-device-management.deletev2logginglevel
with:
targetType: rest.targetType
targetName: rest.targetName
outputParameters:
- type: object
mapping: $.
- path: /v1/v2loggingoptions
name: v2loggingoptions
description: REST surface for v2LoggingOptions.
operations:
- method: GET
name: getv2loggingoptions
description: Amazon IoT Device Management Get V2 Logging Options
call: amazon-iot-device-management.getv2loggingoptions
outputParameters:
- type: object
mapping: $.
- method: POST
name: setv2loggingoptions
description: Amazon IoT Device Management Set V2 Logging Options
call: amazon-iot-device-management.setv2loggingoptions
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/violation-events-starttime-endtime
name: violation-events-starttime-endtime
description: REST surface for violation-events#startTime&endTime.
operations:
- method: GET
name: listviolationevents
description: Amazon IoT Device Management List Violation Events
call: amazon-iot-device-management.listviolationevents
with:
startTime: rest.startTime
endTime: rest.endTime
thingName: rest.thingName
securityProfileName: rest.securityProfileName
behaviorCriteriaType: rest.behaviorCriteriaType
listSuppressedAlerts: rest.listSuppressedAlerts
verificationState: rest.verificationState
nextToken: rest.nextToken
maxResults: rest.maxResults
outputParameters:
- type: object
mapping: $.
- path: /v1/violations/verification-state/{violationid}
name: violations-verification-state-violationid
description: REST surface for violations-verification-state-violationId.
operations:
- method: POST
name: putverificationstateonviolation
description: Amazon IoT Device Management Put Verification State on Violation
call: amazon-iot-device-management.putverificationstateonviolation
with:
violationId: rest.violationId
body: rest.body
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: amazon-iot-device-management-mcp
port: 9090
transport: http
description: MCP adapter for AWS IoT. One tool per consumed operation, routed inline through this capability's consumes
block.
tools:
- name: amazon-iot-device-management-accept
description: Amazon IoT Device Management Accept Certificate Transfer
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.acceptcertificatetransfer
with:
certificateId: tools.certificateId
setAsActive: tools.setAsActive
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list
description: Amazon IoT Device Management List Active Violations
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listactiveviolations
with:
thingName: tools.thingName
securityProfileName: tools.securityProfileName
behaviorCriteriaType: tools.behaviorCriteriaType
listSuppressedAlerts: tools.listSuppressedAlerts
verificationState: tools.verificationState
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-2
description: Amazon IoT Device Management List Attached Policies
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.listattachedpolicies
with:
target: tools.target
recursive: tools.recursive
marker: tools.marker
pageSize: tools.pageSize
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete
description: Amazon IoT Device Management Delete Account Audit Configuration
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deleteaccountauditconfiguration
with:
deleteScheduledAudits: tools.deleteScheduledAudits
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe
description: Amazon IoT Device Management Describe Account Audit Configuration
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeaccountauditconfiguration
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update
description: Amazon IoT Device Management Update Account Audit Configuration
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updateaccountauditconfiguration
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-3
description: Amazon IoT Device Management List Audit Findings
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.listauditfindings
with:
maxResults: tools.maxResults
nextToken: tools.nextToken
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-2
description: Amazon IoT Device Management Describe Audit Finding
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeauditfinding
with:
findingId: tools.findingId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-4
description: Amazon IoT Device Management List Audit Mitigation Actions Executions
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listauditmitigationactionsexecutions
with:
taskId: tools.taskId
actionStatus: tools.actionStatus
findingId: tools.findingId
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-5
description: Amazon IoT Device Management List Audit Mitigation Actions Tasks
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listauditmitigationactionstasks
with:
auditTaskId: tools.auditTaskId
findingId: tools.findingId
taskStatus: tools.taskStatus
maxResults: tools.maxResults
nextToken: tools.nextToken
startTime: tools.startTime
endTime: tools.endTime
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-3
description: Amazon IoT Device Management Describe Audit Mitigation Actions Task
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeauditmitigationactionstask
with:
taskId: tools.taskId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-start
description: Amazon IoT Device Management Start Audit Mitigation Actions Task
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.startauditmitigationactionstask
with:
taskId: tools.taskId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-cancel
description: Amazon IoT Device Management Cancel Audit Mitigation Actions Task
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.cancelauditmitigationactionstask
with:
taskId: tools.taskId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-6
description: Amazon IoT Device Management List Related Resources for Audit Finding
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listrelatedresourcesforauditfinding
with:
findingId: tools.findingId
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-7
description: Amazon IoT Device Management List Scheduled Audits
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listscheduledaudits
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create
description: Amazon IoT Device Management Create Scheduled Audit
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createscheduledaudit
with:
scheduledAuditName: tools.scheduledAuditName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-2
description: Amazon IoT Device Management Delete Scheduled Audit
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletescheduledaudit
with:
scheduledAuditName: tools.scheduledAuditName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-4
description: Amazon IoT Device Management Describe Scheduled Audit
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describescheduledaudit
with:
scheduledAuditName: tools.scheduledAuditName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-2
description: Amazon IoT Device Management Update Scheduled Audit
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatescheduledaudit
with:
scheduledAuditName: tools.scheduledAuditName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-2
description: Amazon IoT Device Management Create Audit Suppression
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createauditsuppression
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-3
description: Amazon IoT Device Management Delete Audit Suppression
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.deleteauditsuppression
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-5
description: Amazon IoT Device Management Describe Audit Suppression
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.describeauditsuppression
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-8
description: Amazon IoT Device Management List Audit Suppressions
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.listauditsuppressions
with:
maxResults: tools.maxResults
nextToken: tools.nextToken
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-3
description: Amazon IoT Device Management Update Audit Suppression
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updateauditsuppression
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-start-2
description: Amazon IoT Device Management Start on Demand Audit Task
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.startondemandaudittask
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-9
description: Amazon IoT Device Management List Audit Tasks
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listaudittasks
with:
startTime: tools.startTime
endTime: tools.endTime
taskType: tools.taskType
taskStatus: tools.taskStatus
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-6
description: Amazon IoT Device Management Describe Audit Task
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeaudittask
with:
taskId: tools.taskId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-cancel-2
description: Amazon IoT Device Management Cancel Audit Task
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.cancelaudittask
with:
taskId: tools.taskId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-3
description: Amazon IoT Device Management Create Authorizer
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createauthorizer
with:
authorizerName: tools.authorizerName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-4
description: Amazon IoT Device Management Delete Authorizer
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deleteauthorizer
with:
authorizerName: tools.authorizerName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-7
description: Amazon IoT Device Management Describe Authorizer
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeauthorizer
with:
authorizerName: tools.authorizerName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-4
description: Amazon IoT Device Management Update Authorizer
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updateauthorizer
with:
authorizerName: tools.authorizerName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-test
description: Amazon IoT Device Management Test Invoke Authorizer
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.testinvokeauthorizer
with:
authorizerName: tools.authorizerName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-10
description: Amazon IoT Device Management List Authorizers
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listauthorizers
with:
pageSize: tools.pageSize
marker: tools.marker
isAscendingOrder: tools.isAscendingOrder
status: tools.status
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get
description: Amazon IoT Device Management Get Behavior Model Training Summaries
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.getbehaviormodeltrainingsummaries
with:
securityProfileName: tools.securityProfileName
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-11
description: Amazon IoT Device Management List Billing Groups
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listbillinggroups
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
namePrefixFilter: tools.namePrefixFilter
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-add
description: Amazon IoT Device Management Add Thing to Billing Group
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.addthingtobillinggroup
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-remove
description: Amazon IoT Device Management Remove Thing from Billing Group
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.removethingfrombillinggroup
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-4
description: Amazon IoT Device Management Create Billing Group
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createbillinggroup
with:
billingGroupName: tools.billingGroupName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-5
description: Amazon IoT Device Management Delete Billing Group
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletebillinggroup
with:
billingGroupName: tools.billingGroupName
expectedVersion: tools.expectedVersion
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-8
description: Amazon IoT Device Management Describe Billing Group
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describebillinggroup
with:
billingGroupName: tools.billingGroupName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-5
description: Amazon IoT Device Management Update Billing Group
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatebillinggroup
with:
billingGroupName: tools.billingGroupName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-12
description: Amazon IoT Device Management List Things in Billing Group
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listthingsinbillinggroup
with:
billingGroupName: tools.billingGroupName
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-register
description: Amazon IoT Device Management Register C a Certificate
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.registercacertificate
with:
setAsActive: tools.setAsActive
allowAutoRegistration: tools.allowAutoRegistration
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-6
description: Amazon IoT Device Management Delete C a Certificate
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletecacertificate
with:
caCertificateId: tools.caCertificateId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-9
description: Amazon IoT Device Management Describe C a Certificate
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describecacertificate
with:
caCertificateId: tools.caCertificateId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-6
description: Amazon IoT Device Management Update C a Certificate
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatecacertificate
with:
caCertificateId: tools.caCertificateId
newStatus: tools.newStatus
newAutoRegistrationStatus: tools.newAutoRegistrationStatus
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-13
description: Amazon IoT Device Management List C a Certificates
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listcacertificates
with:
pageSize: tools.pageSize
marker: tools.marker
isAscendingOrder: tools.isAscendingOrder
templateName: tools.templateName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-cancel-3
description: Amazon IoT Device Management Cancel Certificate Transfer
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.cancelcertificatetransfer
with:
certificateId: tools.certificateId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-register-2
description: Amazon IoT Device Management Register Certificate
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.registercertificate
with:
setAsActive: tools.setAsActive
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-register-3
description: Amazon IoT Device Management Register Certificate Without C a
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.registercertificatewithoutca
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-5
description: Amazon IoT Device Management Create Certificate from Csr
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createcertificatefromcsr
with:
setAsActive: tools.setAsActive
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-14
description: Amazon IoT Device Management List Certificates
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listcertificates
with:
pageSize: tools.pageSize
marker: tools.marker
isAscendingOrder: tools.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-15
description: Amazon IoT Device Management List Certificates by C a
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listcertificatesbyca
with:
caCertificateId: tools.caCertificateId
pageSize: tools.pageSize
marker: tools.marker
isAscendingOrder: tools.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-16
description: Amazon IoT Device Management List Outgoing Certificates
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listoutgoingcertificates
with:
pageSize: tools.pageSize
marker: tools.marker
isAscendingOrder: tools.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-7
description: Amazon IoT Device Management Delete Certificate
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletecertificate
with:
certificateId: tools.certificateId
forceDelete: tools.forceDelete
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-10
description: Amazon IoT Device Management Describe Certificate
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describecertificate
with:
certificateId: tools.certificateId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-7
description: Amazon IoT Device Management Update Certificate
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatecertificate
with:
certificateId: tools.certificateId
newStatus: tools.newStatus
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-confirm
description: Amazon IoT Device Management Confirm Topic Rule Destination
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.confirmtopicruledestination
with:
confirmationToken: tools.confirmationToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-6
description: Amazon IoT Device Management Create Custom Metric
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createcustommetric
with:
metricName: tools.metricName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-8
description: Amazon IoT Device Management Delete Custom Metric
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletecustommetric
with:
metricName: tools.metricName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-11
description: Amazon IoT Device Management Describe Custom Metric
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describecustommetric
with:
metricName: tools.metricName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-8
description: Amazon IoT Device Management Update Custom Metric
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatecustommetric
with:
metricName: tools.metricName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-17
description: Amazon IoT Device Management List Custom Metrics
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listcustommetrics
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-clear
description: Amazon IoT Device Management Clear Default Authorizer
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.cleardefaultauthorizer
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-12
description: Amazon IoT Device Management Describe Default Authorizer
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describedefaultauthorizer
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-set
description: Amazon IoT Device Management Set Default Authorizer
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.setdefaultauthorizer
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-7
description: Amazon IoT Device Management Create Topic Rule Destination
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createtopicruledestination
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-18
description: Amazon IoT Device Management List Topic Rule Destinations
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listtopicruledestinations
with:
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-9
description: Amazon IoT Device Management Update Topic Rule Destination
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatetopicruledestination
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-9
description: Amazon IoT Device Management Delete Topic Rule Destination
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletetopicruledestination
with:
arn: tools.arn
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-2
description: Amazon IoT Device Management Get Topic Rule Destination
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.gettopicruledestination
with:
arn: tools.arn
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-19
description: Amazon IoT Device Management List Detect Mitigation Actions Executions
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listdetectmitigationactionsexecutions
with:
taskId: tools.taskId
violationId: tools.violationId
thingName: tools.thingName
startTime: tools.startTime
endTime: tools.endTime
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-20
description: Amazon IoT Device Management List Detect Mitigation Actions Tasks
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listdetectmitigationactionstasks
with:
maxResults: tools.maxResults
nextToken: tools.nextToken
startTime: tools.startTime
endTime: tools.endTime
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-13
description: Amazon IoT Device Management Describe Detect Mitigation Actions Task
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describedetectmitigationactionstask
with:
taskId: tools.taskId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-start-3
description: Amazon IoT Device Management Start Detect Mitigation Actions Task
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.startdetectmitigationactionstask
with:
taskId: tools.taskId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-cancel-4
description: Amazon IoT Device Management Cancel Detect Mitigation Actions Task
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.canceldetectmitigationactionstask
with:
taskId: tools.taskId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-21
description: Amazon IoT Device Management List Dimensions
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listdimensions
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-8
description: Amazon IoT Device Management Create Dimension
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createdimension
with:
name: tools.name
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-10
description: Amazon IoT Device Management Delete Dimension
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletedimension
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-14
description: Amazon IoT Device Management Describe Dimension
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describedimension
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-10
description: Amazon IoT Device Management Update Dimension
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatedimension
with:
name: tools.name
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-22
description: Amazon IoT Device Management List Domain Configurations
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listdomainconfigurations
with:
marker: tools.marker
pageSize: tools.pageSize
serviceType: tools.serviceType
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-9
description: Amazon IoT Device Management Create Domain Configuration
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createdomainconfiguration
with:
domainConfigurationName: tools.domainConfigurationName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-11
description: Amazon IoT Device Management Delete Domain Configuration
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletedomainconfiguration
with:
domainConfigurationName: tools.domainConfigurationName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-15
description: Amazon IoT Device Management Describe Domain Configuration
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describedomainconfiguration
with:
domainConfigurationName: tools.domainConfigurationName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-11
description: Amazon IoT Device Management Update Domain Configuration
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatedomainconfiguration
with:
domainConfigurationName: tools.domainConfigurationName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-10
description: Amazon IoT Device Management Create Dynamic Thing Group
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createdynamicthinggroup
with:
thingGroupName: tools.thingGroupName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-12
description: Amazon IoT Device Management Delete Dynamic Thing Group
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletedynamicthinggroup
with:
thingGroupName: tools.thingGroupName
expectedVersion: tools.expectedVersion
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-12
description: Amazon IoT Device Management Update Dynamic Thing Group
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatedynamicthinggroup
with:
thingGroupName: tools.thingGroupName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-3
description: Amazon IoT Device Management Get Effective Policies
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.geteffectivepolicies
with:
thingName: tools.thingName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-16
description: Amazon IoT Device Management Describe Endpoint
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeendpoint
with:
endpointType: tools.endpointType
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-17
description: Amazon IoT Device Management Describe Event Configurations
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeeventconfigurations
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-13
description: Amazon IoT Device Management Update Event Configurations
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updateeventconfigurations
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-11
description: Amazon IoT Device Management Create Fleet Metric
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.createfleetmetric
with:
metricName: tools.metricName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-13
description: Amazon IoT Device Management Delete Fleet Metric
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletefleetmetric
with:
metricName: tools.metricName
expectedVersion: tools.expectedVersion
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-18
description: Amazon IoT Device Management Describe Fleet Metric
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describefleetmetric
with:
metricName: tools.metricName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-14
description: Amazon IoT Device Management Update Fleet Metric
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatefleetmetric
with:
metricName: tools.metricName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-23
description: Amazon IoT Device Management List Fleet Metrics
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listfleetmetrics
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-4
description: Amazon IoT Device Management Get Indexing Configuration
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.getindexingconfiguration
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-15
description: Amazon IoT Device Management Update Indexing Configuration
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.updateindexingconfiguration
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-24
description: Amazon IoT Device Management List Indices
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listindices
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-5
description: Amazon IoT Device Management Get Buckets Aggregation
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.getbucketsaggregation
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-6
description: Amazon IoT Device Management Get Cardinality
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.getcardinality
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-7
description: Amazon IoT Device Management Get Percentiles
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.getpercentiles
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-search
description: Amazon IoT Device Management Search Index
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.searchindex
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-8
description: Amazon IoT Device Management Get Statistics
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.getstatistics
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-19
description: Amazon IoT Device Management Describe Index
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeindex
with:
indexName: tools.indexName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-25
description: Amazon IoT Device Management List Job Templates
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listjobtemplates
with:
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-12
description: Amazon IoT Device Management Create Job Template
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.createjobtemplate
with:
jobTemplateId: tools.jobTemplateId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-14
description: Amazon IoT Device Management Delete Job Template
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletejobtemplate
with:
jobTemplateId: tools.jobTemplateId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-20
description: Amazon IoT Device Management Describe Job Template
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describejobtemplate
with:
jobTemplateId: tools.jobTemplateId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-26
description: Amazon IoT Device Management List Jobs
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listjobs
with:
status: tools.status
targetSelection: tools.targetSelection
maxResults: tools.maxResults
nextToken: tools.nextToken
thingGroupName: tools.thingGroupName
thingGroupId: tools.thingGroupId
namespaceId: tools.namespaceId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-13
description: Amazon IoT Device Management Create Job
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.createjob
with:
jobId: tools.jobId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-15
description: Amazon IoT Device Management Delete Job
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletejob
with:
jobId: tools.jobId
force: tools.force
namespaceId: tools.namespaceId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-21
description: Amazon IoT Device Management Describe Job
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describejob
with:
jobId: tools.jobId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-16
description: Amazon IoT Device Management Update Job
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatejob
with:
jobId: tools.jobId
namespaceId: tools.namespaceId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-cancel-5
description: Amazon IoT Device Management Cancel Job
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.canceljob
with:
jobId: tools.jobId
force: tools.force
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-9
description: Amazon IoT Device Management Get Job Document
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.getjobdocument
with:
jobId: tools.jobId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-associate
description: Amazon IoT Device Management Associate Targets with Job
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.associatetargetswithjob
with:
jobId: tools.jobId
namespaceId: tools.namespaceId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-27
description: Amazon IoT Device Management List Job Executions for Job
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listjobexecutionsforjob
with:
jobId: tools.jobId
status: tools.status
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-14
description: Amazon IoT Device Management Create Keys and Certificate
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createkeysandcertificate
with:
setAsActive: tools.setAsActive
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-10
description: Amazon IoT Device Management Get Logging Options
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.getloggingoptions
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-set-2
description: Amazon IoT Device Management Set Logging Options
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.setloggingoptions
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-28
description: Amazon IoT Device Management List Managed Job Templates
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listmanagedjobtemplates
with:
templateName: tools.templateName
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-22
description: Amazon IoT Device Management Describe Managed Job Template
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describemanagedjobtemplate
with:
templateName: tools.templateName
templateVersion: tools.templateVersion
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-29
description: Amazon IoT Device Management List Metric Values
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listmetricvalues
with:
thingName: tools.thingName
metricName: tools.metricName
dimensionName: tools.dimensionName
dimensionValueOperator: tools.dimensionValueOperator
startTime: tools.startTime
endTime: tools.endTime
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-30
description: Amazon IoT Device Management List Mitigation Actions
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listmitigationactions
with:
actionType: tools.actionType
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-15
description: Amazon IoT Device Management Create Mitigation Action
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createmitigationaction
with:
actionName: tools.actionName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-16
description: Amazon IoT Device Management Delete Mitigation Action
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletemitigationaction
with:
actionName: tools.actionName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-23
description: Amazon IoT Device Management Describe Mitigation Action
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describemitigationaction
with:
actionName: tools.actionName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-17
description: Amazon IoT Device Management Update Mitigation Action
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatemitigationaction
with:
actionName: tools.actionName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-31
description: Amazon IoT Device Management List O T a Updates
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listotaupdates
with:
maxResults: tools.maxResults
nextToken: tools.nextToken
otaUpdateStatus: tools.otaUpdateStatus
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-16
description: Amazon IoT Device Management Create O T a Update
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createotaupdate
with:
otaUpdateId: tools.otaUpdateId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-17
description: Amazon IoT Device Management Delete O T a Update
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deleteotaupdate
with:
otaUpdateId: tools.otaUpdateId
deleteStream: tools.deleteStream
forceDeleteAWSJob: tools.forceDeleteAWSJob
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-11
description: Amazon IoT Device Management Get O T a Update
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.getotaupdate
with:
otaUpdateId: tools.otaUpdateId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-32
description: Amazon IoT Device Management List Policies
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listpolicies
with:
marker: tools.marker
pageSize: tools.pageSize
isAscendingOrder: tools.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-17
description: Amazon IoT Device Management Create Policy
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createpolicy
with:
policyName: tools.policyName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-18
description: Amazon IoT Device Management Delete Policy
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletepolicy
with:
policyName: tools.policyName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-12
description: Amazon IoT Device Management Get Policy
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.getpolicy
with:
policyName: tools.policyName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-18
description: Amazon IoT Device Management Create Policy Version
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createpolicyversion
with:
policyName: tools.policyName
setAsDefault: tools.setAsDefault
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-33
description: Amazon IoT Device Management List Policy Versions
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listpolicyversions
with:
policyName: tools.policyName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-19
description: Amazon IoT Device Management Delete Policy Version
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletepolicyversion
with:
policyName: tools.policyName
policyVersionId: tools.policyVersionId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-13
description: Amazon IoT Device Management Get Policy Version
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.getpolicyversion
with:
policyName: tools.policyName
policyVersionId: tools.policyVersionId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-set-3
description: Amazon IoT Device Management Set Default Policy Version
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.setdefaultpolicyversion
with:
policyName: tools.policyName
policyVersionId: tools.policyVersionId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-34
description: Amazon IoT Device Management List Policy Principals
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listpolicyprincipals
with:
x-amzn-iot-policy: tools.x-amzn-iot-policy
marker: tools.marker
pageSize: tools.pageSize
isAscendingOrder: tools.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-35
description: Amazon IoT Device Management List Targets for Policy
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.listtargetsforpolicy
with:
policyName: tools.policyName
marker: tools.marker
pageSize: tools.pageSize
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-36
description: Amazon IoT Device Management List Principal Policies
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listprincipalpolicies
with:
x-amzn-iot-principal: tools.x-amzn-iot-principal
marker: tools.marker
pageSize: tools.pageSize
isAscendingOrder: tools.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-attach
description: Amazon IoT Device Management Attach Principal Policy
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.attachprincipalpolicy
with:
policyName: tools.policyName
x-amzn-iot-principal: tools.x-amzn-iot-principal
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-detach
description: Amazon IoT Device Management Detach Principal Policy
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.detachprincipalpolicy
with:
policyName: tools.policyName
x-amzn-iot-principal: tools.x-amzn-iot-principal
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-37
description: Amazon IoT Device Management List Principal Things
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listprincipalthings
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
x-amzn-principal: tools.x-amzn-principal
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-19
description: Amazon IoT Device Management Create Provisioning Template
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createprovisioningtemplate
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-38
description: Amazon IoT Device Management List Provisioning Templates
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listprovisioningtemplates
with:
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-20
description: Amazon IoT Device Management Delete Provisioning Template
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deleteprovisioningtemplate
with:
templateName: tools.templateName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-24
description: Amazon IoT Device Management Describe Provisioning Template
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeprovisioningtemplate
with:
templateName: tools.templateName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-18
description: Amazon IoT Device Management Update Provisioning Template
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updateprovisioningtemplate
with:
templateName: tools.templateName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-20
description: Amazon IoT Device Management Create Provisioning Claim
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createprovisioningclaim
with:
templateName: tools.templateName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-21
description: Amazon IoT Device Management Create Provisioning Template Version
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createprovisioningtemplateversion
with:
templateName: tools.templateName
setAsDefault: tools.setAsDefault
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-39
description: Amazon IoT Device Management List Provisioning Template Versions
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listprovisioningtemplateversions
with:
templateName: tools.templateName
maxResults: tools.maxResults
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-21
description: Amazon IoT Device Management Delete Provisioning Template Version
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deleteprovisioningtemplateversion
with:
templateName: tools.templateName
versionId: tools.versionId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-25
description: Amazon IoT Device Management Describe Provisioning Template Version
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describeprovisioningtemplateversion
with:
templateName: tools.templateName
versionId: tools.versionId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-22
description: Amazon IoT Device Management Delete Registration Code
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deleteregistrationcode
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-14
description: Amazon IoT Device Management Get Registration Code
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.getregistrationcode
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-reject
description: Amazon IoT Device Management Reject Certificate Transfer
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.rejectcertificatetransfer
with:
certificateId: tools.certificateId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-40
description: Amazon IoT Device Management List Role Aliases
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listrolealiases
with:
pageSize: tools.pageSize
marker: tools.marker
isAscendingOrder: tools.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-22
description: Amazon IoT Device Management Create Role Alias
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createrolealias
with:
roleAlias: tools.roleAlias
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-23
description: Amazon IoT Device Management Delete Role Alias
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deleterolealias
with:
roleAlias: tools.roleAlias
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-26
description: Amazon IoT Device Management Describe Role Alias
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describerolealias
with:
roleAlias: tools.roleAlias
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-19
description: Amazon IoT Device Management Update Role Alias
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updaterolealias
with:
roleAlias: tools.roleAlias
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-41
description: Amazon IoT Device Management List Topic Rules
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listtopicrules
with:
topic: tools.topic
maxResults: tools.maxResults
nextToken: tools.nextToken
ruleDisabled: tools.ruleDisabled
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-23
description: Amazon IoT Device Management Create Topic Rule
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createtopicrule
with:
ruleName: tools.ruleName
x-amz-tagging: tools.x-amz-tagging
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-24
description: Amazon IoT Device Management Delete Topic Rule
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletetopicrule
with:
ruleName: tools.ruleName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-15
description: Amazon IoT Device Management Get Topic Rule
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.gettopicrule
with:
ruleName: tools.ruleName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-replace
description: Amazon IoT Device Management Replace Topic Rule
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.replacetopicrule
with:
ruleName: tools.ruleName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-disable
description: Amazon IoT Device Management Disable Topic Rule
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.disabletopicrule
with:
ruleName: tools.ruleName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-enable
description: Amazon IoT Device Management Enable Topic Rule
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.enabletopicrule
with:
ruleName: tools.ruleName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-validate
description: Amazon IoT Device Management Validate Security Profile Behaviors
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.validatesecurityprofilebehaviors
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-42
description: Amazon IoT Device Management List Security Profiles
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listsecurityprofiles
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
dimensionName: tools.dimensionName
metricName: tools.metricName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-43
description: Amazon IoT Device Management List Security Profiles for Target
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listsecurityprofilesfortarget
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
recursive: tools.recursive
securityProfileTargetArn: tools.securityProfileTargetArn
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-24
description: Amazon IoT Device Management Create Security Profile
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createsecurityprofile
with:
securityProfileName: tools.securityProfileName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-25
description: Amazon IoT Device Management Delete Security Profile
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletesecurityprofile
with:
securityProfileName: tools.securityProfileName
expectedVersion: tools.expectedVersion
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-27
description: Amazon IoT Device Management Describe Security Profile
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describesecurityprofile
with:
securityProfileName: tools.securityProfileName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-20
description: Amazon IoT Device Management Update Security Profile
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatesecurityprofile
with:
securityProfileName: tools.securityProfileName
expectedVersion: tools.expectedVersion
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-44
description: Amazon IoT Device Management List Targets for Security Profile
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listtargetsforsecurityprofile
with:
securityProfileName: tools.securityProfileName
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-attach-2
description: Amazon IoT Device Management Attach Security Profile
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.attachsecurityprofile
with:
securityProfileName: tools.securityProfileName
securityProfileTargetArn: tools.securityProfileTargetArn
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-detach-2
description: Amazon IoT Device Management Detach Security Profile
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.detachsecurityprofile
with:
securityProfileName: tools.securityProfileName
securityProfileTargetArn: tools.securityProfileTargetArn
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-45
description: Amazon IoT Device Management List Streams
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.liststreams
with:
maxResults: tools.maxResults
nextToken: tools.nextToken
isAscendingOrder: tools.isAscendingOrder
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-25
description: Amazon IoT Device Management Create Stream
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createstream
with:
streamId: tools.streamId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-26
description: Amazon IoT Device Management Delete Stream
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletestream
with:
streamId: tools.streamId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-28
description: Amazon IoT Device Management Describe Stream
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describestream
with:
streamId: tools.streamId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-21
description: Amazon IoT Device Management Update Stream
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatestream
with:
streamId: tools.streamId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-tag
description: Amazon IoT Device Management Tag Resource
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.tagresource
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-46
description: Amazon IoT Device Management List Tags for Resource
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listtagsforresource
with:
resourceArn: tools.resourceArn
nextToken: tools.nextToken
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-attach-3
description: Amazon IoT Device Management Attach Policy
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.attachpolicy
with:
policyName: tools.policyName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-detach-3
description: Amazon IoT Device Management Detach Policy
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.detachpolicy
with:
policyName: tools.policyName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-test-2
description: Amazon IoT Device Management Test Authorization
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-iot-device-management.testauthorization
with:
clientId: tools.clientId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-47
description: Amazon IoT Device Management List Thing Groups
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listthinggroups
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
parentGroup: tools.parentGroup
namePrefixFilter: tools.namePrefixFilter
recursive: tools.recursive
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-add-2
description: Amazon IoT Device Management Add Thing to Thing Group
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.addthingtothinggroup
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-remove-2
description: Amazon IoT Device Management Remove Thing from Thing Group
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.removethingfromthinggroup
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-22
description: Amazon IoT Device Management Update Thing Groups for Thing
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatethinggroupsforthing
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-26
description: Amazon IoT Device Management Create Thing Group
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createthinggroup
with:
thingGroupName: tools.thingGroupName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-27
description: Amazon IoT Device Management Delete Thing Group
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletethinggroup
with:
thingGroupName: tools.thingGroupName
expectedVersion: tools.expectedVersion
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-29
description: Amazon IoT Device Management Describe Thing Group
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describethinggroup
with:
thingGroupName: tools.thingGroupName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-23
description: Amazon IoT Device Management Update Thing Group
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatethinggroup
with:
thingGroupName: tools.thingGroupName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-48
description: Amazon IoT Device Management List Things in Thing Group
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listthingsinthinggroup
with:
thingGroupName: tools.thingGroupName
recursive: tools.recursive
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-49
description: Amazon IoT Device Management List Thing Registration Tasks
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listthingregistrationtasks
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
status: tools.status
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-start-4
description: Amazon IoT Device Management Start Thing Registration Task
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.startthingregistrationtask
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-30
description: Amazon IoT Device Management Describe Thing Registration Task
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describethingregistrationtask
with:
taskId: tools.taskId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-stop
description: Amazon IoT Device Management Stop Thing Registration Task
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.stopthingregistrationtask
with:
taskId: tools.taskId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-50
description: Amazon IoT Device Management List Thing Registration Task Reports
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listthingregistrationtaskreports
with:
taskId: tools.taskId
reportType: tools.reportType
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-51
description: Amazon IoT Device Management List Thing Types
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listthingtypes
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
thingTypeName: tools.thingTypeName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-27
description: Amazon IoT Device Management Create Thing Type
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.createthingtype
with:
thingTypeName: tools.thingTypeName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-28
description: Amazon IoT Device Management Delete Thing Type
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletethingtype
with:
thingTypeName: tools.thingTypeName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-31
description: Amazon IoT Device Management Describe Thing Type
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describethingtype
with:
thingTypeName: tools.thingTypeName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-deprecate
description: Amazon IoT Device Management Deprecate Thing Type
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.deprecatethingtype
with:
thingTypeName: tools.thingTypeName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-52
description: Amazon IoT Device Management List Things
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listthings
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
attributeName: tools.attributeName
attributeValue: tools.attributeValue
thingTypeName: tools.thingTypeName
usePrefixAttributeValue: tools.usePrefixAttributeValue
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-register-4
description: Amazon IoT Device Management Register Thing
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.registerthing
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-create-28
description: Amazon IoT Device Management Create Thing
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.creatething
with:
thingName: tools.thingName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-29
description: Amazon IoT Device Management Delete Thing
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletething
with:
thingName: tools.thingName
expectedVersion: tools.expectedVersion
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-32
description: Amazon IoT Device Management Describe Thing
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describething
with:
thingName: tools.thingName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-update-24
description: Amazon IoT Device Management Update Thing
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.updatething
with:
thingName: tools.thingName
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-53
description: Amazon IoT Device Management List Job Executions for Thing
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listjobexecutionsforthing
with:
thingName: tools.thingName
status: tools.status
namespaceId: tools.namespaceId
maxResults: tools.maxResults
nextToken: tools.nextToken
jobId: tools.jobId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-describe-33
description: Amazon IoT Device Management Describe Job Execution
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.describejobexecution
with:
jobId: tools.jobId
thingName: tools.thingName
executionNumber: tools.executionNumber
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-cancel-6
description: Amazon IoT Device Management Cancel Job Execution
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.canceljobexecution
with:
jobId: tools.jobId
thingName: tools.thingName
force: tools.force
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-30
description: Amazon IoT Device Management Delete Job Execution
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletejobexecution
with:
jobId: tools.jobId
thingName: tools.thingName
executionNumber: tools.executionNumber
force: tools.force
namespaceId: tools.namespaceId
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-54
description: Amazon IoT Device Management List Thing Principals
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listthingprincipals
with:
nextToken: tools.nextToken
maxResults: tools.maxResults
thingName: tools.thingName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-attach-4
description: Amazon IoT Device Management Attach Thing Principal
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.attachthingprincipal
with:
thingName: tools.thingName
x-amzn-principal: tools.x-amzn-principal
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-detach-4
description: Amazon IoT Device Management Detach Thing Principal
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.detachthingprincipal
with:
thingName: tools.thingName
x-amzn-principal: tools.x-amzn-principal
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-55
description: Amazon IoT Device Management List Thing Groups for Thing
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listthinggroupsforthing
with:
thingName: tools.thingName
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-transfer
description: Amazon IoT Device Management Transfer Certificate
hints:
readOnly: false
destructive: false
idempotent: true
call: amazon-iot-device-management.transfercertificate
with:
certificateId: tools.certificateId
targetAwsAccount: tools.targetAwsAccount
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-untag
description: Amazon IoT Device Management Untag Resource
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.untagresource
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-56
description: Amazon IoT Device Management List V2 Logging Levels
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listv2logginglevels
with:
targetType: tools.targetType
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-set-4
description: Amazon IoT Device Management Set V2 Logging Level
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.setv2logginglevel
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-delete-31
description: Amazon IoT Device Management Delete V2 Logging Level
hints:
readOnly: false
destructive: true
idempotent: true
call: amazon-iot-device-management.deletev2logginglevel
with:
targetType: tools.targetType
targetName: tools.targetName
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-get-16
description: Amazon IoT Device Management Get V2 Logging Options
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.getv2loggingoptions
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-set-5
description: Amazon IoT Device Management Set V2 Logging Options
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.setv2loggingoptions
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-list-57
description: Amazon IoT Device Management List Violation Events
hints:
readOnly: true
destructive: false
idempotent: true
call: amazon-iot-device-management.listviolationevents
with:
startTime: tools.startTime
endTime: tools.endTime
thingName: tools.thingName
securityProfileName: tools.securityProfileName
behaviorCriteriaType: tools.behaviorCriteriaType
listSuppressedAlerts: tools.listSuppressedAlerts
verificationState: tools.verificationState
nextToken: tools.nextToken
maxResults: tools.maxResults
outputParameters:
- type: object
mapping: $.
- name: amazon-iot-device-management-put
description: Amazon IoT Device Management Put Verification State on Violation
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-iot-device-management.putverificationstateonviolation
with:
violationId: tools.violationId
body: tools.body
outputParameters:
- type: object
mapping: $.