openapi: 3.0.0 info: version: 2015-05-28 x-release: v4 title: AWS IoT Accept Certificate Transfer Audit API description: 'IoT

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 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) security: - hmac: [] tags: - name: Audit paths: /audit/mitigationactions/tasks/{taskId}/cancel: 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: 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 tags: - Audit /audit/tasks/{taskId}/cancel: 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: 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 tags: - Audit /audit/suppressions/create: 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: 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. (Use DescribeAccountAuditConfiguration 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 tags: - Audit /audit/scheduledaudits/{scheduledAuditName}: 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: 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, either DAILY, 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 tags: - Audit 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 tags: - Audit 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 tags: - Audit 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, either DAILY, 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 tags: - Audit /audit/configuration: 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: DeleteAccountAuditConfiguration description:

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 tags: - Audit 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 tags: - Audit 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.

type: object additionalProperties: $ref: '#/components/schemas/AuditCheckConfiguration' summary: Amazon IoT Device Management Update Account Audit Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Audit /audit/suppressions/delete: 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: DeleteAuditSuppression description:

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. (Use DescribeAccountAuditConfiguration 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 tags: - Audit /audit/findings/{findingId}: 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: 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 tags: - Audit /audit/mitigationactions/tasks/{taskId}: 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: 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 tags: - Audit 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 tags: - Audit /audit/suppressions/describe: 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: 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. (Use DescribeAccountAuditConfiguration 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 tags: - Audit /audit/tasks/{taskId}: 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: 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 tags: - Audit /audit/findings: 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: 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. (Use DescribeAccountAuditConfiguration 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 tags: - Audit /audit/mitigationactions/executions#taskId&findingId: 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: 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 tags: - Audit /audit/mitigationactions/tasks#startTime&endTime: 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: 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 tags: - Audit /audit/suppressions/list: 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: 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. (Use DescribeAccountAuditConfiguration 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 tags: - Audit /audit/tasks#startTime&endTime: 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: 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 tags: - Audit /audit/relatedResources#findingId: 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: ListRelatedResourcesForAuditFinding description:

The related resources of an Audit finding. The following resources can be returned from calling this API:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRelatedResourcesForAuditFindingResponse' '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: query required: true description: The finding Id. schema: type: string pattern: '[a-zA-Z0-9_-]+' minLength: 1 maxLength: 128 - name: nextToken in: query required: false description: A token that can be used to retrieve the next set of results, or 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 tags: - Audit /audit/scheduledaudits: 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: 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 tags: - Audit /audit/tasks: 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: 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. Use DescribeAccountAuditConfiguration 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 tags: - Audit /audit/suppressions/update: 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: 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. (Use DescribeAccountAuditConfiguration 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 tags: - Audit components: schemas: 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. ' ReasonForNonComplianceCode: type: string 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. ResourceAlreadyExistsException: {} MitigationActionsTaskId: type: string pattern: '[a-zA-Z0-9_-]+' minLength: 1 maxLength: 128 InProgressChecksCount: type: integer 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. Timestamp: type: string format: date-time 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. PolicyVersionId: type: string pattern: '[0-9]+' AuditFrequency: type: string enum: - DAILY - WEEKLY - BIWEEKLY - MONTHLY 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. 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. AuditDescription: type: string pattern: '[\p{Graph}\x20]*' maxLength: 1000 DeleteAccountAuditConfigurationResponse: type: object properties: {} CanceledChecksCount: type: integer LogLevel: type: string enum: - DEBUG - INFO - ERROR - WARN - DISABLED SuppressedNonCompliantResourcesCount: type: integer 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. AuditDetails: type: object additionalProperties: $ref: '#/components/schemas/AuditCheckDetails' MitigationActionName: type: string pattern: '[a-zA-Z0-9_-]+' maxLength: 128 TaskStatistics: type: object properties: totalChecks: allOf: - $ref: '#/components/schemas/TotalChecksCount' - description: The number of checks in this audit. inProgressChecks: allOf: - $ref: '#/components/schemas/InProgressChecksCount' - description: The number of checks in progress. waitingForDataCollectionChecks: allOf: - $ref: '#/components/schemas/WaitingForDataCollectionChecksCount' - description: The number of checks waiting for data collection. compliantChecks: allOf: - $ref: '#/components/schemas/CompliantChecksCount' - description: The number of checks that found compliant resources. nonCompliantChecks: allOf: - $ref: '#/components/schemas/NonCompliantChecksCount' - description: The number of checks that found noncompliant resources. failedChecks: allOf: - $ref: '#/components/schemas/FailedChecksCount' - description: The number of checks. canceledChecks: allOf: - $ref: '#/components/schemas/CanceledChecksCount' - description: The number of checks that did not run because the audit was canceled. description: Statistics for the checks performed during the audit. 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. ScheduledAuditName: type: string pattern: '[a-zA-Z0-9_-]+' minLength: 1 maxLength: 128 CertificateId: type: string pattern: (0x)?[a-fA-F0-9]+ minLength: 64 maxLength: 64 TaskAlreadyExistsException: {} AuditFindings: type: array items: $ref: '#/components/schemas/AuditFinding' ScheduledAuditMetadataList: type: array items: $ref: '#/components/schemas/ScheduledAuditMetadata' 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. ' AuditMitigationActionExecutionMetadataList: type: array items: $ref: '#/components/schemas/AuditMitigationActionExecutionMetadata' ScheduledAuditArn: type: string SkippedFindingsCount: type: integer TargetAuditCheckNames: type: array items: $ref: '#/components/schemas/AuditCheckName' DeviceCertificateUpdateAction: type: string enum: - DEACTIVATE MitigationActionId: type: string AuditCheckConfigurations: type: object additionalProperties: $ref: '#/components/schemas/AuditCheckConfiguration' ErrorCode: type: string MitigationActionList: type: array items: $ref: '#/components/schemas/MitigationAction' ThingGroupName: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 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. ReasonForNonCompliance: type: string DescribeAccountAuditConfigurationResponse: type: object properties: roleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description:

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.

auditNotificationTargetConfigurations: allOf: - $ref: '#/components/schemas/AuditNotificationTargetConfigurations' - description: Information about the targets to which audit notifications are sent for this account. auditCheckConfigurations: allOf: - $ref: '#/components/schemas/AuditCheckConfigurations' - description: Which audit checks are enabled and disabled for this account. Enabled: type: boolean AuditCheckToActionsMapping: type: object additionalProperties: $ref: '#/components/schemas/MitigationActionNameList' FindingIds: type: array items: $ref: '#/components/schemas/FindingId' minItems: 1 maxItems: 25 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. AuditTaskMetadataList: type: array items: $ref: '#/components/schemas/AuditTaskMetadata' 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. 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. FindingId: type: string pattern: '[a-zA-Z0-9_-]+' minLength: 1 maxLength: 128 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. SnsTopicArn: type: string maxLength: 350 StartOnDemandAuditTaskResponse: type: object properties: taskId: allOf: - $ref: '#/components/schemas/AuditTaskId' - description: The ID of the on-demand audit you started. AuditTaskStatus: type: string enum: - IN_PROGRESS - COMPLETED - FAILED - CANCELED 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. NullableBoolean: type: boolean InvalidRequestException: {} DayOfWeek: type: string enum: - SUN - MON - TUE - WED - THU - FRI - SAT ErrorMessage: type: string maxLength: 2048 SucceededFindingsCount: type: integer CreateScheduledAuditResponse: type: object properties: scheduledAuditArn: allOf: - $ref: '#/components/schemas/ScheduledAuditArn' - description: The ARN of the scheduled audit. AuditTaskId: type: string pattern: '[a-zA-Z0-9\-]+' minLength: 1 maxLength: 40 ReasonForNonComplianceCodes: type: array items: $ref: '#/components/schemas/ReasonForNonComplianceCode' minItems: 1 maxItems: 25 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. 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. 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. 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. 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. TotalFindingsCount: type: integer AuditFindingSeverity: type: string enum: - CRITICAL - HIGH - MEDIUM - LOW AuditTaskType: type: string enum: - ON_DEMAND_AUDIT_TASK - SCHEDULED_AUDIT_TASK DeleteAuditSuppressionResponse: type: object properties: {} IsSuppressed: type: boolean ClientId: type: string 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. UpdateAccountAuditConfigurationResponse: type: object properties: {} IssuerId: type: string pattern: (0x)?[a-fA-F0-9]+ maxLength: 64 CertificateArn: type: string 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. CognitoIdentityPoolId: type: string AuditCheckToReasonCodeFilter: type: object additionalProperties: $ref: '#/components/schemas/ReasonForNonComplianceCodes' NonCompliantResourcesCount: type: integer ThingGroupNames: type: array items: $ref: '#/components/schemas/ThingGroupName' minItems: 1 maxItems: 10 CheckCompliant: type: boolean 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. String: type: string 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. DescribeAuditTaskResponse: type: object properties: taskStatus: allOf: - $ref: '#/components/schemas/AuditTaskStatus' - description: 'The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".' taskType: allOf: - $ref: '#/components/schemas/AuditTaskType' - description: 'The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".' taskStartTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the audit started. taskStatistics: allOf: - $ref: '#/components/schemas/TaskStatistics' - description: Statistical information about the audit. scheduledAuditName: allOf: - $ref: '#/components/schemas/ScheduledAuditName' - description: The name of the scheduled audit (only if the audit was a scheduled audit). auditDetails: allOf: - $ref: '#/components/schemas/AuditDetails' - description: Detailed information about each check performed during this audit. DeleteScheduledAuditResponse: type: object properties: {} SuppressIndefinitely: type: boolean DescribeAuditSuppressionResponse: type: object 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. ' UpdateAuditSuppressionResponse: 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. 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. AwsAccountId: type: string pattern: '[0-9]+' minLength: 12 maxLength: 12 StringMap: type: object additionalProperties: $ref: '#/components/schemas/String' 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. CACertificateUpdateAction: type: string enum: - DEACTIVATE CreateAuditSuppressionResponse: type: object properties: {} ResourceNotFoundException: {} AuditMitigationActionsTaskStatus: type: string enum: - IN_PROGRESS - COMPLETED - FAILED - CANCELED TotalChecksCount: type: integer CompliantChecksCount: type: integer AuditCheckRunStatus: type: string enum: - IN_PROGRESS - WAITING_FOR_DATA_COLLECTION - CANCELED - COMPLETED_COMPLIANT - COMPLETED_NON_COMPLIANT - FAILED AuditMitigationActionsTaskStatistics: type: object additionalProperties: $ref: '#/components/schemas/TaskStatisticsForAuditCheck' DescribeAuditFindingResponse: type: object properties: finding: $ref: '#/components/schemas/AuditFinding' 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. 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. PolicyName: type: string pattern: '[\w+=,.@-]+' minLength: 1 maxLength: 128 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. MitigationAction: type: object properties: name: allOf: - $ref: '#/components/schemas/MitigationActionName' - description: A user-friendly name for the mitigation action. id: allOf: - $ref: '#/components/schemas/MitigationActionId' - description: A unique identifier for the mitigation action. roleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: The IAM role ARN used to apply this mitigation action. actionParams: allOf: - $ref: '#/components/schemas/MitigationActionParams' - description: The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply. description: Describes which changes should be applied as part of a mitigation action. RoleArn: type: string minLength: 20 maxLength: 2048 TagValue: type: string minLength: 0 maxLength: 256 UpdateScheduledAuditResponse: type: object properties: scheduledAuditArn: allOf: - $ref: '#/components/schemas/ScheduledAuditArn' - description: The ARN of the scheduled audit. AuditSuppressionList: type: array items: $ref: '#/components/schemas/AuditSuppression' ThrottlingException: {} AuditNotificationTargetConfigurations: type: object additionalProperties: $ref: '#/components/schemas/AuditNotificationTarget' CancelAuditTaskResponse: type: object properties: {} TagKey: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ minLength: 1 maxLength: 128 RelatedResources: type: array items: $ref: '#/components/schemas/RelatedResource' IssuerCertificateSubject: type: string pattern: '[\p{Graph}\x20]*' maxLength: 1000 InternalFailureException: {} MitigationActionNameList: type: array items: $ref: '#/components/schemas/MitigationActionName' minItems: 1 maxItems: 5 DescribeAuditMitigationActionsTaskResponse: type: object properties: taskStatus: allOf: - $ref: '#/components/schemas/AuditMitigationActionsTaskStatus' - description: The current status of the task. 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. taskStatistics: allOf: - $ref: '#/components/schemas/AuditMitigationActionsTaskStatistics' - description: Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task. target: allOf: - $ref: '#/components/schemas/AuditMitigationActionsTaskTarget' - description: Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings. auditCheckToActionsMapping: allOf: - $ref: '#/components/schemas/AuditCheckToActionsMapping' - description: Specifies the mitigation actions that should be applied to specific audit checks. actionsDefinition: allOf: - $ref: '#/components/schemas/MitigationActionList' - description: Specifies the mitigation actions and their parameters that are applied as part of this task. AuditMitigationActionsExecutionStatus: type: string enum: - IN_PROGRESS - COMPLETED - FAILED - CANCELED - SKIPPED - PENDING LimitExceededException: {} CancelAuditMitigationActionsTaskResponse: type: object properties: {} 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. TotalResourcesCount: type: integer CanceledFindingsCount: type: integer NextToken: type: string TargetArn: type: string maxLength: 2048 AuditCheckName: type: string description: An audit check name. 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.) WaitingForDataCollectionChecksCount: 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 RoleAliasArn: type: string minLength: 1 maxLength: 2048 AuditMitigationActionsTaskMetadataList: type: array items: $ref: '#/components/schemas/AuditMitigationActionsTaskMetadata' DayOfMonth: type: string pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$ 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. FailedChecksCount: type: integer PolicyTemplateName: type: string enum: - BLANK_POLICY 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). IssuerCertificateSerialNumber: type: string pattern: '[a-fA-F0-9:]+' maxLength: 20 NonCompliantChecksCount: type: integer FailedFindingsCount: type: integer parameters: X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential 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 X-Amz-Algorithm: name: X-Amz-Algorithm 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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/iot/ x-hasEquivalentPaths: true