openapi: 3.0.0
info:
version: 2015-05-28
x-release: v4
title: AWS IoT
description: '
IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.
The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.
For more information about how IoT works, see the Developer Guide.
For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.
' x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: "#FFFFFF" termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: iot x-aws-signingName: iot x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-2015-05-28.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/iot/ servers: - url: http://iot.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS IoT multi-region endpoint - url: https://iot.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS IoT multi-region endpoint - url: http://iot.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT endpoint for China (Beijing) and China (Ningxia) - url: https://iot.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: "/accept-certificate-transfer/{certificateId}": patch: operationId: AcceptCertificateTransfer description:Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
Requires permission to access the AcceptCertificateTransfer action.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: TransferAlreadyCompletedException content: application/json: schema: $ref: "#/components/schemas/TransferAlreadyCompletedException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: certificateId in: path required: true description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 - name: setAsActive in: query required: false description: Specifies whether the certificate is active. schema: type: boolean summary: Amazon IoT Device Management Accept Certificate Transfer x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /billing-groups/addThingToBillingGroup: put: operationId: AddThingToBillingGroup description:Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AddThingToBillingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: [] requestBody: required: true content: application/json: schema: type: object properties: billingGroupName: description:The name of the billing group.
This call is asynchronous. It might take several seconds for the detachment to propagate.
Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AddThingToThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: [] requestBody: required: true content: application/json: schema: type: object properties: thingGroupName: description: The name of the group to which you are adding a thing. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 thingGroupArn: description: The ARN of the group to which you are adding a thing. type: string thingName: description: The name of the thing to add to a group. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 thingArn: description: The ARN of the thing to add to a group. type: string overrideDynamicGroups: description: Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group. type: boolean summary: Amazon IoT Device Management Add Thing to Thing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/jobs/{jobId}/targets": post: operationId: AssociateTargetsWithJob description: 'Associates a group with a continuous job. The following criteria must be met:
The job must have been created with the targetSelection field set to "CONTINUOUS".
The job status must currently be "IN_PROGRESS".
The total number of targets associated with a job must not exceed 100.
Requires permission to access the AssociateTargetsWithJob action.
' responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AssociateTargetsWithJobResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: jobId in: path required: true description: The unique identifier you assigned to this job when it was created. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 - name: namespaceId in: query required: false description:The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The
namespaceId feature is in public preview.
Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: policyName in: path required: true description: The name of the policy to attach. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - target properties: target: description: The identity to which the policy is attached. For example, a thing group or a certificate. type: string summary: Amazon IoT Device Management Attach Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: operationId: DetachPolicy description:Detaches a policy from the specified target.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.
Requires permission to access the DetachPolicy action.
responses: "200": description: Success "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: policyName in: path required: true description: The policy to detach. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - target properties: target: description: The target from which the policy will be detached. type: string summary: Amazon IoT Device Management Detach Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK "/principal-policies/{policyName}#x-amzn-iot-principal": put: deprecated: true operationId: AttachPrincipalPolicy description:Attaches the specified policy to the specified principal (certificate or other credential).
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.
Requires permission to access the AttachPrincipalPolicy action.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: policyName in: path required: true description: The policy name. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: x-amzn-iot-principal in: header required: true description: The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID. schema: type: string summary: Amazon IoT Device Management Attach Principal Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" delete: deprecated: true operationId: DetachPrincipalPolicy description:Removes the specified policy from the specified certificate.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.
Requires permission to access the DetachPrincipalPolicy action.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: policyName in: path required: true description: The name of the policy to detach. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: x-amzn-iot-principal in: header required: true description:The principal.
Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
schema: type: string summary: Amazon IoT Device Management Detach Principal Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK "/security-profiles/{securityProfileName}/targets#securityProfileTargetArn": put: operationId: AttachSecurityProfile description:Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
Requires permission to access the AttachSecurityProfile action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AttachSecurityProfileResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: securityProfileName in: path required: true description: The security profile that is attached. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: securityProfileTargetArn in: query required: true description: The ARN of the target (thing group) to which the security profile is attached. schema: type: string summary: Amazon IoT Device Management Attach Security Profile x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" delete: operationId: DetachSecurityProfile description:Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DetachSecurityProfileResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: securityProfileName in: path required: true description: The security profile that is detached. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: securityProfileTargetArn in: query required: true description: The ARN of the thing group from which the security profile is detached. schema: type: string summary: Amazon IoT Device Management Detach Security Profile x-microcks-operation: delay: 0 dispatcher: FALLBACK "/things/{thingName}/principals#x-amzn-principal": put: operationId: AttachThingPrincipal description:Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities.
Requires permission to access the AttachThingPrincipal action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AttachThingPrincipalResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingName in: path required: true description: The name of the thing. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: x-amzn-principal in: header required: true description: The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID. schema: type: string summary: Amazon IoT Device Management Attach Thing Principal x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" delete: operationId: DetachThingPrincipal description:Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This call is asynchronous. It might take several seconds for the detachment to propagate.
Requires permission to access the DetachThingPrincipal action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DetachThingPrincipalResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingName in: path required: true description: The name of the thing. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: x-amzn-principal in: header required: true 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 Amazon Cognito identity. schema: type: string summary: Amazon IoT Device Management Detach Thing Principal x-microcks-operation: delay: 0 dispatcher: FALLBACK "/audit/mitigationactions/tasks/{taskId}/cancel": put: operationId: CancelAuditMitigationActionsTask description:Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
Requires permission to access the CancelAuditMitigationActionsTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CancelAuditMitigationActionsTaskResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: path required: true description: "The unique identifier for the task that you want to cancel. " schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Cancel Audit Mitigation Actions Task x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/audit/tasks/{taskId}/cancel": put: operationId: CancelAuditTask description:Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.
Requires permission to access the CancelAuditTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CancelAuditTaskResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: path required: true description: The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS". schema: type: string pattern: "[a-zA-Z0-9\\-]+" minLength: 1 maxLength: 40 summary: Amazon IoT Device Management Cancel Audit Task x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/cancel-certificate-transfer/{certificateId}": patch: operationId: CancelCertificateTransfer description:Cancels a pending transfer for the specified certificate.
Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
Requires permission to access the CancelCertificateTransfer action.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: TransferAlreadyCompletedException content: application/json: schema: $ref: "#/components/schemas/TransferAlreadyCompletedException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: certificateId in: path required: true description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 summary: Amazon IoT Device Management Cancel Certificate Transfer x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/detect/mitigationactions/tasks/{taskId}/cancel": put: operationId: CancelDetectMitigationActionsTask description:Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CancelDetectMitigationActionsTaskResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: path required: true description: " The unique identifier of the task. " schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Cancel Detect Mitigation Actions Task x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/jobs/{jobId}/cancel": put: operationId: CancelJob description:Cancels a job.
Requires permission to access the CancelJob action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CancelJobResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: jobId in: path required: true description: The unique identifier you assigned to this job when it was created. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 - name: force in: query required: false description:(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default
is false.
Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.
schema: type: boolean requestBody: required: true content: application/json: schema: type: object properties: reasonCode: description: (Optional)A reason code string that explains why the job was canceled. type: string pattern: "[\\p{Upper}\\p{Digit}_]+" maxLength: 128 comment: description: An optional comment string describing why the job was canceled. type: string pattern: "[^\\p{C}]+" maxLength: 2028 summary: Amazon IoT Device Management Cancel Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/things/{thingName}/jobs/{jobId}/cancel": put: operationId: CancelJobExecution description:Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
responses: "200": description: Success "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InvalidStateTransitionException content: application/json: schema: $ref: "#/components/schemas/InvalidStateTransitionException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" parameters: - name: jobId in: path required: true description: The ID of the job to be canceled. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 - name: thingName in: path required: true description: The name of the thing whose execution of the job will be canceled. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: force in: query required: false description:(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status
QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be
thrown. The default is false.
Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
schema: type: boolean requestBody: required: true content: application/json: schema: type: object properties: expectedVersion: description: (Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.) type: integer statusDetails: description: A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs. type: object additionalProperties: $ref: "#/components/schemas/DetailsValue" summary: Amazon IoT Device Management Cancel Job Execution x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /default-authorizer: delete: operationId: ClearDefaultAuthorizer description:Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ClearDefaultAuthorizerResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] summary: Amazon IoT Device Management Clear Default Authorizer x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeDefaultAuthorizer description:Describes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeDefaultAuthorizerResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] summary: Amazon IoT Device Management Describe Default Authorizer x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: SetDefaultAuthorizer description:Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
Requires permission to access the SetDefaultAuthorizer action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/SetDefaultAuthorizerResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - authorizerName properties: authorizerName: description: The authorizer name. type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Set Default Authorizer x-microcks-operation: delay: 0 dispatcher: FALLBACK "/confirmdestination/{confirmationToken}": get: operationId: ConfirmTopicRuleDestination description:Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message
includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.
Requires permission to access the ConfirmTopicRuleDestination action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ConfirmTopicRuleDestinationResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: - name: confirmationToken in: path required: true description: The token used to confirm ownership or access to the topic rule confirmation URL. schema: type: string minLength: 1 maxLength: 2048 summary: Amazon IoT Device Management Confirm Topic Rule Destination x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /audit/suppressions/create: post: operationId: CreateAuditSuppression description:Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateAuditSuppressionResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - checkName - resourceIdentifier - clientRequestToken properties: checkName: description: An audit check name. Checks must be enabled for your account. (UseDescribeAccountAuditConfiguration to see the list of all checks, including those that are
enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
type: string
resourceIdentifier:
description: Information that identifies the noncompliant resource.
type: object
properties:
deviceCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the certificate attached to the resource.
caCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the CA certificate used to authorize the certificate.
cognitoIdentityPoolId:
allOf:
- $ref: "#/components/schemas/CognitoIdentityPoolId"
- description: The ID of the Amazon Cognito identity pool.
clientId:
allOf:
- $ref: "#/components/schemas/ClientId"
- description: The client ID.
policyVersionIdentifier:
allOf:
- $ref: "#/components/schemas/PolicyVersionIdentifier"
- description: The version of the policy associated with the resource.
account:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: The account with which the resource is associated.
iamRoleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the IAM role that has overly permissive actions.
roleAliasArn:
allOf:
- $ref: "#/components/schemas/RoleAliasArn"
- description: The ARN of the role alias that has overly permissive actions.
issuerCertificateIdentifier:
allOf:
- $ref: "#/components/schemas/IssuerCertificateIdentifier"
- description: The issuer certificate identifier.
deviceCertificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the identified device certificate.
expirationDate:
description: " The epoch timestamp in seconds at which this suppression expires. "
type: string
format: date-time
suppressIndefinitely:
description: " Indicates whether a suppression should exist indefinitely or not. "
type: boolean
description:
description: " The description of the audit suppression. "
type: string
pattern: "[\\p{Graph}\\x20]*"
maxLength: 1000
clientRequestToken:
description: " Each audit supression must have a unique client request token. If you try to create a new audit suppression with the same token as one that already exists, an exception
occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request."
type: string
pattern: ^[a-zA-Z0-9-_]+$
minLength: 1
maxLength: 64
summary: Amazon IoT Device Management Create Audit Suppression
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/authorizer/{authorizerName}":
post:
operationId: CreateAuthorizer
description: Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateAuthorizerResponse" "480": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: authorizerName in: path required: true description: The authorizer name. schema: type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - authorizerFunctionArn properties: authorizerFunctionArn: description: The ARN of the authorizer's Lambda function. type: string pattern: "[\\s\\S]*" maxLength: 2048 tokenKeyName: description: The name of the token key used to extract the token from the HTTP headers. type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 tokenSigningPublicKeys: description: The public keys used to verify the digital signature returned by your custom authentication service. type: object additionalProperties: $ref: "#/components/schemas/KeyValue" status: description: The status of the create authorizer request. type: string enum: - ACTIVE - INACTIVE tags: description: 'Metadata which can be used to manage the custom authorizer.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the
time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.
The default value
is false.
Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteAuthorizerResponse" "480": description: DeleteConflictException content: application/json: schema: $ref: "#/components/schemas/DeleteConflictException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: authorizerName in: path required: true description: The name of the authorizer to delete. schema: type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Delete Authorizer x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeAuthorizer description:Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAuthorizerResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: authorizerName in: path required: true description: The name of the authorizer to describe. schema: type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Authorizer x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateAuthorizer description:Updates an authorizer.
Requires permission to access the UpdateAuthorizer action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateAuthorizerResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: authorizerName in: path required: true description: The authorizer name. schema: type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: authorizerFunctionArn: description: The ARN of the authorizer's Lambda function. type: string pattern: "[\\s\\S]*" maxLength: 2048 tokenKeyName: description: "The key used to extract the token from the HTTP headers. " type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 tokenSigningPublicKeys: description: The public keys used to verify the token signature. type: object additionalProperties: $ref: "#/components/schemas/KeyValue" status: description: The status of the update authorizer request. type: string enum: - ACTIVE - INACTIVE enableCachingForHttp: description: Whentrue, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is
used while the device reuses the same HTTP connection.
type: boolean
summary: Amazon IoT Device Management Update Authorizer
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/billing-groups/{billingGroupName}":
post:
operationId: CreateBillingGroup
description: Creates a billing group.
Requires permission to access the CreateBillingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateBillingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: billingGroupName in: path required: true description: The name you wish to give to the billing group. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: billingGroupProperties: description: The properties of a billing group. type: object properties: billingGroupDescription: allOf: - $ref: "#/components/schemas/BillingGroupDescription" - description: The description of the billing group. tags: description: Metadata which can be used to manage the billing group. type: array items: $ref: "#/components/schemas/Tag" summary: Amazon IoT Device Management Create Billing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" delete: operationId: DeleteBillingGroup description:Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteBillingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: billingGroupName in: path required: true description: The name of the billing group. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: expectedVersion in: query required: false 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, theDeleteBillingGroup
request is rejected with a VersionConflictException.
schema:
type: integer
summary: Amazon IoT Device Management Delete Billing Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: DescribeBillingGroup
description: Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeBillingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: billingGroupName in: path required: true description: The name of the billing group. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Billing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateBillingGroup description:Updates information about the billing group.
Requires permission to access the UpdateBillingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateBillingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: billingGroupName in: path required: true description: The name of the billing group. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - billingGroupProperties properties: billingGroupProperties: description: The properties of a billing group. type: object properties: billingGroupDescription: allOf: - $ref: "#/components/schemas/BillingGroupDescription" - description: The description of the billing group. expectedVersion: 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, theUpdateBillingGroup request is rejected with a VersionConflictException.
type: integer
summary: Amazon IoT Device Management Update Billing Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/certificates:
post:
operationId: CreateCertificateFromCsr
description: 'Creates an X.509 certificate using the specified certificate signing request.
Requires permission to access the CreateCertificateFromCsr action.
The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-25 or NIST P-384 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr
files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands,
we assume that a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr
--certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for the corresponding CSR.
You can also run the aws iot create-certificate-from-csr part of the command in parallel to
speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request
file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c
"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
Lists the certificates registered in your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCertificates action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListCertificatesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: pageSize in: query required: false description: The result page size. schema: type: integer minimum: 1 maximum: 250 - name: marker in: query required: false description: The marker for the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: isAscendingOrder in: query required: false description: Specifies the order for results. If True, the results are returned in ascending order, based on the creation date. schema: type: boolean summary: Amazon IoT Device Management List Certificates x-microcks-operation: delay: 0 dispatcher: FALLBACK "/custom-metric/{metricName}": post: operationId: CreateCustomMetric description:Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateCustomMetricResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: metricName in: path required: true 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 withaws:. You can't change the name after
you define it."
schema:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- metricType
- clientRequestToken
properties:
displayName:
description: " The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You
can update the friendly name after you define it."
type: string
pattern: "[\\p{Graph}\\x20]*"
maxLength: 128
metricType:
description: The type of the custom metric.
The type number only takes a single metric value as an input, but when you submit the metrics value
in the DeviceMetrics report, you must pass it as an array with a single value.
Deletes a Device Defender detect custom metric.
Requires permission to access the DeleteCustomMetric action.
Before you can delete a
custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeCustomMetricResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: metricName in: path required: true description: " The name of the custom metric. " schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Custom Metric x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateCustomMetric description:Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateCustomMetricResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: metricName in: path required: true description: " The name of the custom metric. Cannot be updated. " schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - displayName properties: displayName: description: " Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated. " type: string pattern: "[\\p{Graph}\\x20]*" maxLength: 128 summary: Amazon IoT Device Management Update Custom Metric x-microcks-operation: delay: 0 dispatcher: FALLBACK "/dimensions/{name}": post: operationId: CreateDimension description:Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension,
you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
Requires permission to access the CreateDimension action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateDimensionResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: name in: path required: true description: A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - type - stringValues - clientRequestToken properties: type: description: "Specifies the type of dimension. Supported types:TOPIC_FILTER. "
type: string
enum:
- TOPIC_FILTER
stringValues:
description: Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example,
"admin/#").
type: array
items:
$ref: "#/components/schemas/DimensionStringValue"
minItems: 1
maxItems: 100
tags:
description: Metadata that can be used to manage the dimension.
type: array
items:
$ref: "#/components/schemas/Tag"
clientRequestToken:
description: Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs.
If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
type: string
pattern: ^[a-zA-Z0-9-_]+$
minLength: 1
maxLength: 64
summary: Amazon IoT Device Management Create Dimension
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeleteDimension
description: Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteDimensionResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: name in: path required: true description: The unique identifier for the dimension that you want to delete. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Delete Dimension x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeDimension description:Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeDimensionResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: name in: path required: true description: The unique identifier for the dimension. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Dimension x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateDimension description:Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
Requires permission to access the UpdateDimension action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateDimensionResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: name in: path required: true description: A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - stringValues properties: stringValues: description: Specifies the value or list of values for the dimension. ForTOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example,
"admin/#").
type: array
items:
$ref: "#/components/schemas/DimensionStringValue"
minItems: 1
maxItems: 100
summary: Amazon IoT Device Management Update Dimension
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/domainConfigurations/{domainConfigurationName}":
post:
operationId: CreateDomainConfiguration
description: Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateDomainConfigurationResponse" "480": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: CertificateValidationException content: application/json: schema: $ref: "#/components/schemas/CertificateValidationException" "482": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "486": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "487": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: domainConfigurationName in: path required: true description: The name of the domain configuration. This value must be unique to a region. schema: type: string pattern: "[\\w.-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: domainName: description: The name of the domain. type: string pattern: "[\\s\\S]*" minLength: 1 maxLength: 253 serverCertificateArns: description: The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains. type: array items: $ref: "#/components/schemas/AcmCertificateArn" minItems: 0 maxItems: 1 validationCertificateArn: description: The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains. type: string pattern: arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+ minLength: 1 maxLength: 2048 authorizerConfig: description: An object that specifies the authorization service for a domain. type: object properties: defaultAuthorizerName: allOf: - $ref: "#/components/schemas/AuthorizerName" - description: The name of the authorization service for a domain configuration. allowAuthorizerOverride: allOf: - $ref: "#/components/schemas/AllowAuthorizerOverride" - description: A Boolean that specifies whether the domain configuration's authorization service can be overridden. serviceType: description:The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the DATA service type.
Metadata which can be used to manage the domain configuration.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteDomainConfigurationResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" parameters: - name: domainConfigurationName in: path required: true description: The name of the domain configuration to be deleted. schema: type: string pattern: "[\\w.-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Delete Domain Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeDomainConfiguration description:Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeDomainConfigurationResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: domainConfigurationName in: path required: true description: The name of the domain configuration. schema: type: string pattern: "[\\w.:-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Domain Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateDomainConfiguration description:Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
Requires permission to access the UpdateDomainConfiguration action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateDomainConfigurationResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: CertificateValidationException content: application/json: schema: $ref: "#/components/schemas/CertificateValidationException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: domainConfigurationName in: path required: true description: The name of the domain configuration to be updated. schema: type: string pattern: "[\\w.:-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: authorizerConfig: description: An object that specifies the authorization service for a domain. type: object properties: defaultAuthorizerName: allOf: - $ref: "#/components/schemas/AuthorizerName" - description: The name of the authorization service for a domain configuration. allowAuthorizerOverride: allOf: - $ref: "#/components/schemas/AllowAuthorizerOverride" - description: A Boolean that specifies whether the domain configuration's authorization service can be overridden. domainConfigurationStatus: description: The status to which the domain configuration should be updated. type: string enum: - ENABLED - DISABLED removeAuthorizerConfig: description: Removes the authorization configuration from a domain. type: boolean summary: Amazon IoT Device Management Update Domain Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK "/dynamic-thing-groups/{thingGroupName}": post: operationId: CreateDynamicThingGroup description:Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateDynamicThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: InvalidQueryException content: application/json: schema: $ref: "#/components/schemas/InvalidQueryException" "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: thingGroupName in: path required: true description: The dynamic thing group name to create. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - queryString properties: thingGroupProperties: description: Thing group properties. type: object properties: thingGroupDescription: allOf: - $ref: "#/components/schemas/ThingGroupDescription" - description: The thing group description. attributePayload: allOf: - $ref: "#/components/schemas/AttributePayload" - description: The thing group attributes in JSON format. indexName: description: "The dynamic thing group index name.
Currently one index is supported: AWS_Things.
The dynamic thing group search query string.
See Query Syntax for information about query string syntax.
type: string minLength: 1 queryVersion: description: 'The dynamic thing group query version.
Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteDynamicThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingGroupName in: path required: true description: The name of the dynamic thing group to delete. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: expectedVersion in: query required: false description: The expected version of the dynamic thing group to delete. schema: type: integer summary: Amazon IoT Device Management Delete Dynamic Thing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateDynamicThingGroup description:Updates a dynamic thing group.
Requires permission to access the UpdateDynamicThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateDynamicThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "485": description: InvalidQueryException content: application/json: schema: $ref: "#/components/schemas/InvalidQueryException" parameters: - name: thingGroupName in: path required: true description: The name of the dynamic thing group to update. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - thingGroupProperties properties: thingGroupProperties: description: Thing group properties. type: object properties: thingGroupDescription: allOf: - $ref: "#/components/schemas/ThingGroupDescription" - description: The thing group description. attributePayload: allOf: - $ref: "#/components/schemas/AttributePayload" - description: The thing group attributes in JSON format. expectedVersion: description: The expected version of the dynamic thing group to update. type: integer indexName: description: "The dynamic thing group index to update.
Currently one index is supported: AWS_Things.
The dynamic thing group query version to update.
Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateFleetMetricResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "486": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "487": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "488": description: InvalidQueryException content: application/json: schema: $ref: "#/components/schemas/InvalidQueryException" "489": description: InvalidAggregationException content: application/json: schema: $ref: "#/components/schemas/InvalidAggregationException" "490": description: IndexNotReadyException content: application/json: schema: $ref: "#/components/schemas/IndexNotReadyException" parameters: - name: metricName in: path required: true description: The name of the fleet metric to create. schema: type: string pattern: "[a-zA-Z0-9_\\-\\.]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - queryString - aggregationType - period - aggregationField properties: queryString: description: The search query string. type: string minLength: 1 aggregationType: description: The type of aggregation queries. type: object properties: name: allOf: - $ref: "#/components/schemas/AggregationTypeName" - description: The name of the aggregation type. values: allOf: - $ref: "#/components/schemas/AggregationTypeValues" - description: A list of the values of aggregation types. period: description: The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60. type: integer minimum: 60 maximum: 86400 aggregationField: description: The field to aggregate. type: string minLength: 1 description: description: The fleet metric description. type: string pattern: "[\\p{Graph}\\x20]*" maxLength: 1024 queryVersion: description: The query version. type: string indexName: description: The name of the index to search. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 unit: description: Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null. type: string enum: - Seconds - Microseconds - Milliseconds - Bytes - Kilobytes - Megabytes - Gigabytes - Terabytes - Bits - Kilobits - Megabits - Gigabits - Terabits - Percent - Count - Bytes/Second - Kilobytes/Second - Megabytes/Second - Gigabytes/Second - Terabytes/Second - Bits/Second - Kilobits/Second - Megabits/Second - Gigabits/Second - Terabits/Second - Count/Second - None tags: description: Metadata, which can be used to manage the fleet metric. type: array items: $ref: "#/components/schemas/Tag" summary: Amazon IoT Device Management Create Fleet Metric x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" delete: operationId: DeleteFleetMetric description:Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.
Requires permission to access the DeleteFleetMetric action.
responses: "200": description: Success "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" parameters: - name: metricName in: path required: true description: The name of the fleet metric to delete. schema: type: string pattern: "[a-zA-Z0-9_\\-\\.]+" minLength: 1 maxLength: 128 - name: expectedVersion in: query required: false description: The expected version of the fleet metric to delete. schema: type: integer summary: Amazon IoT Device Management Delete Fleet Metric x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeFleetMetric description:Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeFleetMetricResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: metricName in: path required: true description: The name of the fleet metric to describe. schema: type: string pattern: "[a-zA-Z0-9_\\-\\.]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Fleet Metric x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateFleetMetric description:Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
responses: "200": description: Success "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "486": description: InvalidQueryException content: application/json: schema: $ref: "#/components/schemas/InvalidQueryException" "487": description: InvalidAggregationException content: application/json: schema: $ref: "#/components/schemas/InvalidAggregationException" "488": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "489": description: IndexNotReadyException content: application/json: schema: $ref: "#/components/schemas/IndexNotReadyException" parameters: - name: metricName in: path required: true description: The name of the fleet metric to update. schema: type: string pattern: "[a-zA-Z0-9_\\-\\.]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - indexName properties: queryString: description: The search query string. type: string minLength: 1 aggregationType: description: The type of aggregation queries. type: object properties: name: allOf: - $ref: "#/components/schemas/AggregationTypeName" - description: The name of the aggregation type. values: allOf: - $ref: "#/components/schemas/AggregationTypeValues" - description: A list of the values of aggregation types. period: description: The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60. type: integer minimum: 60 maximum: 86400 aggregationField: description: The field to aggregate. type: string minLength: 1 description: description: The description of the fleet metric. type: string pattern: "[\\p{Graph}\\x20]*" maxLength: 1024 queryVersion: description: The version of the query. type: string indexName: description: The name of the index to search. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 unit: description: Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. type: string enum: - Seconds - Microseconds - Milliseconds - Bytes - Kilobytes - Megabytes - Gigabytes - Terabytes - Bits - Kilobits - Megabits - Gigabits - Terabits - Percent - Count - Bytes/Second - Kilobytes/Second - Megabytes/Second - Gigabytes/Second - Terabytes/Second - Bits/Second - Kilobits/Second - Megabits/Second - Gigabits/Second - Terabits/Second - Count/Second - None expectedVersion: description: The expected version of the fleet metric record in the registry. type: integer summary: Amazon IoT Device Management Update Fleet Metric x-microcks-operation: delay: 0 dispatcher: FALLBACK "/jobs/{jobId}": put: operationId: CreateJob description:Creates a job.
Requires permission to access the CreateJob action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateJobResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "483": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: jobId in: path required: true 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 here. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 requestBody: required: true content: application/json: schema: type: object required: - targets properties: targets: description: A list of things and thing groups to which the job should be sent. type: array items: $ref: "#/components/schemas/TargetArn" minItems: 1 documentSource: description:An S3 link to the job document. Required if you don't specify a value for document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
documentSource.
type: string
maxLength: 32768
description:
description: A short text description of the job.
type: string
pattern: "[^\\p{C}]+"
maxLength: 2028
presignedUrlConfig:
description: Configuration for pre-signed S3 URLs.
type: object
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.
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). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
IN_PROGRESS. If
the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
type: object
properties:
inProgressTimeoutInMinutes:
allOf:
- $ref: "#/components/schemas/InProgressTimeoutInMinutes"
- description: Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to
10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer
than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
tags:
description: Metadata which can be used to manage the job.
type: array
items:
$ref: "#/components/schemas/Tag"
namespaceId:
description: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
Parameters of an Amazon Web Services managed template that you can specify to create the job document.
documentParameters can only be used
when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.
startTime can be scheduled up to a year in
advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM
for the time.
endTime:
allOf:
- $ref: "#/components/schemas/StringDateTime"
- description: The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years
from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is
thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD
for the date and HH:MM for the time.
endBehavior:
allOf:
- $ref: "#/components/schemas/JobEndBehavior"
- description: Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the
job, then endBehavior does not apply.
maintenanceWindows:
allOf:
- $ref: "#/components/schemas/MaintenanceWindows"
- description: An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the
rollout of a job document to all devices in a target group for a job.
summary: Amazon IoT Device Management Create Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeleteJob
description: Deletes a job and its related job executions.
Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.
Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.
Requires permission to access the DeleteJob action.
responses: "200": description: Success "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InvalidStateTransitionException content: application/json: schema: $ref: "#/components/schemas/InvalidStateTransitionException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: jobId in: path required: true 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 recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 - name: force in: query required: false 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 "CANCELED") or an exception will occur. The default is false.
Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The
namespaceId feature is in public preview.
Describes a job.
Requires permission to access the DescribeJob action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeJobResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: jobId in: path required: true description: The unique identifier you assigned to this job when it was created. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 summary: Amazon IoT Device Management Describe Job x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateJob description:Updates supported fields of the specified job.
Requires permission to access the UpdateJob action.
responses: "200": description: Success "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: jobId in: path required: true description: The ID of the job to be updated. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 - name: namespaceId in: query required: false description:The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The
namespaceId feature is in public preview.
The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.
IN_PROGRESS. If
the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
type: object
properties:
inProgressTimeoutInMinutes:
allOf:
- $ref: "#/components/schemas/InProgressTimeoutInMinutes"
- description: Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to
10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer
than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
jobExecutionsRetryConfig:
description: The configuration that determines how many retries are allowed for each failure type for a job.
type: object
properties:
criteriaList:
allOf:
- $ref: "#/components/schemas/RetryCriteriaList"
- description: The list of criteria that determines how many retries are allowed for each failure type for a job.
summary: Amazon IoT Device Management Update Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/job-templates/{jobTemplateId}":
put:
operationId: CreateJobTemplate
description: Creates a job template.
Requires permission to access the CreateJobTemplate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateJobTemplateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" "483": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: jobTemplateId in: path required: true description: A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 requestBody: required: true content: application/json: schema: type: object required: - description properties: jobArn: description: The ARN of the job to use as the basis for the job template. type: string documentSource: description:An S3 link to the job document to use in the template. Required if you don't specify a value for document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
documentSource.
type: string
maxLength: 32768
description:
description: A description of the job document.
type: string
pattern: "[^\\p{C}]+"
maxLength: 2028
presignedUrlConfig:
description: Configuration for pre-signed S3 URLs.
type: object
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.
IN_PROGRESS. If
the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
type: object
properties:
inProgressTimeoutInMinutes:
allOf:
- $ref: "#/components/schemas/InProgressTimeoutInMinutes"
- description: Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to
10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer
than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
tags:
description: Metadata that can be used to manage the job template.
type: array
items:
$ref: "#/components/schemas/Tag"
jobExecutionsRetryConfig:
description: The configuration that determines how many retries are allowed for each failure type for a job.
type: object
properties:
criteriaList:
allOf:
- $ref: "#/components/schemas/RetryCriteriaList"
- description: The list of criteria that determines how many retries are allowed for each failure type for a job.
maintenanceWindows:
description: Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
type: array
items:
$ref: "#/components/schemas/MaintenanceWindow"
summary: Amazon IoT Device Management Create Job Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeleteJobTemplate
description: Deletes the specified job template.
responses:
"200":
description: Success
"480":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: InternalFailureException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalFailureException"
parameters:
- name: jobTemplateId
in: path
required: true
description: The unique identifier of the job template to delete.
schema:
type: string
pattern: "[a-zA-Z0-9_-]+"
minLength: 1
maxLength: 64
summary: Amazon IoT Device Management Delete Job Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: DescribeJobTemplate
description: Returns information about a job template.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeJobTemplateResponse"
"480":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: InternalFailureException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalFailureException"
parameters:
- name: jobTemplateId
in: path
required: true
description: The unique identifier of the job template.
schema:
type: string
pattern: "[a-zA-Z0-9_-]+"
minLength: 1
maxLength: 64
summary: Amazon IoT Device Management Describe Job Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/keys-and-certificate:
post:
operationId: CreateKeysAndCertificate
description: Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for
more information, see Provisioning MQTT API.
Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.
Requires permission to access the CreateKeysAndCertificate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateKeysAndCertificateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: setAsActive in: query required: false description: Specifies whether the certificate is active. schema: type: boolean summary: Amazon IoT Device Management Create Keys and Certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/mitigationactions/actions/{actionName}": post: operationId: CreateMitigationAction description:Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.
Requires permission to access the CreateMitigationAction action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateMitigationActionResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: actionName in: path required: true description: A friendly name for the action. Choose a friendly name that accurately describes the action (for example,EnableLoggingAction).
schema:
type: string
pattern: "[a-zA-Z0-9_-]+"
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- roleArn
- actionParams
properties:
roleArn:
description: The ARN of the IAM role that is used to apply the mitigation action.
type: string
minLength: 20
maxLength: 2048
actionParams:
description: The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation
action).
type: object
properties:
updateDeviceCertificateParams:
allOf:
- $ref: "#/components/schemas/UpdateDeviceCertificateParams"
- description: Parameters to define a mitigation action that changes the state of the device certificate to inactive.
updateCACertificateParams:
allOf:
- $ref: "#/components/schemas/UpdateCACertificateParams"
- description: Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
addThingsToThingGroupParams:
allOf:
- $ref: "#/components/schemas/AddThingsToThingGroupParams"
- description: Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.
replaceDefaultPolicyVersionParams:
allOf:
- $ref: "#/components/schemas/ReplaceDefaultPolicyVersionParams"
- description: Parameters to define a mitigation action that adds a blank policy to restrict permissions.
enableIoTLoggingParams:
allOf:
- $ref: "#/components/schemas/EnableIoTLoggingParams"
- description: Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.
publishFindingToSnsParams:
allOf:
- $ref: "#/components/schemas/PublishFindingToSnsParams"
- description: Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in
response to the Amazon SNS messages.
tags:
description: Metadata that can be used to manage the mitigation action.
type: array
items:
$ref: "#/components/schemas/Tag"
summary: Amazon IoT Device Management Create Mitigation Action
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeleteMitigationAction
description: Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteMitigationActionResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: actionName in: path required: true description: The name of the mitigation action that you want to delete. schema: type: string pattern: "[a-zA-Z0-9_-]+" maxLength: 128 summary: Amazon IoT Device Management Delete Mitigation Action x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeMitigationAction description:Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeMitigationActionResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: actionName in: path required: true description: The friendly name that uniquely identifies the mitigation action. schema: type: string pattern: "[a-zA-Z0-9_-]+" maxLength: 128 summary: Amazon IoT Device Management Describe Mitigation Action x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateMitigationAction description:Updates the definition for the specified mitigation action.
Requires permission to access the UpdateMitigationAction action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateMitigationActionResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: actionName in: path required: true description: The friendly name for the mitigation action. You cannot change the name by usingUpdateMitigationAction. Instead, you must delete and recreate the mitigation action
with the new name.
schema:
type: string
pattern: "[a-zA-Z0-9_-]+"
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
roleArn:
description: The ARN of the IAM role that is used to apply the mitigation action.
type: string
minLength: 20
maxLength: 2048
actionParams:
description: The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation
action).
type: object
properties:
updateDeviceCertificateParams:
allOf:
- $ref: "#/components/schemas/UpdateDeviceCertificateParams"
- description: Parameters to define a mitigation action that changes the state of the device certificate to inactive.
updateCACertificateParams:
allOf:
- $ref: "#/components/schemas/UpdateCACertificateParams"
- description: Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
addThingsToThingGroupParams:
allOf:
- $ref: "#/components/schemas/AddThingsToThingGroupParams"
- description: Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.
replaceDefaultPolicyVersionParams:
allOf:
- $ref: "#/components/schemas/ReplaceDefaultPolicyVersionParams"
- description: Parameters to define a mitigation action that adds a blank policy to restrict permissions.
enableIoTLoggingParams:
allOf:
- $ref: "#/components/schemas/EnableIoTLoggingParams"
- description: Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.
publishFindingToSnsParams:
allOf:
- $ref: "#/components/schemas/PublishFindingToSnsParams"
- description: Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in
response to the Amazon SNS messages.
summary: Amazon IoT Device Management Update Mitigation Action
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/otaUpdates/{otaUpdateId}":
post:
operationId: CreateOTAUpdate
description: Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateOTAUpdateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "487": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: otaUpdateId in: path required: true description: The ID of the OTA update to be created. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - targets - files - roleArn properties: description: description: The description of the OTA update. type: string pattern: "[^\\p{C}]+" maxLength: 2028 targets: description: The devices targeted to receive OTA updates. type: array items: $ref: "#/components/schemas/Target" minItems: 1 protocols: description: The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol. type: array items: $ref: "#/components/schemas/Protocol" minItems: 1 maxItems: 2 targetSelection: description: "Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT." type: string enum: - CONTINUOUS - SNAPSHOT awsJobExecutionsRolloutConfig: description: Configuration for the rollout of OTA updates. type: object properties: maximumPerMinute: allOf: - $ref: "#/components/schemas/MaximumPerMinute" - description: The maximum number of OTA update job executions started per minute. exponentialRate: allOf: - $ref: "#/components/schemas/AwsJobExponentialRolloutRate" - description: The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout. awsJobPresignedUrlConfig: description: Configuration information for pre-signed URLs. Valid whenprotocols contains HTTP.
type: object
properties:
expiresInSec:
allOf:
- $ref: "#/components/schemas/ExpiresInSeconds"
- description: How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for
the job document is received.
awsJobAbortConfig:
description: The criteria that determine when and how a job abort takes place.
type: object
properties:
abortCriteriaList:
allOf:
- $ref: "#/components/schemas/AwsJobAbortCriteriaList"
- description: The list of criteria that determine when and how to abort the job.
awsJobTimeoutConfig:
description: Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If
the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
type: object
properties:
inProgressTimeoutInMinutes:
allOf:
- $ref: "#/components/schemas/AwsJobTimeoutInProgressTimeoutInMinutes"
- description: Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to
10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer
than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
files:
description: The files to be streamed by the OTA update.
type: array
items:
$ref: "#/components/schemas/OTAUpdateFile"
minItems: 1
roleArn:
description: The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
type: string
minLength: 20
maxLength: 2048
additionalParameters:
description: A list of additional OTA update parameters which are name-value pairs.
type: object
additionalProperties:
$ref: "#/components/schemas/Value"
tags:
description: Metadata which can be used to manage updates.
type: array
items:
$ref: "#/components/schemas/Tag"
summary: Amazon IoT Device Management Create O T a Update
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeleteOTAUpdate
description: Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteOTAUpdateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" parameters: - name: otaUpdateId in: path required: true description: The ID of the OTA update to delete. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 - name: deleteStream in: query required: false 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 by the user. schema: type: boolean - name: forceDeleteAWSJob in: query required: false 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 "CANCELED") an exception will occur. The default is false. schema: type: boolean summary: Amazon IoT Device Management Delete O T a Update x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: GetOTAUpdate description:Gets an OTA update.
Requires permission to access the GetOTAUpdate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetOTAUpdateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: otaUpdateId in: path required: true description: The OTA update ID. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Get O T a Update x-microcks-operation: delay: 0 dispatcher: FALLBACK "/policies/{policyName}": post: operationId: CreatePolicy description:Creates an IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
Requires permission to access the CreatePolicy action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreatePolicyResponse" "480": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "481": description: MalformedPolicyException content: application/json: schema: $ref: "#/components/schemas/MalformedPolicyException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: policyName in: path required: true description: The policy name. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - policyDocument properties: policyDocument: description: The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace. type: string pattern: "[\\s\\S]*" minLength: 0 maxLength: 404600 tags: description: 'Metadata which can be used to manage the policy.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Deletes the specified policy.
A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
To delete a policy, use the DeletePolicyVersion action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.
Requires permission to access the DeletePolicy action.
responses: "200": description: Success "480": description: DeleteConflictException content: application/json: schema: $ref: "#/components/schemas/DeleteConflictException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: policyName in: path required: true description: The name of the policy to delete. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Delete Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: GetPolicy description:Gets information about the specified policy with the policy document of the default version.
Requires permission to access the GetPolicy action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetPolicyResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: policyName in: path required: true description: The name of the policy. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Get Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK "/policies/{policyName}/version": post: operationId: CreatePolicyVersion description:Creates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
Requires permission to access the CreatePolicyVersion action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreatePolicyVersionResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: MalformedPolicyException content: application/json: schema: $ref: "#/components/schemas/MalformedPolicyException" "482": description: VersionsLimitExceededException content: application/json: schema: $ref: "#/components/schemas/VersionsLimitExceededException" "483": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "486": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "487": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: policyName in: path required: true description: The policy name. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: setAsDefault in: query required: false 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 version that is in effect for the certificates to which the policy is attached). schema: type: boolean requestBody: required: true content: application/json: schema: type: object required: - policyDocument properties: policyDocument: description: The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace. type: string pattern: "[\\s\\S]*" minLength: 0 maxLength: 404600 summary: Amazon IoT Device Management Create Policy Version x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: ListPolicyVersions description:Lists the versions of the specified policy and identifies the default version.
Requires permission to access the ListPolicyVersions action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListPolicyVersionsResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: policyName in: path required: true description: The policy name. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management List Policy Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK "/provisioning-templates/{templateName}/provisioning-claim": post: operationId: CreateProvisioningClaim description:Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateProvisioningClaimResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: templateName in: path required: true description: The name of the provisioning template to use. schema: type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 summary: Amazon IoT Device Management Create Provisioning Claim x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /provisioning-templates: post: operationId: CreateProvisioningTemplate description:Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateProvisioningTemplateResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - templateName - templateBody - provisioningRoleArn properties: templateName: description: The name of the provisioning template. type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 description: description: The description of the provisioning template. type: string pattern: "[^\\p{C}]*" minLength: 0 maxLength: 500 templateBody: description: The JSON formatted contents of the provisioning template. type: string pattern: "[\\s\\S]*" minLength: 0 maxLength: 10240 enabled: description: True to enable the provisioning template, otherwise false. type: boolean provisioningRoleArn: description: The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device. type: string minLength: 20 maxLength: 2048 preProvisioningHook: description: Structure that containspayloadVersion and targetArn.
type: object
properties:
payloadVersion:
allOf:
- $ref: "#/components/schemas/PayloadVersion"
- description: The payload that was sent to the target function.
Note: Only Lambda functions are currently supported.
targetArn: allOf: - $ref: "#/components/schemas/TargetArn" - description:The ARN of the target function.
Note: Only Lambda functions are currently supported.
tags: description: 'Metadata which can be used to manage the provisioning template.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning
template. "
type: string
enum:
- FLEET_PROVISIONING
- JITP
summary: Amazon IoT Device Management Create Provisioning Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: ListProvisioningTemplates
description: Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListProvisioningTemplatesResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" parameters: - name: maxResults in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: A token to retrieve the next set of results. schema: type: string summary: Amazon IoT Device Management List Provisioning Templates x-microcks-operation: delay: 0 dispatcher: FALLBACK "/provisioning-templates/{templateName}/versions": post: operationId: CreateProvisioningTemplateVersion description:Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateProvisioningTemplateVersionResponse" "480": description: VersionsLimitExceededException content: application/json: schema: $ref: "#/components/schemas/VersionsLimitExceededException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "485": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "486": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: - name: templateName in: path required: true description: The name of the provisioning template. schema: type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 - name: setAsDefault in: query required: false description: Sets a fleet provision template version as the default version. schema: type: boolean requestBody: required: true content: application/json: schema: type: object required: - templateBody properties: templateBody: description: The JSON formatted contents of the provisioning template. type: string pattern: "[\\s\\S]*" minLength: 0 maxLength: 10240 summary: Amazon IoT Device Management Create Provisioning Template Version x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: ListProvisioningTemplateVersions description:A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListProvisioningTemplateVersionsResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" parameters: - name: templateName in: path required: true description: The name of the provisioning template. schema: type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 - name: maxResults in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: A token to retrieve the next set of results. schema: type: string summary: Amazon IoT Device Management List Provisioning Template Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK "/role-aliases/{roleAlias}": post: operationId: CreateRoleAlias description:Creates a role alias.
Requires permission to access the CreateRoleAlias action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateRoleAliasResponse" "480": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: roleAlias in: path required: true description: The role alias that points to a role ARN. This allows you to change the role without having to update the device. schema: type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - roleArn properties: roleArn: description: The role ARN. type: string minLength: 20 maxLength: 2048 credentialDurationSeconds: description:How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.
This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.
type: integer minimum: 900 maximum: 43200 tags: description: 'Metadata which can be used to manage the role alias.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteRoleAliasResponse" "480": description: DeleteConflictException content: application/json: schema: $ref: "#/components/schemas/DeleteConflictException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: roleAlias in: path required: true description: The role alias to delete. schema: type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Delete Role Alias x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeRoleAlias description:Describes a role alias.
Requires permission to access the DescribeRoleAlias action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeRoleAliasResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: roleAlias in: path required: true description: The role alias to describe. schema: type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Role Alias x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateRoleAlias description:Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateRoleAliasResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: roleAlias in: path required: true description: The role alias to update. schema: type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: roleArn: description: The role ARN. type: string minLength: 20 maxLength: 2048 credentialDurationSeconds: description:The number of seconds the credential will be valid.
This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.
type: integer minimum: 900 maximum: 43200 summary: Amazon IoT Device Management Update Role Alias x-microcks-operation: delay: 0 dispatcher: FALLBACK "/audit/scheduledaudits/{scheduledAuditName}": post: operationId: CreateScheduledAudit description:Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateScheduledAuditResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: scheduledAuditName in: path required: true description: The name you want to give to the scheduled audit. (Max. 128 chars) schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - frequency - targetCheckNames properties: frequency: description: How often the scheduled audit takes place, eitherDAILY, WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is
determined by the system.
type: string
enum:
- DAILY
- WEEKLY
- BIWEEKLY
- MONTHLY
dayOfMonth:
description: The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to
MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the LAST day of the month.
type: string
pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
dayOfWeek:
description: The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU,
FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
type: string
enum:
- SUN
- MON
- TUE
- WED
- THU
- FRI
- SAT
targetCheckNames:
description: Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of
all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
type: array
items:
$ref: "#/components/schemas/AuditCheckName"
tags:
description: Metadata that can be used to manage the scheduled audit.
type: array
items:
$ref: "#/components/schemas/Tag"
summary: Amazon IoT Device Management Create Scheduled Audit
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeleteScheduledAudit
description: Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteScheduledAuditResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: scheduledAuditName in: path required: true description: The name of the scheduled audit you want to delete. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Delete Scheduled Audit x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeScheduledAudit description:Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeScheduledAuditResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: scheduledAuditName in: path required: true description: The name of the scheduled audit whose information you want to get. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Scheduled Audit x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateScheduledAudit description:Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Requires permission to access the UpdateScheduledAudit action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateScheduledAuditResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: scheduledAuditName in: path required: true description: The name of the scheduled audit. (Max. 128 chars) schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: frequency: description: How often the scheduled audit takes place, eitherDAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit
is determined by the system.
type: string
enum:
- DAILY
- WEEKLY
- BIWEEKLY
- MONTHLY
dayOfMonth:
description: The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the
frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of
the month.
type: string
pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
dayOfWeek:
description: The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED,
THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.
type: string
enum:
- SUN
- MON
- TUE
- WED
- THU
- FRI
- SAT
targetCheckNames:
description: Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of
all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
type: array
items:
$ref: "#/components/schemas/AuditCheckName"
summary: Amazon IoT Device Management Update Scheduled Audit
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/security-profiles/{securityProfileName}":
post:
operationId: CreateSecurityProfile
description: Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateSecurityProfileResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: securityProfileName in: path required: true description: The name you are giving to the security profile. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: securityProfileDescription: description: A description of the security profile. type: string pattern: "[\\p{Graph}\\x20]*" maxLength: 1000 behaviors: description: Specifies the behaviors that, when violated by a device (thing), cause an alert. type: array items: $ref: "#/components/schemas/Behavior" maxItems: 100 alertTargets: description: Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior. type: object additionalProperties: $ref: "#/components/schemas/AlertTarget" additionalMetricsToRetain: description:Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default,
data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used
with dimensions.
behaviors, but it is also retained for
any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
type: array
items:
$ref: "#/components/schemas/MetricToRetain"
tags:
description: Metadata that can be used to manage the security profile.
type: array
items:
$ref: "#/components/schemas/Tag"
summary: Amazon IoT Device Management Create Security Profile
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeleteSecurityProfile
description: Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteSecurityProfileResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" parameters: - name: securityProfileName in: path required: true description: The name of the security profile to be deleted. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: expectedVersion in: query required: false 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 the actual version, aVersionConflictException is thrown.
schema:
type: integer
summary: Amazon IoT Device Management Delete Security Profile
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: DescribeSecurityProfile
description: Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeSecurityProfileResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: securityProfileName in: path required: true description: The name of the security profile whose information you want to get. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Security Profile x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateSecurityProfile description:Updates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateSecurityProfileResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: securityProfileName in: path required: true description: The name of the security profile you want to update. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: expectedVersion in: query required: false 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 the actual version, aVersionConflictException is thrown.
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
securityProfileDescription:
description: A description of the security profile.
type: string
pattern: "[\\p{Graph}\\x20]*"
maxLength: 1000
behaviors:
description: Specifies the behaviors that, when violated by a device (thing), cause an alert.
type: array
items:
$ref: "#/components/schemas/Behavior"
maxItems: 100
alertTargets:
description: Where the alerts are sent. (Alerts are always sent to the console.)
type: object
additionalProperties:
$ref: "#/components/schemas/AlertTarget"
additionalMetricsToRetain:
description: Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default,
data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used
with dimensions.
behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
type: boolean
deleteAlertTargets:
description: If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception
occurs.
type: boolean
deleteAdditionalMetricsToRetain:
description: If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current
invocation, an exception occurs.
type: boolean
summary: Amazon IoT Device Management Update Security Profile
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/streams/{streamId}":
post:
operationId: CreateStream
description: Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.
Requires permission to access the CreateStream action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateStreamResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "486": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "487": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: streamId in: path required: true description: The stream ID. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - files - roleArn properties: description: description: A description of the stream. type: string pattern: "[^\\p{C}]+" maxLength: 2028 files: description: The files to stream. type: array items: $ref: "#/components/schemas/StreamFile" minItems: 1 maxItems: 50 roleArn: description: An IAM role that allows the IoT service principal to access your S3 files. type: string minLength: 20 maxLength: 2048 tags: description: Metadata which can be used to manage streams. type: array items: $ref: "#/components/schemas/Tag" summary: Amazon IoT Device Management Create Stream x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" delete: operationId: DeleteStream description:Deletes a stream.
Requires permission to access the DeleteStream action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteStreamResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: DeleteConflictException content: application/json: schema: $ref: "#/components/schemas/DeleteConflictException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: streamId in: path required: true description: The stream ID. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Delete Stream x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeStream description:Gets information about a stream.
Requires permission to access the DescribeStream action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeStreamResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: streamId in: path required: true description: The stream ID. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Stream x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateStream description:Updates an existing stream. The stream version will be incremented by one.
Requires permission to access the UpdateStream action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateStreamResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: streamId in: path required: true description: The stream ID. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: description: description: The description of the stream. type: string pattern: "[^\\p{C}]+" maxLength: 2028 files: description: The files associated with the stream. type: array items: $ref: "#/components/schemas/StreamFile" minItems: 1 maxItems: 50 roleArn: description: An IAM role that allows the IoT service principal assumes to access your S3 files. type: string minLength: 20 maxLength: 2048 summary: Amazon IoT Device Management Update Stream x-microcks-operation: delay: 0 dispatcher: FALLBACK "/things/{thingName}": post: operationId: CreateThing description:Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same
thing name but different configuration a ResourceAlreadyExistsException is thrown.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Requires permission to access the CreateThing action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateThingResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "486": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: thingName in: path required: true description:The name of the thing to create.
You can't change a thing's name after you create it. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.
schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: thingTypeName: description: The name of the thing type associated with the new thing. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 attributePayload: description: The attribute payload. type: object properties: attributes: allOf: - $ref: "#/components/schemas/Attributes" - description:A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of
overwriting them.
To remove an attribute, call UpdateThing with an empty attribute value.
The merge attribute is only valid
when calling UpdateThing or UpdateThingGroup.
Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
Requires permission to access the DeleteThing action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteThingResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingName in: path required: true description: The name of the thing to delete. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: expectedVersion in: query required: false description: The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, theDeleteThing request is rejected with a VersionConflictException.
schema:
type: integer
summary: Amazon IoT Device Management Delete Thing
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: DescribeThing
description: Gets information about the specified thing.
Requires permission to access the DescribeThing action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeThingResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingName in: path required: true description: The name of the thing. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Thing x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateThing description:Updates the data for a thing.
Requires permission to access the UpdateThing action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateThingResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: thingName in: path required: true 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 then delete the old thing.
schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: thingTypeName: description: The name of the thing type. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 attributePayload: description: The attribute payload. type: object properties: attributes: allOf: - $ref: "#/components/schemas/Attributes" - description:A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of
overwriting them.
To remove an attribute, call UpdateThing with an empty attribute value.
The merge attribute is only valid
when calling UpdateThing or UpdateThingGroup.
UpdateThing request is rejected with a VersionConflictException.
type: integer
removeThingType:
description: Remove a thing type association. If true, the association is removed.
type: boolean
summary: Amazon IoT Device Management Update Thing
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/thing-groups/{thingGroupName}":
post:
operationId: CreateThingGroup
description: Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Requires permission to access the CreateThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingGroupName in: path required: true description: The thing group name to create. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: parentGroupName: description: The name of the parent thing group. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 thingGroupProperties: description: Thing group properties. type: object properties: thingGroupDescription: allOf: - $ref: "#/components/schemas/ThingGroupDescription" - description: The thing group description. attributePayload: allOf: - $ref: "#/components/schemas/AttributePayload" - description: The thing group attributes in JSON format. tags: description: Metadata which can be used to manage the thing group. type: array items: $ref: "#/components/schemas/Tag" summary: Amazon IoT Device Management Create Thing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" delete: operationId: DeleteThingGroup description:Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingGroupName in: path required: true description: The name of the thing group to delete. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: expectedVersion in: query required: false description: The expected version of the thing group to delete. schema: type: integer summary: Amazon IoT Device Management Delete Thing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeThingGroup description:Describe a thing group.
Requires permission to access the DescribeThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: thingGroupName in: path required: true description: The name of the thing group. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Thing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateThingGroup description:Update a thing group.
Requires permission to access the UpdateThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: VersionConflictException content: application/json: schema: $ref: "#/components/schemas/VersionConflictException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: thingGroupName in: path required: true description: The thing group to update. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - thingGroupProperties properties: thingGroupProperties: description: Thing group properties. type: object properties: thingGroupDescription: allOf: - $ref: "#/components/schemas/ThingGroupDescription" - description: The thing group description. attributePayload: allOf: - $ref: "#/components/schemas/AttributePayload" - description: The thing group attributes in JSON format. expectedVersion: description: The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail. type: integer summary: Amazon IoT Device Management Update Thing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK "/thing-types/{thingTypeName}": post: operationId: CreateThingType description:Creates a new thing type.
Requires permission to access the CreateThingType action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateThingTypeResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" parameters: - name: thingTypeName in: path required: true description: The name of the thing type. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: thingTypeProperties: description: "The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names." type: object properties: thingTypeDescription: allOf: - $ref: "#/components/schemas/ThingTypeDescription" - description: The description of the thing type. searchableAttributes: allOf: - $ref: "#/components/schemas/SearchableAttributes" - description: A list of searchable thing attribute names. tags: description: Metadata which can be used to manage the thing type. type: array items: $ref: "#/components/schemas/Tag" summary: Amazon IoT Device Management Create Thing Type x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" delete: operationId: DeleteThingType description:Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.
Requires permission to access the DeleteThingType action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteThingTypeResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingTypeName in: path required: true description: The name of the thing type. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Delete Thing Type x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeThingType description:Gets information about the specified thing type.
Requires permission to access the DescribeThingType action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeThingTypeResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingTypeName in: path required: true description: The name of the thing type. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Thing Type x-microcks-operation: delay: 0 dispatcher: FALLBACK "/rules/{ruleName}": post: operationId: CreateTopicRule description:Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
Requires permission to access the CreateTopicRule action.
responses: "200": description: Success "480": description: SqlParseException content: application/json: schema: $ref: "#/components/schemas/SqlParseException" "481": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: - name: ruleName in: path required: true description: The name of the rule. schema: type: string pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 - name: x-amz-tagging in: header required: false description: 'Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Deletes the rule.
Requires permission to access the DeleteTopicRule action.
responses: "200": description: Success "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: - name: ruleName in: path required: true description: The name of the rule. schema: type: string pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Delete Topic Rule x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: GetTopicRule description:Gets information about the rule.
Requires permission to access the GetTopicRule action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetTopicRuleResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" parameters: - name: ruleName in: path required: true description: The name of the rule. schema: type: string pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Get Topic Rule x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: ReplaceTopicRule description:Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
Requires permission to access the ReplaceTopicRule action.
responses: "200": description: Success "480": description: SqlParseException content: application/json: schema: $ref: "#/components/schemas/SqlParseException" "481": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: - name: ruleName in: path required: true description: The name of the rule. schema: type: string pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - topicRulePayload properties: topicRulePayload: description: Describes a rule. type: object properties: sql: allOf: - $ref: "#/components/schemas/SQL" - description: The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide. description: allOf: - $ref: "#/components/schemas/Description" - description: The description of the rule. actions: allOf: - $ref: "#/components/schemas/ActionList" - description: The actions associated with the rule. ruleDisabled: allOf: - $ref: "#/components/schemas/IsDisabled" - description: Specifies whether the rule is disabled. awsIotSqlVersion: allOf: - $ref: "#/components/schemas/AwsIotSqlVersion" - description: The version of the SQL rules engine to use when evaluating the rule. errorAction: allOf: - $ref: "#/components/schemas/Action" - description: The action to take when an error occurs. summary: Amazon IoT Device Management Replace Topic Rule x-microcks-operation: delay: 0 dispatcher: FALLBACK /destinations: post: operationId: CreateTopicRuleDestination description:Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateTopicRuleDestinationResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - destinationConfiguration properties: destinationConfiguration: description: Configuration of the topic rule destination. type: object properties: httpUrlConfiguration: allOf: - $ref: "#/components/schemas/HttpUrlDestinationConfiguration" - description: Configuration of the HTTP URL. vpcConfiguration: allOf: - $ref: "#/components/schemas/VpcDestinationConfiguration" - description: Configuration of the virtual private cloud (VPC) connection. summary: Amazon IoT Device Management Create Topic Rule Destination x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: ListTopicRuleDestinations description:Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTopicRuleDestinationsResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" parameters: - name: maxResults in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 1000 - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
summary: Amazon IoT Device Management List Topic Rule Destinations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
operationId: UpdateTopicRuleDestination
description: Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
Requires permission to access the UpdateTopicRuleDestination action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateTopicRuleDestinationResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - arn - status properties: arn: description: The ARN of the topic rule destination. type: string status: description:The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You
can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new
confirmation challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed. You can
set status to DISABLED by calling UpdateTopicRuleDestination.
Confirmation was completed, and traffic to
this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set
status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
Requires permission to access the DeleteAccountAuditConfiguration action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteAccountAuditConfigurationResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: deleteScheduledAudits in: query required: false description: If true, all scheduled audits are deleted. schema: type: boolean summary: Amazon IoT Device Management Delete Account Audit Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeAccountAuditConfiguration description:Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the DescribeAccountAuditConfiguration action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAccountAuditConfigurationResponse" "480": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] summary: Amazon IoT Device Management Describe Account Audit Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateAccountAuditConfiguration description:Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the UpdateAccountAuditConfiguration action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateAccountAuditConfigurationResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] requestBody: required: true content: application/json: schema: type: object properties: roleArn: description: The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit. type: string minLength: 20 maxLength: 2048 auditNotificationTargetConfigurations: description: Information about the targets to which audit notifications are sent. type: object additionalProperties: $ref: "#/components/schemas/AuditNotificationTarget" auditCheckConfigurations: description:Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including
those that are currently enabled.
Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.
You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.
On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteAuditSuppressionResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - checkName - resourceIdentifier properties: checkName: description: An audit check name. Checks must be enabled for your account. (UseDescribeAccountAuditConfiguration to see the list of all checks, including those that are
enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
type: string
resourceIdentifier:
description: Information that identifies the noncompliant resource.
type: object
properties:
deviceCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the certificate attached to the resource.
caCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the CA certificate used to authorize the certificate.
cognitoIdentityPoolId:
allOf:
- $ref: "#/components/schemas/CognitoIdentityPoolId"
- description: The ID of the Amazon Cognito identity pool.
clientId:
allOf:
- $ref: "#/components/schemas/ClientId"
- description: The client ID.
policyVersionIdentifier:
allOf:
- $ref: "#/components/schemas/PolicyVersionIdentifier"
- description: The version of the policy associated with the resource.
account:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: The account with which the resource is associated.
iamRoleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the IAM role that has overly permissive actions.
roleAliasArn:
allOf:
- $ref: "#/components/schemas/RoleAliasArn"
- description: The ARN of the role alias that has overly permissive actions.
issuerCertificateIdentifier:
allOf:
- $ref: "#/components/schemas/IssuerCertificateIdentifier"
- description: The issuer certificate identifier.
deviceCertificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the identified device certificate.
summary: Amazon IoT Device Management Delete Audit Suppression
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/cacertificate/{caCertificateId}":
delete:
operationId: DeleteCACertificate
description: Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteCACertificateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: CertificateStateException content: application/json: schema: $ref: "#/components/schemas/CertificateStateException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: caCertificateId in: path required: true description: The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.) schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 summary: Amazon IoT Device Management Delete C a Certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeCACertificate description:Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeCACertificateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: caCertificateId in: path required: true description: The CA certificate identifier. schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 summary: Amazon IoT Device Management Describe C a Certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateCACertificate description:Updates a registered CA certificate.
Requires permission to access the UpdateCACertificate action.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: caCertificateId in: path required: true description: The CA certificate identifier. schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 - name: newStatus in: query required: false description:The updated status of the CA certificate.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
schema: type: string enum: - ACTIVE - INACTIVE - name: newAutoRegistrationStatus in: query required: false description: 'The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".' schema: type: string enum: - ENABLE - DISABLE requestBody: required: true content: application/json: schema: type: object properties: registrationConfig: description: The registration configuration. type: object properties: templateBody: allOf: - $ref: "#/components/schemas/TemplateBody" - description: The template body. roleArn: allOf: - $ref: "#/components/schemas/RoleArn" - description: The ARN of the role. templateName: allOf: - $ref: "#/components/schemas/TemplateName" - description: The name of the provisioning template. removeAutoRegistration: description: If true, removes auto registration. type: boolean summary: Amazon IoT Device Management Update C a Certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK "/certificates/{certificateId}": delete: operationId: DeleteCertificate description:Deletes the specified certificate.
A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.
Requires permission to access the DeleteCertificate action.
responses: "200": description: Success "480": description: CertificateStateException content: application/json: schema: $ref: "#/components/schemas/CertificateStateException" "481": description: DeleteConflictException content: application/json: schema: $ref: "#/components/schemas/DeleteConflictException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "487": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: certificateId in: path required: true description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 - name: forceDelete in: query required: false description: Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing. schema: type: boolean summary: Amazon IoT Device Management Delete Certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeCertificate description:Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeCertificateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: certificateId in: path required: true description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 summary: Amazon IoT Device Management Describe Certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK "/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}": delete: operationId: DeleteJobExecution description:Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
responses: "200": description: Success "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InvalidStateTransitionException content: application/json: schema: $ref: "#/components/schemas/InvalidStateTransitionException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: jobId in: path required: true description: The ID of the job whose execution on a particular device will be deleted. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 - name: thingName in: path required: true description: The name of the thing whose job execution will be deleted. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: executionNumber in: path required: true description:The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.
Note that once a job
execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.
(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.
Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The
namespaceId feature is in public preview.
Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
Requires permission to access the DeletePolicyVersion action.
responses: "200": description: Success "480": description: DeleteConflictException content: application/json: schema: $ref: "#/components/schemas/DeleteConflictException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: policyName in: path required: true description: The name of the policy. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: policyVersionId in: path required: true description: The policy version ID. schema: type: string pattern: "[0-9]+" summary: Amazon IoT Device Management Delete Policy Version x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GetPolicyVersion description:Gets information about the specified policy version.
Requires permission to access the GetPolicyVersion action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetPolicyVersionResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: policyName in: path required: true description: The name of the policy. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: policyVersionId in: path required: true description: The policy version ID. schema: type: string pattern: "[0-9]+" summary: Amazon IoT Device Management Get Policy Version x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: SetDefaultPolicyVersion description:Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action.
Requires permission to access the SetDefaultPolicyVersion action.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: policyName in: path required: true description: The policy name. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: policyVersionId in: path required: true description: The policy version ID. schema: type: string pattern: "[0-9]+" summary: Amazon IoT Device Management Set Default Policy Version x-microcks-operation: delay: 0 dispatcher: FALLBACK "/provisioning-templates/{templateName}": delete: operationId: DeleteProvisioningTemplate description:Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteProvisioningTemplateResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: DeleteConflictException content: application/json: schema: $ref: "#/components/schemas/DeleteConflictException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" "486": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" parameters: - name: templateName in: path required: true description: The name of the fleet provision template to delete. schema: type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 summary: Amazon IoT Device Management Delete Provisioning Template x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeProvisioningTemplate description:Returns information about a provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeProvisioningTemplateResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" parameters: - name: templateName in: path required: true description: The name of the provisioning template. schema: type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 summary: Amazon IoT Device Management Describe Provisioning Template x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: UpdateProvisioningTemplate description:Updates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateProvisioningTemplateResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: - name: templateName in: path required: true description: The name of the provisioning template. schema: type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 requestBody: required: true content: application/json: schema: type: object properties: description: description: The description of the provisioning template. type: string pattern: "[^\\p{C}]*" minLength: 0 maxLength: 500 enabled: description: True to enable the provisioning template, otherwise false. type: boolean defaultVersionId: description: The ID of the default provisioning template version. type: integer provisioningRoleArn: description: The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device. type: string minLength: 20 maxLength: 2048 preProvisioningHook: description: Structure that containspayloadVersion and targetArn.
type: object
properties:
payloadVersion:
allOf:
- $ref: "#/components/schemas/PayloadVersion"
- description: The payload that was sent to the target function.
Note: Only Lambda functions are currently supported.
targetArn: allOf: - $ref: "#/components/schemas/TargetArn" - description:The ARN of the target function.
Note: Only Lambda functions are currently supported.
removePreProvisioningHook: description: Removes pre-provisioning hook template. type: boolean summary: Amazon IoT Device Management Update Provisioning Template x-microcks-operation: delay: 0 dispatcher: FALLBACK "/provisioning-templates/{templateName}/versions/{versionId}": delete: operationId: DeleteProvisioningTemplateVersion description:Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteProvisioningTemplateVersionResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" "486": description: DeleteConflictException content: application/json: schema: $ref: "#/components/schemas/DeleteConflictException" parameters: - name: templateName in: path required: true description: The name of the provisioning template version to delete. schema: type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 - name: versionId in: path required: true description: The provisioning template version ID to delete. schema: type: integer summary: Amazon IoT Device Management Delete Provisioning Template Version x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeProvisioningTemplateVersion description:Returns information about a provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeProvisioningTemplateVersionResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" parameters: - name: templateName in: path required: true description: The template name. schema: type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 - name: versionId in: path required: true description: The provisioning template version ID. schema: type: integer summary: Amazon IoT Device Management Describe Provisioning Template Version x-microcks-operation: delay: 0 dispatcher: FALLBACK /registrationcode: delete: operationId: DeleteRegistrationCode description:Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteRegistrationCodeResponse" "480": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] summary: Amazon IoT Device Management Delete Registration Code x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GetRegistrationCode description:Gets a registration code used to register a CA certificate with IoT.
Requires permission to access the GetRegistrationCode action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetRegistrationCodeResponse" "480": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" parameters: [] summary: Amazon IoT Device Management Get Registration Code x-microcks-operation: delay: 0 dispatcher: FALLBACK "/destinations/{arn}": delete: operationId: DeleteTopicRuleDestination description:Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteTopicRuleDestinationResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: - name: arn in: path required: true description: The ARN of the topic rule destination to delete. schema: type: string summary: Amazon IoT Device Management Delete Topic Rule Destination x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GetTopicRuleDestination description:Gets information about a topic rule destination.
Requires permission to access the GetTopicRuleDestination action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetTopicRuleDestinationResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" parameters: - name: arn in: path required: true description: The ARN of the topic rule destination. schema: type: string summary: Amazon IoT Device Management Get Topic Rule Destination x-microcks-operation: delay: 0 dispatcher: FALLBACK /v2LoggingLevel#targetType&targetName: delete: operationId: DeleteV2LoggingLevel description:Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
responses: "200": description: Success "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: targetType in: query required: true description: The type of resource for which you are configuring logging. Must beTHING_Group.
schema:
type: string
enum:
- DEFAULT
- THING_GROUP
- CLIENT_ID
- SOURCE_IP
- PRINCIPAL_ID
- name: targetName
in: query
required: true
description: The name of the resource for which you are configuring logging.
schema:
type: string
summary: Amazon IoT Device Management Delete V2 Logging Level
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/thing-types/{thingTypeName}/deprecate":
post:
operationId: DeprecateThingType
description: Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeprecateThingTypeResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingTypeName in: path required: true description: The name of the thing type to deprecate. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: undoDeprecate: description: Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things. type: boolean summary: Amazon IoT Device Management Deprecate Thing Type x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/audit/findings/{findingId}": get: operationId: DescribeAuditFinding description:Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
Requires permission to access the DescribeAuditFinding action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAuditFindingResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: findingId in: path required: true description: A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Audit Finding x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/audit/mitigationactions/tasks/{taskId}": get: operationId: DescribeAuditMitigationActionsTask description: Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAuditMitigationActionsTaskResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: path required: true description: The unique identifier for the audit mitigation task. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Audit Mitigation Actions Task x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: operationId: StartAuditMitigationActionsTask description:Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartAuditMitigationActionsTaskResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: TaskAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/TaskAlreadyExistsException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: path required: true description: A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - target - auditCheckToActionsMapping - clientRequestToken properties: target: description: Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears. type: object properties: auditTaskId: allOf: - $ref: "#/components/schemas/AuditTaskId" - description: If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit. findingIds: allOf: - $ref: "#/components/schemas/FindingIds" - description: If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings. auditCheckToReasonCodeFilter: allOf: - $ref: "#/components/schemas/AuditCheckToReasonCodeFilter" - description: Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply. auditCheckToActionsMapping: description: For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts. type: object additionalProperties: $ref: "#/components/schemas/MitigationActionNameList" clientRequestToken: description: Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically. type: string pattern: ^[a-zA-Z0-9-_]+$ minLength: 1 maxLength: 64 summary: Amazon IoT Device Management Start Audit Mitigation Actions Task x-microcks-operation: delay: 0 dispatcher: FALLBACK /audit/suppressions/describe: post: operationId: DescribeAuditSuppression description: " Gets information about a Device Defender audit suppression. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAuditSuppressionResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - checkName - resourceIdentifier properties: checkName: description: An audit check name. Checks must be enabled for your account. (UseDescribeAccountAuditConfiguration to see the list of all checks, including those that are
enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
type: string
resourceIdentifier:
description: Information that identifies the noncompliant resource.
type: object
properties:
deviceCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the certificate attached to the resource.
caCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the CA certificate used to authorize the certificate.
cognitoIdentityPoolId:
allOf:
- $ref: "#/components/schemas/CognitoIdentityPoolId"
- description: The ID of the Amazon Cognito identity pool.
clientId:
allOf:
- $ref: "#/components/schemas/ClientId"
- description: The client ID.
policyVersionIdentifier:
allOf:
- $ref: "#/components/schemas/PolicyVersionIdentifier"
- description: The version of the policy associated with the resource.
account:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: The account with which the resource is associated.
iamRoleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the IAM role that has overly permissive actions.
roleAliasArn:
allOf:
- $ref: "#/components/schemas/RoleAliasArn"
- description: The ARN of the role alias that has overly permissive actions.
issuerCertificateIdentifier:
allOf:
- $ref: "#/components/schemas/IssuerCertificateIdentifier"
- description: The issuer certificate identifier.
deviceCertificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the identified device certificate.
summary: Amazon IoT Device Management Describe Audit Suppression
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/audit/tasks/{taskId}":
get:
operationId: DescribeAuditTask
description: Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAuditTaskResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: path required: true description: The ID of the audit whose information you want to get. schema: type: string pattern: "[a-zA-Z0-9\\-]+" minLength: 1 maxLength: 40 summary: Amazon IoT Device Management Describe Audit Task x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/detect/mitigationactions/tasks/{taskId}": get: operationId: DescribeDetectMitigationActionsTask description:Gets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeDetectMitigationActionsTaskResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: path required: true description: " The unique identifier of the task. " schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Detect Mitigation Actions Task x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" put: operationId: StartDetectMitigationActionsTask description:Starts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartDetectMitigationActionsTaskResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: TaskAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/TaskAlreadyExistsException" "482": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: path required: true description: " The unique identifier of the task. " schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - target - actions - clientRequestToken properties: target: description: " The target of a mitigation action task. " type: object properties: violationIds: allOf: - $ref: "#/components/schemas/TargetViolationIdsForDetectMitigationActions" - description: " The unique identifiers of the violations. " securityProfileName: allOf: - $ref: "#/components/schemas/SecurityProfileName" - description: " The name of the security profile. " behaviorName: allOf: - $ref: "#/components/schemas/BehaviorName" - description: " The name of the behavior. " actions: description: " The actions to be performed when a device has unexpected behavior. " type: array items: $ref: "#/components/schemas/MitigationActionName" minItems: 1 maxItems: 5 violationEventOccurrenceRange: description: " Specifies the time period of which violation events occurred between. " type: object properties: startTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: " The start date and time of a time period in which violation events occurred. " endTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: " The end date and time of a time period in which violation events occurred. " includeOnlyActiveViolations: description: " Specifies to list only active violations. " type: boolean includeSuppressedAlerts: description: " Specifies to include suppressed alerts. " type: boolean clientRequestToken: description: " Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request. " type: string pattern: ^[a-zA-Z0-9-_]+$ minLength: 1 maxLength: 64 summary: Amazon IoT Device Management Start Detect Mitigation Actions Task x-microcks-operation: delay: 0 dispatcher: FALLBACK /endpoint: get: operationId: DescribeEndpoint description:Returns a unique endpoint specific to the Amazon Web Services account making the call.
Requires permission to access the DescribeEndpoint action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeEndpointResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: endpointType in: query required: false description:The endpoint type. Valid endpoint types include:
iot:Data - Returns a VeriSign signed data endpoint.
iot:Data-ATS - Returns an ATS signed data endpoint.
iot:CredentialProvider - Returns an IoT credentials provider API endpoint.
iot:Jobs - Returns an IoT device management Jobs API endpoint.
We strongly recommend that customers use the newer
iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.
Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeEventConfigurationsResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: [] summary: Amazon IoT Device Management Describe Event Configurations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" patch: operationId: UpdateEventConfigurations description:Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateEventConfigurationsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: [] requestBody: required: true content: application/json: schema: type: object properties: eventConfigurations: description: The new event configuration values. type: object additionalProperties: $ref: "#/components/schemas/Configuration" summary: Amazon IoT Device Management Update Event Configurations x-microcks-operation: delay: 0 dispatcher: FALLBACK "/indices/{indexName}": get: operationId: DescribeIndex description:Describes a search index.
Requires permission to access the DescribeIndex action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeIndexResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: indexName in: path required: true description: The index name. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Describe Index x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/things/{thingName}/jobs/{jobId}": get: operationId: DescribeJobExecution description:Describes a job execution.
Requires permission to access the DescribeJobExecution action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeJobExecutionResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: jobId in: path required: true description: The unique identifier you assigned to this job when it was created. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 - name: thingName in: path required: true description: The name of the thing on which the job execution is running. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: executionNumber in: query required: false description: A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device. schema: type: integer summary: Amazon IoT Device Management Describe Job Execution x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/managed-job-templates/{templateName}": get: operationId: DescribeManagedJobTemplate description: View details of a managed job template. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeManagedJobTemplateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: - name: templateName in: path required: true description: The unique name of a managed job template, which is required. schema: type: string minLength: 1 maxLength: 64 - name: templateVersion in: query required: false description: An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned. schema: type: string pattern: ^[1-9]+.[0-9]+ summary: Amazon IoT Device Management Describe Managed Job Template x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/thing-registration-tasks/{taskId}": get: operationId: DescribeThingRegistrationTask description:Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeThingRegistrationTaskResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: taskId in: path required: true description: The task ID. schema: type: string maxLength: 40 summary: Amazon IoT Device Management Describe Thing Registration Task x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/rules/{ruleName}/disable": post: operationId: DisableTopicRule description:Disables the rule.
Requires permission to access the DisableTopicRule action.
responses: "200": description: Success "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: - name: ruleName in: path required: true description: The name of the rule to disable. schema: type: string pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Disable Topic Rule x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/rules/{ruleName}/enable": post: operationId: EnableTopicRule description:Enables the rule.
Requires permission to access the EnableTopicRule action.
responses: "200": description: Success "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" parameters: - name: ruleName in: path required: true description: The name of the topic rule to enable. schema: type: string pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 summary: Amazon IoT Device Management Enable Topic Rule x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /behavior-model-training/summaries: get: operationId: GetBehaviorModelTrainingSummaries description:Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetBehaviorModelTrainingSummariesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: securityProfileName in: query required: false description: " The name of the security profile. " schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: maxResults in: query required: false description: " The maximum number of results to return at one time. The default is 10. " schema: type: integer minimum: 1 maximum: 10 - name: nextToken in: query required: false description: " The token for the next set of results. " schema: type: string summary: Amazon IoT Device Management Get Behavior Model Training Summaries x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /indices/buckets: post: operationId: GetBucketsAggregation description:Aggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetBucketsAggregationResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "486": description: InvalidQueryException content: application/json: schema: $ref: "#/components/schemas/InvalidQueryException" "487": description: InvalidAggregationException content: application/json: schema: $ref: "#/components/schemas/InvalidAggregationException" "488": description: IndexNotReadyException content: application/json: schema: $ref: "#/components/schemas/IndexNotReadyException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - queryString - aggregationField - bucketsAggregationType properties: indexName: description: The name of the index to search. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 queryString: description: The search query string. type: string minLength: 1 aggregationField: description: The aggregation field. type: string minLength: 1 queryVersion: description: The version of the query. type: string bucketsAggregationType: description: The type of bucketed aggregation performed. type: object properties: termsAggregation: allOf: - $ref: "#/components/schemas/TermsAggregation" - description: Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value. summary: Amazon IoT Device Management Get Buckets Aggregation x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /indices/cardinality: post: operationId: GetCardinality description:Returns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetCardinalityResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "486": description: InvalidQueryException content: application/json: schema: $ref: "#/components/schemas/InvalidQueryException" "487": description: InvalidAggregationException content: application/json: schema: $ref: "#/components/schemas/InvalidAggregationException" "488": description: IndexNotReadyException content: application/json: schema: $ref: "#/components/schemas/IndexNotReadyException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - queryString properties: indexName: description: The name of the index to search. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 queryString: description: The search query string. type: string minLength: 1 aggregationField: description: The field to aggregate. type: string minLength: 1 queryVersion: description: The query version. type: string summary: Amazon IoT Device Management Get Cardinality x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /effective-policies: post: operationId: GetEffectivePolicies description:Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway.
Requires permission to access the GetEffectivePolicies action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetEffectivePoliciesResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: thingName in: query required: false description: The thing name. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: principal: description: The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id). type: string cognitoIdentityPoolId: description: The Cognito identity pool ID. type: string summary: Amazon IoT Device Management Get Effective Policies x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /indexing/config: get: operationId: GetIndexingConfiguration description:Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetIndexingConfigurationResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] summary: Amazon IoT Device Management Get Indexing Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: operationId: UpdateIndexingConfiguration description:Updates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateIndexingConfigurationResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] requestBody: required: true content: application/json: schema: type: object properties: thingIndexingConfiguration: description: The thing indexing configuration. For more information, see Managing Thing Indexing. type: object properties: thingIndexingMode: allOf: - $ref: "#/components/schemas/ThingIndexingMode" - description:Thing indexing mode. Valid values are:
REGISTRY – Your thing index contains registry data only.
REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
OFF - Thing indexing is disabled.
Thing connectivity indexing mode. Valid values are:
STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.
OFF - Thing connectivity status indexing is disabled.
Device Defender indexing mode. Valid values are:
VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.
OFF - Device Defender indexing is disabled.
For more information about Device Defender violations, see Device Defender Detect.
namedShadowIndexingMode: allOf: - $ref: "#/components/schemas/NamedShadowIndexingMode" - description:Named shadow indexing mode. Valid values are:
ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.
OFF - Named shadow indexing is disabled.
For more information about Shadows, see IoT Device Shadow service.
managedFields: allOf: - $ref: "#/components/schemas/Fields" - description: Contains fields that are indexed and whose types are already known by the Fleet Indexing service. customFields: allOf: - $ref: "#/components/schemas/Fields" - description: Contains custom field names and their data type. filter: allOf: - $ref: "#/components/schemas/IndexingFilter" - description: Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, setnamedShadowIndexingMode to be ON and specify your shadow names in filter.
thingGroupIndexingConfiguration:
description: Thing group indexing configuration.
type: object
properties:
thingGroupIndexingMode:
allOf:
- $ref: "#/components/schemas/ThingGroupIndexingMode"
- description: Thing group indexing mode.
managedFields:
allOf:
- $ref: "#/components/schemas/Fields"
- description: Contains fields that are indexed and whose types are already known by the Fleet Indexing service. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer
Guide.
customFields:
allOf:
- $ref: "#/components/schemas/Fields"
- description: A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
Contains custom field names and their data type.
summary: Amazon IoT Device Management Update Indexing Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK "/jobs/{jobId}/job-document": get: operationId: GetJobDocument description:Gets a job document.
Requires permission to access the GetJobDocument action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetJobDocumentResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: jobId in: path required: true description: The unique identifier you assigned to this job when it was created. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 summary: Amazon IoT Device Management Get Job Document x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /loggingOptions: get: operationId: GetLoggingOptions description: 'Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
Requires permission to access the GetLoggingOptions action.
' responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetLoggingOptionsResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: [] summary: Amazon IoT Device Management Get Logging Options x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: operationId: SetLoggingOptions description: 'Sets the logging options.
NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
Requires permission to access the SetLoggingOptions action.
' responses: "200": description: Success "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - loggingOptionsPayload properties: loggingOptionsPayload: description: Describes the logging options payload. type: object properties: roleArn: allOf: - $ref: "#/components/schemas/AwsArn" - description: The ARN of the IAM role that grants access. logLevel: allOf: - $ref: "#/components/schemas/LogLevel" - description: The log level. summary: Amazon IoT Device Management Set Logging Options x-microcks-operation: delay: 0 dispatcher: FALLBACK /indices/percentiles: post: operationId: GetPercentiles description: 'Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call
GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value
that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values
that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.
Requires permission to access the GetPercentiles action.
' responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetPercentilesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "486": description: InvalidQueryException content: application/json: schema: $ref: "#/components/schemas/InvalidQueryException" "487": description: InvalidAggregationException content: application/json: schema: $ref: "#/components/schemas/InvalidAggregationException" "488": description: IndexNotReadyException content: application/json: schema: $ref: "#/components/schemas/IndexNotReadyException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - queryString properties: indexName: description: The name of the index to search. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 queryString: description: The search query string. type: string minLength: 1 aggregationField: description: The field to aggregate. type: string minLength: 1 queryVersion: description: The query version. type: string percents: description: The percentile groups returned. type: array items: $ref: "#/components/schemas/Percent" summary: Amazon IoT Device Management Get Percentiles x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /indices/statistics: post: operationId: GetStatistics description:Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type
String, only the count statistic is returned.
Requires permission to access the GetStatistics action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetStatisticsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "486": description: InvalidQueryException content: application/json: schema: $ref: "#/components/schemas/InvalidQueryException" "487": description: InvalidAggregationException content: application/json: schema: $ref: "#/components/schemas/InvalidAggregationException" "488": description: IndexNotReadyException content: application/json: schema: $ref: "#/components/schemas/IndexNotReadyException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - queryString properties: indexName: description: The name of the index to search. The default value isAWS_Things.
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
queryString:
description: The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.
type: string
minLength: 1
aggregationField:
description: The aggregation field name.
type: string
minLength: 1
queryVersion:
description: The version of the query used to search.
type: string
summary: Amazon IoT Device Management Get Statistics
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/v2LoggingOptions:
get:
operationId: GetV2LoggingOptions
description: Gets the fine grained logging options.
Requires permission to access the GetV2LoggingOptions action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetV2LoggingOptionsResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: NotConfiguredException content: application/json: schema: $ref: "#/components/schemas/NotConfiguredException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: [] summary: Amazon IoT Device Management Get V2 Logging Options x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: operationId: SetV2LoggingOptions description:Sets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
responses: "200": description: Success "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: [] requestBody: required: true content: application/json: schema: type: object properties: roleArn: description: The ARN of the role that allows IoT to write to Cloudwatch logs. type: string defaultLogLevel: description: The default logging level. type: string enum: - DEBUG - INFO - ERROR - WARN - DISABLED disableAllLogs: description: If true all logs are disabled. The default is false. type: boolean summary: Amazon IoT Device Management Set V2 Logging Options x-microcks-operation: delay: 0 dispatcher: FALLBACK /active-violations: get: operationId: ListActiveViolations description:Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListActiveViolationsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: thingName in: query required: false description: The name of the thing whose active violations are listed. schema: type: string minLength: 1 maxLength: 128 - name: securityProfileName in: query required: false description: The name of the Device Defender security profile for which violations are listed. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: behaviorCriteriaType in: query required: false description: " The criteria for a behavior. " schema: type: string enum: - STATIC - STATISTICAL - MACHINE_LEARNING - name: listSuppressedAlerts in: query required: false description: " A list of all suppressed alerts. " schema: type: boolean - name: verificationState in: query required: false description: The verification state of the violation (detect alarm). schema: type: string enum: - FALSE_POSITIVE - BENIGN_POSITIVE - TRUE_POSITIVE - UNKNOWN - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Device Management List Active Violations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/attached-policies/{target}": post: operationId: ListAttachedPolicies description:Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAttachedPoliciesResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: target in: path required: true description: The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id). schema: type: string - name: recursive in: query required: false description: When true, recursively list attached policies. schema: type: boolean - name: marker in: query required: false description: The token to retrieve the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: pageSize in: query required: false description: The maximum number of results to be returned per request. schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Device Management List Attached Policies x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /audit/findings: post: operationId: ListAuditFindings description:Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)
Requires permission to access the ListAuditFindings action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAuditFindingsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: taskId: description: A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both. type: string pattern: "[a-zA-Z0-9\\-]+" minLength: 1 maxLength: 40 checkName: description: An audit check name. Checks must be enabled for your account. (UseDescribeAccountAuditConfiguration to see the list of all checks, including those that are
enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
type: string
resourceIdentifier:
description: Information that identifies the noncompliant resource.
type: object
properties:
deviceCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the certificate attached to the resource.
caCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the CA certificate used to authorize the certificate.
cognitoIdentityPoolId:
allOf:
- $ref: "#/components/schemas/CognitoIdentityPoolId"
- description: The ID of the Amazon Cognito identity pool.
clientId:
allOf:
- $ref: "#/components/schemas/ClientId"
- description: The client ID.
policyVersionIdentifier:
allOf:
- $ref: "#/components/schemas/PolicyVersionIdentifier"
- description: The version of the policy associated with the resource.
account:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: The account with which the resource is associated.
iamRoleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the IAM role that has overly permissive actions.
roleAliasArn:
allOf:
- $ref: "#/components/schemas/RoleAliasArn"
- description: The ARN of the role alias that has overly permissive actions.
issuerCertificateIdentifier:
allOf:
- $ref: "#/components/schemas/IssuerCertificateIdentifier"
- description: The issuer certificate identifier.
deviceCertificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the identified device certificate.
maxResults:
description: The maximum number of results to return at one time. The default is 25.
type: integer
minimum: 1
maximum: 250
nextToken:
description: The token for the next set of results.
type: string
startTime:
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.
type: string
format: date-time
endTime:
description: A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.
type: string
format: date-time
listSuppressedFindings:
description: " Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both
suppressed and unsuppressed findings. "
type: boolean
summary: Amazon IoT Device Management List Audit Findings
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/audit/mitigationactions/executions#taskId&findingId:
get:
operationId: ListAuditMitigationActionsExecutions
description: Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAuditMitigationActionsExecutionsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: query required: true description: Specify this filter to limit results to actions for a specific audit mitigation actions task. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 - name: actionStatus in: query required: false description: Specify this filter to limit results to those with a specific status. schema: type: string enum: - IN_PROGRESS - COMPLETED - FAILED - CANCELED - SKIPPED - PENDING - name: findingId in: query required: true description: Specify this filter to limit results to those that were applied to a specific audit finding. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 - name: maxResults in: query required: false description: The maximum number of results to return at one time. The default is 25. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string summary: Amazon IoT Device Management List Audit Mitigation Actions Executions x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /audit/mitigationactions/tasks#startTime&endTime: get: operationId: ListAuditMitigationActionsTasks description:Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAuditMitigationActionsTasksResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: auditTaskId in: query required: false description: Specify this filter to limit results to tasks that were applied to results for a specific audit. schema: type: string pattern: "[a-zA-Z0-9\\-]+" minLength: 1 maxLength: 40 - name: findingId in: query required: false description: Specify this filter to limit results to tasks that were applied to a specific audit finding. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 - name: taskStatus in: query required: false description: Specify this filter to limit results to tasks that are in a specific state. schema: type: string enum: - IN_PROGRESS - COMPLETED - FAILED - CANCELED - name: maxResults in: query required: false description: The maximum number of results to return at one time. The default is 25. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string - name: startTime in: query required: true description: Specify this filter to limit results to tasks that began on or after a specific date and time. schema: type: string format: date-time - name: endTime in: query required: true description: Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time. schema: type: string format: date-time summary: Amazon IoT Device Management List Audit Mitigation Actions Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /audit/suppressions/list: post: operationId: ListAuditSuppressions description:Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAuditSuppressionsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: checkName: description: An audit check name. Checks must be enabled for your account. (UseDescribeAccountAuditConfiguration to see the list of all checks, including those that are
enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
type: string
resourceIdentifier:
description: Information that identifies the noncompliant resource.
type: object
properties:
deviceCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the certificate attached to the resource.
caCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the CA certificate used to authorize the certificate.
cognitoIdentityPoolId:
allOf:
- $ref: "#/components/schemas/CognitoIdentityPoolId"
- description: The ID of the Amazon Cognito identity pool.
clientId:
allOf:
- $ref: "#/components/schemas/ClientId"
- description: The client ID.
policyVersionIdentifier:
allOf:
- $ref: "#/components/schemas/PolicyVersionIdentifier"
- description: The version of the policy associated with the resource.
account:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: The account with which the resource is associated.
iamRoleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the IAM role that has overly permissive actions.
roleAliasArn:
allOf:
- $ref: "#/components/schemas/RoleAliasArn"
- description: The ARN of the role alias that has overly permissive actions.
issuerCertificateIdentifier:
allOf:
- $ref: "#/components/schemas/IssuerCertificateIdentifier"
- description: The issuer certificate identifier.
deviceCertificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the identified device certificate.
ascendingOrder:
description: " Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, ascendingOrder=true. "
type: boolean
nextToken:
description: " The token for the next set of results. "
type: string
maxResults:
description: " The maximum number of results to return at one time. The default is 25. "
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT Device Management List Audit Suppressions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/audit/tasks#startTime&endTime:
get:
operationId: ListAuditTasks
description: Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAuditTasksResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: startTime in: query required: true description: The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException". schema: type: string format: date-time - name: endTime in: query required: true description: The end of the time period. schema: type: string format: date-time - name: taskType in: query required: false 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".' schema: type: string enum: - ON_DEMAND_AUDIT_TASK - SCHEDULED_AUDIT_TASK - name: taskStatus in: query required: false description: 'A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".' schema: type: string enum: - IN_PROGRESS - COMPLETED - FAILED - CANCELED - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to return at one time. The default is 25. schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Device Management List Audit Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /authorizers/: get: operationId: ListAuthorizers description:Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAuthorizersResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: pageSize in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 - name: marker in: query required: false description: A marker used to get the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: isAscendingOrder in: query required: false description: Return the list of authorizers in ascending alphabetical order. schema: type: boolean - name: status in: query required: false description: The status of the list authorizers request. schema: type: string enum: - ACTIVE - INACTIVE summary: Amazon IoT Device Management List Authorizers x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /billing-groups: get: operationId: ListBillingGroups description:Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListBillingGroupsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return per request.
schema:
type: integer
minimum: 1
maximum: 250
- name: namePrefixFilter
in: query
required: false
description: Limit the results to billing groups whose names have the given prefix.
schema:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
summary: Amazon IoT Device Management List Billing Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/cacertificates:
get:
operationId: ListCACertificates
description: Lists the CA certificates registered for your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCACertificates action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListCACertificatesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: pageSize in: query required: false description: The result page size. schema: type: integer minimum: 1 maximum: 250 - name: marker in: query required: false description: The marker for the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: isAscendingOrder in: query required: false description: Determines the order of the results. schema: type: boolean - name: templateName in: query required: false description: The name of the provisioning template. schema: type: string pattern: ^[0-9A-Za-z_-]+$ minLength: 1 maxLength: 36 summary: Amazon IoT Device Management List C a Certificates x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/certificates-by-ca/{caCertificateId}": get: operationId: ListCertificatesByCA description:List the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListCertificatesByCAResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: caCertificateId in: path required: true description: The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate. schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 - name: pageSize in: query required: false description: The result page size. schema: type: integer minimum: 1 maximum: 250 - name: marker in: query required: false description: The marker for the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: isAscendingOrder in: query required: false description: Specifies the order for results. If True, the results are returned in ascending order, based on the creation date. schema: type: boolean summary: Amazon IoT Device Management List Certificates by C a x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /custom-metrics: get: operationId: ListCustomMetrics description:Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListCustomMetricsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: nextToken in: query required: false description: " The token for the next set of results. " schema: type: string - name: maxResults in: query required: false description: " The maximum number of results to return at one time. The default is 25. " schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Device Management List Custom Metrics x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /detect/mitigationactions/executions: get: operationId: ListDetectMitigationActionsExecutions description:Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListDetectMitigationActionsExecutionsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: taskId in: query required: false description: " The unique identifier of the task. " schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 - name: violationId in: query required: false description: " The unique identifier of the violation. " schema: type: string pattern: "[a-zA-Z0-9\\-]+" minLength: 1 maxLength: 128 - name: thingName in: query required: false description: " The name of the thing whose mitigation actions are listed. " schema: type: string minLength: 1 maxLength: 128 - name: startTime in: query required: false 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. " schema: type: string format: date-time - name: endTime in: query required: false description: " The end of the time period for which ML Detect mitigation actions executions are returned. " schema: type: string format: date-time - name: maxResults in: query required: false description: " The maximum number of results to return at one time. The default is 25. " schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: " The token for the next set of results. " schema: type: string summary: Amazon IoT Device Management List Detect Mitigation Actions Executions x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /detect/mitigationactions/tasks#startTime&endTime: get: operationId: ListDetectMitigationActionsTasks description:List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListDetectMitigationActionsTasksResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: maxResults in: query required: false description: The maximum number of results to return at one time. The default is 25. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: " The token for the next set of results. " schema: type: string - name: startTime in: query required: true 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. " schema: type: string format: date-time - name: endTime in: query required: true description: " The end of the time period for which ML Detect mitigation actions tasks are returned. " schema: type: string format: date-time summary: Amazon IoT Device Management List Detect Mitigation Actions Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /dimensions: get: operationId: ListDimensions description:List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListDimensionsResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to retrieve at one time. schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Device Management List Dimensions x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /domainConfigurations: get: operationId: ListDomainConfigurations description:Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
Requires permission to access the ListDomainConfigurations action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListDomainConfigurationsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: marker in: query required: false description: The marker for the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: pageSize in: query required: false description: The result page size. schema: type: integer minimum: 1 maximum: 250 - name: serviceType in: query required: false description: The type of service delivered by the endpoint. schema: type: string enum: - DATA - CREDENTIAL_PROVIDER - JOBS summary: Amazon IoT Device Management List Domain Configurations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /fleet-metrics: get: operationId: ListFleetMetrics description:Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListFleetMetricsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return in this operation.
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT Device Management List Fleet Metrics
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/indices:
get:
operationId: ListIndices
description: Lists the search indices.
Requires permission to access the ListIndices action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListIndicesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: nextToken in: query required: false description: The token used to get the next set of results, ornull if there are no additional results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 500
summary: Amazon IoT Device Management List Indices
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/jobs/{jobId}/things":
get:
operationId: ListJobExecutionsForJob
description: Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListJobExecutionsForJobResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: jobId in: path required: true description: The unique identifier you assigned to this job when it was created. schema: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 64 - name: status in: query required: false description: The status of the job. schema: type: string enum: - QUEUED - IN_PROGRESS - SUCCEEDED - FAILED - TIMED_OUT - REJECTED - REMOVED - CANCELED - name: maxResults in: query required: false description: The maximum number of results to be returned per request. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: The token to retrieve the next set of results. schema: type: string summary: Amazon IoT Device Management List Job Executions for Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/things/{thingName}/jobs": get: operationId: ListJobExecutionsForThing description:Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListJobExecutionsForThingResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: thingName in: path required: true description: The thing name. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: status in: query required: false description: An optional filter that lets you search for jobs that have the specified status. schema: type: string enum: - QUEUED - IN_PROGRESS - SUCCEEDED - FAILED - TIMED_OUT - REJECTED - REMOVED - CANCELED - name: namespaceId in: query required: false description:The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The
namespaceId feature is in public preview.
Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListJobTemplatesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: maxResults in: query required: false description: The maximum number of results to return in the list. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: The token to use to return the next set of results in the list. schema: type: string summary: Amazon IoT Device Management List Job Templates x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /jobs: get: operationId: ListJobs description:Lists jobs.
Requires permission to access the ListJobs action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListJobsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: status in: query required: false description: An optional filter that lets you search for jobs that have the specified status. schema: type: string enum: - IN_PROGRESS - CANCELED - COMPLETED - DELETION_IN_PROGRESS - SCHEDULED - name: targetSelection in: query required: false 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). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The
namespaceId feature is in public preview.
Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListMitigationActionsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: actionType in: query required: false description: Specify a value to limit the result to mitigation actions with a specific action type. schema: type: string enum: - UPDATE_DEVICE_CERTIFICATE - UPDATE_CA_CERTIFICATE - ADD_THINGS_TO_THING_GROUP - REPLACE_DEFAULT_POLICY_VERSION - ENABLE_IOT_LOGGING - PUBLISH_FINDING_TO_SNS - name: maxResults in: query required: false description: The maximum number of results to return at one time. The default is 25. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string summary: Amazon IoT Device Management List Mitigation Actions x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /otaUpdates: get: operationId: ListOTAUpdates description:Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListOTAUpdatesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: maxResults in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: A token used to retrieve the next set of results. schema: type: string - name: otaUpdateStatus in: query required: false description: The OTA update job status. schema: type: string enum: - CREATE_PENDING - CREATE_IN_PROGRESS - CREATE_COMPLETE - CREATE_FAILED - DELETE_IN_PROGRESS - DELETE_FAILED summary: Amazon IoT Device Management List O T a Updates x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /certificates-out-going: get: operationId: ListOutgoingCertificates description:Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListOutgoingCertificatesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: pageSize in: query required: false description: The result page size. schema: type: integer minimum: 1 maximum: 250 - name: marker in: query required: false description: The marker for the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: isAscendingOrder in: query required: false description: Specifies the order for results. If True, the results are returned in ascending order, based on the creation date. schema: type: boolean summary: Amazon IoT Device Management List Outgoing Certificates x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /policies: get: operationId: ListPolicies description:Lists your policies.
Requires permission to access the ListPolicies action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListPoliciesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: marker in: query required: false description: The marker for the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: pageSize in: query required: false description: The result page size. schema: type: integer minimum: 1 maximum: 250 - name: isAscendingOrder in: query required: false description: Specifies the order for results. If true, the results are returned in ascending creation order. schema: type: boolean summary: Amazon IoT Device Management List Policies x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /policy-principals#x-amzn-iot-policy: get: deprecated: true operationId: ListPolicyPrincipals description:Lists the principals associated with the specified policy.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.
Requires permission to access the ListPolicyPrincipals action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListPolicyPrincipalsResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: x-amzn-iot-policy in: header required: true description: The policy name. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: marker in: query required: false description: The marker for the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: pageSize in: query required: false description: The result page size. schema: type: integer minimum: 1 maximum: 250 - name: isAscendingOrder in: query required: false description: Specifies the order for results. If true, the results are returned in ascending creation order. schema: type: boolean summary: Amazon IoT Device Management List Policy Principals x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /principal-policies#x-amzn-iot-principal: get: deprecated: true operationId: ListPrincipalPolicies description:Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.
Requires permission to access the ListPrincipalPolicies action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListPrincipalPoliciesResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: x-amzn-iot-principal in: header required: true description: The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id). schema: type: string - name: marker in: query required: false description: The marker for the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: pageSize in: query required: false description: The result page size. schema: type: integer minimum: 1 maximum: 250 - name: isAscendingOrder in: query required: false description: Specifies the order for results. If true, results are returned in ascending creation order. schema: type: boolean summary: Amazon IoT Device Management List Principal Policies x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /principals/things#x-amzn-principal: get: operationId: ListPrincipalThings description:Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListPrincipalThings action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListPrincipalThingsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return in this operation.
schema:
type: integer
minimum: 1
maximum: 250
- name: x-amzn-principal
in: header
required: true
description: The principal.
schema:
type: string
summary: Amazon IoT Device Management List Principal Things
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/audit/relatedResources#findingId:
get:
operationId: ListRelatedResourcesForAuditFinding
description: The related resources of an Audit finding. The following resources can be returned from calling this API:
DEVICE_CERTIFICATE
CA_CERTIFICATE
IOT_POLICY
COGNITO_IDENTITY_POOL
CLIENT_ID
ACCOUNT_SETTINGS
ROLE_ALIAS
IAM_ROLE
ISSUER_CERTIFICATE
This API is similar to DescribeAuditFinding's RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.
null if there are no additional results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT Device Management List Related Resources for Audit Finding
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/role-aliases:
get:
operationId: ListRoleAliases
description: Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListRoleAliasesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: pageSize in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 - name: marker in: query required: false description: A marker used to get the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: isAscendingOrder in: query required: false description: Return the list of role aliases in ascending alphabetical order. schema: type: boolean summary: Amazon IoT Device Management List Role Aliases x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /audit/scheduledaudits: get: operationId: ListScheduledAudits description:Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListScheduledAuditsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to return at one time. The default is 25. schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Device Management List Scheduled Audits x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /security-profiles: get: operationId: ListSecurityProfiles description:Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.
Requires permission to access the ListSecurityProfiles action.
dimensionName and metricName cannot be used in the same request.
metricName "
schema:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
- name: metricName
in: query
required: false
description: " The name of the custom metric. Cannot be used with dimensionName. "
schema:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
summary: Amazon IoT Device Management List Security Profiles
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/security-profiles-for-target#securityProfileTargetArn:
get:
operationId: ListSecurityProfilesForTarget
description: Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListSecurityProfilesForTargetResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 - name: recursive in: query required: false description: If true, return child groups too. schema: type: boolean - name: securityProfileTargetArn in: query required: true description: The ARN of the target (thing group) whose attached security profiles you want to get. schema: type: string summary: Amazon IoT Device Management List Security Profiles for Target x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /streams: get: operationId: ListStreams description:Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListStreamsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: maxResults in: query required: false description: The maximum number of results to return at a time. schema: type: integer minimum: 1 maximum: 250 - name: nextToken in: query required: false description: A token used to get the next set of results. schema: type: string - name: isAscendingOrder in: query required: false description: Set to true to return the list of streams in ascending order. schema: type: boolean summary: Amazon IoT Device Management List Streams x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /tags#resourceArn: get: operationId: ListTagsForResource description:Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: resourceArn in: query required: true description: The ARN of the resource. schema: type: string - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
summary: Amazon IoT Device Management List Tags for Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/policy-targets/{policyName}":
post:
operationId: ListTargetsForPolicy
description: List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTargetsForPolicyResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: policyName in: path required: true description: The policy name. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: marker in: query required: false description: A marker used to get the next set of results. schema: type: string pattern: "[A-Za-z0-9+/]+={0,2}" maxLength: 1024 - name: pageSize in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Device Management List Targets for Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/security-profiles/{securityProfileName}/targets": get: operationId: ListTargetsForSecurityProfile description:Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTargetsForSecurityProfileResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: securityProfileName in: path required: true description: The security profile. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Device Management List Targets for Security Profile x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /thing-groups: get: operationId: ListThingGroups description:List the thing groups in your account.
Requires permission to access the ListThingGroups action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListThingGroupsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
- name: parentGroup
in: query
required: false
description: A filter that limits the results to those with the specified parent group.
schema:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
- name: namePrefixFilter
in: query
required: false
description: A filter that limits the results to those with the specified name prefix.
schema:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
- name: recursive
in: query
required: false
description: If true, return child groups as well.
schema:
type: boolean
summary: Amazon IoT Device Management List Thing Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/things/{thingName}/thing-groups":
get:
operationId: ListThingGroupsForThing
description: List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListThingGroupsForThingResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: thingName in: path required: true description: The thing name. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT Device Management List Thing Groups for Thing
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/things/{thingName}/principals":
get:
operationId: ListThingPrincipals
description: Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListThingPrincipals action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListThingPrincipalsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return in this operation.
schema:
type: integer
minimum: 1
maximum: 250
- name: thingName
in: path
required: true
description: The name of the thing.
schema:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
summary: Amazon IoT Device Management List Thing Principals
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/thing-registration-tasks/{taskId}/reports#reportType":
get:
operationId: ListThingRegistrationTaskReports
description: Information about the thing registration tasks.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListThingRegistrationTaskReportsResponse"
"480":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
"481":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"482":
description: UnauthorizedException
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedException"
"483":
description: InternalFailureException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalFailureException"
parameters:
- name: taskId
in: path
required: true
description: The id of the task.
schema:
type: string
maxLength: 40
- name: reportType
in: query
required: true
description: The type of task report.
schema:
type: string
enum:
- ERRORS
- RESULTS
- name: nextToken
in: query
required: false
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return per request.
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT Device Management List Thing Registration Task Reports
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/thing-registration-tasks:
get:
operationId: ListThingRegistrationTasks
description: List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListThingRegistrationTasksResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
- name: status
in: query
required: false
description: The status of the bulk thing provisioning task.
schema:
type: string
enum:
- InProgress
- Completed
- Failed
- Cancelled
- Cancelling
summary: Amazon IoT Device Management List Thing Registration Tasks
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
operationId: StartThingRegistrationTask
description: Creates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartThingRegistrationTaskResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - templateBody - inputFileBucket - inputFileKey - roleArn properties: templateBody: description: The provisioning template. type: string pattern: "[\\s\\S]*" minLength: 0 maxLength: 10240 inputFileBucket: description: The S3 bucket that contains the input file. type: string pattern: "[a-zA-Z0-9._-]+" minLength: 3 maxLength: 256 inputFileKey: description: The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing). type: string pattern: "[a-zA-Z0-9!_.*'()-\\/]+" minLength: 1 maxLength: 1024 roleArn: description: The IAM role ARN that grants permission the input file. type: string minLength: 20 maxLength: 2048 summary: Amazon IoT Device Management Start Thing Registration Task x-microcks-operation: delay: 0 dispatcher: FALLBACK /thing-types: get: operationId: ListThingTypes description:Lists the existing thing types.
Requires permission to access the ListThingTypes action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListThingTypesResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return in this operation.
schema:
type: integer
minimum: 1
maximum: 250
- name: thingTypeName
in: query
required: false
description: The name of the thing type.
schema:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
summary: Amazon IoT Device Management List Thing Types
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/things:
get:
operationId: ListThings
description: Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color
and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. For more information, see List Things from the Amazon Web Services IoT Core Developer Guide.
Requires permission to access the ListThings action.
You
will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no
pagination token and no results were returned.
nextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return in this operation.
schema:
type: integer
minimum: 1
maximum: 250
- name: attributeName
in: query
required: false
description: The attribute name used to search for things.
schema:
type: string
pattern: "[a-zA-Z0-9_.,@/:#-]+"
maxLength: 128
- name: attributeValue
in: query
required: false
description: The attribute value used to search for things.
schema:
type: string
pattern: "[a-zA-Z0-9_.,@/:#-]*"
maxLength: 800
- name: thingTypeName
in: query
required: false
description: The name of the thing type used to search for things.
schema:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
- name: usePrefixAttributeValue
in: query
required: false
description: When true, the action returns the thing resources with attribute values that start with the attributeValue provided.
When false,
or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.
Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.
Requires permission to access the RegisterThing action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RegisterThingResponse" "480": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "481": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: ConflictingResourceUpdateException content: application/json: schema: $ref: "#/components/schemas/ConflictingResourceUpdateException" "486": description: ResourceRegistrationFailureException content: application/json: schema: $ref: "#/components/schemas/ResourceRegistrationFailureException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - templateBody properties: templateBody: description: The provisioning template. See Provisioning Devices That Have Device Certificates for more information. type: string pattern: "[\\s\\S]*" minLength: 0 maxLength: 10240 parameters: description: The parameters for provisioning a thing. See Provisioning Templates for more information. type: object additionalProperties: $ref: "#/components/schemas/Value" summary: Amazon IoT Device Management Register Thing x-microcks-operation: delay: 0 dispatcher: FALLBACK "/billing-groups/{billingGroupName}/things": get: operationId: ListThingsInBillingGroup description:Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListThingsInBillingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: billingGroupName in: path required: true description: The name of the billing group. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return per request.
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT Device Management List Things in Billing Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/thing-groups/{thingGroupName}/things":
get:
operationId: ListThingsInThingGroup
description: Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListThingsInThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: - name: thingGroupName in: path required: true description: The thing group name. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: recursive in: query required: false description: When true, list things in this thing group and in all child groups as well. schema: type: boolean - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT Device Management List Things in Thing Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/rules:
get:
operationId: ListTopicRules
description: Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTopicRulesResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: topic in: query required: false description: The topic. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to return. schema: type: integer minimum: 1 maximum: 10000 - name: nextToken in: query required: false description: To retrieve the next set of results, thenextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: ruleDisabled
in: query
required: false
description: Specifies whether the rule is disabled.
schema:
type: boolean
summary: Amazon IoT Device Management List Topic Rules
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/v2LoggingLevel:
get:
operationId: ListV2LoggingLevels
description: Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListV2LoggingLevelsResponse" "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: NotConfiguredException content: application/json: schema: $ref: "#/components/schemas/NotConfiguredException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" parameters: - name: targetType in: query required: false description: The type of resource for which you are configuring logging. Must beTHING_Group.
schema:
type: string
enum:
- DEFAULT
- THING_GROUP
- CLIENT_ID
- SOURCE_IP
- PRINCIPAL_ID
- name: nextToken
in: query
required: false
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT Device Management List V2 Logging Levels
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
operationId: SetV2LoggingLevel
description: Sets the logging level.
Requires permission to access the SetV2LoggingLevel action.
responses: "200": description: Success "480": description: InternalException content: application/json: schema: $ref: "#/components/schemas/InternalException" "481": description: NotConfiguredException content: application/json: schema: $ref: "#/components/schemas/NotConfiguredException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - logTarget - logLevel properties: logTarget: description: A log target. type: object properties: targetType: allOf: - $ref: "#/components/schemas/LogTargetType" - description: The target type. targetName: allOf: - $ref: "#/components/schemas/LogTargetName" - description: The target name. logLevel: description: The log level. type: string enum: - DEBUG - INFO - ERROR - WARN - DISABLED summary: Amazon IoT Device Management Set V2 Logging Level x-microcks-operation: delay: 0 dispatcher: FALLBACK /violation-events#startTime&endTime: get: operationId: ListViolationEvents description:Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
Requires permission to access the ListViolationEvents action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListViolationEventsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: startTime in: query required: true description: The start time for the alerts to be listed. schema: type: string format: date-time - name: endTime in: query required: true description: The end time for the alerts to be listed. schema: type: string format: date-time - name: thingName in: query required: false description: A filter to limit results to those alerts caused by the specified thing. schema: type: string minLength: 1 maxLength: 128 - name: securityProfileName in: query required: false description: A filter to limit results to those alerts generated by the specified security profile. schema: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 - name: behaviorCriteriaType in: query required: false description: " The criteria for a behavior. " schema: type: string enum: - STATIC - STATISTICAL - MACHINE_LEARNING - name: listSuppressedAlerts in: query required: false description: " A list of all suppressed alerts. " schema: type: boolean - name: verificationState in: query required: false description: The verification state of the violation (detect alarm). schema: type: string enum: - FALSE_POSITIVE - BENIGN_POSITIVE - TRUE_POSITIVE - UNKNOWN - name: nextToken in: query required: false description: The token for the next set of results. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to return at one time. schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Device Management List Violation Events x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/violations/verification-state/{violationId}": post: operationId: PutVerificationStateOnViolation description: Set a verification state and provide a description of that verification state on a violation (detect alarm). responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutVerificationStateOnViolationResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: violationId in: path required: true description: The violation ID. schema: type: string pattern: "[a-zA-Z0-9\\-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - verificationState properties: verificationState: description: The verification state of the violation. type: string enum: - FALSE_POSITIVE - BENIGN_POSITIVE - TRUE_POSITIVE - UNKNOWN verificationStateDescription: description: The description of the verification state of the violation (detect alarm). type: string pattern: "[^\\p{Cntrl}]*" maxLength: 1000 summary: Amazon IoT Device Management Put Verification State on Violation x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /cacertificate: post: operationId: RegisterCACertificate description:Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can
register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.
Requires permission to access the RegisterCACertificate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RegisterCACertificateResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "482": description: RegistrationCodeValidationException content: application/json: schema: $ref: "#/components/schemas/RegistrationCodeValidationException" "483": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "484": description: CertificateValidationException content: application/json: schema: $ref: "#/components/schemas/CertificateValidationException" "485": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" "487": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "488": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "489": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: setAsActive in: query required: false description: "A boolean value that specifies if the CA certificate is set to active.
Valid values: ACTIVE | INACTIVE
Metadata which can be used to manage the CA certificate.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
verificationCertificate field is not provided, set certificateMode
to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode
is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more
information about certificate mode for device certificates, see
certificate mode. '
type: string
enum:
- DEFAULT
- SNI_ONLY
summary: Amazon IoT Device Management Register C a Certificate
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/certificate/register:
post:
operationId: RegisterCertificate
description: Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
Requires permission to access the RegisterCertificate action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RegisterCertificateResponse" "480": description: ResourceAlreadyExistsException content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: CertificateValidationException content: application/json: schema: $ref: "#/components/schemas/CertificateValidationException" "483": description: CertificateStateException content: application/json: schema: $ref: "#/components/schemas/CertificateStateException" "484": description: CertificateConflictException content: application/json: schema: $ref: "#/components/schemas/CertificateConflictException" "485": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "486": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "487": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "488": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: setAsActive in: query required: false description: "A boolean value that specifies if the certificate is set to active.
Valid values: ACTIVE | INACTIVE
ACTIVE, INACTIVE, and REVOKED.
type: string
enum:
- ACTIVE
- INACTIVE
- REVOKED
- PENDING_TRANSFER
- REGISTER_INACTIVE
- PENDING_ACTIVATION
summary: Amazon IoT Device Management Register Certificate
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/certificate/register-no-ca:
post:
operationId: RegisterCertificateWithoutCA
description: 'Register a certificate that does not have a certificate authority (CA). For supported certificates, consult
Certificate signing algorithms supported by IoT. '
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/RegisterCertificateWithoutCAResponse"
"480":
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceAlreadyExistsException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
"482":
description: CertificateStateException
content:
application/json:
schema:
$ref: "#/components/schemas/CertificateStateException"
"483":
description: CertificateValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/CertificateValidationException"
"484":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"485":
description: UnauthorizedException
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedException"
"486":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
"487":
description: InternalFailureException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalFailureException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- certificatePem
properties:
certificatePem:
description: The PEM of a certificate.
type: string
pattern: "[\\s\\S]*"
minLength: 1
maxLength: 65536
status:
description: The status of the register certificate request.
type: string
enum:
- ACTIVE
- INACTIVE
- REVOKED
- PENDING_TRANSFER
- REGISTER_INACTIVE
- PENDING_ACTIVATION
summary: Amazon IoT Device Management Register Certificate Without C a
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/reject-certificate-transfer/{certificateId}":
patch:
operationId: RejectCertificateTransfer
description: Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
Requires permission to access the RejectCertificateTransfer action.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: TransferAlreadyCompletedException content: application/json: schema: $ref: "#/components/schemas/TransferAlreadyCompletedException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: certificateId in: path required: true description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 requestBody: required: true content: application/json: schema: type: object properties: rejectReason: description: The reason the certificate transfer was rejected. type: string pattern: "[\\s\\S]*" maxLength: 128 summary: Amazon IoT Device Management Reject Certificate Transfer x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /billing-groups/removeThingFromBillingGroup: put: operationId: RemoveThingFromBillingGroup description:Removes the given thing from the billing group.
Requires permission to access the RemoveThingFromBillingGroup action.
This call is asynchronous. It might take several seconds for the detachment to propagate.
Remove the specified thing from the specified group.
You must specify either a thingGroupArn or a thingGroupName to identify the thing group and
either a thingArn or a thingName to identify the thing to remove from the thing group.
Requires permission to access the RemoveThingFromThingGroup action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RemoveThingFromThingGroupResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: [] requestBody: required: true content: application/json: schema: type: object properties: thingGroupName: description: The group name. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 thingGroupArn: description: The group ARN. type: string thingName: description: The name of the thing to remove from the group. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 thingArn: description: The ARN of the thing to remove from the group. type: string summary: Amazon IoT Device Management Remove Thing from Thing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /indices/search: post: operationId: SearchIndex description:The query search index.
Requires permission to access the SearchIndex action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/SearchIndexResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "484": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "486": description: InvalidQueryException content: application/json: schema: $ref: "#/components/schemas/InvalidQueryException" "487": description: IndexNotReadyException content: application/json: schema: $ref: "#/components/schemas/IndexNotReadyException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - queryString properties: indexName: description: The search index name. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 queryString: description: The search query string. For more information about the search query syntax, see Query syntax. type: string minLength: 1 nextToken: description: The token used to get the next set of results, ornull if there are no additional results.
type: string
maxResults:
description: The maximum number of results to return at one time.
type: integer
minimum: 1
maximum: 500
queryVersion:
description: The query version.
type: string
summary: Amazon IoT Device Management Search Index
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/audit/tasks:
post:
operationId: StartOnDemandAuditTask
description: Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartOnDemandAuditTaskResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - targetCheckNames properties: targetCheckNames: description: Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. UseDescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which
checks are enabled.
type: array
items:
$ref: "#/components/schemas/AuditCheckName"
summary: Amazon IoT Device Management Start on Demand Audit Task
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/thing-registration-tasks/{taskId}/cancel":
put:
operationId: StopThingRegistrationTask
description: Cancels a bulk thing provisioning task.
Requires permission to access the StopThingRegistrationTask action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StopThingRegistrationTaskResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "484": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: taskId in: path required: true description: The bulk thing provisioning task ID. schema: type: string maxLength: 40 summary: Amazon IoT Device Management Stop Thing Registration Task x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /tags: post: operationId: TagResource description:Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
Requires permission to access the TagResource action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/TagResourceResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - resourceArn - tags properties: resourceArn: description: The ARN of the resource. type: string tags: description: The new or modified tags for the resource. type: array items: $ref: "#/components/schemas/Tag" summary: Amazon IoT Device Management Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /test-authorization: post: operationId: TestAuthorization description:Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestAuthorization action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/TestAuthorizationResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" parameters: - name: clientId in: query required: false description: The MQTT client ID. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - authInfos properties: principal: description: The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id). type: string cognitoIdentityPoolId: description: The Cognito identity pool ID. type: string authInfos: description: A list of authorization info objects. Simulating authorization will create a response for eachauthInfo object in the list.
type: array
items:
$ref: "#/components/schemas/AuthInfo"
minItems: 1
maxItems: 10
policyNamesToAdd:
description: When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
type: array
items:
$ref: "#/components/schemas/PolicyName"
policyNamesToSkip:
description: When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
type: array
items:
$ref: "#/components/schemas/PolicyName"
summary: Amazon IoT Device Management Test Authorization
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/authorizer/{authorizerName}/test":
post:
operationId: TestInvokeAuthorizer
description: Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestInvokeAuthorizer action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/TestInvokeAuthorizerResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "485": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "486": description: InvalidResponseException content: application/json: schema: $ref: "#/components/schemas/InvalidResponseException" parameters: - name: authorizerName in: path required: true description: The custom authorizer name. schema: type: string pattern: "[\\w=,@-]+" minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: token: description: The token returned by your custom authentication service. type: string pattern: "[\\s\\S]*" minLength: 1 maxLength: 6144 tokenSignature: description: The signature made with the token and your custom authentication service's private key. This value must be Base-64-encoded. type: string pattern: "[A-Za-z0-9+/]+={0,2}" minLength: 1 maxLength: 2560 httpContext: description: Specifies the HTTP context to use for the test authorizer request. type: object properties: headers: allOf: - $ref: "#/components/schemas/HttpHeaders" - description: The header keys and values in an HTTP authorization request. queryString: allOf: - $ref: "#/components/schemas/HttpQueryString" - description: The query string keys and values in an HTTP authorization request. mqttContext: description: Specifies the MQTT context to use for the test authorizer request type: object properties: username: allOf: - $ref: "#/components/schemas/MqttUsername" - description: The value of theusername key in an MQTT authorization request.
password:
allOf:
- $ref: "#/components/schemas/MqttPassword"
- description: The value of the password key in an MQTT authorization request.
clientId:
allOf:
- $ref: "#/components/schemas/MqttClientId"
- description: The value of the clientId key in an MQTT authorization request.
tlsContext:
description: Specifies the TLS context to use for the test authorizer request.
type: object
properties:
serverName:
allOf:
- $ref: "#/components/schemas/ServerName"
- description: The value of the serverName key in a TLS authorization request.
summary: Amazon IoT Device Management Test Invoke Authorizer
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/transfer-certificate/{certificateId}#targetAwsAccount":
patch:
operationId: TransferCertificate
description: Transfers the specified certificate to the specified Amazon Web Services account.
Requires permission to access the TransferCertificate action.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/TransferCertificateResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: CertificateStateException content: application/json: schema: $ref: "#/components/schemas/CertificateStateException" "483": description: TransferConflictException content: application/json: schema: $ref: "#/components/schemas/TransferConflictException" "484": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "485": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "486": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "487": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: certificateId in: path required: true description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 - name: targetAwsAccount in: query required: true description: The Amazon Web Services account. schema: type: string pattern: "[0-9]+" minLength: 12 maxLength: 12 requestBody: required: true content: application/json: schema: type: object properties: transferMessage: description: The transfer message. type: string pattern: "[\\s\\S]*" maxLength: 128 summary: Amazon IoT Device Management Transfer Certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /untag: post: operationId: UntagResource description:Removes the given tags (metadata) from the resource.
Requires permission to access the UntagResource action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UntagResourceResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - resourceArn - tagKeys properties: resourceArn: description: The ARN of the resource. type: string tagKeys: description: A list of the keys of the tags to be removed from the resource. type: array items: $ref: "#/components/schemas/TagKey" summary: Amazon IoT Device Management Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /audit/suppressions/update: patch: operationId: UpdateAuditSuppression description: " Updates a Device Defender audit suppression. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateAuditSuppressionResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "483": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - checkName - resourceIdentifier properties: checkName: description: An audit check name. Checks must be enabled for your account. (UseDescribeAccountAuditConfiguration to see the list of all checks, including those that are
enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
type: string
resourceIdentifier:
description: Information that identifies the noncompliant resource.
type: object
properties:
deviceCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the certificate attached to the resource.
caCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the CA certificate used to authorize the certificate.
cognitoIdentityPoolId:
allOf:
- $ref: "#/components/schemas/CognitoIdentityPoolId"
- description: The ID of the Amazon Cognito identity pool.
clientId:
allOf:
- $ref: "#/components/schemas/ClientId"
- description: The client ID.
policyVersionIdentifier:
allOf:
- $ref: "#/components/schemas/PolicyVersionIdentifier"
- description: The version of the policy associated with the resource.
account:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: The account with which the resource is associated.
iamRoleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the IAM role that has overly permissive actions.
roleAliasArn:
allOf:
- $ref: "#/components/schemas/RoleAliasArn"
- description: The ARN of the role alias that has overly permissive actions.
issuerCertificateIdentifier:
allOf:
- $ref: "#/components/schemas/IssuerCertificateIdentifier"
- description: The issuer certificate identifier.
deviceCertificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the identified device certificate.
expirationDate:
description: " The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to. "
type: string
format: date-time
suppressIndefinitely:
description: " Indicates whether a suppression should exist indefinitely or not. "
type: boolean
description:
description: " The description of the audit suppression. "
type: string
pattern: "[\\p{Graph}\\x20]*"
maxLength: 1000
summary: Amazon IoT Device Management Update Audit Suppression
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/certificates/{certificateId}#newStatus":
put:
operationId: UpdateCertificate
description: Updates the status of the specified certificate. This operation is idempotent.
Requires permission to access the UpdateCertificate action.
Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.
Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: CertificateStateException content: application/json: schema: $ref: "#/components/schemas/CertificateStateException" "482": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "483": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "484": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" "486": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: - name: certificateId in: path required: true description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) schema: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 - name: newStatus in: query required: true description:The new status.
Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by IoT. They are not intended for developer use.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
schema: type: string enum: - ACTIVE - INACTIVE - REVOKED - PENDING_TRANSFER - REGISTER_INACTIVE - PENDING_ACTIVATION summary: Amazon IoT Device Management Update Certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /thing-groups/updateThingGroupsForThing: put: operationId: UpdateThingGroupsForThing description:Updates the groups to which the thing belongs.
Requires permission to access the UpdateThingGroupsForThing action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateThingGroupsForThingResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: [] requestBody: required: true content: application/json: schema: type: object properties: thingName: description: The thing whose group memberships will be updated. type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 128 thingGroupsToAdd: description: The groups to which the thing will be added. type: array items: $ref: "#/components/schemas/ThingGroupName" thingGroupsToRemove: description: The groups from which the thing will be removed. type: array items: $ref: "#/components/schemas/ThingGroupName" overrideDynamicGroups: description: Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group. type: boolean summary: Amazon IoT Device Management Update Thing Groups for Thing x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /security-profile-behaviors/validate: post: operationId: ValidateSecurityProfileBehaviors description:Validates a Device Defender security profile behaviors specification.
Requires permission to access the ValidateSecurityProfileBehaviors action.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ValidateSecurityProfileBehaviorsResponse" "480": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "482": description: InternalFailureException content: application/json: schema: $ref: "#/components/schemas/InternalFailureException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - behaviors properties: behaviors: description: Specifies the behaviors that, when violated by a device (thing), cause an alert. type: array items: $ref: "#/components/schemas/Behavior" maxItems: 100 summary: Amazon IoT Device Management Validate Security Profile Behaviors x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: ResourceNotFoundException: {} TransferAlreadyCompletedException: {} InvalidRequestException: {} ThrottlingException: {} UnauthorizedException: {} ServiceUnavailableException: {} InternalFailureException: {} AddThingToBillingGroupResponse: type: object properties: {} AddThingToThingGroupResponse: type: object properties: {} AssociateTargetsWithJobResponse: type: object properties: jobArn: allOf: - $ref: "#/components/schemas/JobArn" - description: An ARN identifying the job. jobId: allOf: - $ref: "#/components/schemas/JobId" - description: The unique identifier you assigned to this job when it was created. description: allOf: - $ref: "#/components/schemas/JobDescription" - description: A short text description of the job. TargetArn: type: string maxLength: 2048 LimitExceededException: {} AttachSecurityProfileResponse: type: object properties: {} VersionConflictException: {} AttachThingPrincipalResponse: type: object properties: {} description: The output from the AttachThingPrincipal operation. CancelAuditMitigationActionsTaskResponse: type: object properties: {} CancelAuditTaskResponse: type: object properties: {} CancelDetectMitigationActionsTaskResponse: type: object properties: {} CancelJobResponse: type: object properties: jobArn: allOf: - $ref: "#/components/schemas/JobArn" - description: The job ARN. jobId: allOf: - $ref: "#/components/schemas/JobId" - description: The unique identifier you assigned to this job when it was created. description: allOf: - $ref: "#/components/schemas/JobDescription" - description: A short text description of the job. DetailsValue: type: string pattern: "[^\\p{C}]+" minLength: 1 InvalidStateTransitionException: {} ClearDefaultAuthorizerResponse: type: object properties: {} ConfirmTopicRuleDestinationResponse: type: object properties: {} InternalException: {} ConflictingResourceUpdateException: {} CreateAuditSuppressionResponse: type: object properties: {} CertificateId: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 CognitoIdentityPoolId: type: string ClientId: type: string PolicyVersionIdentifier: type: object properties: policyName: allOf: - $ref: "#/components/schemas/PolicyName" - description: The name of the policy. policyVersionId: allOf: - $ref: "#/components/schemas/PolicyVersionId" - description: The ID of the version of the policy associated with the resource. description: Information about the version of the policy associated with the resource. AwsAccountId: type: string pattern: "[0-9]+" minLength: 12 maxLength: 12 RoleArn: type: string minLength: 20 maxLength: 2048 RoleAliasArn: type: string minLength: 1 maxLength: 2048 IssuerCertificateIdentifier: type: object properties: issuerCertificateSubject: allOf: - $ref: "#/components/schemas/IssuerCertificateSubject" - description: The subject of the issuer certificate. issuerId: allOf: - $ref: "#/components/schemas/IssuerId" - description: The issuer ID. issuerCertificateSerialNumber: allOf: - $ref: "#/components/schemas/IssuerCertificateSerialNumber" - description: The issuer certificate serial number. description: The certificate issuer indentifier. CertificateArn: type: string ResourceAlreadyExistsException: {} CreateAuthorizerResponse: type: object properties: authorizerName: allOf: - $ref: "#/components/schemas/AuthorizerName" - description: The authorizer's name. authorizerArn: allOf: - $ref: "#/components/schemas/AuthorizerArn" - description: The authorizer ARN. KeyValue: type: string pattern: "[\\s\\S]*" maxLength: 5120 Tag: type: object required: - Key properties: Key: allOf: - $ref: "#/components/schemas/TagKey" - description: The tag's key. Value: allOf: - $ref: "#/components/schemas/TagValue" - description: The tag's value. description: A set of key/value pairs that are used to manage the resource. CreateBillingGroupResponse: type: object properties: billingGroupName: allOf: - $ref: "#/components/schemas/BillingGroupName" - description: The name you gave to the billing group. billingGroupArn: allOf: - $ref: "#/components/schemas/BillingGroupArn" - description: The ARN of the billing group. billingGroupId: allOf: - $ref: "#/components/schemas/BillingGroupId" - description: The ID of the billing group. BillingGroupDescription: type: string pattern: "[\\p{Graph}\\x20]*" maxLength: 2028 CreateCertificateFromCsrResponse: type: object properties: certificateArn: allOf: - $ref: "#/components/schemas/CertificateArn" - description: The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations. certificateId: allOf: - $ref: "#/components/schemas/CertificateId" - description: The ID of the certificate. Certificate management operations only take a certificateId. certificatePem: allOf: - $ref: "#/components/schemas/CertificatePem" - description: The certificate data, in PEM format. description: The output from the CreateCertificateFromCsr operation. CreateCustomMetricResponse: type: object properties: metricName: allOf: - $ref: "#/components/schemas/MetricName" - description: " The name of the custom metric to be used in the metric report. " metricArn: allOf: - $ref: "#/components/schemas/CustomMetricArn" - description: " The Amazon Resource Number (ARN) of the custom metric. For example,arn:aws-partition:iot:region:accountId:custommetric/metricName "
CreateDimensionResponse:
type: object
properties:
name:
allOf:
- $ref: "#/components/schemas/DimensionName"
- description: A unique identifier for the dimension.
arn:
allOf:
- $ref: "#/components/schemas/DimensionArn"
- description: The Amazon Resource Name (ARN) of the created dimension.
DimensionStringValue:
type: string
minLength: 1
maxLength: 256
CreateDomainConfigurationResponse:
type: object
properties:
domainConfigurationName:
allOf:
- $ref: "#/components/schemas/DomainConfigurationName"
- description: The name of the domain configuration.
domainConfigurationArn:
allOf:
- $ref: "#/components/schemas/DomainConfigurationArn"
- description: The ARN of the domain configuration.
AcmCertificateArn:
type: string
pattern: arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+
minLength: 1
maxLength: 2048
AuthorizerName:
type: string
pattern: "[\\w=,@-]+"
minLength: 1
maxLength: 128
AllowAuthorizerOverride:
type: boolean
CertificateValidationException: {}
CreateDynamicThingGroupResponse:
type: object
properties:
thingGroupName:
allOf:
- $ref: "#/components/schemas/ThingGroupName"
- description: The dynamic thing group name.
thingGroupArn:
allOf:
- $ref: "#/components/schemas/ThingGroupArn"
- description: The dynamic thing group ARN.
thingGroupId:
allOf:
- $ref: "#/components/schemas/ThingGroupId"
- description: The dynamic thing group ID.
indexName:
allOf:
- $ref: "#/components/schemas/IndexName"
- description: The dynamic thing group index name.
queryString:
allOf:
- $ref: "#/components/schemas/QueryString"
- description: The dynamic thing group search query string.
queryVersion:
allOf:
- $ref: "#/components/schemas/QueryVersion"
- description: The dynamic thing group query version.
ThingGroupDescription:
type: string
pattern: "[\\p{Graph}\\x20]*"
maxLength: 2028
AttributePayload:
type: object
properties:
attributes:
allOf:
- $ref: "#/components/schemas/Attributes"
- description: A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting
them.
To remove an attribute, call UpdateThing with an empty attribute value.
The merge attribute is only valid when calling
UpdateThing or UpdateThingGroup.
The exponential factor to increase the rate of rollout for a job.
Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).
rateIncreaseCriteria: allOf: - $ref: "#/components/schemas/RateIncreaseCriteria" - description: The criteria to initiate the increase in rate of rollout for a job. description: Allows you to create an exponential rate of rollout for a job. AbortCriteriaList: type: array items: $ref: "#/components/schemas/AbortCriteria" minItems: 1 InProgressTimeoutInMinutes: type: integer RetryCriteriaList: type: array items: $ref: "#/components/schemas/RetryCriteria" minItems: 1 maxItems: 2 ParameterValue: type: string pattern: "[^\\p{C}]+" minLength: 1 maxLength: 512 StringDateTime: type: string minLength: 1 maxLength: 64 JobEndBehavior: type: string enum: - STOP_ROLLOUT - CANCEL - FORCE_CANCEL MaintenanceWindows: type: array items: $ref: "#/components/schemas/MaintenanceWindow" CreateJobTemplateResponse: type: object properties: jobTemplateArn: allOf: - $ref: "#/components/schemas/JobTemplateArn" - description: The ARN of the job template. jobTemplateId: allOf: - $ref: "#/components/schemas/JobTemplateId" - description: The unique identifier of the job template. MaintenanceWindow: type: object required: - startTime - durationInMinutes properties: startTime: allOf: - $ref: "#/components/schemas/CronExpression" - description: Displays the start time of the next maintenance window. durationInMinutes: allOf: - $ref: "#/components/schemas/DurationInMinutes" - description: Displays the duration of the next maintenance window. description: An optional configuration within theSchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job
document to all devices in a target group for a job.
ConflictException: {}
CreateKeysAndCertificateResponse:
type: object
properties:
certificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the certificate.
certificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the certificate. IoT issues a default subject name for the certificate (for example, IoT Certificate).
certificatePem:
allOf:
- $ref: "#/components/schemas/CertificatePem"
- description: The certificate data, in PEM format.
keyPair:
allOf:
- $ref: "#/components/schemas/KeyPair"
- description: The generated key pair.
description: The output of the CreateKeysAndCertificate operation.
CreateMitigationActionResponse:
type: object
properties:
actionArn:
allOf:
- $ref: "#/components/schemas/MitigationActionArn"
- description: The ARN for the new mitigation action.
actionId:
allOf:
- $ref: "#/components/schemas/MitigationActionId"
- description: A unique identifier for the new mitigation action.
UpdateDeviceCertificateParams:
type: object
required:
- action
properties:
action:
allOf:
- $ref: "#/components/schemas/DeviceCertificateUpdateAction"
- description: The action that you want to apply to the device certificate. The only supported value is DEACTIVATE.
description: Parameters to define a mitigation action that changes the state of the device certificate to inactive.
UpdateCACertificateParams:
type: object
required:
- action
properties:
action:
allOf:
- $ref: "#/components/schemas/CACertificateUpdateAction"
- description: The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE.
description: Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
AddThingsToThingGroupParams:
type: object
required:
- thingGroupNames
properties:
thingGroupNames:
allOf:
- $ref: "#/components/schemas/ThingGroupNames"
- description: The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can't add a thing to more
than one group in the same hierarchy.
overrideDynamicGroups:
allOf:
- $ref: "#/components/schemas/NullableBoolean"
- description: Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.
description: Parameters used when defining a mitigation action that move a set of things to a thing group.
ReplaceDefaultPolicyVersionParams:
type: object
required:
- templateName
properties:
templateName:
allOf:
- $ref: "#/components/schemas/PolicyTemplateName"
- description: The name of the template to be applied. The only supported value is BLANK_POLICY.
description: Parameters to define a mitigation action that adds a blank policy to restrict permissions.
EnableIoTLoggingParams:
type: object
required:
- roleArnForLogging
- logLevel
properties:
roleArnForLogging:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The Amazon Resource Name (ARN) of the IAM role used for logging.
logLevel:
allOf:
- $ref: "#/components/schemas/LogLevel"
- description: Specifies the type of information to be logged.
description: Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.
PublishFindingToSnsParams:
type: object
required:
- topicArn
properties:
topicArn:
allOf:
- $ref: "#/components/schemas/SnsTopicArn"
- description: The ARN of the topic to which you want to publish the findings.
description: Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.
CreateOTAUpdateResponse:
type: object
properties:
otaUpdateId:
allOf:
- $ref: "#/components/schemas/OTAUpdateId"
- description: The OTA update ID.
awsIotJobId:
allOf:
- $ref: "#/components/schemas/AwsIotJobId"
- description: The IoT job ID associated with the OTA update.
otaUpdateArn:
allOf:
- $ref: "#/components/schemas/OTAUpdateArn"
- description: The OTA update ARN.
awsIotJobArn:
allOf:
- $ref: "#/components/schemas/AwsIotJobArn"
- description: The IoT job ARN associated with the OTA update.
otaUpdateStatus:
allOf:
- $ref: "#/components/schemas/OTAUpdateStatus"
- description: The OTA update status.
Target:
type: string
Protocol:
type: string
enum:
- MQTT
- HTTP
MaximumPerMinute:
type: integer
minimum: 1
maximum: 1000
AwsJobExponentialRolloutRate:
type: object
required:
- baseRatePerMinute
- incrementFactor
- rateIncreaseCriteria
properties:
baseRatePerMinute:
allOf:
- $ref: "#/components/schemas/AwsJobRolloutRatePerMinute"
- description: The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout.
incrementFactor:
allOf:
- $ref: "#/components/schemas/AwsJobRolloutIncrementFactor"
- description: The rate of increase for a job rollout. The number of things notified is multiplied by this factor.
rateIncreaseCriteria:
allOf:
- $ref: "#/components/schemas/AwsJobRateIncreaseCriteria"
- description: The criteria to initiate the increase in rate of rollout for a job.
Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).
description: The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout. ExpiresInSeconds: type: integer AwsJobAbortCriteriaList: type: array items: $ref: "#/components/schemas/AwsJobAbortCriteria" minItems: 1 AwsJobTimeoutInProgressTimeoutInMinutes: type: integer OTAUpdateFile: type: object properties: fileName: allOf: - $ref: "#/components/schemas/FileName" - description: The name of the file. fileType: allOf: - $ref: "#/components/schemas/FileType" - description: An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud. fileVersion: allOf: - $ref: "#/components/schemas/OTAUpdateFileVersion" - description: The file version. fileLocation: allOf: - $ref: "#/components/schemas/FileLocation" - description: The location of the updated firmware. codeSigning: allOf: - $ref: "#/components/schemas/CodeSigning" - description: The code signing method of the file. attributes: allOf: - $ref: "#/components/schemas/AttributesMap" - description: A list of name/attribute pairs. description: Describes a file to be associated with an OTA update. Value: type: string pattern: "[\\s\\S]*" minLength: 0 maxLength: 4096 CreatePolicyResponse: type: object properties: policyName: allOf: - $ref: "#/components/schemas/PolicyName" - description: The policy name. policyArn: allOf: - $ref: "#/components/schemas/PolicyArn" - description: The policy ARN. policyDocument: allOf: - $ref: "#/components/schemas/PolicyDocument" - description: The JSON document that describes the policy. policyVersionId: allOf: - $ref: "#/components/schemas/PolicyVersionId" - description: The policy version ID. description: The output from the CreatePolicy operation. MalformedPolicyException: {} CreatePolicyVersionResponse: type: object properties: policyArn: allOf: - $ref: "#/components/schemas/PolicyArn" - description: The policy ARN. policyDocument: allOf: - $ref: "#/components/schemas/PolicyDocument" - description: The JSON document that describes the policy. policyVersionId: allOf: - $ref: "#/components/schemas/PolicyVersionId" - description: The policy version ID. isDefaultVersion: allOf: - $ref: "#/components/schemas/IsDefaultVersion" - description: Specifies whether the policy version is the default. description: The output of the CreatePolicyVersion operation. VersionsLimitExceededException: {} CreateProvisioningClaimResponse: type: object properties: certificateId: allOf: - $ref: "#/components/schemas/CertificateId" - description: The ID of the certificate. certificatePem: allOf: - $ref: "#/components/schemas/CertificatePem" - description: The provisioning claim certificate. keyPair: allOf: - $ref: "#/components/schemas/KeyPair" - description: The provisioning claim key pair. expiration: allOf: - $ref: "#/components/schemas/DateType" - description: The provisioning claim expiration time. CreateProvisioningTemplateResponse: type: object properties: templateArn: allOf: - $ref: "#/components/schemas/TemplateArn" - description: The ARN that identifies the provisioning template. templateName: allOf: - $ref: "#/components/schemas/TemplateName" - description: The name of the provisioning template. defaultVersionId: allOf: - $ref: "#/components/schemas/TemplateVersionId" - description: The default version of the provisioning template. PayloadVersion: type: string pattern: ^[0-9-]+$ minLength: 10 maxLength: 32 CreateProvisioningTemplateVersionResponse: type: object properties: templateArn: allOf: - $ref: "#/components/schemas/TemplateArn" - description: The ARN that identifies the provisioning template. templateName: allOf: - $ref: "#/components/schemas/TemplateName" - description: The name of the provisioning template. versionId: allOf: - $ref: "#/components/schemas/TemplateVersionId" - description: The version of the provisioning template. isDefaultVersion: allOf: - $ref: "#/components/schemas/IsDefaultVersion" - description: True if the provisioning template version is the default version, otherwise false. CreateRoleAliasResponse: type: object properties: roleAlias: allOf: - $ref: "#/components/schemas/RoleAlias" - description: The role alias. roleAliasArn: allOf: - $ref: "#/components/schemas/RoleAliasArn" - description: The role alias ARN. CreateScheduledAuditResponse: type: object properties: scheduledAuditArn: allOf: - $ref: "#/components/schemas/ScheduledAuditArn" - description: The ARN of the scheduled audit. AuditCheckName: type: string description: An audit check name. Checks must be enabled for your account. (UseDescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or
use UpdateAccountAuditConfiguration to select which checks are enabled.)
CreateSecurityProfileResponse:
type: object
properties:
securityProfileName:
allOf:
- $ref: "#/components/schemas/SecurityProfileName"
- description: The name you gave to the security profile.
securityProfileArn:
allOf:
- $ref: "#/components/schemas/SecurityProfileArn"
- description: The ARN of the security profile.
Behavior:
type: object
required:
- name
properties:
name:
allOf:
- $ref: "#/components/schemas/BehaviorName"
- description: The name you've given to the behavior.
metric:
allOf:
- $ref: "#/components/schemas/BehaviorMetric"
- description: What is measured by the behavior.
metricDimension:
allOf:
- $ref: "#/components/schemas/MetricDimension"
- description: The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where
the name matches the pattern specified in the dimension. This can't be used with custom metrics.
criteria:
allOf:
- $ref: "#/components/schemas/BehaviorCriteria"
- description: The criteria that determine if a device is behaving normally in regard to the metric.
suppressAlerts:
allOf:
- $ref: "#/components/schemas/SuppressAlerts"
- description: " Suppresses alerts. "
description: A Device Defender security profile behavior.
AlertTarget:
type: object
required:
- alertTargetArn
- roleArn
properties:
alertTargetArn:
allOf:
- $ref: "#/components/schemas/AlertTargetArn"
- description: The Amazon Resource Name (ARN) of the notification target to which alerts are sent.
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the role that grants permission to send alerts to the notification target.
description: A structure containing the alert target ARN and the role ARN.
BehaviorMetric:
type: string
MetricToRetain:
type: object
required:
- metric
properties:
metric:
allOf:
- $ref: "#/components/schemas/BehaviorMetric"
- description: What is measured by the behavior.
metricDimension:
allOf:
- $ref: "#/components/schemas/MetricDimension"
- description: The dimension of a metric. This can't be used with custom metrics.
description: The metric you want to retain. Dimensions are optional.
CreateStreamResponse:
type: object
properties:
streamId:
allOf:
- $ref: "#/components/schemas/StreamId"
- description: The stream ID.
streamArn:
allOf:
- $ref: "#/components/schemas/StreamArn"
- description: The stream ARN.
description:
allOf:
- $ref: "#/components/schemas/StreamDescription"
- description: A description of the stream.
streamVersion:
allOf:
- $ref: "#/components/schemas/StreamVersion"
- description: The version of the stream.
StreamFile:
type: object
properties:
fileId:
allOf:
- $ref: "#/components/schemas/FileId"
- description: The file ID.
s3Location:
allOf:
- $ref: "#/components/schemas/S3Location"
- description: The location of the file in S3.
description: Represents a file to stream.
CreateThingResponse:
type: object
properties:
thingName:
allOf:
- $ref: "#/components/schemas/ThingName"
- description: The name of the new thing.
thingArn:
allOf:
- $ref: "#/components/schemas/ThingArn"
- description: The ARN of the new thing.
thingId:
allOf:
- $ref: "#/components/schemas/ThingId"
- description: The thing ID.
description: The output of the CreateThing operation.
Attributes:
type: object
additionalProperties:
$ref: "#/components/schemas/AttributeValue"
Flag:
type: boolean
CreateThingGroupResponse:
type: object
properties:
thingGroupName:
allOf:
- $ref: "#/components/schemas/ThingGroupName"
- description: The thing group name.
thingGroupArn:
allOf:
- $ref: "#/components/schemas/ThingGroupArn"
- description: The thing group ARN.
thingGroupId:
allOf:
- $ref: "#/components/schemas/ThingGroupId"
- description: The thing group ID.
CreateThingTypeResponse:
type: object
properties:
thingTypeName:
allOf:
- $ref: "#/components/schemas/ThingTypeName"
- description: The name of the thing type.
thingTypeArn:
allOf:
- $ref: "#/components/schemas/ThingTypeArn"
- description: The Amazon Resource Name (ARN) of the thing type.
thingTypeId:
allOf:
- $ref: "#/components/schemas/ThingTypeId"
- description: The thing type ID.
description: The output of the CreateThingType operation.
ThingTypeDescription:
type: string
pattern: "[\\p{Graph}\\x20]*"
maxLength: 2028
SearchableAttributes:
type: array
items:
$ref: "#/components/schemas/AttributeName"
SQL:
type: string
Description:
type: string
ActionList:
type: array
items:
$ref: "#/components/schemas/Action"
minItems: 0
maxItems: 10
IsDisabled:
type: boolean
AwsIotSqlVersion:
type: string
Action:
type: object
properties:
dynamoDB:
allOf:
- $ref: "#/components/schemas/DynamoDBAction"
- description: Write to a DynamoDB table.
dynamoDBv2:
allOf:
- $ref: "#/components/schemas/DynamoDBv2Action"
- description: Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
lambda:
allOf:
- $ref: "#/components/schemas/LambdaAction"
- description: Invoke a Lambda function.
sns:
allOf:
- $ref: "#/components/schemas/SnsAction"
- description: Publish to an Amazon SNS topic.
sqs:
allOf:
- $ref: "#/components/schemas/SqsAction"
- description: Publish to an Amazon SQS queue.
kinesis:
allOf:
- $ref: "#/components/schemas/KinesisAction"
- description: Write data to an Amazon Kinesis stream.
republish:
allOf:
- $ref: "#/components/schemas/RepublishAction"
- description: Publish to another MQTT topic.
s3:
allOf:
- $ref: "#/components/schemas/S3Action"
- description: Write to an Amazon S3 bucket.
firehose:
allOf:
- $ref: "#/components/schemas/FirehoseAction"
- description: Write to an Amazon Kinesis Firehose stream.
cloudwatchMetric:
allOf:
- $ref: "#/components/schemas/CloudwatchMetricAction"
- description: Capture a CloudWatch metric.
cloudwatchAlarm:
allOf:
- $ref: "#/components/schemas/CloudwatchAlarmAction"
- description: Change the state of a CloudWatch alarm.
cloudwatchLogs:
allOf:
- $ref: "#/components/schemas/CloudwatchLogsAction"
- description: Send data to CloudWatch Logs.
elasticsearch:
allOf:
- $ref: "#/components/schemas/ElasticsearchAction"
- description: Write data to an Amazon OpenSearch Service domain.
The Elasticsearch action can only be used by existing rule actions. To create a new rule
action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.
The ARN of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
On the first call to UpdateAccountAuditConfiguration, this parameter is required.
The type of the custom metric.
The type number only takes a single metric value as an input, but while submitting the metrics value in the
DeviceMetrics report, it must be passed as an array with a single value.
Contains a value that specifies the type of indexing performed. Valid values are:
REGISTRY – Your thing index contains only registry data.
REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.
REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.
MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.
AWS-Reboot.
templateArn:
allOf:
- $ref: "#/components/schemas/JobTemplateArn"
- description: The unique Amazon Resource Name (ARN) of the managed template.
description:
allOf:
- $ref: "#/components/schemas/JobDescription"
- description: The unique description of a managed template.
templateVersion:
allOf:
- $ref: "#/components/schemas/ManagedTemplateVersion"
- description: The version for a managed template.
environments:
allOf:
- $ref: "#/components/schemas/Environments"
- description: A list of environments that are supported with the managed job template.
documentParameters:
allOf:
- $ref: "#/components/schemas/DocumentParameters"
- description: A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.
documentParameters can
only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.
FLEET_PROVISIONING.
For more information about provisioning template, see: Provisioning template. "
DescribeProvisioningTemplateVersionResponse:
type: object
properties:
versionId:
allOf:
- $ref: "#/components/schemas/TemplateVersionId"
- description: The provisioning template version ID.
creationDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date when the provisioning template version was created.
templateBody:
allOf:
- $ref: "#/components/schemas/TemplateBody"
- description: The JSON formatted contents of the provisioning template version.
isDefaultVersion:
allOf:
- $ref: "#/components/schemas/IsDefaultVersion"
- description: True if the provisioning template version is the default version.
DescribeRoleAliasResponse:
type: object
properties:
roleAliasDescription:
allOf:
- $ref: "#/components/schemas/RoleAliasDescription"
- description: The role alias description.
DescribeScheduledAuditResponse:
type: object
properties:
frequency:
allOf:
- $ref: "#/components/schemas/AuditFrequency"
- description: How often the scheduled audit takes place, either one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit
is determined by the system.
dayOfMonth:
allOf:
- $ref: "#/components/schemas/DayOfMonth"
- description: The day of the month on which the scheduled audit takes place. This is will be 1 through 31 or LAST. If days
29-31 are specified, and the month does not have that many days, the audit takes place on the LAST day of the month.
dayOfWeek:
allOf:
- $ref: "#/components/schemas/DayOfWeek"
- description: The day of the week on which the scheduled audit takes place, either one of SUN, MON, TUE, WED, THU,
FRI, or SAT.
targetCheckNames:
allOf:
- $ref: "#/components/schemas/TargetAuditCheckNames"
- description: Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all
checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
scheduledAuditName:
allOf:
- $ref: "#/components/schemas/ScheduledAuditName"
- description: The name of the scheduled audit.
scheduledAuditArn:
allOf:
- $ref: "#/components/schemas/ScheduledAuditArn"
- description: The ARN of the scheduled audit.
DescribeSecurityProfileResponse:
type: object
properties:
securityProfileName:
allOf:
- $ref: "#/components/schemas/SecurityProfileName"
- description: The name of the security profile.
securityProfileArn:
allOf:
- $ref: "#/components/schemas/SecurityProfileArn"
- description: The ARN of the security profile.
securityProfileDescription:
allOf:
- $ref: "#/components/schemas/SecurityProfileDescription"
- description: A description of the security profile (associated with the security profile when it was created or updated).
behaviors:
allOf:
- $ref: "#/components/schemas/Behaviors"
- description: Specifies the behaviors that, when violated by a device (thing), cause an alert.
alertTargets:
allOf:
- $ref: "#/components/schemas/AlertTargets"
- description: Where the alerts are sent. (Alerts are always sent to the console.)
additionalMetricsToRetain:
allOf:
- $ref: "#/components/schemas/AdditionalMetricsToRetainList"
- deprecated: true
description: Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default, data
is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.
This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
thingName: allOf: - $ref: "#/components/schemas/ThingName" - description: The name of the thing. thingId: allOf: - $ref: "#/components/schemas/ThingId" - description: The ID of the thing to describe. thingArn: allOf: - $ref: "#/components/schemas/ThingArn" - description: The ARN of the thing to describe. thingTypeName: allOf: - $ref: "#/components/schemas/ThingTypeName" - description: The thing type name. attributes: allOf: - $ref: "#/components/schemas/Attributes" - description: The thing attributes. version: allOf: - $ref: "#/components/schemas/Version" - description:The current version of the thing record in the registry.
To avoid unintentional changes to the information in the registry, you can pass the version
information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.
null if there are no additional results. "
GetBucketsAggregationResponse:
type: object
properties:
totalCount:
allOf:
- $ref: "#/components/schemas/Count"
- description: The total number of things that fit the query string criteria.
buckets:
allOf:
- $ref: "#/components/schemas/Buckets"
- description: "The main part of the response with a list of buckets. Each bucket contains a keyValue and a count.
keyValue: The aggregation field
value counted for the particular bucket.
count: The number of documents that have that value.
null if there are no additional results.
ListAttachedPoliciesResponse:
type: object
properties:
policies:
allOf:
- $ref: "#/components/schemas/Policies"
- description: The policies.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The token to retrieve the next set of results, or ``null`` if there are no more results.
ListAuditFindingsResponse:
type: object
properties:
findings:
allOf:
- $ref: "#/components/schemas/AuditFindings"
- description: The findings (results) of the audit.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null if there are no additional results.
ListAuditMitigationActionsExecutionsResponse:
type: object
properties:
actionsExecutions:
allOf:
- $ref: "#/components/schemas/AuditMitigationActionExecutionMetadataList"
- description: A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token for the next set of results.
ListAuditMitigationActionsTasksResponse:
type: object
properties:
tasks:
allOf:
- $ref: "#/components/schemas/AuditMitigationActionsTaskMetadataList"
- description: The collection of audit mitigation tasks that matched the filter criteria.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token for the next set of results.
ListAuditSuppressionsResponse:
type: object
properties:
suppressions:
allOf:
- $ref: "#/components/schemas/AuditSuppressionList"
- description: " List of audit suppressions. "
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: " A token that can be used to retrieve the next set of results, or null if there are no additional results. "
ListAuditTasksResponse:
type: object
properties:
tasks:
allOf:
- $ref: "#/components/schemas/AuditTaskMetadataList"
- description: The audits that were performed during the specified time period.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null if there are no additional results.
ListAuthorizersResponse:
type: object
properties:
authorizers:
allOf:
- $ref: "#/components/schemas/Authorizers"
- description: The authorizers.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: A marker used to get the next set of results.
ListBillingGroupsResponse:
type: object
properties:
billingGroups:
allOf:
- $ref: "#/components/schemas/BillingGroupNameAndArnList"
- description: The list of billing groups.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
ListCACertificatesResponse:
type: object
properties:
certificates:
allOf:
- $ref: "#/components/schemas/CACertificates"
- description: The CA certificates registered in your Amazon Web Services account.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The current position within the list of CA certificates.
description: The output from the ListCACertificates operation.
ListCertificatesResponse:
type: object
properties:
certificates:
allOf:
- $ref: "#/components/schemas/Certificates"
- description: The descriptions of the certificates.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The marker for the next set of results, or null if there are no additional results.
description: The output of the ListCertificates operation.
ListCertificatesByCAResponse:
type: object
properties:
certificates:
allOf:
- $ref: "#/components/schemas/Certificates"
- description: The device certificates signed by the specified CA certificate.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The marker for the next set of results, or null if there are no additional results.
description: The output of the ListCertificatesByCA operation.
ListCustomMetricsResponse:
type: object
properties:
metricNames:
allOf:
- $ref: "#/components/schemas/MetricNames"
- description: " The name of the custom metric. "
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: " A token that can be used to retrieve the next set of results, or null if there are no additional results. "
ListDetectMitigationActionsExecutionsResponse:
type: object
properties:
actionsExecutions:
allOf:
- $ref: "#/components/schemas/DetectMitigationActionExecutionList"
- description: " List of actions executions. "
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: " A token that can be used to retrieve the next set of results, or null if there are no additional results. "
ListDetectMitigationActionsTasksResponse:
type: object
properties:
tasks:
allOf:
- $ref: "#/components/schemas/DetectMitigationActionsTaskSummaryList"
- description: " The collection of ML Detect mitigation tasks that matched the filter criteria. "
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: " A token that can be used to retrieve the next set of results, or null if there are no additional results. "
ListDimensionsResponse:
type: object
properties:
dimensionNames:
allOf:
- $ref: "#/components/schemas/DimensionNames"
- description: A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null if there are no additional results.
ListDomainConfigurationsResponse:
type: object
properties:
domainConfigurations:
allOf:
- $ref: "#/components/schemas/DomainConfigurations"
- description: A list of objects that contain summary information about the user's domain configurations.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The marker for the next set of results.
ListFleetMetricsResponse:
type: object
properties:
fleetMetrics:
allOf:
- $ref: "#/components/schemas/FleetMetricNameAndArnList"
- description: The list of fleet metrics objects.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token for the next set of results. Will not be returned if the operation has returned all results.
ListIndicesResponse:
type: object
properties:
indexNames:
allOf:
- $ref: "#/components/schemas/IndexNamesList"
- description: The index names.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token used to get the next set of results, or null if there are no additional results.
ListJobExecutionsForJobResponse:
type: object
properties:
executionSummaries:
allOf:
- $ref: "#/components/schemas/JobExecutionSummaryForJobList"
- description: A list of job execution summaries.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token for the next set of results, or null if there are no additional results.
ListJobExecutionsForThingResponse:
type: object
properties:
executionSummaries:
allOf:
- $ref: "#/components/schemas/JobExecutionSummaryForThingList"
- description: A list of job execution summaries.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token for the next set of results, or null if there are no additional results.
ListJobTemplatesResponse:
type: object
properties:
jobTemplates:
allOf:
- $ref: "#/components/schemas/JobTemplateSummaryList"
- description: A list of objects that contain information about the job templates.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token for the next set of results, or null if there are no additional results.
ListJobsResponse:
type: object
properties:
jobs:
allOf:
- $ref: "#/components/schemas/JobSummaryList"
- description: A list of jobs.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token for the next set of results, or null if there are no additional results.
ListManagedJobTemplatesResponse:
type: object
properties:
managedJobTemplates:
allOf:
- $ref: "#/components/schemas/ManagedJobTemplatesSummaryList"
- description: A list of managed job templates that are returned.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to retrieve the next set of results.
ListMetricValuesResponse:
type: object
properties:
metricDatumList:
allOf:
- $ref: "#/components/schemas/MetricDatumList"
- description: The data the thing reports for the metric during the specified time period.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null if there are no additional results.
ListMitigationActionsResponse:
type: object
properties:
actionIdentifiers:
allOf:
- $ref: "#/components/schemas/MitigationActionIdentifierList"
- description: A set of actions that matched the specified filter criteria.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token for the next set of results.
ListOTAUpdatesResponse:
type: object
properties:
otaUpdates:
allOf:
- $ref: "#/components/schemas/OTAUpdatesSummary"
- description: A list of OTA update jobs.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token to use to get the next set of results.
ListOutgoingCertificatesResponse:
type: object
properties:
outgoingCertificates:
allOf:
- $ref: "#/components/schemas/OutgoingCertificates"
- description: The certificates that are being transferred but not yet accepted.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The marker for the next set of results.
description: The output from the ListOutgoingCertificates operation.
ListPoliciesResponse:
type: object
properties:
policies:
allOf:
- $ref: "#/components/schemas/Policies"
- description: The descriptions of the policies.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The marker for the next set of results, or null if there are no additional results.
description: The output from the ListPolicies operation.
ListPolicyPrincipalsResponse:
type: object
properties:
principals:
allOf:
- $ref: "#/components/schemas/Principals"
- description: The descriptions of the principals.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The marker for the next set of results, or null if there are no additional results.
description: The output from the ListPolicyPrincipals operation.
ListPolicyVersionsResponse:
type: object
properties:
policyVersions:
allOf:
- $ref: "#/components/schemas/PolicyVersions"
- description: The policy versions.
description: The output from the ListPolicyVersions operation.
ListPrincipalPoliciesResponse:
type: object
properties:
policies:
allOf:
- $ref: "#/components/schemas/Policies"
- description: The policies.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The marker for the next set of results, or null if there are no additional results.
description: The output from the ListPrincipalPolicies operation.
ListPrincipalThingsResponse:
type: object
properties:
things:
allOf:
- $ref: "#/components/schemas/ThingNameList"
- description: The things.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
description: The output from the ListPrincipalThings operation.
ListProvisioningTemplateVersionsResponse:
type: object
properties:
versions:
allOf:
- $ref: "#/components/schemas/ProvisioningTemplateVersionListing"
- description: The list of provisioning template versions.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token to retrieve the next set of results.
ListProvisioningTemplatesResponse:
type: object
properties:
templates:
allOf:
- $ref: "#/components/schemas/ProvisioningTemplateListing"
- description: A list of provisioning templates
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token to retrieve the next set of results.
ListRelatedResourcesForAuditFindingResponse:
type: object
properties:
relatedResources:
allOf:
- $ref: "#/components/schemas/RelatedResources"
- description: The related resources.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null for the first API call.
ListRoleAliasesResponse:
type: object
properties:
roleAliases:
allOf:
- $ref: "#/components/schemas/RoleAliases"
- description: The role aliases.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: A marker used to get the next set of results.
ListScheduledAuditsResponse:
type: object
properties:
scheduledAudits:
allOf:
- $ref: "#/components/schemas/ScheduledAuditMetadataList"
- description: The list of scheduled audits.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null if there are no additional results.
ListSecurityProfilesResponse:
type: object
properties:
securityProfileIdentifiers:
allOf:
- $ref: "#/components/schemas/SecurityProfileIdentifiers"
- description: A list of security profile identifiers (names and ARNs).
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null if there are no additional results.
ListSecurityProfilesForTargetResponse:
type: object
properties:
securityProfileTargetMappings:
allOf:
- $ref: "#/components/schemas/SecurityProfileTargetMappings"
- description: A list of security profiles and their associated targets.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null if there are no additional results.
ListStreamsResponse:
type: object
properties:
streams:
allOf:
- $ref: "#/components/schemas/StreamsSummary"
- description: A list of streams.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token used to get the next set of results.
ListTagsForResourceResponse:
type: object
properties:
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: The list of tags assigned to the resource.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
ListTargetsForPolicyResponse:
type: object
properties:
targets:
allOf:
- $ref: "#/components/schemas/PolicyTargets"
- description: The policy targets.
nextMarker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: A marker used to get the next set of results.
ListTargetsForSecurityProfileResponse:
type: object
properties:
securityProfileTargets:
allOf:
- $ref: "#/components/schemas/SecurityProfileTargets"
- description: The thing groups to which the security profile is attached.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null if there are no additional results.
ListThingGroupsResponse:
type: object
properties:
thingGroups:
allOf:
- $ref: "#/components/schemas/ThingGroupNameAndArnList"
- description: The thing groups.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results. Will not be returned if operation has returned all results.
ListThingGroupsForThingResponse:
type: object
properties:
thingGroups:
allOf:
- $ref: "#/components/schemas/ThingGroupNameAndArnList"
- description: The thing groups.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
ListThingPrincipalsResponse:
type: object
properties:
principals:
allOf:
- $ref: "#/components/schemas/Principals"
- description: The principals associated with the thing.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
description: The output from the ListThingPrincipals operation.
ListThingRegistrationTaskReportsResponse:
type: object
properties:
resourceLinks:
allOf:
- $ref: "#/components/schemas/S3FileUrlList"
- description: Links to the task resources.
reportType:
allOf:
- $ref: "#/components/schemas/ReportType"
- description: The type of task report.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
ListThingRegistrationTasksResponse:
type: object
properties:
taskIds:
allOf:
- $ref: "#/components/schemas/TaskIdList"
- description: A list of bulk thing provisioning task IDs.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
ListThingTypesResponse:
type: object
properties:
thingTypes:
allOf:
- $ref: "#/components/schemas/ThingTypeList"
- description: The thing types.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token for the next set of results. Will not be returned if operation has returned all results.
description: The output for the ListThingTypes operation.
ListThingsResponse:
type: object
properties:
things:
allOf:
- $ref: "#/components/schemas/ThingAttributeList"
- description: The things.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results. Will not be returned if operation has returned all results.
description: The output from the ListThings operation.
ListThingsInBillingGroupResponse:
type: object
properties:
things:
allOf:
- $ref: "#/components/schemas/ThingNameList"
- description: A list of things in the billing group.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results. Will not be returned if operation has returned all results.
ListThingsInThingGroupResponse:
type: object
properties:
things:
allOf:
- $ref: "#/components/schemas/ThingNameList"
- description: The things in the specified thing group.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
ListTopicRuleDestinationsResponse:
type: object
properties:
destinationSummaries:
allOf:
- $ref: "#/components/schemas/TopicRuleDestinationSummaries"
- description: Information about a topic rule destination.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
ListTopicRulesResponse:
type: object
properties:
rules:
allOf:
- $ref: "#/components/schemas/TopicRuleList"
- description: The rules.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
description: The output from the ListTopicRules operation.
ListV2LoggingLevelsResponse:
type: object
properties:
logTargetConfigurations:
allOf:
- $ref: "#/components/schemas/LogTargetConfigurations"
- description: The logging configuration for a target.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token to use to get the next set of results, or null if there are no additional results.
ListViolationEventsResponse:
type: object
properties:
violationEvents:
allOf:
- $ref: "#/components/schemas/ViolationEvents"
- description: The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device)
violating.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: A token that can be used to retrieve the next set of results, or null if there are no additional results.
PutVerificationStateOnViolationResponse:
type: object
properties: {}
RegisterCACertificateResponse:
type: object
properties:
certificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The CA certificate ARN.
certificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The CA certificate identifier.
description: The output from the RegisterCACertificateResponse operation.
TemplateBody:
type: string
pattern: "[\\s\\S]*"
minLength: 0
maxLength: 10240
TemplateName:
type: string
pattern: ^[0-9A-Za-z_-]+$
minLength: 1
maxLength: 36
RegistrationCodeValidationException: {}
RegisterCertificateResponse:
type: object
properties:
certificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The certificate ARN.
certificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The certificate identifier.
description: The output from the RegisterCertificate operation.
CertificateConflictException: {}
RegisterCertificateWithoutCAResponse:
type: object
properties:
certificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The Amazon Resource Name (ARN) of the registered certificate.
certificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the registered certificate. (The last part of the certificate ARN contains the certificate ID.
RegisterThingResponse:
type: object
properties:
certificatePem:
allOf:
- $ref: "#/components/schemas/CertificatePem"
- description: The certificate data, in PEM format.
resourceArns:
allOf:
- $ref: "#/components/schemas/ResourceArns"
- description: ARNs for the generated resources.
ResourceRegistrationFailureException: {}
RemoveThingFromBillingGroupResponse:
type: object
properties: {}
RemoveThingFromThingGroupResponse:
type: object
properties: {}
SearchIndexResponse:
type: object
properties:
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token used to get the next set of results, or null if there are no additional results.
things:
allOf:
- $ref: "#/components/schemas/ThingDocumentList"
- description: The things that match the search query.
thingGroups:
allOf:
- $ref: "#/components/schemas/ThingGroupDocumentList"
- description: The thing groups that match the search query.
SetDefaultAuthorizerResponse:
type: object
properties:
authorizerName:
allOf:
- $ref: "#/components/schemas/AuthorizerName"
- description: The authorizer name.
authorizerArn:
allOf:
- $ref: "#/components/schemas/AuthorizerArn"
- description: The authorizer ARN.
AwsArn:
type: string
LogLevel:
type: string
enum:
- DEBUG
- INFO
- ERROR
- WARN
- DISABLED
LogTargetType:
type: string
enum:
- DEFAULT
- THING_GROUP
- CLIENT_ID
- SOURCE_IP
- PRINCIPAL_ID
LogTargetName:
type: string
StartAuditMitigationActionsTaskResponse:
type: object
properties:
taskId:
allOf:
- $ref: "#/components/schemas/MitigationActionsTaskId"
- description: The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.
AuditTaskId:
type: string
pattern: "[a-zA-Z0-9\\-]+"
minLength: 1
maxLength: 40
FindingIds:
type: array
items:
$ref: "#/components/schemas/FindingId"
minItems: 1
maxItems: 25
AuditCheckToReasonCodeFilter:
type: object
additionalProperties:
$ref: "#/components/schemas/ReasonForNonComplianceCodes"
MitigationActionNameList:
type: array
items:
$ref: "#/components/schemas/MitigationActionName"
minItems: 1
maxItems: 5
TaskAlreadyExistsException: {}
StartDetectMitigationActionsTaskResponse:
type: object
properties:
taskId:
allOf:
- $ref: "#/components/schemas/MitigationActionsTaskId"
- description: " The unique identifier of the task. "
TargetViolationIdsForDetectMitigationActions:
type: array
items:
$ref: "#/components/schemas/ViolationId"
minItems: 1
maxItems: 25
SecurityProfileName:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
BehaviorName:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
MitigationActionName:
type: string
pattern: "[a-zA-Z0-9_-]+"
maxLength: 128
Timestamp:
type: string
format: date-time
StartOnDemandAuditTaskResponse:
type: object
properties:
taskId:
allOf:
- $ref: "#/components/schemas/AuditTaskId"
- description: The ID of the on-demand audit you started.
StartThingRegistrationTaskResponse:
type: object
properties:
taskId:
allOf:
- $ref: "#/components/schemas/TaskId"
- description: The bulk thing provisioning task ID.
StopThingRegistrationTaskResponse:
type: object
properties: {}
TagResourceResponse:
type: object
properties: {}
TestAuthorizationResponse:
type: object
properties:
authResults:
allOf:
- $ref: "#/components/schemas/AuthResults"
- description: The authentication results.
AuthInfo:
type: object
required:
- resources
properties:
actionType:
allOf:
- $ref: "#/components/schemas/ActionType"
- description: The type of action for which the principal is being authorized.
resources:
allOf:
- $ref: "#/components/schemas/Resources"
- description: The resources for which the principal is being authorized to perform the specified action.
description: A collection of authorization information.
PolicyName:
type: string
pattern: "[\\w+=,.@-]+"
minLength: 1
maxLength: 128
TestInvokeAuthorizerResponse:
type: object
properties:
isAuthenticated:
allOf:
- $ref: "#/components/schemas/IsAuthenticated"
- description: True if the token is authenticated, otherwise false.
principalId:
allOf:
- $ref: "#/components/schemas/PrincipalId"
- description: The principal ID.
policyDocuments:
allOf:
- $ref: "#/components/schemas/PolicyDocuments"
- description: IAM policy documents.
refreshAfterInSeconds:
allOf:
- $ref: "#/components/schemas/Seconds"
- description: The number of seconds after which the temporary credentials are refreshed.
disconnectAfterInSeconds:
allOf:
- $ref: "#/components/schemas/Seconds"
- description: The number of seconds after which the connection is terminated.
HttpHeaders:
type: object
additionalProperties:
$ref: "#/components/schemas/HttpHeaderValue"
HttpQueryString:
type: string
pattern: "[\\s\\S]*"
minLength: 1
maxLength: 4096
MqttUsername:
type: string
pattern: "[\\s\\S]*"
minLength: 1
maxLength: 65535
MqttPassword:
type: string
minLength: 1
maxLength: 65535
MqttClientId:
type: string
pattern: "[\\s\\S]*"
minLength: 1
maxLength: 65535
ServerName:
type: string
pattern: "[\\s\\S]*"
minLength: 1
maxLength: 253
InvalidResponseException: {}
TransferCertificateResponse:
type: object
properties:
transferredCertificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the certificate.
description: The output from the TransferCertificate operation.
TransferConflictException: {}
UntagResourceResponse:
type: object
properties: {}
TagKey:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
minLength: 1
maxLength: 128
UpdateAccountAuditConfigurationResponse:
type: object
properties: {}
AuditNotificationTarget:
type: object
properties:
targetArn:
allOf:
- $ref: "#/components/schemas/TargetArn"
- description: The ARN of the target (SNS topic) to which audit notifications are sent.
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the role that grants permission to send notifications to the target.
enabled:
allOf:
- $ref: "#/components/schemas/Enabled"
- description: True if notifications to the target are enabled.
description: Information about the targets to which audit notifications are sent.
AuditCheckConfiguration:
type: object
properties:
enabled:
allOf:
- $ref: "#/components/schemas/Enabled"
- description: True if this audit check is enabled for this account.
description: Which audit checks are enabled and disabled for this account.
UpdateAuditSuppressionResponse:
type: object
properties: {}
UpdateAuthorizerResponse:
type: object
properties:
authorizerName:
allOf:
- $ref: "#/components/schemas/AuthorizerName"
- description: The authorizer name.
authorizerArn:
allOf:
- $ref: "#/components/schemas/AuthorizerArn"
- description: The authorizer ARN.
UpdateBillingGroupResponse:
type: object
properties:
version:
allOf:
- $ref: "#/components/schemas/Version"
- description: The latest version of the billing group.
UpdateCustomMetricResponse:
type: object
properties:
metricName:
allOf:
- $ref: "#/components/schemas/MetricName"
- description: " The name of the custom metric. "
metricArn:
allOf:
- $ref: "#/components/schemas/CustomMetricArn"
- description: " The Amazon Resource Number (ARN) of the custom metric. "
metricType:
allOf:
- $ref: "#/components/schemas/CustomMetricType"
- description: The type of the custom metric.
The type number only takes a single metric value as an input, but while submitting the metrics value in the
DeviceMetrics report, it must be passed as an array with a single value.
namedShadowIndexingMode to be ON and specify your shadow names in filter.
ThingGroupIndexingMode:
type: string
enum:
- OFF
- ON
UpdateMitigationActionResponse:
type: object
properties:
actionArn:
allOf:
- $ref: "#/components/schemas/MitigationActionArn"
- description: The ARN for the new mitigation action.
actionId:
allOf:
- $ref: "#/components/schemas/MitigationActionId"
- description: A unique identifier for the mitigation action.
UpdateProvisioningTemplateResponse:
type: object
properties: {}
UpdateRoleAliasResponse:
type: object
properties:
roleAlias:
allOf:
- $ref: "#/components/schemas/RoleAlias"
- description: The role alias.
roleAliasArn:
allOf:
- $ref: "#/components/schemas/RoleAliasArn"
- description: The role alias ARN.
UpdateScheduledAuditResponse:
type: object
properties:
scheduledAuditArn:
allOf:
- $ref: "#/components/schemas/ScheduledAuditArn"
- description: The ARN of the scheduled audit.
UpdateSecurityProfileResponse:
type: object
properties:
securityProfileName:
allOf:
- $ref: "#/components/schemas/SecurityProfileName"
- description: The name of the security profile that was updated.
securityProfileArn:
allOf:
- $ref: "#/components/schemas/SecurityProfileArn"
- description: The ARN of the security profile that was updated.
securityProfileDescription:
allOf:
- $ref: "#/components/schemas/SecurityProfileDescription"
- description: The description of the security profile.
behaviors:
allOf:
- $ref: "#/components/schemas/Behaviors"
- description: Specifies the behaviors that, when violated by a device (thing), cause an alert.
alertTargets:
allOf:
- $ref: "#/components/schemas/AlertTargets"
- description: Where the alerts are sent. (Alerts are always sent to the console.)
additionalMetricsToRetain:
allOf:
- $ref: "#/components/schemas/AdditionalMetricsToRetainList"
- deprecated: true
description: Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default, data is
retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.
The minimum percentage of job execution failures that must occur to initiate the job abort.
Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
minNumberOfExecutedThings: allOf: - $ref: "#/components/schemas/MinimumNumberOfExecutedThings" - description: The minimum number of things which must receive job execution notifications before the job can be aborted. description: The criteria that determine when and how a job abort takes place. SetAsActive: type: boolean AcceptCertificateTransferRequest: type: object title: AcceptCertificateTransferRequest properties: {} description: The input for the AcceptCertificateTransfer operation. DynamoDBAction: type: object required: - tableName - roleArn - hashKeyField - hashKeyValue properties: tableName: allOf: - $ref: "#/components/schemas/TableName" - description: The name of the DynamoDB table. roleArn: allOf: - $ref: "#/components/schemas/AwsArn" - description: The ARN of the IAM role that grants access to the DynamoDB table. operation: allOf: - $ref: "#/components/schemas/DynamoOperation" - description: "The type of operation to be performed. This follows the substitution template, so it can be${operation}, but the substitution must result in one of the following:
INSERT, UPDATE, or DELETE."
hashKeyField:
allOf:
- $ref: "#/components/schemas/HashKeyField"
- description: The hash key name.
hashKeyValue:
allOf:
- $ref: "#/components/schemas/HashKeyValue"
- description: The hash key value.
hashKeyType:
allOf:
- $ref: "#/components/schemas/DynamoKeyType"
- description: The hash key type. Valid values are "STRING" or "NUMBER"
rangeKeyField:
allOf:
- $ref: "#/components/schemas/RangeKeyField"
- description: The range key name.
rangeKeyValue:
allOf:
- $ref: "#/components/schemas/RangeKeyValue"
- description: The range key value.
rangeKeyType:
allOf:
- $ref: "#/components/schemas/DynamoKeyType"
- description: The range key type. Valid values are "STRING" or "NUMBER"
payloadField:
allOf:
- $ref: "#/components/schemas/PayloadField"
- description: The action payload. This name can be customized.
description: 'Describes an action to write to a DynamoDB table.
The tableName, hashKeyField, and rangeKeyField values must match the values used when
you created the table.
The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows:
${sql-expression}.
You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:
"hashKeyValue": "${topic(3)}"
The following field uses the timestamp:
"rangeKeyValue": "${timestamp()}"
Specifies the DynamoDB table to which the message data will be written. For example:
{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName":
"my-table" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
' description:Describes an action to write to a DynamoDB table.
This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.
LambdaAction: type: object required: - functionArn properties: functionArn: allOf: - $ref: "#/components/schemas/FunctionArn" - description: The ARN of the Lambda function. description: Describes an action to invoke a Lambda function. SnsAction: type: object required: - targetArn - roleArn properties: targetArn: allOf: - $ref: "#/components/schemas/AwsArn" - description: The ARN of the SNS topic. roleArn: allOf: - $ref: "#/components/schemas/AwsArn" - description: The ARN of the IAM role that grants access. messageFormat: allOf: - $ref: "#/components/schemas/MessageFormat" - description: (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation. description: Describes an action to publish to an Amazon SNS topic. SqsAction: type: object required: - roleArn - queueUrl properties: roleArn: allOf: - $ref: "#/components/schemas/AwsArn" - description: The ARN of the IAM role that grants access. queueUrl: allOf: - $ref: "#/components/schemas/QueueUrl" - description: The URL of the Amazon SQS queue. useBase64: allOf: - $ref: "#/components/schemas/UseBase64" - description: Specifies whether to use Base64 encoding. description: Describes an action to publish data to an Amazon SQS queue. KinesisAction: type: object required: - roleArn - streamName properties: roleArn: allOf: - $ref: "#/components/schemas/AwsArn" - description: The ARN of the IAM role that grants access to the Amazon Kinesis stream. streamName: allOf: - $ref: "#/components/schemas/StreamName" - description: The name of the Amazon Kinesis stream. partitionKey: allOf: - $ref: "#/components/schemas/PartitionKey" - description: The partition key. description: Describes an action to write data to an Amazon Kinesis stream. RepublishAction: type: object required: - roleArn - topic properties: roleArn: allOf: - $ref: "#/components/schemas/AwsArn" - description: The ARN of the IAM role that grants access. topic: allOf: - $ref: "#/components/schemas/TopicPattern" - description: The name of the MQTT topic. qos: allOf: - $ref: "#/components/schemas/Qos" - description: The Quality of Service (QoS) level to use when republishing messages. The default value is 0. headers: allOf: - $ref: "#/components/schemas/MqttHeaders" - description: MQTT Version 5.0 headers information. For more information, see MQTT from the Amazon Web Services IoT Core Developer Guide. description: Describes an action to republish to another topic. S3Action: type: object required: - roleArn - bucketName - key properties: roleArn: allOf: - $ref: "#/components/schemas/AwsArn" - description: The ARN of the IAM role that grants access. bucketName: allOf: - $ref: "#/components/schemas/BucketName" - description: The Amazon S3 bucket. key: allOf: - $ref: "#/components/schemas/Key" - description: The object key. For more information, see Actions, resources, and condition keys for Amazon S3. cannedAcl: allOf: - $ref: "#/components/schemas/CannedAccessControlList" - description: The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs. description: Describes an action to write data to an Amazon S3 bucket. FirehoseAction: type: object required: - roleArn - deliveryStreamName properties: roleArn: allOf: - $ref: "#/components/schemas/AwsArn" - description: The IAM role that grants access to the Amazon Kinesis Firehose stream. deliveryStreamName: allOf: - $ref: "#/components/schemas/DeliveryStreamName" - description: The delivery stream name. separator: allOf: - $ref: "#/components/schemas/FirehoseSeparator" - description: "A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)." batchMode: allOf: - $ref: "#/components/schemas/BatchMode" - description:Whether to deliver the Kinesis Data Firehose stream as a batch by using
PutRecordBatch . The default value is false.
When batchMode is true and the rule's SQL statement evaluates to an Array,
each Array element forms one record in the PutRecordBatch request. The
resulting array can't have more than 500 records.
true or false (default).
description: Describes an action that sends data to CloudWatch Logs.
ElasticsearchAction:
type: object
required:
- roleArn
- endpoint
- index
- type
- id
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/AwsArn"
- description: The IAM role ARN that has access to OpenSearch.
endpoint:
allOf:
- $ref: "#/components/schemas/ElasticsearchEndpoint"
- description: The endpoint of your OpenSearch domain.
index:
allOf:
- $ref: "#/components/schemas/ElasticsearchIndex"
- description: The index where you want to store your data.
type:
allOf:
- $ref: "#/components/schemas/ElasticsearchType"
- description: The type of document you are storing.
id:
allOf:
- $ref: "#/components/schemas/ElasticsearchId"
- description: The unique identifier for the document you are storing.
description: Describes an action that writes data to an Amazon OpenSearch Service domain.
The Elasticsearch action can only be used by existing rule actions. To
create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.
Whether to process the action as a batch. The default value is false.
When batchMode is true and the rule SQL statement
evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the IoT Analytics channel. The resulting array can't
have more than 100 messages.
The ID of the message. The default messageId is a new UUID value.
When batchMode is true, you can't specify a
messageId--a new UUID value will be assigned.
Assign a value to this property to ensure that only one input (message) with a given messageId will be
processed by an IoT Events detector.
Whether to process the event actions as a batch. The default value is false.
When batchMode is true, you can't specify a
messageId.
When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message
when it's sent to IoT Events by calling BatchPutMessage .
The resulting array can't have more than 10 messages.
"Action": "iotsitewise:BatchPutAssetPropertyValue"). The trust policy
can restrict access to specific asset hierarchy paths.'
description: Describes an action to send data from an MQTT message that triggered the rule to IoT SiteWise asset properties.
StepFunctionsAction:
type: object
required:
- stateMachineName
- roleArn
properties:
executionNamePrefix:
allOf:
- $ref: "#/components/schemas/ExecutionNamePrefix"
- description: (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state
machine execution if one is not provided.
stateMachineName:
allOf:
- $ref: "#/components/schemas/StateMachineName"
- description: The name of the Step Functions state machine whose execution will be started.
roleArn:
allOf:
- $ref: "#/components/schemas/AwsArn"
- description: The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
description: Starts execution of a Step Functions state machine.
TimestreamAction:
type: object
required:
- roleArn
- databaseName
- tableName
- dimensions
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/AwsArn"
- description: The ARN of the role that grants permission to write to the Amazon Timestream database table.
databaseName:
allOf:
- $ref: "#/components/schemas/TimestreamDatabaseName"
- description: The name of an Amazon Timestream database.
tableName:
allOf:
- $ref: "#/components/schemas/TimestreamTableName"
- description: The name of the database table into which to write the measure records.
dimensions:
allOf:
- $ref: "#/components/schemas/TimestreamDimensionList"
- description: Metadata attributes of the time series that are written in each measure record.
timestamp:
allOf:
- $ref: "#/components/schemas/TimestreamTimestamp"
- description: Specifies an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column.
You can use this property to specify the value and the precision of the Timestream record's timestamp. You can specify a value from the message payload or a value computed by a substitution template.
If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it processed the rule.
description: The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation. HttpAction: type: object required: - url properties: url: allOf: - $ref: "#/components/schemas/Url" - description: The endpoint URL. If substitution templates are used in the URL, you must also specify aconfirmationUrl. If this is a new destination, a new
TopicRuleDestination is created if possible.
confirmationUrl:
allOf:
- $ref: "#/components/schemas/Url"
- description: The URL to which IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses
the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of
the substitution template before traffic is allowed to your endpoint URL.
headers:
allOf:
- $ref: "#/components/schemas/HeaderList"
- description: The HTTP headers to send with the message data.
auth:
allOf:
- $ref: "#/components/schemas/HttpAuthorization"
- description: The authentication method to use when sending data to an HTTPS endpoint.
description: Send data to an HTTPS endpoint.
KafkaAction:
type: object
required:
- destinationArn
- topic
- clientProperties
properties:
destinationArn:
allOf:
- $ref: "#/components/schemas/AwsArn"
- description: The ARN of Kafka action's VPC TopicRuleDestination.
topic:
allOf:
- $ref: "#/components/schemas/String"
- description: The Kafka topic for messages to be sent to the Kafka broker.
key:
allOf:
- $ref: "#/components/schemas/String"
- description: The Kafka message key.
partition:
allOf:
- $ref: "#/components/schemas/String"
- description: The Kafka message partition.
clientProperties:
allOf:
- $ref: "#/components/schemas/ClientProperties"
- description: Properties of the Apache Kafka producer client.
description: Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
OpenSearchAction:
type: object
required:
- roleArn
- endpoint
- index
- type
- id
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/AwsArn"
- description: The IAM role ARN that has access to OpenSearch.
endpoint:
allOf:
- $ref: "#/components/schemas/ElasticsearchEndpoint"
- description: The endpoint of your OpenSearch domain.
index:
allOf:
- $ref: "#/components/schemas/ElasticsearchIndex"
- description: The OpenSearch index where you want to store your data.
type:
allOf:
- $ref: "#/components/schemas/ElasticsearchType"
- description: The type of document you are storing.
id:
allOf:
- $ref: "#/components/schemas/ElasticsearchId"
- description: The unique identifier for the document you are storing.
description: Describes an action that writes data to an Amazon OpenSearch Service domain.
LocationAction:
type: object
required:
- roleArn
- trackerName
- deviceId
- latitude
- longitude
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/AwsArn"
- description: The IAM role that grants permission to write to the Amazon Location resource.
trackerName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the tracker resource in Amazon Location in which the location is updated.
deviceId:
allOf:
- $ref: "#/components/schemas/String"
- description: The unique ID of the device providing the location data.
timestamp:
allOf:
- $ref: "#/components/schemas/LocationTimestamp"
- description: The time that the location data was sampled. The default value is the time the MQTT message was processed.
latitude:
allOf:
- $ref: "#/components/schemas/String"
- description: A string that evaluates to a double value that represents the latitude of the device's location.
longitude:
allOf:
- $ref: "#/components/schemas/String"
- description: A string that evaluates to a double value that represents the longitude of the device's location.
description: The Amazon Location rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.
ActionType:
type: string
enum:
- PUBLISH
- SUBSCRIBE
- RECEIVE
- CONNECT
ViolationId:
type: string
pattern: "[a-zA-Z0-9\\-]+"
minLength: 1
maxLength: 128
DeviceDefenderThingName:
type: string
minLength: 1
maxLength: 128
MetricValue:
type: object
properties:
count:
allOf:
- $ref: "#/components/schemas/UnsignedLong"
- description: If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.
cidrs:
allOf:
- $ref: "#/components/schemas/Cidrs"
- description: If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
ports:
allOf:
- $ref: "#/components/schemas/Ports"
- description: If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
number:
allOf:
- $ref: "#/components/schemas/Number"
- description: " The numeral value of a metric. "
numbers:
allOf:
- $ref: "#/components/schemas/NumberList"
- description: " The numeral values of a metric. "
strings:
allOf:
- $ref: "#/components/schemas/StringList"
- description: " The string values of a metric. "
description: The value to be compared with the metric.
ViolationEventAdditionalInfo:
type: object
properties:
confidenceLevel:
allOf:
- $ref: "#/components/schemas/ConfidenceLevel"
- description: " The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High. "
description: " The details of a violation event. "
VerificationState:
type: string
enum:
- FALSE_POSITIVE
- BENIGN_POSITIVE
- TRUE_POSITIVE
- UNKNOWN
VerificationStateDescription:
type: string
pattern: "[^\\p{Cntrl}]*"
maxLength: 1000
ActiveViolation:
type: object
properties:
violationId:
allOf:
- $ref: "#/components/schemas/ViolationId"
- description: The ID of the active violation.
thingName:
allOf:
- $ref: "#/components/schemas/DeviceDefenderThingName"
- description: The name of the thing responsible for the active violation.
securityProfileName:
allOf:
- $ref: "#/components/schemas/SecurityProfileName"
- description: The security profile with the behavior is in violation.
behavior:
allOf:
- $ref: "#/components/schemas/Behavior"
- description: The behavior that is being violated.
lastViolationValue:
allOf:
- $ref: "#/components/schemas/MetricValue"
- description: The value of the metric (the measurement) that caused the most recent violation.
violationEventAdditionalInfo:
allOf:
- $ref: "#/components/schemas/ViolationEventAdditionalInfo"
- description: " The details of a violation event. "
verificationState:
allOf:
- $ref: "#/components/schemas/VerificationState"
- description: The verification state of the violation (detect alarm).
verificationStateDescription:
allOf:
- $ref: "#/components/schemas/VerificationStateDescription"
- description: The description of the verification state of the violation.
lastViolationTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The time the most recent violation occurred.
violationStartTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The time the violation started.
description: Information about an active Device Defender security profile behavior violation.
ActiveViolations:
type: array
items:
$ref: "#/components/schemas/ActiveViolation"
BillingGroupName:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
BillingGroupArn:
type: string
ThingName:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
ThingArn:
type: string
AddThingToBillingGroupRequest:
type: object
title: AddThingToBillingGroupRequest
properties:
billingGroupName:
allOf:
- $ref: "#/components/schemas/BillingGroupName"
- description: The name of the billing group.
This call is asynchronous. It might take several seconds for the detachment to propagate.
true or false) of the value entry. Accepts substitution templates.
description: Contains an asset property value (of a single type).
AssetPropertyValue:
type: object
required:
- value
- timestamp
properties:
value:
allOf:
- $ref: "#/components/schemas/AssetPropertyVariant"
- description: The value of the asset property.
timestamp:
allOf:
- $ref: "#/components/schemas/AssetPropertyTimestamp"
- description: The asset property value timestamp.
quality:
allOf:
- $ref: "#/components/schemas/AssetPropertyQuality"
- description: Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD, BAD, or UNCERTAIN.
description: An asset property value entry containing the following information.
AssetPropertyValueList:
type: array
items:
$ref: "#/components/schemas/AssetPropertyValue"
minItems: 1
JobTargets:
type: array
items:
$ref: "#/components/schemas/TargetArn"
minItems: 1
JobId:
type: string
pattern: "[a-zA-Z0-9_-]+"
minLength: 1
maxLength: 64
Comment:
type: string
pattern: "[^\\p{C}]+"
maxLength: 2028
NamespaceId:
type: string
pattern: "[a-zA-Z0-9_-]+"
AssociateTargetsWithJobRequest:
type: object
required:
- targets
title: AssociateTargetsWithJobRequest
properties:
targets:
allOf:
- $ref: "#/components/schemas/JobTargets"
- description: A list of thing group ARNs that define the targets of the job.
comment:
allOf:
- $ref: "#/components/schemas/Comment"
- description: An optional comment string describing why the job was associated with the targets.
JobArn:
type: string
JobDescription:
type: string
pattern: "[^\\p{C}]+"
maxLength: 2028
PolicyTarget:
type: string
AttachPolicyRequest:
type: object
required:
- target
title: AttachPolicyRequest
properties:
target:
allOf:
- $ref: "#/components/schemas/PolicyTarget"
- description: The identity to which the policy is attached. For example, a thing group or a
certificate.
Principal:
type: string
AttachPrincipalPolicyRequest:
type: object
title: AttachPrincipalPolicyRequest
properties: {}
description: The input for the AttachPrincipalPolicy operation.
SecurityProfileTargetArn:
type: string
AttachSecurityProfileRequest:
type: object
title: AttachSecurityProfileRequest
properties: {}
AttachThingPrincipalRequest:
type: object
title: AttachThingPrincipalRequest
properties: {}
description: The input for the AttachThingPrincipal operation.
AttributeKey:
type: string
AttributeName:
type: string
pattern: "[a-zA-Z0-9_.,@/:#-]+"
maxLength: 128
AttributeValue:
type: string
pattern: "[a-zA-Z0-9_.,@/:#-]*"
maxLength: 800
AttributesMap:
type: object
additionalProperties:
$ref: "#/components/schemas/Value"
Enabled:
type: boolean
AuditCheckConfigurations:
type: object
additionalProperties:
$ref: "#/components/schemas/AuditCheckConfiguration"
AuditCheckRunStatus:
type: string
enum:
- IN_PROGRESS
- WAITING_FOR_DATA_COLLECTION
- CANCELED
- COMPLETED_COMPLIANT
- COMPLETED_NON_COMPLIANT
- FAILED
CheckCompliant:
type: boolean
TotalResourcesCount:
type: integer
NonCompliantResourcesCount:
type: integer
SuppressedNonCompliantResourcesCount:
type: integer
ErrorCode:
type: string
ErrorMessage:
type: string
maxLength: 2048
AuditCheckDetails:
type: object
properties:
checkRunStatus:
allOf:
- $ref: "#/components/schemas/AuditCheckRunStatus"
- description: The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".
checkCompliant:
allOf:
- $ref: "#/components/schemas/CheckCompliant"
- description: True if the check is complete and found all resources compliant.
totalResourcesCount:
allOf:
- $ref: "#/components/schemas/TotalResourcesCount"
- description: The number of resources on which the check was performed.
nonCompliantResourcesCount:
allOf:
- $ref: "#/components/schemas/NonCompliantResourcesCount"
- description: The number of resources that were found noncompliant during the check.
suppressedNonCompliantResourcesCount:
allOf:
- $ref: "#/components/schemas/SuppressedNonCompliantResourcesCount"
- description: " Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed. "
errorCode:
allOf:
- $ref: "#/components/schemas/ErrorCode"
- description: The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".
message:
allOf:
- $ref: "#/components/schemas/ErrorMessage"
- description: The message associated with any error encountered when this check is performed during this audit.
description: Information about the audit check.
AuditCheckToActionsMapping:
type: object
additionalProperties:
$ref: "#/components/schemas/MitigationActionNameList"
ReasonForNonComplianceCodes:
type: array
items:
$ref: "#/components/schemas/ReasonForNonComplianceCode"
minItems: 1
maxItems: 25
AuditDescription:
type: string
pattern: "[\\p{Graph}\\x20]*"
maxLength: 1000
AuditDetails:
type: object
additionalProperties:
$ref: "#/components/schemas/AuditCheckDetails"
FindingId:
type: string
pattern: "[a-zA-Z0-9_-]+"
minLength: 1
maxLength: 128
AuditFindingSeverity:
type: string
enum:
- CRITICAL
- HIGH
- MEDIUM
- LOW
NonCompliantResource:
type: object
properties:
resourceType:
allOf:
- $ref: "#/components/schemas/ResourceType"
- description: The type of the noncompliant resource.
resourceIdentifier:
allOf:
- $ref: "#/components/schemas/ResourceIdentifier"
- description: Information that identifies the noncompliant resource.
additionalInfo:
allOf:
- $ref: "#/components/schemas/StringMap"
- description: Other information about the noncompliant resource.
description: Information about the resource that was noncompliant with the audit check.
RelatedResources:
type: array
items:
$ref: "#/components/schemas/RelatedResource"
ReasonForNonCompliance:
type: string
ReasonForNonComplianceCode:
type: string
IsSuppressed:
type: boolean
AuditFinding:
type: object
properties:
findingId:
allOf:
- $ref: "#/components/schemas/FindingId"
- description: A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.
taskId:
allOf:
- $ref: "#/components/schemas/AuditTaskId"
- description: The ID of the audit that generated this result (finding).
checkName:
allOf:
- $ref: "#/components/schemas/AuditCheckName"
- description: The audit check that generated this result.
taskStartTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The time the audit started.
findingTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The time the result (finding) was discovered.
severity:
allOf:
- $ref: "#/components/schemas/AuditFindingSeverity"
- description: The severity of the result (finding).
nonCompliantResource:
allOf:
- $ref: "#/components/schemas/NonCompliantResource"
- description: The resource that was found to be noncompliant with the audit check.
relatedResources:
allOf:
- $ref: "#/components/schemas/RelatedResources"
- description: The list of related resources.
reasonForNonCompliance:
allOf:
- $ref: "#/components/schemas/ReasonForNonCompliance"
- description: The reason the resource was noncompliant.
reasonForNonComplianceCode:
allOf:
- $ref: "#/components/schemas/ReasonForNonComplianceCode"
- description: A code that indicates the reason that the resource was noncompliant.
isSuppressed:
allOf:
- $ref: "#/components/schemas/IsSuppressed"
- description: " Indicates whether the audit finding was suppressed or not during reporting. "
description: The findings (results) of the audit.
AuditFindings:
type: array
items:
$ref: "#/components/schemas/AuditFinding"
AuditFrequency:
type: string
enum:
- DAILY
- WEEKLY
- BIWEEKLY
- MONTHLY
MitigationActionsTaskId:
type: string
pattern: "[a-zA-Z0-9_-]+"
minLength: 1
maxLength: 128
MitigationActionId:
type: string
AuditMitigationActionsExecutionStatus:
type: string
enum:
- IN_PROGRESS
- COMPLETED
- FAILED
- CANCELED
- SKIPPED
- PENDING
AuditMitigationActionExecutionMetadata:
type: object
properties:
taskId:
allOf:
- $ref: "#/components/schemas/MitigationActionsTaskId"
- description: The unique identifier for the task that applies the mitigation action.
findingId:
allOf:
- $ref: "#/components/schemas/FindingId"
- description: The unique identifier for the findings to which the task and associated mitigation action are applied.
actionName:
allOf:
- $ref: "#/components/schemas/MitigationActionName"
- description: The friendly name of the mitigation action being applied by the task.
actionId:
allOf:
- $ref: "#/components/schemas/MitigationActionId"
- description: The unique identifier for the mitigation action being applied by the task.
status:
allOf:
- $ref: "#/components/schemas/AuditMitigationActionsExecutionStatus"
- description: The current status of the task being executed.
startTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The date and time when the task was started.
endTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The date and time when the task was completed or canceled. Blank if the task is still running.
errorCode:
allOf:
- $ref: "#/components/schemas/ErrorCode"
- description: If an error occurred, the code that indicates which type of error occurred.
message:
allOf:
- $ref: "#/components/schemas/ErrorMessage"
- description: If an error occurred, a message that describes the error.
description: Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.
AuditMitigationActionExecutionMetadataList:
type: array
items:
$ref: "#/components/schemas/AuditMitigationActionExecutionMetadata"
AuditMitigationActionsTaskStatus:
type: string
enum:
- IN_PROGRESS
- COMPLETED
- FAILED
- CANCELED
AuditMitigationActionsTaskMetadata:
type: object
properties:
taskId:
allOf:
- $ref: "#/components/schemas/MitigationActionsTaskId"
- description: The unique identifier for the task.
startTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The time at which the audit mitigation actions task was started.
taskStatus:
allOf:
- $ref: "#/components/schemas/AuditMitigationActionsTaskStatus"
- description: The current state of the audit mitigation actions task.
description: Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks.
AuditMitigationActionsTaskMetadataList:
type: array
items:
$ref: "#/components/schemas/AuditMitigationActionsTaskMetadata"
TaskStatisticsForAuditCheck:
type: object
properties:
totalFindingsCount:
allOf:
- $ref: "#/components/schemas/TotalFindingsCount"
- description: The total number of findings to which a task is being applied.
failedFindingsCount:
allOf:
- $ref: "#/components/schemas/FailedFindingsCount"
- description: The number of findings for which at least one of the actions failed when applied.
succeededFindingsCount:
allOf:
- $ref: "#/components/schemas/SucceededFindingsCount"
- description: The number of findings for which all mitigation actions succeeded when applied.
skippedFindingsCount:
allOf:
- $ref: "#/components/schemas/SkippedFindingsCount"
- description: The number of findings skipped because of filter conditions provided in the parameters to the command.
canceledFindingsCount:
allOf:
- $ref: "#/components/schemas/CanceledFindingsCount"
- description: The number of findings to which the mitigation action task was canceled when applied.
description: Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.
AuditMitigationActionsTaskStatistics:
type: object
additionalProperties:
$ref: "#/components/schemas/TaskStatisticsForAuditCheck"
AuditMitigationActionsTaskTarget:
type: object
properties:
auditTaskId:
allOf:
- $ref: "#/components/schemas/AuditTaskId"
- description: If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.
findingIds:
allOf:
- $ref: "#/components/schemas/FindingIds"
- description: If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.
auditCheckToReasonCodeFilter:
allOf:
- $ref: "#/components/schemas/AuditCheckToReasonCodeFilter"
- description: Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.
description: Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.
AuditNotificationTargetConfigurations:
type: object
additionalProperties:
$ref: "#/components/schemas/AuditNotificationTarget"
AuditNotificationType:
type: string
enum:
- SNS
ResourceIdentifier:
type: object
properties:
deviceCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the certificate attached to the resource.
caCertificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the CA certificate used to authorize the certificate.
cognitoIdentityPoolId:
allOf:
- $ref: "#/components/schemas/CognitoIdentityPoolId"
- description: The ID of the Amazon Cognito identity pool.
clientId:
allOf:
- $ref: "#/components/schemas/ClientId"
- description: The client ID.
policyVersionIdentifier:
allOf:
- $ref: "#/components/schemas/PolicyVersionIdentifier"
- description: The version of the policy associated with the resource.
account:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: The account with which the resource is associated.
iamRoleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the IAM role that has overly permissive actions.
roleAliasArn:
allOf:
- $ref: "#/components/schemas/RoleAliasArn"
- description: The ARN of the role alias that has overly permissive actions.
issuerCertificateIdentifier:
allOf:
- $ref: "#/components/schemas/IssuerCertificateIdentifier"
- description: The issuer certificate identifier.
deviceCertificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the identified device certificate.
description: Information that identifies the noncompliant resource.
SuppressIndefinitely:
type: boolean
AuditSuppression:
type: object
required:
- checkName
- resourceIdentifier
properties:
checkName:
$ref: "#/components/schemas/AuditCheckName"
resourceIdentifier:
$ref: "#/components/schemas/ResourceIdentifier"
expirationDate:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to. "
suppressIndefinitely:
allOf:
- $ref: "#/components/schemas/SuppressIndefinitely"
- description: " Indicates whether a suppression should exist indefinitely or not. "
description:
allOf:
- $ref: "#/components/schemas/AuditDescription"
- description: " The description of the audit suppression. "
description: " Filters out specific findings of a Device Defender audit. "
AuditSuppressionList:
type: array
items:
$ref: "#/components/schemas/AuditSuppression"
AuditTaskStatus:
type: string
enum:
- IN_PROGRESS
- COMPLETED
- FAILED
- CANCELED
AuditTaskType:
type: string
enum:
- ON_DEMAND_AUDIT_TASK
- SCHEDULED_AUDIT_TASK
AuditTaskMetadata:
type: object
properties:
taskId:
allOf:
- $ref: "#/components/schemas/AuditTaskId"
- description: The ID of this audit.
taskStatus:
allOf:
- $ref: "#/components/schemas/AuditTaskStatus"
- description: The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
taskType:
allOf:
- $ref: "#/components/schemas/AuditTaskType"
- description: The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
description: The audits that were performed.
AuditTaskMetadataList:
type: array
items:
$ref: "#/components/schemas/AuditTaskMetadata"
AuthDecision:
type: string
enum:
- ALLOWED
- EXPLICIT_DENY
- IMPLICIT_DENY
Resources:
type: array
items:
$ref: "#/components/schemas/Resource"
AuthInfos:
type: array
items:
$ref: "#/components/schemas/AuthInfo"
minItems: 1
maxItems: 10
Denied:
type: object
properties:
implicitDeny:
allOf:
- $ref: "#/components/schemas/ImplicitDeny"
- description: Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.
explicitDeny:
allOf:
- $ref: "#/components/schemas/ExplicitDeny"
- description: "Information that explicitly denies the authorization. "
description: Contains information that denied the authorization.
MissingContextValues:
type: array
items:
$ref: "#/components/schemas/MissingContextValue"
AuthResult:
type: object
properties:
authInfo:
allOf:
- $ref: "#/components/schemas/AuthInfo"
- description: Authorization information.
allowed:
allOf:
- $ref: "#/components/schemas/Allowed"
- description: The policies and statements that allowed the specified action.
denied:
allOf:
- $ref: "#/components/schemas/Denied"
- description: The policies and statements that denied the specified action.
authDecision:
allOf:
- $ref: "#/components/schemas/AuthDecision"
- description: The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can
override multiple allow statements.
missingContextValues:
allOf:
- $ref: "#/components/schemas/MissingContextValues"
- description: Contains any missing context values found while evaluating policy.
description: The authorizer result.
AuthResults:
type: array
items:
$ref: "#/components/schemas/AuthResult"
AuthorizerArn:
type: string
maxLength: 2048
AuthorizerConfig:
type: object
properties:
defaultAuthorizerName:
allOf:
- $ref: "#/components/schemas/AuthorizerName"
- description: The name of the authorization service for a domain configuration.
allowAuthorizerOverride:
allOf:
- $ref: "#/components/schemas/AllowAuthorizerOverride"
- description: A Boolean that specifies whether the domain configuration's authorization service can be overridden.
description: An object that specifies the authorization service for a domain.
AuthorizerFunctionArn:
type: string
pattern: "[\\s\\S]*"
maxLength: 2048
TokenKeyName:
type: string
pattern: "[a-zA-Z0-9_-]+"
minLength: 1
maxLength: 128
PublicKeyMap:
type: object
additionalProperties:
$ref: "#/components/schemas/KeyValue"
AuthorizerStatus:
type: string
enum:
- ACTIVE
- INACTIVE
DateType:
type: string
format: date-time
BooleanKey:
type: boolean
EnableCachingForHttp:
type: boolean
AuthorizerDescription:
type: object
properties:
authorizerName:
allOf:
- $ref: "#/components/schemas/AuthorizerName"
- description: The authorizer name.
authorizerArn:
allOf:
- $ref: "#/components/schemas/AuthorizerArn"
- description: The authorizer ARN.
authorizerFunctionArn:
allOf:
- $ref: "#/components/schemas/AuthorizerFunctionArn"
- description: The authorizer's Lambda function ARN.
tokenKeyName:
allOf:
- $ref: "#/components/schemas/TokenKeyName"
- description: The key used to extract the token from the HTTP headers.
tokenSigningPublicKeys:
allOf:
- $ref: "#/components/schemas/PublicKeyMap"
- description: The public keys used to validate the token signature returned by your custom authentication service.
status:
allOf:
- $ref: "#/components/schemas/AuthorizerStatus"
- description: The status of the authorizer.
creationDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The UNIX timestamp of when the authorizer was created.
lastModifiedDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The UNIX timestamp of when the authorizer was last updated.
signingDisabled:
allOf:
- $ref: "#/components/schemas/BooleanKey"
- description: Specifies whether IoT validates the token signature in an authorization request.
enableCachingForHttp:
allOf:
- $ref: "#/components/schemas/EnableCachingForHttp"
- description: When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used
while the device reuses the same HTTP connection.
description: The authorizer description.
AuthorizerSummary:
type: object
properties:
authorizerName:
allOf:
- $ref: "#/components/schemas/AuthorizerName"
- description: The authorizer name.
authorizerArn:
allOf:
- $ref: "#/components/schemas/AuthorizerArn"
- description: The authorizer ARN.
description: The authorizer summary.
Authorizers:
type: array
items:
$ref: "#/components/schemas/AuthorizerSummary"
AutoRegistrationStatus:
type: string
enum:
- ENABLE
- DISABLE
Average:
type: number
format: double
AwsIotJobArn:
type: string
AwsIotJobId:
type: string
AwsJobAbortConfig:
type: object
required:
- abortCriteriaList
properties:
abortCriteriaList:
allOf:
- $ref: "#/components/schemas/AwsJobAbortCriteriaList"
- description: The list of criteria that determine when and how to abort the job.
description: The criteria that determine when and how a job abort takes place.
AwsJobAbortCriteriaFailureType:
type: string
enum:
- FAILED
- REJECTED
- TIMED_OUT
- ALL
AwsJobAbortCriteriaAbortAction:
type: string
enum:
- CANCEL
AwsJobAbortCriteriaAbortThresholdPercentage:
type: number
format: double
maximum: 100
AwsJobAbortCriteriaMinimumNumberOfExecutedThings:
type: integer
minimum: 1
AwsJobAbortCriteria:
type: object
required:
- failureType
- action
- thresholdPercentage
- minNumberOfExecutedThings
properties:
failureType:
allOf:
- $ref: "#/components/schemas/AwsJobAbortCriteriaFailureType"
- description: The type of job execution failures that can initiate a job abort.
action:
allOf:
- $ref: "#/components/schemas/AwsJobAbortCriteriaAbortAction"
- description: The type of job action to take to initiate the job abort.
thresholdPercentage:
allOf:
- $ref: "#/components/schemas/AwsJobAbortCriteriaAbortThresholdPercentage"
- description: The minimum percentage of job execution failures that must occur to initiate the job abort.
Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
minNumberOfExecutedThings: allOf: - $ref: "#/components/schemas/AwsJobAbortCriteriaMinimumNumberOfExecutedThings" - description: The minimum number of things which must receive job execution notifications before the job can be aborted. description: The criteria that determine when and how a job abort takes place. AwsJobExecutionsRolloutConfig: type: object properties: maximumPerMinute: allOf: - $ref: "#/components/schemas/MaximumPerMinute" - description: The maximum number of OTA update job executions started per minute. exponentialRate: allOf: - $ref: "#/components/schemas/AwsJobExponentialRolloutRate" - description: The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout. description: Configuration for the rollout of OTA updates. AwsJobRolloutRatePerMinute: type: integer minimum: 1 maximum: 1000 AwsJobRolloutIncrementFactor: type: number format: double AwsJobRateIncreaseCriteria: type: object properties: numberOfNotifiedThings: allOf: - $ref: "#/components/schemas/AwsJobRateIncreaseCriteriaNumberOfThings" - description: When this number of things have been notified, it will initiate an increase in the rollout rate. numberOfSucceededThings: allOf: - $ref: "#/components/schemas/AwsJobRateIncreaseCriteriaNumberOfThings" - description: When this number of things have succeeded in their job execution, it will initiate an increase in the rollout rate. description: The criteria to initiate the increase in rate of rollout for a job. AwsJobPresignedUrlConfig: type: object properties: expiresInSec: allOf: - $ref: "#/components/schemas/ExpiresInSeconds" - description: How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received. description: Configuration information for pre-signed URLs. Valid whenprotocols contains HTTP.
AwsJobRateIncreaseCriteriaNumberOfThings:
type: integer
minimum: 1
AwsJobTimeoutConfig:
type: object
properties:
inProgressTimeoutInMinutes:
allOf:
- $ref: "#/components/schemas/AwsJobTimeoutInProgressTimeoutInMinutes"
- description: Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080
minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this
interval, the job execution will fail and switch to the terminal TIMED_OUT status.
description: Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job
execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
BatchMode:
type: boolean
MetricDimension:
type: object
required:
- dimensionName
properties:
dimensionName:
allOf:
- $ref: "#/components/schemas/DimensionName"
- description: A unique identifier for the dimension.
operator:
allOf:
- $ref: "#/components/schemas/DimensionValueOperator"
- description: "Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted
only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional:
if it's not provided (is null), it will be interpreted as IN."
description: The dimension of a metric.
BehaviorCriteria:
type: object
properties:
comparisonOperator:
allOf:
- $ref: "#/components/schemas/ComparisonOperator"
- description: "The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:
string-list: in-set and not-in-set
number-list: in-set and not-in-set
ip-address-list: in-cidr-set and not-in-cidr-set
number: less-than, less-than-equals,
greater-than, and greater-than-equals
metric.
durationSeconds:
allOf:
- $ref: "#/components/schemas/DurationSeconds"
- description: Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a
statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later,
measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.
consecutiveDatapointsToAlarm:
allOf:
- $ref: "#/components/schemas/ConsecutiveDatapointsToAlarm"
- description: If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
consecutiveDatapointsToClear:
allOf:
- $ref: "#/components/schemas/ConsecutiveDatapointsToClear"
- description: If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not
specified, the default is 1.
statisticalThreshold:
allOf:
- $ref: "#/components/schemas/StatisticalThreshold"
- description: A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
mlDetectionConfig:
allOf:
- $ref: "#/components/schemas/MachineLearningDetectionConfig"
- description: " The configuration of an ML Detect "
description: The criteria by which the behavior is determined to be normal.
SuppressAlerts:
type: boolean
ComparisonOperator:
type: string
enum:
- less-than
- less-than-equals
- greater-than
- greater-than-equals
- in-cidr-set
- not-in-cidr-set
- in-port-set
- not-in-port-set
- in-set
- not-in-set
DurationSeconds:
type: integer
ConsecutiveDatapointsToAlarm:
type: integer
minimum: 1
maximum: 10
ConsecutiveDatapointsToClear:
type: integer
minimum: 1
maximum: 10
StatisticalThreshold:
type: object
properties:
statistic:
allOf:
- $ref: "#/components/schemas/EvaluationStatistic"
- description: The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period
(durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period.
If the accumulated measurements from the device fall above or below (comparisonOperator) the value associated with the percentile specified, then the device is considered to
be in compliance with the behavior, otherwise a violation occurs.
description: A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
MachineLearningDetectionConfig:
type: object
required:
- confidenceLevel
properties:
confidenceLevel:
allOf:
- $ref: "#/components/schemas/ConfidenceLevel"
- description: " The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High. "
description: " The configuration of an ML Detect Security Profile. "
BehaviorCriteriaType:
type: string
enum:
- STATIC
- STATISTICAL
- MACHINE_LEARNING
BehaviorModelTrainingSummary:
type: object
properties:
securityProfileName:
allOf:
- $ref: "#/components/schemas/SecurityProfileName"
- description: " The name of the security profile. "
behaviorName:
allOf:
- $ref: "#/components/schemas/BehaviorName"
- description: " The name of the behavior. "
trainingDataCollectionStartDate:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The date a training model started collecting data. "
modelStatus:
allOf:
- $ref: "#/components/schemas/ModelStatus"
- description: " The status of the behavior model. "
datapointsCollectionPercentage:
allOf:
- $ref: "#/components/schemas/DataCollectionPercentage"
- description: " The percentage of datapoints collected. "
lastModelRefreshDate:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The date the model was last refreshed. "
description: " The summary of an ML Detect behavior model. "
BehaviorModelTrainingSummaries:
type: array
items:
$ref: "#/components/schemas/BehaviorModelTrainingSummary"
ModelStatus:
type: string
enum:
- PENDING_BUILD
- ACTIVE
- EXPIRED
DataCollectionPercentage:
type: number
format: double
minimum: 0
maximum: 100
Behaviors:
type: array
items:
$ref: "#/components/schemas/Behavior"
maxItems: 100
BillingGroupId:
type: string
pattern: "[a-zA-Z0-9\\-]+"
minLength: 1
maxLength: 128
CreationDate:
type: string
format: date-time
BillingGroupMetadata:
type: object
properties:
creationDate:
allOf:
- $ref: "#/components/schemas/CreationDate"
- description: The date the billing group was created.
description: Additional information about the billing group.
GroupNameAndArn:
type: object
properties:
groupName:
allOf:
- $ref: "#/components/schemas/ThingGroupName"
- description: The group name.
groupArn:
allOf:
- $ref: "#/components/schemas/ThingGroupArn"
- description: The group ARN.
description: The name and ARN of a group.
BillingGroupNameAndArnList:
type: array
items:
$ref: "#/components/schemas/GroupNameAndArn"
BillingGroupProperties:
type: object
properties:
billingGroupDescription:
allOf:
- $ref: "#/components/schemas/BillingGroupDescription"
- description: The description of the billing group.
description: The properties of a billing group.
Boolean:
type: boolean
BooleanWrapperObject:
type: boolean
BucketKeyValue:
type: string
Count:
type: integer
Bucket:
type: object
properties:
keyValue:
allOf:
- $ref: "#/components/schemas/BucketKeyValue"
- description: The value counted for the particular bucket.
count:
allOf:
- $ref: "#/components/schemas/Count"
- description: The number of documents that have the value counted for the particular bucket.
description: A count of documents that meets a specific aggregation criteria.
BucketName:
type: string
Buckets:
type: array
items:
$ref: "#/components/schemas/Bucket"
BucketsAggregationType:
type: object
properties:
termsAggregation:
allOf:
- $ref: "#/components/schemas/TermsAggregation"
- description: Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.
description: The type of bucketed aggregation performed.
CACertificateStatus:
type: string
enum:
- ACTIVE
- INACTIVE
CACertificate:
type: object
properties:
certificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: The ARN of the CA certificate.
certificateId:
allOf:
- $ref: "#/components/schemas/CertificateId"
- description: The ID of the CA certificate.
status:
allOf:
- $ref: "#/components/schemas/CACertificateStatus"
- description: The status of the CA certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
creationDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date the CA certificate was created. description: A CA certificate. CertificatePem: type: string pattern: "[\\s\\S]*" description: The PEM of a certificate. minLength: 1 maxLength: 65536 CustomerVersion: type: integer minimum: 1 GenerationId: type: string CertificateValidity: type: object properties: notBefore: allOf: - $ref: "#/components/schemas/DateType" - description: The certificate is not valid before this date. notAfter: allOf: - $ref: "#/components/schemas/DateType" - description: The certificate is not valid after this date. description: When the certificate is valid. CertificateMode: type: string enum: - DEFAULT - SNI_ONLY CACertificateDescription: type: object properties: certificateArn: allOf: - $ref: "#/components/schemas/CertificateArn" - description: The CA certificate ARN. certificateId: allOf: - $ref: "#/components/schemas/CertificateId" - description: The CA certificate ID. status: allOf: - $ref: "#/components/schemas/CACertificateStatus" - description: The status of a CA certificate. certificatePem: allOf: - $ref: "#/components/schemas/CertificatePem" - description: The CA certificate data, in PEM format. ownedBy: allOf: - $ref: "#/components/schemas/AwsAccountId" - description: The owner of the CA certificate. creationDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date the CA certificate was created. autoRegistrationStatus: allOf: - $ref: "#/components/schemas/AutoRegistrationStatus" - description: Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE" lastModifiedDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date the CA certificate was last modified. customerVersion: allOf: - $ref: "#/components/schemas/CustomerVersion" - description: The customer version of the CA certificate. generationId: allOf: - $ref: "#/components/schemas/GenerationId" - description: The generation ID of the CA certificate. validity: allOf: - $ref: "#/components/schemas/CertificateValidity" - description: When the CA certificate is valid. certificateMode: allOf: - $ref: "#/components/schemas/CertificateMode" - description:The mode of the CA.
All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode.
description: Describes a CA certificate. CACertificateUpdateAction: type: string enum: - DEACTIVATE CACertificates: type: array items: $ref: "#/components/schemas/CACertificate" CancelAuditMitigationActionsTaskRequest: type: object title: CancelAuditMitigationActionsTaskRequest properties: {} CancelAuditTaskRequest: type: object title: CancelAuditTaskRequest properties: {} CancelCertificateTransferRequest: type: object title: CancelCertificateTransferRequest properties: {} description: The input for the CancelCertificateTransfer operation. CancelDetectMitigationActionsTaskRequest: type: object title: CancelDetectMitigationActionsTaskRequest properties: {} ForceFlag: type: boolean ExpectedVersion: type: integer DetailsMap: type: object additionalProperties: $ref: "#/components/schemas/DetailsValue" CancelJobExecutionRequest: type: object title: CancelJobExecutionRequest properties: expectedVersion: allOf: - $ref: "#/components/schemas/ExpectedVersion" - description: (Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.) statusDetails: allOf: - $ref: "#/components/schemas/DetailsMap" - description: A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs. ReasonCode: type: string pattern: "[\\p{Upper}\\p{Digit}_]+" maxLength: 128 CancelJobRequest: type: object title: CancelJobRequest properties: reasonCode: allOf: - $ref: "#/components/schemas/ReasonCode" - description: (Optional)A reason code string that explains why the job was canceled. comment: allOf: - $ref: "#/components/schemas/Comment" - description: An optional comment string describing why the job was canceled. CanceledChecksCount: type: integer CanceledFindingsCount: type: integer CanceledThings: type: integer CannedAccessControlList: type: string enum: - private - public-read - public-read-write - aws-exec-read - authenticated-read - bucket-owner-read - bucket-owner-full-control - log-delivery-write CertificateStatus: type: string enum: - ACTIVE - INACTIVE - REVOKED - PENDING_TRANSFER - REGISTER_INACTIVE - PENDING_ACTIVATION Certificate: type: object properties: certificateArn: allOf: - $ref: "#/components/schemas/CertificateArn" - description: The ARN of the certificate. certificateId: allOf: - $ref: "#/components/schemas/CertificateId" - description: The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) status: allOf: - $ref: "#/components/schemas/CertificateStatus" - description:The status of the certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
certificateMode: allOf: - $ref: "#/components/schemas/CertificateMode" - description: "The mode of the certificate.
DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with
an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension
when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web
Services IoT Core.
SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must
send the SNI extension when connecting to Amazon Web Services IoT Core.
The mode of the certificate.
DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with
an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension
when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web
Services IoT Core.
SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must
send the SNI extension when connecting to Amazon Web Services IoT Core.
For more information about the value for SNI extension, see Transport security in IoT.
" description: Describes a certificate. CertificateName: type: string CertificatePathOnDevice: type: string CertificateSigningRequest: type: string pattern: "[\\s\\S]*" minLength: 1 maxLength: 4096 Certificates: type: array items: $ref: "#/components/schemas/Certificate" ChannelName: type: string Cidr: type: string pattern: "[a-fA-F0-9:\\.\\/]+" minLength: 2 maxLength: 43 Cidrs: type: array items: $ref: "#/components/schemas/Cidr" ClearDefaultAuthorizerRequest: type: object title: ClearDefaultAuthorizerRequest properties: {} String: type: string ClientProperties: type: object additionalProperties: $ref: "#/components/schemas/String" ClientRequestToken: type: string pattern: ^[a-zA-Z0-9-_]+$ minLength: 1 maxLength: 64 StateReason: type: string StateValue: type: string LogGroupName: type: string Code: type: string SigningJobId: type: string StartSigningJobParameter: type: object properties: signingProfileParameter: allOf: - $ref: "#/components/schemas/SigningProfileParameter" - description: Describes the code-signing profile. signingProfileName: allOf: - $ref: "#/components/schemas/SigningProfileName" - description: The code-signing profile name. destination: allOf: - $ref: "#/components/schemas/Destination" - description: The location to write the code-signed file. description: Information required to start a signing job. CustomCodeSigning: type: object properties: signature: allOf: - $ref: "#/components/schemas/CodeSigningSignature" - description: The signature for the file. certificateChain: allOf: - $ref: "#/components/schemas/CodeSigningCertificateChain" - description: The certificate chain. hashAlgorithm: allOf: - $ref: "#/components/schemas/HashAlgorithm" - description: The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS usesSHA256 or SHA1, so you can pass either of them based on which was used for
generating the signature.
signatureAlgorithm:
allOf:
- $ref: "#/components/schemas/SignatureAlgorithm"
- description: The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature
that was generated using the same signature algorithm. For example, FreeRTOS uses ECDSA or RSA, so you can pass either of them based on which was used for
generating the signature.
description: Describes a custom method used to code sign a file.
CodeSigning:
type: object
properties:
awsSignerJobId:
allOf:
- $ref: "#/components/schemas/SigningJobId"
- description: The ID of the AWSSignerJob which was created to sign the file.
startSigningJobParameter:
allOf:
- $ref: "#/components/schemas/StartSigningJobParameter"
- description: Describes the code-signing job.
customCodeSigning:
allOf:
- $ref: "#/components/schemas/CustomCodeSigning"
- description: A custom method for code signing a file.
description: Describes the method to use when code signing a file.
InlineDocument:
type: string
CodeSigningCertificateChain:
type: object
properties:
certificateName:
allOf:
- $ref: "#/components/schemas/CertificateName"
- description: The name of the certificate.
inlineDocument:
allOf:
- $ref: "#/components/schemas/InlineDocument"
- description: A base64 encoded binary representation of the code signing certificate chain.
description: Describes the certificate chain being used when code signing a file.
Signature:
type: string
CodeSigningSignature:
type: object
properties:
inlineDocument:
allOf:
- $ref: "#/components/schemas/Signature"
- description: A base64 encoded binary representation of the code signing signature.
description: Describes the signature for a file.
CompliantChecksCount:
type: integer
ConfidenceLevel:
type: string
enum:
- LOW
- MEDIUM
- HIGH
ConfirmationToken:
type: string
minLength: 1
maxLength: 2048
ConfirmTopicRuleDestinationRequest:
type: object
title: ConfirmTopicRuleDestinationRequest
properties: {}
ConnectivityTimestamp:
type: integer
ContentType:
type: string
minLength: 0
maxLength: 1024
CorrelationData:
type: string
minLength: 0
maxLength: 1024
CreateAuditSuppressionRequest:
type: object
required:
- checkName
- resourceIdentifier
- clientRequestToken
title: CreateAuditSuppressionRequest
properties:
checkName:
$ref: "#/components/schemas/AuditCheckName"
resourceIdentifier:
$ref: "#/components/schemas/ResourceIdentifier"
expirationDate:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The epoch timestamp in seconds at which this suppression expires. "
suppressIndefinitely:
allOf:
- $ref: "#/components/schemas/SuppressIndefinitely"
- description: " Indicates whether a suppression should exist indefinitely or not. "
description:
allOf:
- $ref: "#/components/schemas/AuditDescription"
- description: " The description of the audit suppression. "
clientRequestToken:
allOf:
- $ref: "#/components/schemas/ClientRequestToken"
- description: " Each audit supression must have a unique client request token. If you try to create a new audit suppression with the same token as one that already exists, an exception occurs.
If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request."
TagList:
type: array
items:
$ref: "#/components/schemas/Tag"
CreateAuthorizerRequest:
type: object
required:
- authorizerFunctionArn
title: CreateAuthorizerRequest
properties:
authorizerFunctionArn:
allOf:
- $ref: "#/components/schemas/AuthorizerFunctionArn"
- description: The ARN of the authorizer's Lambda function.
tokenKeyName:
allOf:
- $ref: "#/components/schemas/TokenKeyName"
- description: The name of the token key used to extract the token from the HTTP headers.
tokenSigningPublicKeys:
allOf:
- $ref: "#/components/schemas/PublicKeyMap"
- description: The public keys used to verify the digital signature returned by your custom authentication service.
status:
allOf:
- $ref: "#/components/schemas/AuthorizerStatus"
- description: The status of the create authorizer request.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: 'Metadata which can be used to manage the custom authorizer.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time
specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.
The default value is
false.
The type of the custom metric.
The type number only takes a single metric value as an input, but when you submit the metrics value in the
DeviceMetrics report, you must pass it as an array with a single value.
TOPIC_FILTER. "
stringValues:
allOf:
- $ref: "#/components/schemas/DimensionStringValues"
- description: Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: Metadata that can be used to manage the dimension.
clientRequestToken:
allOf:
- $ref: "#/components/schemas/ClientRequestToken"
- description: Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If
you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
DimensionArn:
type: string
DomainConfigurationName:
type: string
pattern: "[\\w.-]+"
minLength: 1
maxLength: 128
DomainName:
type: string
pattern: "[\\s\\S]*"
minLength: 1
maxLength: 253
ServerCertificateArns:
type: array
items:
$ref: "#/components/schemas/AcmCertificateArn"
minItems: 0
maxItems: 1
ServiceType:
type: string
enum:
- DATA
- CREDENTIAL_PROVIDER
- JOBS
CreateDomainConfigurationRequest:
type: object
title: CreateDomainConfigurationRequest
properties:
domainName:
allOf:
- $ref: "#/components/schemas/DomainName"
- description: The name of the domain.
serverCertificateArns:
allOf:
- $ref: "#/components/schemas/ServerCertificateArns"
- description: The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon
Web Services-managed domains.
validationCertificateArn:
allOf:
- $ref: "#/components/schemas/AcmCertificateArn"
- description: The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not
required for Amazon Web Services-managed domains.
authorizerConfig:
allOf:
- $ref: "#/components/schemas/AuthorizerConfig"
- description: An object that specifies the authorization service for a domain.
serviceType:
allOf:
- $ref: "#/components/schemas/ServiceType"
- description: The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the DATA service type.
Metadata which can be used to manage the domain configuration.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
The dynamic thing group index name.
Currently one index is supported: AWS_Things.
The dynamic thing group search query string.
See Query Syntax for information about query string syntax.
queryVersion: allOf: - $ref: "#/components/schemas/QueryVersion" - description: 'The dynamic thing group query version.
Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.
TIMED_OUT status.
description: Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job
execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
JobTemplateArn:
type: string
pattern: ^arn:[!-~]+$
minLength: 1
maxLength: 1600
JobExecutionsRetryConfig:
type: object
required:
- criteriaList
properties:
criteriaList:
allOf:
- $ref: "#/components/schemas/RetryCriteriaList"
- description: The list of criteria that determines how many retries are allowed for each failure type for a job.
description: The configuration that determines how many retries are allowed for each failure type for a job.
ParameterMap:
type: object
additionalProperties:
$ref: "#/components/schemas/ParameterValue"
SchedulingConfig:
type: object
properties:
startTime:
allOf:
- $ref: "#/components/schemas/StringDateTime"
- description: The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and
must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for the time.
endTime:
allOf:
- $ref: "#/components/schemas/StringDateTime"
- description: The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the
current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The
maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the
time.
endBehavior:
allOf:
- $ref: "#/components/schemas/JobEndBehavior"
- description: Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then
endBehavior does not apply.
maintenanceWindows:
allOf:
- $ref: "#/components/schemas/MaintenanceWindows"
- description: An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a
job document to all devices in a target group for a job.
description: Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end behavior for each job
execution when it reaches the scheduled end time.
CreateJobRequest:
type: object
required:
- targets
title: CreateJobRequest
properties:
targets:
allOf:
- $ref: "#/components/schemas/JobTargets"
- description: A list of things and thing groups to which the job should be sent.
documentSource:
allOf:
- $ref: "#/components/schemas/JobDocumentSource"
- description: An S3 link to the job document. Required if you don't specify a value for document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
documentSource.
description:
allOf:
- $ref: "#/components/schemas/JobDescription"
- description: A short text description of the job.
presignedUrlConfig:
allOf:
- $ref: "#/components/schemas/PresignedUrlConfig"
- description: Configuration information for pre-signed S3 URLs.
targetSelection:
allOf:
- $ref: "#/components/schemas/TargetSelection"
- 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). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
IN_PROGRESS. If the
job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: Metadata which can be used to manage the job.
namespaceId:
allOf:
- $ref: "#/components/schemas/NamespaceId"
- description: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
Parameters of an Amazon Web Services managed template that you can specify to create the job document.
documentParameters can only be used when
creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.
An S3 link to the job document to use in the template. Required if you don't specify a value for document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
documentSource.
description:
allOf:
- $ref: "#/components/schemas/JobDescription"
- description: A description of the job document.
presignedUrlConfig:
$ref: "#/components/schemas/PresignedUrlConfig"
jobExecutionsRolloutConfig:
$ref: "#/components/schemas/JobExecutionsRolloutConfig"
abortConfig:
$ref: "#/components/schemas/AbortConfig"
timeoutConfig:
$ref: "#/components/schemas/TimeoutConfig"
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: Metadata that can be used to manage the job template.
jobExecutionsRetryConfig:
allOf:
- $ref: "#/components/schemas/JobExecutionsRetryConfig"
- description: Allows you to create the criteria to retry a job.
maintenanceWindows:
allOf:
- $ref: "#/components/schemas/MaintenanceWindows"
- description: Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
CreateKeysAndCertificateRequest:
type: object
title: CreateKeysAndCertificateRequest
properties: {}
description: The input for the CreateKeysAndCertificate operation.
Requires permission to access the CreateKeysAndCertificateRequest action.
KeyPair: type: object properties: PublicKey: allOf: - $ref: "#/components/schemas/PublicKey" - description: The public key. PrivateKey: allOf: - $ref: "#/components/schemas/PrivateKey" - description: The private key. description: Describes a key pair. MitigationActionParams: type: object properties: updateDeviceCertificateParams: allOf: - $ref: "#/components/schemas/UpdateDeviceCertificateParams" - description: Parameters to define a mitigation action that changes the state of the device certificate to inactive. updateCACertificateParams: allOf: - $ref: "#/components/schemas/UpdateCACertificateParams" - description: Parameters to define a mitigation action that changes the state of the CA certificate to inactive. addThingsToThingGroupParams: allOf: - $ref: "#/components/schemas/AddThingsToThingGroupParams" - description: Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine. replaceDefaultPolicyVersionParams: allOf: - $ref: "#/components/schemas/ReplaceDefaultPolicyVersionParams" - description: Parameters to define a mitigation action that adds a blank policy to restrict permissions. enableIoTLoggingParams: allOf: - $ref: "#/components/schemas/EnableIoTLoggingParams" - description: Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail. publishFindingToSnsParams: allOf: - $ref: "#/components/schemas/PublishFindingToSnsParams" - description: Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages. description: The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action). CreateMitigationActionRequest: type: object required: - roleArn - actionParams title: CreateMitigationActionRequest properties: roleArn: allOf: - $ref: "#/components/schemas/RoleArn" - description: The ARN of the IAM role that is used to apply the mitigation action. actionParams: allOf: - $ref: "#/components/schemas/MitigationActionParams" - description: Defines the type of action and the parameters for that action. tags: allOf: - $ref: "#/components/schemas/TagList" - description: Metadata that can be used to manage the mitigation action. MitigationActionArn: type: string OTAUpdateId: type: string pattern: "[a-zA-Z0-9_-]+" minLength: 1 maxLength: 128 OTAUpdateDescription: type: string pattern: "[^\\p{C}]+" maxLength: 2028 Targets: type: array items: $ref: "#/components/schemas/Target" minItems: 1 Protocols: type: array items: $ref: "#/components/schemas/Protocol" minItems: 1 maxItems: 2 OTAUpdateFiles: type: array items: $ref: "#/components/schemas/OTAUpdateFile" minItems: 1 CreateOTAUpdateRequest: type: object required: - targets - files - roleArn title: CreateOTAUpdateRequest properties: description: allOf: - $ref: "#/components/schemas/OTAUpdateDescription" - description: The description of the OTA update. targets: allOf: - $ref: "#/components/schemas/Targets" - description: The devices targeted to receive OTA updates. protocols: allOf: - $ref: "#/components/schemas/Protocols" - description: The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol. targetSelection: allOf: - $ref: "#/components/schemas/TargetSelection" - description: "Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT." awsJobExecutionsRolloutConfig: allOf: - $ref: "#/components/schemas/AwsJobExecutionsRolloutConfig" - description: Configuration for the rollout of OTA updates. awsJobPresignedUrlConfig: allOf: - $ref: "#/components/schemas/AwsJobPresignedUrlConfig" - description: Configuration information for pre-signed URLs. awsJobAbortConfig: allOf: - $ref: "#/components/schemas/AwsJobAbortConfig" - description: The criteria that determine when and how a job abort takes place. awsJobTimeoutConfig: allOf: - $ref: "#/components/schemas/AwsJobTimeoutConfig" - description: Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set toIN_PROGRESS. If the
job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
files:
allOf:
- $ref: "#/components/schemas/OTAUpdateFiles"
- description: The files to be streamed by the OTA update.
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
additionalParameters:
allOf:
- $ref: "#/components/schemas/AdditionalParameterMap"
- description: A list of additional OTA update parameters which are name-value pairs.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: Metadata which can be used to manage updates.
OTAUpdateArn:
type: string
OTAUpdateStatus:
type: string
enum:
- CREATE_PENDING
- CREATE_IN_PROGRESS
- CREATE_COMPLETE
- CREATE_FAILED
- DELETE_IN_PROGRESS
- DELETE_FAILED
PolicyDocument:
type: string
pattern: "[\\s\\S]*"
minLength: 0
maxLength: 404600
CreatePolicyRequest:
type: object
required:
- policyDocument
title: CreatePolicyRequest
properties:
policyDocument:
allOf:
- $ref: "#/components/schemas/PolicyDocument"
- description: The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: 'Metadata which can be used to manage the policy.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
The payload that was sent to the target function.
Note: Only Lambda functions are currently supported.
targetArn: allOf: - $ref: "#/components/schemas/TargetArn" - description:The ARN of the target function.
Note: Only Lambda functions are currently supported.
description: Structure that containspayloadVersion and targetArn.
TemplateType:
type: string
enum:
- FLEET_PROVISIONING
- JITP
CreateProvisioningTemplateRequest:
type: object
required:
- templateName
- templateBody
- provisioningRoleArn
title: CreateProvisioningTemplateRequest
properties:
templateName:
allOf:
- $ref: "#/components/schemas/TemplateName"
- description: The name of the provisioning template.
description:
allOf:
- $ref: "#/components/schemas/TemplateDescription"
- description: The description of the provisioning template.
templateBody:
allOf:
- $ref: "#/components/schemas/TemplateBody"
- description: The JSON formatted contents of the provisioning template.
enabled:
allOf:
- $ref: "#/components/schemas/Enabled"
- description: True to enable the provisioning template, otherwise false.
provisioningRoleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.
preProvisioningHook:
allOf:
- $ref: "#/components/schemas/ProvisioningHook"
- description: Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: 'Metadata which can be used to manage the provisioning template.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
FLEET_PROVISIONING.
For more information about provisioning template, see: Provisioning template. "
TemplateArn:
type: string
TemplateVersionId:
type: integer
CreateProvisioningTemplateVersionRequest:
type: object
required:
- templateBody
title: CreateProvisioningTemplateVersionRequest
properties:
templateBody:
allOf:
- $ref: "#/components/schemas/TemplateBody"
- description: The JSON formatted contents of the provisioning template.
RoleAlias:
type: string
pattern: "[\\w=,@-]+"
minLength: 1
maxLength: 128
CredentialDurationSeconds:
type: integer
minimum: 900
maximum: 43200
CreateRoleAliasRequest:
type: object
required:
- roleArn
title: CreateRoleAliasRequest
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The role ARN.
credentialDurationSeconds:
allOf:
- $ref: "#/components/schemas/CredentialDurationSeconds"
- description: How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.
This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.
tags: allOf: - $ref: "#/components/schemas/TagList" - description: 'Metadata which can be used to manage the role alias.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
DAILY, WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is
determined by the system.
dayOfMonth:
allOf:
- $ref: "#/components/schemas/DayOfMonth"
- description: The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to
MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the LAST day of the month.
dayOfWeek:
allOf:
- $ref: "#/components/schemas/DayOfWeek"
- description: The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU,
FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
targetCheckNames:
allOf:
- $ref: "#/components/schemas/TargetAuditCheckNames"
- description: Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all
checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: Metadata that can be used to manage the scheduled audit.
ScheduledAuditArn:
type: string
SecurityProfileDescription:
type: string
pattern: "[\\p{Graph}\\x20]*"
maxLength: 1000
CreateSecurityProfileRequest:
type: object
title: CreateSecurityProfileRequest
properties:
securityProfileDescription:
allOf:
- $ref: "#/components/schemas/SecurityProfileDescription"
- description: A description of the security profile.
behaviors:
allOf:
- $ref: "#/components/schemas/Behaviors"
- description: Specifies the behaviors that, when violated by a device (thing), cause an alert.
alertTargets:
allOf:
- $ref: "#/components/schemas/AlertTargets"
- description: Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
additionalMetricsToRetain:
allOf:
- $ref: "#/components/schemas/AdditionalMetricsToRetainList"
- deprecated: true
description: Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default, data is
retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with
dimensions.
behaviors, but it is also retained for any
metric specified here. Can be used with custom metrics; cannot be used with dimensions.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: Metadata that can be used to manage the security profile.
SecurityProfileArn:
type: string
StreamId:
type: string
pattern: "[a-zA-Z0-9_-]+"
minLength: 1
maxLength: 128
StreamDescription:
type: string
pattern: "[^\\p{C}]+"
maxLength: 2028
StreamFiles:
type: array
items:
$ref: "#/components/schemas/StreamFile"
minItems: 1
maxItems: 50
CreateStreamRequest:
type: object
required:
- files
- roleArn
title: CreateStreamRequest
properties:
description:
allOf:
- $ref: "#/components/schemas/StreamDescription"
- description: A description of the stream.
files:
allOf:
- $ref: "#/components/schemas/StreamFiles"
- description: The files to stream.
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: An IAM role that allows the IoT service principal to access your S3 files.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: Metadata which can be used to manage streams.
StreamArn:
type: string
StreamVersion:
type: integer
minimum: 0
maximum: 65535
CreateThingGroupRequest:
type: object
title: CreateThingGroupRequest
properties:
parentGroupName:
allOf:
- $ref: "#/components/schemas/ThingGroupName"
- description: The name of the parent thing group.
thingGroupProperties:
allOf:
- $ref: "#/components/schemas/ThingGroupProperties"
- description: The thing group properties.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: Metadata which can be used to manage the thing group.
ThingTypeName:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
CreateThingRequest:
type: object
title: CreateThingRequest
properties:
thingTypeName:
allOf:
- $ref: "#/components/schemas/ThingTypeName"
- description: The name of the thing type associated with the new thing.
attributePayload:
allOf:
- $ref: "#/components/schemas/AttributePayload"
- description: The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:
{\"attributes\":{\"string1\":\"string2\"}}
The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You can
set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed. You can set
status to DISABLED by calling UpdateTopicRuleDestination.
Confirmation was completed, and traffic to this
destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
Confirmation
could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to
IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your
confirmation endpoint.
true if the job execution was canceled with the optional force parameter set to true.
statusDetails:
allOf:
- $ref: "#/components/schemas/JobExecutionStatusDetails"
- description: A collection of name/value pairs that describe the status of the job execution.
thingArn:
allOf:
- $ref: "#/components/schemas/ThingArn"
- description: The ARN of the thing on which the job execution is running.
queuedAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The time, in seconds since the epoch, when the job execution was queued.
startedAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The time, in seconds since the epoch, when the job execution started.
lastUpdatedAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The time, in seconds since the epoch, when the job execution was last updated.
executionNumber:
allOf:
- $ref: "#/components/schemas/ExecutionNumber"
- description: 'A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update
job execution information. '
versionNumber:
allOf:
- $ref: "#/components/schemas/VersionNumber"
- description: The version of the job execution. Job execution versions are incremented each time they are updated by a device.
approximateSecondsBeforeTimedOut:
allOf:
- $ref: "#/components/schemas/ApproximateSecondsBeforeTimedOut"
- description: The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute
and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has
reached a terminal status.
description: The job execution object represents the execution of a job on a particular device.
DescribeJobRequest:
type: object
title: DescribeJobRequest
properties: {}
Job:
type: object
properties:
jobArn:
allOf:
- $ref: "#/components/schemas/JobArn"
- description: An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
jobId:
allOf:
- $ref: "#/components/schemas/JobId"
- description: The unique identifier you assigned to this job when it was created.
targetSelection:
allOf:
- $ref: "#/components/schemas/TargetSelection"
- 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). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED. "
forceCanceled:
allOf:
- $ref: "#/components/schemas/Forced"
- description: Will be true if the job was canceled with the optional force parameter set to true.
reasonCode:
allOf:
- $ref: "#/components/schemas/ReasonCode"
- description: If the job was updated, provides the reason code for the update.
comment:
allOf:
- $ref: "#/components/schemas/Comment"
- description: If the job was updated, describes the reason for the update.
targets:
allOf:
- $ref: "#/components/schemas/JobTargets"
- description: A list of IoT things and thing groups to which the job should be sent.
description:
allOf:
- $ref: "#/components/schemas/JobDescription"
- description: A short text description of the job.
presignedUrlConfig:
allOf:
- $ref: "#/components/schemas/PresignedUrlConfig"
- description: Configuration for pre-signed S3 URLs.
jobExecutionsRolloutConfig:
allOf:
- $ref: "#/components/schemas/JobExecutionsRolloutConfig"
- description: Allows you to create a staged rollout of a job.
abortConfig:
allOf:
- $ref: "#/components/schemas/AbortConfig"
- description: Configuration for criteria to abort the job.
createdAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The time, in seconds since the epoch, when the job was created.
lastUpdatedAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The time, in seconds since the epoch, when the job was last updated.
completedAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The time, in seconds since the epoch, when the job was completed.
jobProcessDetails:
allOf:
- $ref: "#/components/schemas/JobProcessDetails"
- description: Details about the job process.
timeoutConfig:
allOf:
- $ref: "#/components/schemas/TimeoutConfig"
- description: Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the
job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
namespaceId:
allOf:
- $ref: "#/components/schemas/NamespaceId"
- description: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.
documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This
parameter can't be used with custom job templates or to create jobs from them.
Job object contains details about a job.
DescribeJobTemplateRequest:
type: object
title: DescribeJobTemplateRequest
properties: {}
ManagedJobTemplateName:
type: string
minLength: 1
maxLength: 64
ManagedTemplateVersion:
type: string
pattern: ^[1-9]+.[0-9]+
DescribeManagedJobTemplateRequest:
type: object
title: DescribeManagedJobTemplateRequest
properties: {}
Environments:
type: array
items:
$ref: "#/components/schemas/Environment"
DocumentParameters:
type: array
items:
$ref: "#/components/schemas/DocumentParameter"
DescribeMitigationActionRequest:
type: object
title: DescribeMitigationActionRequest
properties: {}
MitigationActionType:
type: string
enum:
- UPDATE_DEVICE_CERTIFICATE
- UPDATE_CA_CERTIFICATE
- ADD_THINGS_TO_THING_GROUP
- REPLACE_DEFAULT_POLICY_VERSION
- ENABLE_IOT_LOGGING
- PUBLISH_FINDING_TO_SNS
DescribeProvisioningTemplateRequest:
type: object
title: DescribeProvisioningTemplateRequest
properties: {}
DescribeProvisioningTemplateVersionRequest:
type: object
title: DescribeProvisioningTemplateVersionRequest
properties: {}
DescribeRoleAliasRequest:
type: object
title: DescribeRoleAliasRequest
properties: {}
RoleAliasDescription:
type: object
properties:
roleAlias:
allOf:
- $ref: "#/components/schemas/RoleAlias"
- description: The role alias.
roleAliasArn:
allOf:
- $ref: "#/components/schemas/RoleAliasArn"
- description: The ARN of the role alias.
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The role ARN.
owner:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: The role alias owner.
credentialDurationSeconds:
allOf:
- $ref: "#/components/schemas/CredentialDurationSeconds"
- description: The number of seconds for which the credential is valid.
creationDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The UNIX timestamp of when the role alias was created.
lastModifiedDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The UNIX timestamp of when the role alias was last modified.
description: Role alias description.
DescribeScheduledAuditRequest:
type: object
title: DescribeScheduledAuditRequest
properties: {}
DescribeSecurityProfileRequest:
type: object
title: DescribeSecurityProfileRequest
properties: {}
DescribeStreamRequest:
type: object
title: DescribeStreamRequest
properties: {}
StreamInfo:
type: object
properties:
streamId:
allOf:
- $ref: "#/components/schemas/StreamId"
- description: The stream ID.
streamArn:
allOf:
- $ref: "#/components/schemas/StreamArn"
- description: The stream ARN.
streamVersion:
allOf:
- $ref: "#/components/schemas/StreamVersion"
- description: The stream version.
description:
allOf:
- $ref: "#/components/schemas/StreamDescription"
- description: The description of the stream.
files:
allOf:
- $ref: "#/components/schemas/StreamFiles"
- description: The files to stream.
createdAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date when the stream was created.
lastUpdatedAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date when the stream was last updated.
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: An IAM role IoT assumes to access your S3 files.
description: Information about a stream.
DescribeThingGroupRequest:
type: object
title: DescribeThingGroupRequest
properties: {}
ThingGroupMetadata:
type: object
properties:
parentGroupName:
allOf:
- $ref: "#/components/schemas/ThingGroupName"
- description: The parent thing group name.
rootToParentThingGroups:
allOf:
- $ref: "#/components/schemas/ThingGroupNameAndArnList"
- description: The root parent thing group.
creationDate:
allOf:
- $ref: "#/components/schemas/CreationDate"
- description: The UNIX timestamp of when the thing group was created.
description: Thing group metadata.
DynamicGroupStatus:
type: string
enum:
- ACTIVE
- BUILDING
- REBUILDING
TaskId:
type: string
maxLength: 40
DescribeThingRegistrationTaskRequest:
type: object
title: DescribeThingRegistrationTaskRequest
properties: {}
RegistryS3BucketName:
type: string
pattern: "[a-zA-Z0-9._-]+"
minLength: 3
maxLength: 256
RegistryS3KeyName:
type: string
pattern: "[a-zA-Z0-9!_.*'()-\\/]+"
minLength: 1
maxLength: 1024
Status:
type: string
enum:
- InProgress
- Completed
- Failed
- Cancelled
- Cancelling
Percentage:
type: integer
minimum: 0
maximum: 100
DescribeThingRequest:
type: object
title: DescribeThingRequest
properties: {}
description: The input for the DescribeThing operation.
DescribeThingTypeRequest:
type: object
title: DescribeThingTypeRequest
properties: {}
description: The input for the DescribeThingType operation.
ThingTypeMetadata:
type: object
properties:
deprecated:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether the thing type is deprecated. If true, no new things could be associated with this type.
deprecationDate:
allOf:
- $ref: "#/components/schemas/DeprecationDate"
- description: The date and time when the thing type was deprecated.
creationDate:
allOf:
- $ref: "#/components/schemas/CreationDate"
- description: The date and time when the thing type was created.
description: "The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and
time when time was deprecated."
S3Destination:
type: object
properties:
bucket:
allOf:
- $ref: "#/components/schemas/S3Bucket"
- description: The S3 bucket that contains the updated firmware.
prefix:
allOf:
- $ref: "#/components/schemas/Prefix"
- description: The S3 prefix.
description: Describes the location of updated firmware in S3.
Destination:
type: object
properties:
s3Destination:
allOf:
- $ref: "#/components/schemas/S3Destination"
- description: Describes the location in S3 of the updated firmware.
description: Describes the location of the updated firmware.
DetachPolicyRequest:
type: object
required:
- target
title: DetachPolicyRequest
properties:
target:
allOf:
- $ref: "#/components/schemas/PolicyTarget"
- description: The target from which the policy will be detached.
DetachPrincipalPolicyRequest:
type: object
title: DetachPrincipalPolicyRequest
properties: {}
description: The input for the DetachPrincipalPolicy operation.
DetachSecurityProfileRequest:
type: object
title: DetachSecurityProfileRequest
properties: {}
DetachThingPrincipalRequest:
type: object
title: DetachThingPrincipalRequest
properties: {}
description: The input for the DetachThingPrincipal operation.
DetailsKey:
type: string
pattern: "[a-zA-Z0-9:_-]+"
minLength: 1
maxLength: 128
DetectMitigationActionExecutionStatus:
type: string
enum:
- IN_PROGRESS
- SUCCESSFUL
- FAILED
- SKIPPED
DetectMitigationActionExecutionErrorCode:
type: string
DetectMitigationActionExecution:
type: object
properties:
taskId:
allOf:
- $ref: "#/components/schemas/MitigationActionsTaskId"
- description: " The unique identifier of the task. "
violationId:
allOf:
- $ref: "#/components/schemas/ViolationId"
- description: " The unique identifier of the violation. "
actionName:
allOf:
- $ref: "#/components/schemas/MitigationActionName"
- description: " The friendly name that uniquely identifies the mitigation action. "
thingName:
allOf:
- $ref: "#/components/schemas/DeviceDefenderThingName"
- description: " The name of the thing. "
executionStartDate:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The date a mitigation action was started. "
executionEndDate:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The date a mitigation action ended. "
status:
allOf:
- $ref: "#/components/schemas/DetectMitigationActionExecutionStatus"
- description: " The status of a mitigation action. "
errorCode:
allOf:
- $ref: "#/components/schemas/DetectMitigationActionExecutionErrorCode"
- description: " The error code of a mitigation action. "
message:
allOf:
- $ref: "#/components/schemas/ErrorMessage"
- description: " The message of a mitigation action. "
description: " Describes which mitigation actions should be executed. "
DetectMitigationActionExecutionList:
type: array
items:
$ref: "#/components/schemas/DetectMitigationActionExecution"
GenericLongValue:
type: integer
DetectMitigationActionsTaskStatistics:
type: object
properties:
actionsExecuted:
allOf:
- $ref: "#/components/schemas/GenericLongValue"
- description: " The actions that were performed. "
actionsSkipped:
allOf:
- $ref: "#/components/schemas/GenericLongValue"
- description: " The actions that were skipped. "
actionsFailed:
allOf:
- $ref: "#/components/schemas/GenericLongValue"
- description: " The actions that failed. "
description: " The statistics of a mitigation action task. "
DetectMitigationActionsTaskStatus:
type: string
enum:
- IN_PROGRESS
- SUCCESSFUL
- FAILED
- CANCELED
DetectMitigationActionsTaskTarget:
type: object
properties:
violationIds:
allOf:
- $ref: "#/components/schemas/TargetViolationIdsForDetectMitigationActions"
- description: " The unique identifiers of the violations. "
securityProfileName:
allOf:
- $ref: "#/components/schemas/SecurityProfileName"
- description: " The name of the security profile. "
behaviorName:
allOf:
- $ref: "#/components/schemas/BehaviorName"
- description: " The name of the behavior. "
description: " The target of a mitigation action task. "
ViolationEventOccurrenceRange:
type: object
required:
- startTime
- endTime
properties:
startTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The start date and time of a time period in which violation events occurred. "
endTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The end date and time of a time period in which violation events occurred. "
description: " Specifies the time period of which violation events occurred between. "
PrimitiveBoolean:
type: boolean
DetectMitigationActionsTaskSummaryList:
type: array
items:
$ref: "#/components/schemas/DetectMitigationActionsTaskSummary"
DetectMitigationActionsToExecuteList:
type: array
items:
$ref: "#/components/schemas/MitigationActionName"
minItems: 1
maxItems: 5
DeviceCertificateUpdateAction:
type: string
enum:
- DEACTIVATE
DimensionNames:
type: array
items:
$ref: "#/components/schemas/DimensionName"
DimensionValueOperator:
type: string
enum:
- IN
- NOT_IN
DisableAllLogs:
type: boolean
DisableTopicRuleRequest:
type: object
title: DisableTopicRuleRequest
properties: {}
description: The input for the DisableTopicRuleRequest operation.
DisconnectReason:
type: string
ParameterKey:
type: string
pattern: "[a-zA-Z0-9_-]+"
minLength: 1
maxLength: 128
Regex:
type: string
Example:
type: string
pattern: "[^\\p{C}]+"
Optional:
type: boolean
DocumentParameter:
type: object
properties:
key:
allOf:
- $ref: "#/components/schemas/ParameterKey"
- description: Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
description:
allOf:
- $ref: "#/components/schemas/JobDescription"
- description: Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
regex:
allOf:
- $ref: "#/components/schemas/Regex"
- description: A regular expression of the patterns that need to be replaced in a managed template job document schema.
example:
allOf:
- $ref: "#/components/schemas/Example"
- description: An example illustrating a pattern that need to be replaced in a managed template job document schema.
optional:
allOf:
- $ref: "#/components/schemas/Optional"
- description: Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
description: A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.
documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This
parameter can't be used with custom job templates or to create jobs from them.
The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. A domain configuration can be associated with an Amazon Web Services-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.
Data
Jobs
CredentialProvider
Thing indexing mode. Valid values are:
REGISTRY – Your thing index contains registry data only.
REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
OFF - Thing indexing is disabled.
Thing connectivity indexing mode. Valid values are:
STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.
OFF - Thing connectivity status indexing is disabled.
Device Defender indexing mode. Valid values are:
VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.
OFF - Device Defender indexing is disabled.
For more information about Device Defender violations, see Device Defender Detect.
namedShadowIndexingMode: allOf: - $ref: "#/components/schemas/NamedShadowIndexingMode" - description:Named shadow indexing mode. Valid values are:
ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.
OFF - Named shadow indexing is disabled.
For more information about Shadows, see IoT Device Shadow service.
managedFields: allOf: - $ref: "#/components/schemas/Fields" - description: Contains fields that are indexed and whose types are already known by the Fleet Indexing service. customFields: allOf: - $ref: "#/components/schemas/Fields" - description: Contains custom field names and their data type. filter: allOf: - $ref: "#/components/schemas/IndexingFilter" - description: Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, setnamedShadowIndexingMode to be ON and specify your shadow names in filter.
description: The thing indexing configuration. For more information, see Managing Thing Indexing.
ThingGroupIndexingConfiguration:
type: object
required:
- thingGroupIndexingMode
properties:
thingGroupIndexingMode:
allOf:
- $ref: "#/components/schemas/ThingGroupIndexingMode"
- description: Thing group indexing mode.
managedFields:
allOf:
- $ref: "#/components/schemas/Fields"
- description: Contains fields that are indexed and whose types are already known by the Fleet Indexing service. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.
customFields:
allOf:
- $ref: "#/components/schemas/Fields"
- description: A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
Contains custom field names and their data type.
description: Thing group indexing configuration. GetJobDocumentRequest: type: object title: GetJobDocumentRequest properties: {} GetLoggingOptionsRequest: type: object title: GetLoggingOptionsRequest properties: {} description: The input for the GetLoggingOptions operation. GetOTAUpdateRequest: type: object title: GetOTAUpdateRequest properties: {} OTAUpdateInfo: type: object properties: otaUpdateId: allOf: - $ref: "#/components/schemas/OTAUpdateId" - description: The OTA update ID. otaUpdateArn: allOf: - $ref: "#/components/schemas/OTAUpdateArn" - description: The OTA update ARN. creationDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date when the OTA update was created. lastModifiedDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date when the OTA update was last updated. description: allOf: - $ref: "#/components/schemas/OTAUpdateDescription" - description: A description of the OTA update. targets: allOf: - $ref: "#/components/schemas/Targets" - description: The targets of the OTA update. protocols: allOf: - $ref: "#/components/schemas/Protocols" - description: The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol. awsJobExecutionsRolloutConfig: allOf: - $ref: "#/components/schemas/AwsJobExecutionsRolloutConfig" - description: Configuration for the rollout of OTA updates. awsJobPresignedUrlConfig: allOf: - $ref: "#/components/schemas/AwsJobPresignedUrlConfig" - description: Configuration information for pre-signed URLs. Valid whenprotocols contains HTTP.
targetSelection:
allOf:
- $ref: "#/components/schemas/TargetSelection"
- description: "Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If
continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even
after the OTA update was completed by all things originally in the group. "
otaUpdateFiles:
allOf:
- $ref: "#/components/schemas/OTAUpdateFiles"
- description: A list of files associated with the OTA update.
otaUpdateStatus:
allOf:
- $ref: "#/components/schemas/OTAUpdateStatus"
- description: The status of the OTA update.
awsIotJobId:
allOf:
- $ref: "#/components/schemas/AwsIotJobId"
- description: The IoT job ID associated with the OTA update.
awsIotJobArn:
allOf:
- $ref: "#/components/schemas/AwsIotJobArn"
- description: The IoT job ARN associated with the OTA update.
errorInfo:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- description: Error information associated with the OTA update.
additionalParameters:
allOf:
- $ref: "#/components/schemas/AdditionalParameterMap"
- description: A collection of name/value pairs
description: Information about an OTA update.
PercentList:
type: array
items:
$ref: "#/components/schemas/Percent"
GetPercentilesRequest:
type: object
required:
- queryString
title: GetPercentilesRequest
properties:
indexName:
allOf:
- $ref: "#/components/schemas/IndexName"
- description: The name of the index to search.
queryString:
allOf:
- $ref: "#/components/schemas/QueryString"
- description: The search query string.
aggregationField:
allOf:
- $ref: "#/components/schemas/AggregationField"
- description: The field to aggregate.
queryVersion:
allOf:
- $ref: "#/components/schemas/QueryVersion"
- description: The query version.
percents:
allOf:
- $ref: "#/components/schemas/PercentList"
- description: The percentile groups returned.
Percentiles:
type: array
items:
$ref: "#/components/schemas/PercentPair"
GetPolicyRequest:
type: object
title: GetPolicyRequest
properties: {}
description: The input for the GetPolicy operation.
GetPolicyVersionRequest:
type: object
title: GetPolicyVersionRequest
properties: {}
description: The input for the GetPolicyVersion operation.
GetRegistrationCodeRequest:
type: object
title: GetRegistrationCodeRequest
properties: {}
description: The input to the GetRegistrationCode operation.
RegistrationCode:
type: string
pattern: (0x)?[a-fA-F0-9]+
minLength: 64
maxLength: 64
GetStatisticsRequest:
type: object
required:
- queryString
title: GetStatisticsRequest
properties:
indexName:
allOf:
- $ref: "#/components/schemas/IndexName"
- description: The name of the index to search. The default value is AWS_Things.
queryString:
allOf:
- $ref: "#/components/schemas/QueryString"
- description: The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.
aggregationField:
allOf:
- $ref: "#/components/schemas/AggregationField"
- description: The aggregation field name.
queryVersion:
allOf:
- $ref: "#/components/schemas/QueryVersion"
- description: The version of the query used to search.
Statistics:
type: object
properties:
count:
allOf:
- $ref: "#/components/schemas/Count"
- description: The count of things that match the query string criteria and contain a valid aggregation field value.
average:
allOf:
- $ref: "#/components/schemas/Average"
- description: The average of the aggregated field values.
sum:
allOf:
- $ref: "#/components/schemas/Sum"
- description: The sum of the aggregated field values.
minimum:
allOf:
- $ref: "#/components/schemas/Minimum"
- description: The minimum aggregated field value.
maximum:
allOf:
- $ref: "#/components/schemas/Maximum"
- description: The maximum aggregated field value.
sumOfSquares:
allOf:
- $ref: "#/components/schemas/SumOfSquares"
- description: The sum of the squares of the aggregated field values.
variance:
allOf:
- $ref: "#/components/schemas/Variance"
- description: The variance of the aggregated field values.
stdDeviation:
allOf:
- $ref: "#/components/schemas/StdDeviation"
- description: The standard deviation of the aggregated field values.
description: A map of key-value pairs for all supported statistics. For issues with missing or unexpected values for this API, consult Fleet indexing troubleshooting guide.
GetTopicRuleDestinationRequest:
type: object
title: GetTopicRuleDestinationRequest
properties: {}
GetTopicRuleRequest:
type: object
title: GetTopicRuleRequest
properties: {}
description: The input for the GetTopicRule operation.
RuleArn:
type: string
TopicRule:
type: object
properties:
ruleName:
allOf:
- $ref: "#/components/schemas/RuleName"
- description: The name of the rule.
sql:
allOf:
- $ref: "#/components/schemas/SQL"
- description: The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
description:
allOf:
- $ref: "#/components/schemas/Description"
- description: The description of the rule.
createdAt:
allOf:
- $ref: "#/components/schemas/CreatedAtDate"
- description: The date and time the rule was created.
actions:
allOf:
- $ref: "#/components/schemas/ActionList"
- description: The actions associated with the rule.
ruleDisabled:
allOf:
- $ref: "#/components/schemas/IsDisabled"
- description: Specifies whether the rule is disabled.
awsIotSqlVersion:
allOf:
- $ref: "#/components/schemas/AwsIotSqlVersion"
- description: The version of the SQL rules engine to use when evaluating the rule.
errorAction:
allOf:
- $ref: "#/components/schemas/Action"
- description: The action to perform when an error occurs.
description: Describes a rule.
GetV2LoggingOptionsRequest:
type: object
title: GetV2LoggingOptionsRequest
properties: {}
HeaderKey:
type: string
minLength: 1
maxLength: 256
HttpActionHeader:
type: object
required:
- key
- value
properties:
key:
allOf:
- $ref: "#/components/schemas/HeaderKey"
- description: The HTTP header key.
value:
allOf:
- $ref: "#/components/schemas/HeaderValue"
- description: The HTTP header value. Substitution templates are supported.
description: The HTTP action header.
HeaderList:
type: array
items:
$ref: "#/components/schemas/HttpActionHeader"
minItems: 0
maxItems: 100
HeaderValue:
type: string
Url:
type: string
maxLength: 2000
HttpAuthorization:
type: object
properties:
sigv4:
allOf:
- $ref: "#/components/schemas/SigV4Authorization"
- description: Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process.
description: The authorization method used to send messages.
SigV4Authorization:
type: object
required:
- signingRegion
- serviceName
- roleArn
properties:
signingRegion:
allOf:
- $ref: "#/components/schemas/SigningRegion"
- description: The signing region.
serviceName:
allOf:
- $ref: "#/components/schemas/ServiceName"
- description: The service name to use while signing with Sig V4.
roleArn:
allOf:
- $ref: "#/components/schemas/AwsArn"
- description: The ARN of the signing role.
description: For more information, see Signature Version 4 signing process.
HttpContext:
type: object
properties:
headers:
allOf:
- $ref: "#/components/schemas/HttpHeaders"
- description: The header keys and values in an HTTP authorization request.
queryString:
allOf:
- $ref: "#/components/schemas/HttpQueryString"
- description: The query string keys and values in an HTTP authorization request.
description: Specifies the HTTP context to use for the test authorizer request.
HttpHeaderName:
type: string
pattern: "[\\s\\S]*"
minLength: 1
maxLength: 8192
HttpHeaderValue:
type: string
pattern: "[\\s\\S]*"
minLength: 1
maxLength: 8192
HttpUrlDestinationProperties:
type: object
properties:
confirmationUrl:
allOf:
- $ref: "#/components/schemas/Url"
- description: The URL used to confirm the HTTP topic rule destination URL.
description: HTTP URL destination properties.
HttpUrlDestinationSummary:
type: object
properties:
confirmationUrl:
allOf:
- $ref: "#/components/schemas/Url"
- description: The URL used to confirm ownership of or access to the HTTP topic rule destination URL.
description: Information about an HTTP URL destination.
InProgressChecksCount:
type: integer
InProgressThings:
type: integer
IndexNamesList:
type: array
items:
$ref: "#/components/schemas/IndexName"
NamedShadowNamesFilter:
type: array
items:
$ref: "#/components/schemas/ShadowName"
InputName:
type: string
minLength: 1
maxLength: 128
MessageId:
type: string
maxLength: 128
PutAssetPropertyValueEntryList:
type: array
items:
$ref: "#/components/schemas/PutAssetPropertyValueEntry"
minItems: 1
IsAuthenticated:
type: boolean
IssuerCertificateSubject:
type: string
pattern: "[\\p{Graph}\\x20]*"
maxLength: 1000
IssuerId:
type: string
pattern: (0x)?[a-fA-F0-9]+
maxLength: 64
IssuerCertificateSerialNumber:
type: string
pattern: "[a-fA-F0-9:]+"
maxLength: 20
JobStatus:
type: string
enum:
- IN_PROGRESS
- CANCELED
- COMPLETED
- DELETION_IN_PROGRESS
- SCHEDULED
JobProcessDetails:
type: object
properties:
processingTargets:
allOf:
- $ref: "#/components/schemas/ProcessingTargetNameList"
- description: The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.
numberOfCanceledThings:
allOf:
- $ref: "#/components/schemas/CanceledThings"
- description: The number of things that cancelled the job.
numberOfSucceededThings:
allOf:
- $ref: "#/components/schemas/SucceededThings"
- description: The number of things which successfully completed the job.
numberOfFailedThings:
allOf:
- $ref: "#/components/schemas/FailedThings"
- description: The number of things that failed executing the job.
numberOfRejectedThings:
allOf:
- $ref: "#/components/schemas/RejectedThings"
- description: The number of things that rejected the job.
numberOfQueuedThings:
allOf:
- $ref: "#/components/schemas/QueuedThings"
- description: The number of things that are awaiting execution of the job.
numberOfInProgressThings:
allOf:
- $ref: "#/components/schemas/InProgressThings"
- description: The number of things currently executing the job.
numberOfRemovedThings:
allOf:
- $ref: "#/components/schemas/RemovedThings"
- description: The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.
numberOfTimedOutThings:
allOf:
- $ref: "#/components/schemas/TimedOutThings"
- description: The number of things whose job execution status is TIMED_OUT.
description: The job process details.
ScheduledJobRolloutList:
type: array
items:
$ref: "#/components/schemas/ScheduledJobRollout"
JobExecutionStatus:
type: string
enum:
- QUEUED
- IN_PROGRESS
- SUCCEEDED
- FAILED
- TIMED_OUT
- REJECTED
- REMOVED
- CANCELED
JobExecutionStatusDetails:
type: object
properties:
detailsMap:
allOf:
- $ref: "#/components/schemas/DetailsMap"
- description: The job execution status.
description: Details of the job execution status.
VersionNumber:
type: integer
RetryAttempt:
type: integer
JobExecutionSummary:
type: object
properties:
status:
allOf:
- $ref: "#/components/schemas/JobExecutionStatus"
- description: The status of the job execution.
queuedAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The time, in seconds since the epoch, when the job execution was queued.
startedAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The time, in seconds since the epoch, when the job execution started.
lastUpdatedAt:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The time, in seconds since the epoch, when the job execution was last updated.
executionNumber:
allOf:
- $ref: "#/components/schemas/ExecutionNumber"
- description: A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used later in commands which return or
update job execution information.
retryAttempt:
allOf:
- $ref: "#/components/schemas/RetryAttempt"
- description: The number that indicates how many retry attempts have been completed for this job on this device.
description: The job execution summary.
JobExecutionSummaryForJob:
type: object
properties:
thingArn:
allOf:
- $ref: "#/components/schemas/ThingArn"
- description: The ARN of the thing on which the job execution is running.
jobExecutionSummary:
allOf:
- $ref: "#/components/schemas/JobExecutionSummary"
- description: Contains a subset of information about a job execution.
description: Contains a summary of information about job executions for a specific job.
JobExecutionSummaryForJobList:
type: array
items:
$ref: "#/components/schemas/JobExecutionSummaryForJob"
JobExecutionSummaryForThing:
type: object
properties:
jobId:
allOf:
- $ref: "#/components/schemas/JobId"
- description: The unique identifier you assigned to this job when it was created.
jobExecutionSummary:
allOf:
- $ref: "#/components/schemas/JobExecutionSummary"
- description: Contains a subset of information about a job execution.
description: The job execution summary for a thing.
JobExecutionSummaryForThingList:
type: array
items:
$ref: "#/components/schemas/JobExecutionSummaryForThing"
ProcessingTargetNameList:
type: array
items:
$ref: "#/components/schemas/ProcessingTargetName"
SucceededThings:
type: integer
RejectedThings:
type: integer
QueuedThings:
type: integer
RemovedThings:
type: integer
TimedOutThings:
type: integer
JobSummary:
type: object
properties:
jobArn:
allOf:
- $ref: "#/components/schemas/JobArn"
- description: The job ARN.
jobId:
allOf:
- $ref: "#/components/schemas/JobId"
- description: The unique identifier you assigned to this job when it was created.
thingGroupId:
allOf:
- $ref: "#/components/schemas/ThingGroupId"
- description: The ID of the thing group.
targetSelection:
allOf:
- $ref: "#/components/schemas/TargetSelection"
- 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). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
ascendingOrder=true. "
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: " The token for the next set of results. "
maxResults:
allOf:
- $ref: "#/components/schemas/MaxResults"
- description: " The maximum number of results to return at one time. The default is 25. "
ListAuditTasksRequest:
type: object
title: ListAuditTasksRequest
properties: {}
ListAuthorizersRequest:
type: object
title: ListAuthorizersRequest
properties: {}
RegistryMaxResults:
type: integer
minimum: 1
maximum: 250
ListBillingGroupsRequest:
type: object
title: ListBillingGroupsRequest
properties: {}
ListCACertificatesRequest:
type: object
title: ListCACertificatesRequest
properties: {}
description: Input for the ListCACertificates operation.
ListCertificatesByCARequest:
type: object
title: ListCertificatesByCARequest
properties: {}
description: The input to the ListCertificatesByCA operation.
ListCertificatesRequest:
type: object
title: ListCertificatesRequest
properties: {}
description: The input for the ListCertificates operation.
ListCustomMetricsRequest:
type: object
title: ListCustomMetricsRequest
properties: {}
MetricNames:
type: array
items:
$ref: "#/components/schemas/MetricName"
ListDetectMitigationActionsExecutionsRequest:
type: object
title: ListDetectMitigationActionsExecutionsRequest
properties: {}
ListDetectMitigationActionsTasksRequest:
type: object
title: ListDetectMitigationActionsTasksRequest
properties: {}
ListDimensionsRequest:
type: object
title: ListDimensionsRequest
properties: {}
ListDomainConfigurationsRequest:
type: object
title: ListDomainConfigurationsRequest
properties: {}
ListFleetMetricsRequest:
type: object
title: ListFleetMetricsRequest
properties: {}
QueryMaxResults:
type: integer
minimum: 1
maximum: 500
ListIndicesRequest:
type: object
title: ListIndicesRequest
properties: {}
ListJobExecutionsForJobRequest:
type: object
title: ListJobExecutionsForJobRequest
properties: {}
ListJobExecutionsForThingRequest:
type: object
title: ListJobExecutionsForThingRequest
properties: {}
ListJobTemplatesRequest:
type: object
title: ListJobTemplatesRequest
properties: {}
ListJobsRequest:
type: object
title: ListJobsRequest
properties: {}
ListManagedJobTemplatesRequest:
type: object
title: ListManagedJobTemplatesRequest
properties: {}
ManagedJobTemplatesSummaryList:
type: array
items:
$ref: "#/components/schemas/ManagedJobTemplateSummary"
ListMetricValuesRequest:
type: object
title: ListMetricValuesRequest
properties: {}
MetricDatumList:
type: array
items:
$ref: "#/components/schemas/MetricDatum"
ListMitigationActionsRequest:
type: object
title: ListMitigationActionsRequest
properties: {}
MitigationActionIdentifierList:
type: array
items:
$ref: "#/components/schemas/MitigationActionIdentifier"
ListOTAUpdatesRequest:
type: object
title: ListOTAUpdatesRequest
properties: {}
OTAUpdatesSummary:
type: array
items:
$ref: "#/components/schemas/OTAUpdateSummary"
ListOutgoingCertificatesRequest:
type: object
title: ListOutgoingCertificatesRequest
properties: {}
description: The input to the ListOutgoingCertificates operation.
OutgoingCertificates:
type: array
items:
$ref: "#/components/schemas/OutgoingCertificate"
ListPoliciesRequest:
type: object
title: ListPoliciesRequest
properties: {}
description: The input for the ListPolicies operation.
ListPolicyPrincipalsRequest:
type: object
title: ListPolicyPrincipalsRequest
properties: {}
description: The input for the ListPolicyPrincipals operation.
Principals:
type: array
items:
$ref: "#/components/schemas/PrincipalArn"
ListPolicyVersionsRequest:
type: object
title: ListPolicyVersionsRequest
properties: {}
description: The input for the ListPolicyVersions operation.
PolicyVersions:
type: array
items:
$ref: "#/components/schemas/PolicyVersion"
ListPrincipalPoliciesRequest:
type: object
title: ListPrincipalPoliciesRequest
properties: {}
description: The input for the ListPrincipalPolicies operation.
ListPrincipalThingsRequest:
type: object
title: ListPrincipalThingsRequest
properties: {}
description: The input for the ListPrincipalThings operation.
ThingNameList:
type: array
items:
$ref: "#/components/schemas/ThingName"
ListProvisioningTemplateVersionsRequest:
type: object
title: ListProvisioningTemplateVersionsRequest
properties: {}
ProvisioningTemplateVersionListing:
type: array
items:
$ref: "#/components/schemas/ProvisioningTemplateVersionSummary"
ListProvisioningTemplatesRequest:
type: object
title: ListProvisioningTemplatesRequest
properties: {}
ProvisioningTemplateListing:
type: array
items:
$ref: "#/components/schemas/ProvisioningTemplateSummary"
ListRelatedResourcesForAuditFindingRequest:
type: object
title: ListRelatedResourcesForAuditFindingRequest
properties: {}
ListRoleAliasesRequest:
type: object
title: ListRoleAliasesRequest
properties: {}
RoleAliases:
type: array
items:
$ref: "#/components/schemas/RoleAlias"
ListScheduledAuditsRequest:
type: object
title: ListScheduledAuditsRequest
properties: {}
ScheduledAuditMetadataList:
type: array
items:
$ref: "#/components/schemas/ScheduledAuditMetadata"
ListSecurityProfilesForTargetRequest:
type: object
title: ListSecurityProfilesForTargetRequest
properties: {}
SecurityProfileTargetMappings:
type: array
items:
$ref: "#/components/schemas/SecurityProfileTargetMapping"
ListSecurityProfilesRequest:
type: object
title: ListSecurityProfilesRequest
properties: {}
SecurityProfileIdentifiers:
type: array
items:
$ref: "#/components/schemas/SecurityProfileIdentifier"
ListStreamsRequest:
type: object
title: ListStreamsRequest
properties: {}
StreamsSummary:
type: array
items:
$ref: "#/components/schemas/StreamSummary"
ResourceArn:
type: string
ListTagsForResourceRequest:
type: object
title: ListTagsForResourceRequest
properties: {}
ListTargetsForPolicyRequest:
type: object
title: ListTargetsForPolicyRequest
properties: {}
PolicyTargets:
type: array
items:
$ref: "#/components/schemas/PolicyTarget"
ListTargetsForSecurityProfileRequest:
type: object
title: ListTargetsForSecurityProfileRequest
properties: {}
SecurityProfileTargets:
type: array
items:
$ref: "#/components/schemas/SecurityProfileTarget"
ListThingGroupsForThingRequest:
type: object
title: ListThingGroupsForThingRequest
properties: {}
ThingGroupNameAndArnList:
type: array
items:
$ref: "#/components/schemas/GroupNameAndArn"
RecursiveWithoutDefault:
type: boolean
ListThingGroupsRequest:
type: object
title: ListThingGroupsRequest
properties: {}
ListThingPrincipalsRequest:
type: object
title: ListThingPrincipalsRequest
properties: {}
description: The input for the ListThingPrincipal operation.
ReportType:
type: string
enum:
- ERRORS
- RESULTS
ListThingRegistrationTaskReportsRequest:
type: object
title: ListThingRegistrationTaskReportsRequest
properties: {}
S3FileUrlList:
type: array
items:
$ref: "#/components/schemas/S3FileUrl"
ListThingRegistrationTasksRequest:
type: object
title: ListThingRegistrationTasksRequest
properties: {}
TaskIdList:
type: array
items:
$ref: "#/components/schemas/TaskId"
ListThingTypesRequest:
type: object
title: ListThingTypesRequest
properties: {}
description: The input for the ListThingTypes operation.
ThingTypeList:
type: array
items:
$ref: "#/components/schemas/ThingTypeDefinition"
ListThingsInBillingGroupRequest:
type: object
title: ListThingsInBillingGroupRequest
properties: {}
ListThingsInThingGroupRequest:
type: object
title: ListThingsInThingGroupRequest
properties: {}
usePrefixAttributeValue:
type: boolean
ListThingsRequest:
type: object
title: ListThingsRequest
properties: {}
description: The input for the ListThings operation.
ThingAttributeList:
type: array
items:
$ref: "#/components/schemas/ThingAttribute"
TopicRuleDestinationMaxResults:
type: integer
minimum: 1
maximum: 1000
ListTopicRuleDestinationsRequest:
type: object
title: ListTopicRuleDestinationsRequest
properties: {}
TopicRuleDestinationSummaries:
type: array
items:
$ref: "#/components/schemas/TopicRuleDestinationSummary"
Topic:
type: string
TopicRuleMaxResults:
type: integer
minimum: 1
maximum: 10000
ListTopicRulesRequest:
type: object
title: ListTopicRulesRequest
properties: {}
description: The input for the ListTopicRules operation.
TopicRuleList:
type: array
items:
$ref: "#/components/schemas/TopicRuleListItem"
SkyfallMaxResults:
type: integer
minimum: 1
maximum: 250
ListV2LoggingLevelsRequest:
type: object
title: ListV2LoggingLevelsRequest
properties: {}
LogTargetConfigurations:
type: array
items:
$ref: "#/components/schemas/LogTargetConfiguration"
ListViolationEventsRequest:
type: object
title: ListViolationEventsRequest
properties: {}
ViolationEvents:
type: array
items:
$ref: "#/components/schemas/ViolationEvent"
LocationTimestamp:
type: object
required:
- value
properties:
value:
allOf:
- $ref: "#/components/schemas/String"
- description: An expression that returns a long epoch time value.
unit:
allOf:
- $ref: "#/components/schemas/String"
- description: "The precision of the timestamp value that results from the expression described in value.
Valid values: SECONDS | MILLISECONDS
| MICROSECONDS | NANOSECONDS. The default is MILLISECONDS.
username key in an MQTT authorization request.
password:
allOf:
- $ref: "#/components/schemas/MqttPassword"
- description: The value of the password key in an MQTT authorization request.
clientId:
allOf:
- $ref: "#/components/schemas/MqttClientId"
- description: The value of the clientId key in an MQTT authorization request.
description: Specifies the MQTT context to use for the test authorizer request
PayloadFormatIndicator:
type: string
minLength: 0
maxLength: 1024
ResponseTopic:
type: string
minLength: 0
maxLength: 1024
UserProperties:
type: array
items:
$ref: "#/components/schemas/UserProperty"
minItems: 1
maxItems: 100
MqttHeaders:
type: object
properties:
payloadFormatIndicator:
allOf:
- $ref: "#/components/schemas/PayloadFormatIndicator"
- description: An Enum string value that indicates whether the payload is formatted as UTF-8.
Valid values are UNSPECIFIED_BYTES and
UTF8_DATA.
For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates.
contentType: allOf: - $ref: "#/components/schemas/ContentType" - description:A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type from the MQTT Version 5.0 specification.
Supports substitution templates.
responseTopic: allOf: - $ref: "#/components/schemas/ResponseTopic" - description:A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic from the MQTT Version 5.0 specification.
Supports substitution templates.
correlationData: allOf: - $ref: "#/components/schemas/CorrelationData" - description:The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.
For more information, see Correlation Data from the MQTT Version 5.0 specification.
This binary data must be based64-encoded.
Supports substitution templates.
messageExpiry: allOf: - $ref: "#/components/schemas/MessageExpiry" - description:A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer
relevant to the subscriber. The value of messageExpiry represents the number of seconds before it expires. For more information about the limits of
messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas
from the Amazon Web Services Reference Guide.
Supports substitution templates.
userProperties: allOf: - $ref: "#/components/schemas/UserProperties" - description: An array of key-value pairs that you define in the MQTT5 header. description: Specifies MQTT Version 5.0 headers information. For more information, see MQTT from Amazon Web Services IoT Core Developer Guide. ShadowName: type: string pattern: "[a-zA-Z0-9:_-]+" minLength: 1 maxLength: 64 NonCompliantChecksCount: type: integer ResourceType: type: string enum: - DEVICE_CERTIFICATE - CA_CERTIFICATE - IOT_POLICY - COGNITO_IDENTITY_POOL - CLIENT_ID - ACCOUNT_SETTINGS - ROLE_ALIAS - IAM_ROLE - ISSUER_CERTIFICATE StringMap: type: object additionalProperties: $ref: "#/components/schemas/String" NumberOfRetries: type: integer minimum: 0 maximum: 10 NumberOfThings: type: integer minimum: 1 OTAUpdateFileVersion: type: string OTAUpdateSummary: type: object properties: otaUpdateId: allOf: - $ref: "#/components/schemas/OTAUpdateId" - description: The OTA update ID. otaUpdateArn: allOf: - $ref: "#/components/schemas/OTAUpdateArn" - description: The OTA update ARN. creationDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date when the OTA update was created. description: An OTA update summary. OutgoingCertificate: type: object properties: certificateArn: allOf: - $ref: "#/components/schemas/CertificateArn" - description: The certificate ARN. certificateId: allOf: - $ref: "#/components/schemas/CertificateId" - description: The certificate ID. transferredTo: allOf: - $ref: "#/components/schemas/AwsAccountId" - description: The Amazon Web Services account to which the transfer was made. transferDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date the transfer was initiated. transferMessage: allOf: - $ref: "#/components/schemas/Message" - description: The transfer message. creationDate: allOf: - $ref: "#/components/schemas/DateType" - description: The certificate creation date. description: A certificate that has been transferred but not yet accepted. Parameter: type: string pattern: "[\\s\\S]*" minLength: 0 maxLength: 2048 Parameters: type: object additionalProperties: $ref: "#/components/schemas/Value" PercentValue: type: number format: double PercentPair: type: object properties: percent: allOf: - $ref: "#/components/schemas/Percent" - description: The percentile. value: allOf: - $ref: "#/components/schemas/PercentValue" - description: The value of the percentile. description: Describes the percentile and percentile value. Platform: type: string Policy: type: object properties: policyName: allOf: - $ref: "#/components/schemas/PolicyName" - description: The policy name. policyArn: allOf: - $ref: "#/components/schemas/PolicyArn" - description: The policy ARN. description: Describes an IoT policy. PolicyDocuments: type: array items: $ref: "#/components/schemas/PolicyDocument" PolicyNames: type: array items: $ref: "#/components/schemas/PolicyName" PolicyTemplateName: type: string enum: - BLANK_POLICY PolicyVersion: type: object properties: versionId: allOf: - $ref: "#/components/schemas/PolicyVersionId" - description: The policy version ID. isDefaultVersion: allOf: - $ref: "#/components/schemas/IsDefaultVersion" - description: Specifies whether the policy version is the default. createDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date and time the policy was created. description: Describes a policy version. Port: type: integer minimum: 0 maximum: 65535 Prefix: type: string PrincipalArn: type: string PrincipalId: type: string pattern: "[a-zA-Z0-9]+" minLength: 1 maxLength: 128 ProcessingTargetName: type: string ProvisioningTemplateSummary: type: object properties: templateArn: allOf: - $ref: "#/components/schemas/TemplateArn" - description: The ARN of the provisioning template. templateName: allOf: - $ref: "#/components/schemas/TemplateName" - description: The name of the provisioning template. description: allOf: - $ref: "#/components/schemas/TemplateDescription" - description: The description of the provisioning template. creationDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date when the provisioning template summary was created. lastModifiedDate: allOf: - $ref: "#/components/schemas/DateType" - description: The date when the provisioning template summary was last modified. enabled: allOf: - $ref: "#/components/schemas/Enabled" - description: True if the fleet provision template is enabled, otherwise false. type: allOf: - $ref: "#/components/schemas/TemplateType" - description: "The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value isFLEET_PROVISIONING.
For more information about provisioning template, see: Provisioning template. "
description: A summary of information about a provisioning template.
ProvisioningTemplateVersionSummary:
type: object
properties:
versionId:
allOf:
- $ref: "#/components/schemas/TemplateVersionId"
- description: The ID of the fleet provisioning template version.
creationDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date when the provisioning template version was created
isDefaultVersion:
allOf:
- $ref: "#/components/schemas/IsDefaultVersion"
- description: True if the provisioning template version is the default version, otherwise false.
description: A summary of information about a fleet provision template version.
SnsTopicArn:
type: string
maxLength: 350
PutAssetPropertyValueEntry:
type: object
required:
- propertyValues
properties:
entryId:
allOf:
- $ref: "#/components/schemas/AssetPropertyEntryId"
- description: Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to
a new UUID.
assetId:
allOf:
- $ref: "#/components/schemas/AssetId"
- description: The ID of the IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution
templates.
propertyId:
allOf:
- $ref: "#/components/schemas/AssetPropertyId"
- description: The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution
templates.
propertyAlias:
allOf:
- $ref: "#/components/schemas/AssetPropertyAlias"
- description: The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a
propertyId. Accepts substitution templates.
propertyValues:
allOf:
- $ref: "#/components/schemas/AssetPropertyValueList"
- description: A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
description: An asset property value entry containing the following information.
PutVerificationStateOnViolationRequest:
type: object
required:
- verificationState
title: PutVerificationStateOnViolationRequest
properties:
verificationState:
allOf:
- $ref: "#/components/schemas/VerificationState"
- description: The verification state of the violation.
verificationStateDescription:
allOf:
- $ref: "#/components/schemas/VerificationStateDescription"
- description: The description of the verification state of the violation (detect alarm).
Qos:
type: integer
minimum: 0
maximum: 1
QueueUrl:
type: string
RegisterCACertificateRequest:
type: object
required:
- caCertificate
title: RegisterCACertificateRequest
properties:
caCertificate:
allOf:
- $ref: "#/components/schemas/CertificatePem"
- description: The CA certificate.
verificationCertificate:
allOf:
- $ref: "#/components/schemas/CertificatePem"
- description: "The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode
is DEFAULT or not provided, the verificationCertificate field must not be empty. "
registrationConfig:
allOf:
- $ref: "#/components/schemas/RegistrationConfig"
- description: Information about the registration configuration.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: 'Metadata which can be used to manage the CA certificate.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
verificationCertificate field is not provided, set certificateMode
to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is
not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information
about certificate mode for device certificates, see
certificate mode. '
description: The input to the RegisterCACertificate operation.
SetAsActiveFlag:
type: boolean
RegisterCertificateRequest:
type: object
required:
- certificatePem
title: RegisterCertificateRequest
properties:
certificatePem:
allOf:
- $ref: "#/components/schemas/CertificatePem"
- description: The certificate data, in PEM format.
caCertificatePem:
allOf:
- $ref: "#/components/schemas/CertificatePem"
- description: The CA certificate used to sign the device certificate being registered.
status:
allOf:
- $ref: "#/components/schemas/CertificateStatus"
- description: The status of the register certificate request. Valid values that you can use include ACTIVE, INACTIVE, and REVOKED.
description: The input to the RegisterCertificate operation.
RegisterCertificateWithoutCARequest:
type: object
required:
- certificatePem
title: RegisterCertificateWithoutCARequest
properties:
certificatePem:
allOf:
- $ref: "#/components/schemas/CertificatePem"
- description: The certificate data, in PEM format.
status:
allOf:
- $ref: "#/components/schemas/CertificateStatus"
- description: The status of the register certificate request.
RegisterThingRequest:
type: object
required:
- templateBody
title: RegisterThingRequest
properties:
templateBody:
allOf:
- $ref: "#/components/schemas/TemplateBody"
- description: The provisioning template. See Provisioning Devices That Have Device Certificates for
more information.
parameters:
allOf:
- $ref: "#/components/schemas/Parameters"
- description: The parameters for provisioning a thing. See Provisioning Templates for more
information.
ResourceArns:
type: object
additionalProperties:
$ref: "#/components/schemas/ResourceArn"
RejectCertificateTransferRequest:
type: object
title: RejectCertificateTransferRequest
properties:
rejectReason:
allOf:
- $ref: "#/components/schemas/Message"
- description: The reason the certificate transfer was rejected.
description: The input for the RejectCertificateTransfer operation.
RelatedResource:
type: object
properties:
resourceType:
allOf:
- $ref: "#/components/schemas/ResourceType"
- description: The type of resource.
resourceIdentifier:
allOf:
- $ref: "#/components/schemas/ResourceIdentifier"
- description: Information that identifies the resource.
additionalInfo:
allOf:
- $ref: "#/components/schemas/StringMap"
- description: Other information about the resource.
description: Information about a related resource.
RemoveAuthorizerConfig:
type: boolean
RemoveAutoRegistration:
type: boolean
RemoveHook:
type: boolean
RemoveThingFromBillingGroupRequest:
type: object
title: RemoveThingFromBillingGroupRequest
properties:
billingGroupName:
allOf:
- $ref: "#/components/schemas/BillingGroupName"
- description: The name of the billing group.
billingGroupArn:
allOf:
- $ref: "#/components/schemas/BillingGroupArn"
- description: The ARN of the billing group.
thingName:
allOf:
- $ref: "#/components/schemas/ThingName"
- description: The name of the thing to be removed from the billing group.
thingArn:
allOf:
- $ref: "#/components/schemas/ThingArn"
- description: The ARN of the thing to be removed from the billing group.
RemoveThingFromThingGroupRequest:
type: object
title: RemoveThingFromThingGroupRequest
properties:
thingGroupName:
allOf:
- $ref: "#/components/schemas/ThingGroupName"
- description: The group name.
thingGroupArn:
allOf:
- $ref: "#/components/schemas/ThingGroupArn"
- description: The group ARN.
thingName:
allOf:
- $ref: "#/components/schemas/ThingName"
- description: The name of the thing to remove from the group.
thingArn:
allOf:
- $ref: "#/components/schemas/ThingArn"
- description: The ARN of the thing to remove from the group.
RemoveThingType:
type: boolean
ReplaceTopicRuleRequest:
type: object
required:
- topicRulePayload
title: ReplaceTopicRuleRequest
properties:
topicRulePayload:
allOf:
- $ref: "#/components/schemas/TopicRulePayload"
- description: The rule payload.
description: The input for the ReplaceTopicRule operation.
TopicPattern:
type: string
Resource:
type: string
pattern: "[\\s\\S]*"
maxLength: 2048
ResourceLogicalId:
type: string
RetryableFailureType:
type: string
enum:
- FAILED
- TIMED_OUT
- ALL
RetryCriteria:
type: object
required:
- failureType
- numberOfRetries
properties:
failureType:
allOf:
- $ref: "#/components/schemas/RetryableFailureType"
- description: The type of job execution failures that can initiate a job retry.
numberOfRetries:
allOf:
- $ref: "#/components/schemas/NumberOfRetries"
- description: The number of retries allowed for a failure type for the job.
description: The criteria that determines how many retries are allowed for each failure type for a job.
S3Bucket:
type: string
minLength: 1
S3FileUrl:
type: string
maxLength: 65535
S3Key:
type: string
minLength: 1
S3Version:
type: string
SalesforceToken:
type: string
minLength: 40
SalesforceEndpoint:
type: string
pattern: https://ingestion-[a-zA-Z0-9]{1,12}\.[a-zA-Z0-9]+\.((sfdc-matrix\.net)|(sfdcnow\.com))/streams/\w{1,20}/\w{1,20}/event
maxLength: 2000
ScheduledAuditMetadata:
type: object
properties:
scheduledAuditName:
allOf:
- $ref: "#/components/schemas/ScheduledAuditName"
- description: The name of the scheduled audit.
scheduledAuditArn:
allOf:
- $ref: "#/components/schemas/ScheduledAuditArn"
- description: The ARN of the scheduled audit.
frequency:
allOf:
- $ref: "#/components/schemas/AuditFrequency"
- description: How often the scheduled audit occurs.
dayOfMonth:
allOf:
- $ref: "#/components/schemas/DayOfMonth"
- description: The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days,
the audit takes place on the "LAST" day of the month.
dayOfWeek:
allOf:
- $ref: "#/components/schemas/DayOfWeek"
- description: The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").
description: Information about the scheduled audit.
ScheduledJobRollout:
type: object
properties:
startTime:
allOf:
- $ref: "#/components/schemas/StringDateTime"
- description: Displays the start times of the next seven maintenance window occurrences.
description: Displays the next seven maintenance window occurrences and their start times.
SearchIndexRequest:
type: object
required:
- queryString
title: SearchIndexRequest
properties:
indexName:
allOf:
- $ref: "#/components/schemas/IndexName"
- description: The search index name.
queryString:
allOf:
- $ref: "#/components/schemas/QueryString"
- description: The search query string. For more information about the search query syntax, see Query
syntax.
nextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The token used to get the next set of results, or null if there are no additional results.
maxResults:
allOf:
- $ref: "#/components/schemas/QueryMaxResults"
- description: The maximum number of results to return at one time.
queryVersion:
allOf:
- $ref: "#/components/schemas/QueryVersion"
- description: The query version.
ThingDocumentList:
type: array
items:
$ref: "#/components/schemas/ThingDocument"
ThingGroupDocumentList:
type: array
items:
$ref: "#/components/schemas/ThingGroupDocument"
Seconds:
type: integer
SecurityGroupId:
type: string
SecurityGroupList:
type: array
items:
$ref: "#/components/schemas/SecurityGroupId"
SecurityProfileIdentifier:
type: object
required:
- name
- arn
properties:
name:
allOf:
- $ref: "#/components/schemas/SecurityProfileName"
- description: The name you've given to the security profile.
arn:
allOf:
- $ref: "#/components/schemas/SecurityProfileArn"
- description: The ARN of the security profile.
description: Identifying information for a Device Defender security profile.
SecurityProfileTarget:
type: object
required:
- arn
properties:
arn:
allOf:
- $ref: "#/components/schemas/SecurityProfileTargetArn"
- description: The ARN of the security profile.
description: A target to which an alert is sent when a security profile behavior is violated.
SecurityProfileTargetMapping:
type: object
properties:
securityProfileIdentifier:
allOf:
- $ref: "#/components/schemas/SecurityProfileIdentifier"
- description: Information that identifies the security profile.
target:
allOf:
- $ref: "#/components/schemas/SecurityProfileTarget"
- description: Information about the target (thing group) associated with the security profile.
description: Information about a security profile and the target associated with it.
ServerCertificateStatus:
type: string
enum:
- INVALID
- VALID
ServerCertificateStatusDetail:
type: string
ServerCertificateSummary:
type: object
properties:
serverCertificateArn:
allOf:
- $ref: "#/components/schemas/AcmCertificateArn"
- description: The ARN of the server certificate.
serverCertificateStatus:
allOf:
- $ref: "#/components/schemas/ServerCertificateStatus"
- description: The status of the server certificate.
serverCertificateStatusDetail:
allOf:
- $ref: "#/components/schemas/ServerCertificateStatusDetail"
- description: Details that explain the status of the server certificate.
description: An object that contains information about a server certificate.
ServiceName:
type: string
SetDefaultAuthorizerRequest:
type: object
required:
- authorizerName
title: SetDefaultAuthorizerRequest
properties:
authorizerName:
allOf:
- $ref: "#/components/schemas/AuthorizerName"
- description: The authorizer name.
SetDefaultPolicyVersionRequest:
type: object
title: SetDefaultPolicyVersionRequest
properties: {}
description: The input for the SetDefaultPolicyVersion operation.
SetLoggingOptionsRequest:
type: object
required:
- loggingOptionsPayload
title: SetLoggingOptionsRequest
properties:
loggingOptionsPayload:
allOf:
- $ref: "#/components/schemas/LoggingOptionsPayload"
- description: The logging options payload.
description: The input for the SetLoggingOptions operation.
SetV2LoggingLevelRequest:
type: object
required:
- logTarget
- logLevel
title: SetV2LoggingLevelRequest
properties:
logTarget:
allOf:
- $ref: "#/components/schemas/LogTarget"
- description: The log target.
logLevel:
allOf:
- $ref: "#/components/schemas/LogLevel"
- description: The log level.
SetV2LoggingOptionsRequest:
type: object
title: SetV2LoggingOptionsRequest
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/AwsArn"
- description: The ARN of the role that allows IoT to write to Cloudwatch logs.
defaultLogLevel:
allOf:
- $ref: "#/components/schemas/LogLevel"
- description: The default logging level.
disableAllLogs:
allOf:
- $ref: "#/components/schemas/DisableAllLogs"
- description: If true all logs are disabled. The default is false.
SigningRegion:
type: string
SigningProfileName:
type: string
SigningProfileParameter:
type: object
properties:
certificateArn:
allOf:
- $ref: "#/components/schemas/CertificateArn"
- description: Certificate ARN.
platform:
allOf:
- $ref: "#/components/schemas/Platform"
- description: The hardware platform of your device.
certificatePathOnDevice:
allOf:
- $ref: "#/components/schemas/CertificatePathOnDevice"
- description: The location of the code-signing certificate on your device.
description: Describes the code-signing profile.
SkippedFindingsCount:
type: integer
UseBase64:
type: boolean
StartAuditMitigationActionsTaskRequest:
type: object
required:
- target
- auditCheckToActionsMapping
- clientRequestToken
title: StartAuditMitigationActionsTaskRequest
properties:
target:
allOf:
- $ref: "#/components/schemas/AuditMitigationActionsTaskTarget"
- description: Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of
findings.
auditCheckToActionsMapping:
allOf:
- $ref: "#/components/schemas/AuditCheckToActionsMapping"
- description: For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.
clientRequestToken:
allOf:
- $ref: "#/components/schemas/ClientRequestToken"
- description: Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If
you omit this value, a unique client request token is generated automatically.
StartDetectMitigationActionsTaskRequest:
type: object
required:
- target
- actions
- clientRequestToken
title: StartDetectMitigationActionsTaskRequest
properties:
target:
allOf:
- $ref: "#/components/schemas/DetectMitigationActionsTaskTarget"
- description: " Specifies the ML Detect findings to which the mitigation actions are applied. "
actions:
allOf:
- $ref: "#/components/schemas/DetectMitigationActionsToExecuteList"
- description: " The actions to be performed when a device has unexpected behavior. "
violationEventOccurrenceRange:
allOf:
- $ref: "#/components/schemas/ViolationEventOccurrenceRange"
- description: " Specifies the time period of which violation events occurred between. "
includeOnlyActiveViolations:
allOf:
- $ref: "#/components/schemas/NullableBoolean"
- description: " Specifies to list only active violations. "
includeSuppressedAlerts:
allOf:
- $ref: "#/components/schemas/NullableBoolean"
- description: " Specifies to include suppressed alerts. "
clientRequestToken:
allOf:
- $ref: "#/components/schemas/ClientRequestToken"
- description: " Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If
you omit this value, Amazon Web Services SDKs will automatically generate a unique client request. "
StartOnDemandAuditTaskRequest:
type: object
required:
- targetCheckNames
title: StartOnDemandAuditTaskRequest
properties:
targetCheckNames:
allOf:
- $ref: "#/components/schemas/TargetAuditCheckNames"
- description: Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration
to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.
StartThingRegistrationTaskRequest:
type: object
required:
- templateBody
- inputFileBucket
- inputFileKey
- roleArn
title: StartThingRegistrationTaskRequest
properties:
templateBody:
allOf:
- $ref: "#/components/schemas/TemplateBody"
- description: The provisioning template.
inputFileBucket:
allOf:
- $ref: "#/components/schemas/RegistryS3BucketName"
- description: The S3 bucket that contains the input file.
inputFileKey:
allOf:
- $ref: "#/components/schemas/RegistryS3KeyName"
- description: The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The IAM role ARN that grants permission the input file.
StateMachineName:
type: string
Sum:
type: number
format: double
SumOfSquares:
type: number
format: double
Variance:
type: number
format: double
StdDeviation:
type: number
format: double
StopThingRegistrationTaskRequest:
type: object
title: StopThingRegistrationTaskRequest
properties: {}
StreamSummary:
type: object
properties:
streamId:
allOf:
- $ref: "#/components/schemas/StreamId"
- description: The stream ID.
streamArn:
allOf:
- $ref: "#/components/schemas/StreamArn"
- description: The stream ARN.
streamVersion:
allOf:
- $ref: "#/components/schemas/StreamVersion"
- description: The stream version.
description:
allOf:
- $ref: "#/components/schemas/StreamDescription"
- description: A description of the stream.
description: A summary of a stream.
stringValue:
type: string
SubnetId:
type: string
SubnetIdList:
type: array
items:
$ref: "#/components/schemas/SubnetId"
SucceededFindingsCount:
type: integer
TagValue:
type: string
minLength: 0
maxLength: 256
TagKeyList:
type: array
items:
$ref: "#/components/schemas/TagKey"
TagResourceRequest:
type: object
required:
- resourceArn
- tags
title: TagResourceRequest
properties:
resourceArn:
allOf:
- $ref: "#/components/schemas/ResourceArn"
- description: The ARN of the resource.
tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: The new or modified tags for the resource.
TotalChecksCount:
type: integer
WaitingForDataCollectionChecksCount:
type: integer
TotalFindingsCount:
type: integer
TestAuthorizationRequest:
type: object
required:
- authInfos
title: TestAuthorizationRequest
properties:
principal:
allOf:
- $ref: "#/components/schemas/Principal"
- description: The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
(arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
cognitoIdentityPoolId:
allOf:
- $ref: "#/components/schemas/CognitoIdentityPoolId"
- description: The Cognito identity pool ID.
authInfos:
allOf:
- $ref: "#/components/schemas/AuthInfos"
- description: A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
policyNamesToAdd:
allOf:
- $ref: "#/components/schemas/PolicyNames"
- description: When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
policyNamesToSkip:
allOf:
- $ref: "#/components/schemas/PolicyNames"
- description: When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
Token:
type: string
pattern: "[\\s\\S]*"
minLength: 1
maxLength: 6144
TokenSignature:
type: string
pattern: "[A-Za-z0-9+/]+={0,2}"
minLength: 1
maxLength: 2560
TlsContext:
type: object
properties:
serverName:
allOf:
- $ref: "#/components/schemas/ServerName"
- description: The value of the serverName key in a TLS authorization request.
description: Specifies the TLS context to use for the test authorizer request.
TestInvokeAuthorizerRequest:
type: object
title: TestInvokeAuthorizerRequest
properties:
token:
allOf:
- $ref: "#/components/schemas/Token"
- description: The token returned by your custom authentication service.
tokenSignature:
allOf:
- $ref: "#/components/schemas/TokenSignature"
- description: The signature made with the token and your custom authentication service's private key. This value must be Base-64-encoded.
httpContext:
allOf:
- $ref: "#/components/schemas/HttpContext"
- description: Specifies a test HTTP authorization request.
mqttContext:
allOf:
- $ref: "#/components/schemas/MqttContext"
- description: Specifies a test MQTT authorization request.
tlsContext:
allOf:
- $ref: "#/components/schemas/TlsContext"
- description: Specifies a test TLS authorization request.
ThingAttribute:
type: object
properties:
thingName:
allOf:
- $ref: "#/components/schemas/ThingName"
- description: The name of the thing.
thingTypeName:
allOf:
- $ref: "#/components/schemas/ThingTypeName"
- description: The name of the thing type, if the thing has been associated with a type.
thingArn:
allOf:
- $ref: "#/components/schemas/ThingArn"
- description: The thing ARN.
attributes:
allOf:
- $ref: "#/components/schemas/Attributes"
- description: A list of thing attributes which are name-value pairs.
version:
allOf:
- $ref: "#/components/schemas/Version"
- description: The version of the thing record in the registry.
description: The properties of the thing, including thing name, thing type name, and a list of thing attributes.
ThingConnectivity:
type: object
properties:
connected:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.
timestamp:
allOf:
- $ref: "#/components/schemas/ConnectivityTimestamp"
- description: The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for approximately an hour, the time value might be missing.
disconnectReason:
allOf:
- $ref: "#/components/schemas/DisconnectReason"
- description: The reason why the client is disconnected. If the thing has been disconnected for approximately an hour, the disconnectReason value might be missing.
description: The connectivity status of the thing.
ThingGroupNameList:
type: array
items:
$ref: "#/components/schemas/ThingGroupName"
ThingDocument:
type: object
properties:
thingName:
allOf:
- $ref: "#/components/schemas/ThingName"
- description: The thing name.
thingId:
allOf:
- $ref: "#/components/schemas/ThingId"
- description: The thing ID.
thingTypeName:
allOf:
- $ref: "#/components/schemas/ThingTypeName"
- description: The thing type name.
thingGroupNames:
allOf:
- $ref: "#/components/schemas/ThingGroupNameList"
- description: Thing group names.
attributes:
allOf:
- $ref: "#/components/schemas/Attributes"
- description: The attributes.
shadow:
allOf:
- $ref: "#/components/schemas/JsonDocument"
- description: The unnamed shadow and named shadow.
For more information about shadows, see IoT Device Shadow service.
deviceDefender: allOf: - $ref: "#/components/schemas/JsonDocument" - description:Contains Device Defender data.
For more information about Device Defender, see Device Defender.
connectivity: allOf: - $ref: "#/components/schemas/ThingConnectivity" - description: Indicates whether the thing is connected to the Amazon Web Services IoT Core service. description: The thing search index document. ThingGroupDocument: type: object properties: thingGroupName: allOf: - $ref: "#/components/schemas/ThingGroupName" - description: The thing group name. thingGroupId: allOf: - $ref: "#/components/schemas/ThingGroupId" - description: The thing group ID. thingGroupDescription: allOf: - $ref: "#/components/schemas/ThingGroupDescription" - description: The thing group description. attributes: allOf: - $ref: "#/components/schemas/Attributes" - description: The thing group attributes. parentGroupNames: allOf: - $ref: "#/components/schemas/ThingGroupNameList" - description: Parent group names. description: The thing group search index document. ThingGroupList: type: array items: $ref: "#/components/schemas/ThingGroupName" ThingTypeDefinition: type: object properties: thingTypeName: allOf: - $ref: "#/components/schemas/ThingTypeName" - description: The name of the thing type. thingTypeArn: allOf: - $ref: "#/components/schemas/ThingTypeArn" - description: The thing type ARN. thingTypeProperties: allOf: - $ref: "#/components/schemas/ThingTypeProperties" - description: The ThingTypeProperties for the thing type. thingTypeMetadata: allOf: - $ref: "#/components/schemas/ThingTypeMetadata" - description: "The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated." description: The definition of the thing type, including thing type name and description. TimestreamDatabaseName: type: string TimestreamTableName: type: string TimestreamDimensionList: type: array items: $ref: "#/components/schemas/TimestreamDimension" minItems: 1 maxItems: 128 TimestreamTimestamp: type: object required: - value - unit properties: value: allOf: - $ref: "#/components/schemas/TimestreamTimestampValue" - description: An expression that returns a long epoch time value. unit: allOf: - $ref: "#/components/schemas/TimestreamTimestampUnit" - description: "The precision of the timestamp value that results from the expression described in value.
Valid values: SECONDS | MILLISECONDS
| MICROSECONDS | NANOSECONDS. The default is MILLISECONDS.
The metadata dimension name. This is the name of the column in the Amazon Timestream database table record.
Dimensions cannot be named: measure_name, measure_value,
or time. These names are reserved. Dimension names cannot start with ts_ or measure_value and they cannot contain the colon (:) character.
The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You can
set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed. You can set
status to DISABLED by calling UpdateTopicRuleDestination.
Confirmation was completed, and traffic to this
destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
Confirmation
could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to
IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your
confirmation endpoint.
Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those
that are currently enabled.
Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.
You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.
On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.
true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used
while the device reuses the same HTTP connection.
UpdateBillingGroupRequest:
type: object
required:
- billingGroupProperties
title: UpdateBillingGroupRequest
properties:
billingGroupProperties:
allOf:
- $ref: "#/components/schemas/BillingGroupProperties"
- description: The properties of the billing group.
expectedVersion:
allOf:
- $ref: "#/components/schemas/OptionalVersion"
- 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
UpdateBillingGroup request is rejected with a VersionConflictException.
UpdateCACertificateRequest:
type: object
title: UpdateCACertificateRequest
properties:
registrationConfig:
allOf:
- $ref: "#/components/schemas/RegistrationConfig"
- description: Information about the registration configuration.
removeAutoRegistration:
allOf:
- $ref: "#/components/schemas/RemoveAutoRegistration"
- description: If true, removes auto registration.
description: The input to the UpdateCACertificate operation.
UpdateCertificateRequest:
type: object
title: UpdateCertificateRequest
properties: {}
description: The input for the UpdateCertificate operation.
UpdateCustomMetricRequest:
type: object
required:
- displayName
title: UpdateCustomMetricRequest
properties:
displayName:
allOf:
- $ref: "#/components/schemas/CustomMetricDisplayName"
- description: " Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report.
Can be updated. "
UpdateDimensionRequest:
type: object
required:
- stringValues
title: UpdateDimensionRequest
properties:
stringValues:
allOf:
- $ref: "#/components/schemas/DimensionStringValues"
- description: Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
UpdateDomainConfigurationRequest:
type: object
title: UpdateDomainConfigurationRequest
properties:
authorizerConfig:
allOf:
- $ref: "#/components/schemas/AuthorizerConfig"
- description: An object that specifies the authorization service for a domain.
domainConfigurationStatus:
allOf:
- $ref: "#/components/schemas/DomainConfigurationStatus"
- description: The status to which the domain configuration should be updated.
removeAuthorizerConfig:
allOf:
- $ref: "#/components/schemas/RemoveAuthorizerConfig"
- description: Removes the authorization configuration from a domain.
UpdateDynamicThingGroupRequest:
type: object
required:
- thingGroupProperties
title: UpdateDynamicThingGroupRequest
properties:
thingGroupProperties:
allOf:
- $ref: "#/components/schemas/ThingGroupProperties"
- description: The dynamic thing group properties to update.
expectedVersion:
allOf:
- $ref: "#/components/schemas/OptionalVersion"
- description: The expected version of the dynamic thing group to update.
indexName:
allOf:
- $ref: "#/components/schemas/IndexName"
- description: "The dynamic thing group index to update.
Currently one index is supported: AWS_Things.
The dynamic thing group query version to update.
Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
IN_PROGRESS. If the job
execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT. "
jobExecutionsRetryConfig:
allOf:
- $ref: "#/components/schemas/JobExecutionsRetryConfig"
- description: Allows you to create the criteria to retry a job.
UpdateMitigationActionRequest:
type: object
title: UpdateMitigationActionRequest
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the IAM role that is used to apply the mitigation action.
actionParams:
allOf:
- $ref: "#/components/schemas/MitigationActionParams"
- description: Defines the type of action and the parameters for that action.
UpdateProvisioningTemplateRequest:
type: object
title: UpdateProvisioningTemplateRequest
properties:
description:
allOf:
- $ref: "#/components/schemas/TemplateDescription"
- description: The description of the provisioning template.
enabled:
allOf:
- $ref: "#/components/schemas/Enabled"
- description: True to enable the provisioning template, otherwise false.
defaultVersionId:
allOf:
- $ref: "#/components/schemas/TemplateVersionId"
- description: The ID of the default provisioning template version.
provisioningRoleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
preProvisioningHook:
allOf:
- $ref: "#/components/schemas/ProvisioningHook"
- description: Updates the pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.
removePreProvisioningHook:
allOf:
- $ref: "#/components/schemas/RemoveHook"
- description: Removes pre-provisioning hook template.
UpdateRoleAliasRequest:
type: object
title: UpdateRoleAliasRequest
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The role ARN.
credentialDurationSeconds:
allOf:
- $ref: "#/components/schemas/CredentialDurationSeconds"
- description: The number of seconds the credential will be valid.
This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.
UpdateScheduledAuditRequest: type: object title: UpdateScheduledAuditRequest properties: frequency: allOf: - $ref: "#/components/schemas/AuditFrequency" - description: How often the scheduled audit takes place, eitherDAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is
determined by the system.
dayOfMonth:
allOf:
- $ref: "#/components/schemas/DayOfMonth"
- description: The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the
frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the
month.
dayOfWeek:
allOf:
- $ref: "#/components/schemas/DayOfWeek"
- description: The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU,
FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.
targetCheckNames:
allOf:
- $ref: "#/components/schemas/TargetAuditCheckNames"
- description: Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all
checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
UpdateSecurityProfileRequest:
type: object
title: UpdateSecurityProfileRequest
properties:
securityProfileDescription:
allOf:
- $ref: "#/components/schemas/SecurityProfileDescription"
- description: A description of the security profile.
behaviors:
allOf:
- $ref: "#/components/schemas/Behaviors"
- description: Specifies the behaviors that, when violated by a device (thing), cause an alert.
alertTargets:
allOf:
- $ref: "#/components/schemas/AlertTargets"
- description: Where the alerts are sent. (Alerts are always sent to the console.)
additionalMetricsToRetain:
allOf:
- $ref: "#/components/schemas/AdditionalMetricsToRetainList"
- deprecated: true
description: Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
A list of metrics whose data is retained (stored). By default, data is
retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with
dimensions.
behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
deleteAlertTargets:
allOf:
- $ref: "#/components/schemas/DeleteAlertTargets"
- description: If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
deleteAdditionalMetricsToRetain:
allOf:
- $ref: "#/components/schemas/DeleteAdditionalMetricsToRetain"
- description: If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current
invocation, an exception occurs.
UpdateStreamRequest:
type: object
title: UpdateStreamRequest
properties:
description:
allOf:
- $ref: "#/components/schemas/StreamDescription"
- description: The description of the stream.
files:
allOf:
- $ref: "#/components/schemas/StreamFiles"
- description: The files associated with the stream.
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: An IAM role that allows the IoT service principal assumes to access your S3 files.
UpdateThingGroupRequest:
type: object
required:
- thingGroupProperties
title: UpdateThingGroupRequest
properties:
thingGroupProperties:
allOf:
- $ref: "#/components/schemas/ThingGroupProperties"
- description: The thing group properties.
expectedVersion:
allOf:
- $ref: "#/components/schemas/OptionalVersion"
- description: The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.
UpdateThingGroupsForThingRequest:
type: object
title: UpdateThingGroupsForThingRequest
properties:
thingName:
allOf:
- $ref: "#/components/schemas/ThingName"
- description: The thing whose group memberships will be updated.
thingGroupsToAdd:
allOf:
- $ref: "#/components/schemas/ThingGroupList"
- description: The groups to which the thing will be added.
thingGroupsToRemove:
allOf:
- $ref: "#/components/schemas/ThingGroupList"
- description: The groups from which the thing will be removed.
overrideDynamicGroups:
allOf:
- $ref: "#/components/schemas/OverrideDynamicGroups"
- description: Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing
groups, adding a thing to a static group removes the thing from the last dynamic group.
UpdateThingRequest:
type: object
title: UpdateThingRequest
properties:
thingTypeName:
allOf:
- $ref: "#/components/schemas/ThingTypeName"
- description: The name of the thing type.
attributePayload:
allOf:
- $ref: "#/components/schemas/AttributePayload"
- description: A list of thing attributes, a JSON string containing name-value pairs. For example:
{\"attributes\":{\"name1\":\"value2\"}}
This data is used to add new attributes or update existing attributes.
expectedVersion: allOf: - $ref: "#/components/schemas/OptionalVersion" - description: The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, theUpdateThing request is rejected with a VersionConflictException.
removeThingType:
allOf:
- $ref: "#/components/schemas/RemoveThingType"
- description: Remove a thing type association. If true, the association is removed.
description: The input for the UpdateThing operation.
UpdateTopicRuleDestinationRequest:
type: object
required:
- arn
- status
title: UpdateTopicRuleDestinationRequest
properties:
arn:
allOf:
- $ref: "#/components/schemas/AwsArn"
- description: The ARN of the topic rule destination.
status:
allOf:
- $ref: "#/components/schemas/TopicRuleDestinationStatus"
- description: The status of the topic rule destination. Valid values are:
A topic rule destination was created but has not been confirmed. You can
set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation
challenge to be sent to your confirmation endpoint.
Confirmation was completed, and traffic to this destination is allowed. You can set
status to DISABLED by calling UpdateTopicRuleDestination.
Confirmation was completed, and traffic to this
destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
Confirmation
could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to
IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your
confirmation endpoint.
UserProperty.
value:
allOf:
- $ref: "#/components/schemas/UserPropertyValue"
- description: A value to be specified in UserProperty.
description: A key-value pair that you define in the header. Both the key and the value are either literal strings or valid substitution templates.
UserPropertyKey:
type: string
minLength: 0
maxLength: 1024
UserPropertyValue:
type: string
minLength: 0
maxLength: 1024
Valid:
type: boolean
ValidateSecurityProfileBehaviorsRequest:
type: object
required:
- behaviors
title: ValidateSecurityProfileBehaviorsRequest
properties:
behaviors:
allOf:
- $ref: "#/components/schemas/Behaviors"
- description: Specifies the behaviors that, when violated by a device (thing), cause an alert.
ValidationErrors:
type: array
items:
$ref: "#/components/schemas/ValidationError"
ValidationError:
type: object
properties:
errorMessage:
allOf:
- $ref: "#/components/schemas/ErrorMessage"
- description: The description of an error found in the behaviors.
description: Information about an error found in a behavior specification.
ViolationEventType:
type: string
enum:
- in-alarm
- alarm-cleared
- alarm-invalidated
ViolationEvent:
type: object
properties:
violationId:
allOf:
- $ref: "#/components/schemas/ViolationId"
- description: The ID of the violation event.
thingName:
allOf:
- $ref: "#/components/schemas/DeviceDefenderThingName"
- description: The name of the thing responsible for the violation event.
securityProfileName:
allOf:
- $ref: "#/components/schemas/SecurityProfileName"
- description: The name of the security profile whose behavior was violated.
behavior:
allOf:
- $ref: "#/components/schemas/Behavior"
- description: The behavior that was violated.
metricValue:
allOf:
- $ref: "#/components/schemas/MetricValue"
- description: The value of the metric (the measurement).
violationEventAdditionalInfo:
allOf:
- $ref: "#/components/schemas/ViolationEventAdditionalInfo"
- description: " The details of a violation event. "
violationEventType:
allOf:
- $ref: "#/components/schemas/ViolationEventType"
- description: The type of violation event.
verificationState:
allOf:
- $ref: "#/components/schemas/VerificationState"
- description: The verification state of the violation (detect alarm).
verificationStateDescription:
allOf:
- $ref: "#/components/schemas/VerificationStateDescription"
- description: The description of the verification state of the violation.
violationEventTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The time the violation event occurred.
description: Information about a Device Defender security profile behavior violation.
VpcId:
type: string
security:
- hmac: []