@aws-sdk/client-iot

import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { IoTServiceException as __BaseException } from "./IoTServiceException"; import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AlertTargetType, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CertificateProviderOperation, CustomMetricType, DayOfWeek, DimensionType, DimensionValueOperator, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MaintenanceWindow, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, PackageVersionStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, SchedulingConfig, ServerCertificateConfig, ServiceType, StreamFile, TargetSelection, TaskStatisticsForAuditCheck, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestination, VerificationState } from "./models_0"; /** * @public */ export interface DeleteCustomMetricRequest { /** * * The name of the custom metric. * * @public */ metricName: string | undefined; } /** * @public */ export interface DeleteCustomMetricResponse { } /** * @public */ export interface DeleteDimensionRequest { /** * The unique identifier for the dimension that you want to delete. * @public */ name: string | undefined; } /** * @public */ export interface DeleteDimensionResponse { } /** * @public */ export interface DeleteDomainConfigurationRequest { /** * The name of the domain configuration to be deleted. * @public */ domainConfigurationName: string | undefined; } /** * @public */ export interface DeleteDomainConfigurationResponse { } /** * @public */ export interface DeleteDynamicThingGroupRequest { /** * The name of the dynamic thing group to delete. * @public */ thingGroupName: string | undefined; /** * The expected version of the dynamic thing group to delete. * @public */ expectedVersion?: number; } /** * @public */ export interface DeleteDynamicThingGroupResponse { } /** * @public */ export interface DeleteFleetMetricRequest { /** * The name of the fleet metric to delete. * @public */ metricName: string | undefined; /** * The expected version of the fleet metric to delete. * @public */ expectedVersion?: number; } /** * @public */ export interface DeleteJobRequest { /** * The ID of the job to be deleted. * After a job deletion is completed, you may reuse this jobId when you create a new job. * However, this is not recommended, and you must ensure that your devices are not using the * jobId to refer to the deleted job. * @public */ jobId: string | undefined; /** * (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can * only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception * will occur. The default is false. * <note> * Deleting a job which is "IN_PROGRESS", will cause a device which is executing * the job to be unable to access job information or update the job execution status. * Use caution and ensure that each device executing a job which is deleted is able to recover to * a valid state. * </note> * @public */ force?: boolean; /** * The namespace used to indicate that a job is a customer-managed job. * When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that * contain the value in the following format. * * <code>$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/</code> * * <note> * The <code>namespaceId</code> feature is only supported by IoT Greengrass at * this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting * up IoT Greengrass core devices.</a> * * </note> * @public */ namespaceId?: string; } /** * @public */ export interface DeleteJobExecutionRequest { /** * The ID of the job whose execution on a particular device will be deleted. * @public */ jobId: string | undefined; /** * The name of the thing whose job execution will be deleted. * @public */ thingName: string | undefined; /** * The ID of the job execution to be deleted. The <code>executionNumber</code> refers to the * execution of a particular job on a particular device. * Note that once a job execution is deleted, the <code>executionNumber</code> may be reused * by IoT, so be sure you get and use the correct value here. * @public */ executionNumber: number | undefined; /** * (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, * you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", * "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false. * <note> * Deleting a job execution which is "IN_PROGRESS", will cause the device * to be unable to access job information or update the job execution status. * Use caution and ensure that the device is able to recover to a valid state. * </note> * @public */ force?: boolean; /** * The namespace used to indicate that a job is a customer-managed job. * When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that * contain the value in the following format. * * <code>$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/</code> * * <note> * The <code>namespaceId</code> feature is only supported by IoT Greengrass at * this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting * up IoT Greengrass core devices.</a> * * </note> * @public */ namespaceId?: string; } /** * @public */ export interface DeleteJobTemplateRequest { /** * The unique identifier of the job template to delete. * @public */ jobTemplateId: string | undefined; } /** * @public */ export interface DeleteMitigationActionRequest { /** * The name of the mitigation action that you want to delete. * @public */ actionName: string | undefined; } /** * @public */ export interface DeleteMitigationActionResponse { } /** * @public */ export interface DeleteOTAUpdateRequest { /** * The ID of the OTA update to delete. * @public */ otaUpdateId: string | undefined; /** * When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. * Ignored if the stream specified in the OTAUpdate is supplied by the user. * @public */ deleteStream?: boolean; /** * When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the * job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false. * @public */ forceDeleteAWSJob?: boolean; } /** * @public */ export interface DeleteOTAUpdateResponse { } /** * @public */ export interface DeletePackageRequest { /** * The name of the target software package. * @public */ packageName: string | undefined; /** * A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. * Don't reuse this client token if a new idempotent request is required. * @public */ clientToken?: string; } /** * @public */ export interface DeletePackageResponse { } /** * @public */ export interface DeletePackageVersionRequest { /** * The name of the associated software package. * @public */ packageName: string | undefined; /** * The name of the target package version. * @public */ versionName: string | undefined; /** * A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. * Don't reuse this client token if a new idempotent request is required. * @public */ clientToken?: string; } /** * @public */ export interface DeletePackageVersionResponse { } /** * The input for the DeletePolicy operation. * @public */ export interface DeletePolicyRequest { /** * The name of the policy to delete. * @public */ policyName: string | undefined; } /** * The input for the DeletePolicyVersion operation. * @public */ export interface DeletePolicyVersionRequest { /** * The name of the policy. * @public */ policyName: string | undefined; /** * The policy version ID. * @public */ policyVersionId: string | undefined; } /** * @public */ export interface DeleteProvisioningTemplateRequest { /** * The name of the fleet provision template to delete. * @public */ templateName: string | undefined; } /** * @public */ export interface DeleteProvisioningTemplateResponse { } /** * @public */ export interface DeleteProvisioningTemplateVersionRequest { /** * The name of the provisioning template version to delete. * @public */ templateName: string | undefined; /** * The provisioning template version ID to delete. * @public */ versionId: number | undefined; } /** * @public */ export interface DeleteProvisioningTemplateVersionResponse { } /** * The input for the DeleteRegistrationCode operation. * @public */ export interface DeleteRegistrationCodeRequest { } /** * The output for the DeleteRegistrationCode operation. * @public */ export interface DeleteRegistrationCodeResponse { } /** * @public */ export interface DeleteRoleAliasRequest { /** * The role alias to delete. * @public */ roleAlias: string | undefined; } /** * @public */ export interface DeleteRoleAliasResponse { } /** * @public */ export interface DeleteScheduledAuditRequest { /** * The name of the scheduled audit you want to delete. * @public */ scheduledAuditName: string | undefined; } /** * @public */ export interface DeleteScheduledAuditResponse { } /** * @public */ export interface DeleteSecurityProfileRequest { /** * The name of the security profile to be deleted. * @public */ securityProfileName: string | undefined; /** * The expected version of the security profile. A new version is generated whenever * the security profile is updated. If you specify a value that is different from the actual * version, a <code>VersionConflictException</code> is thrown. * @public */ expectedVersion?: number; } /** * @public */ export interface DeleteSecurityProfileResponse { } /** * @public */ export interface DeleteStreamRequest { /** * The stream ID. * @public */ streamId: string | undefined; } /** * @public */ export interface DeleteStreamResponse { } /** * The input for the DeleteThing operation. * @public */ export interface DeleteThingRequest { /** * The name of the thing to delete. * @public */ thingName: string | undefined; /** * The expected version of the thing record in the registry. If the version of the * record in the registry does not match the expected version specified in the request, the * <code>DeleteThing</code> request is rejected with a * <code>VersionConflictException</code>. * @public */ expectedVersion?: number; } /** * The output of the DeleteThing operation. * @public */ export interface DeleteThingResponse { } /** * @public */ export interface DeleteThingGroupRequest { /** * The name of the thing group to delete. * @public */ thingGroupName: string | undefined; /** * The expected version of the thing group to delete. * @public */ expectedVersion?: number; } /** * @public */ export interface DeleteThingGroupResponse { } /** * The input for the DeleteThingType operation. * @public */ export interface DeleteThingTypeRequest { /** * The name of the thing type. * @public */ thingTypeName: string | undefined; } /** * The output for the DeleteThingType operation. * @public */ export interface DeleteThingTypeResponse { } /** * The input for the DeleteTopicRule operation. * @public */ export interface DeleteTopicRuleRequest { /** * The name of the rule. * @public */ ruleName: string | undefined; } /** * @public */ export interface DeleteTopicRuleDestinationRequest { /** * The ARN of the topic rule destination to delete. * @public */ arn: string | undefined; } /** * @public */ export interface DeleteTopicRuleDestinationResponse { } /** * @public * @enum */ export declare const LogTargetType: { readonly CLIENT_ID: "CLIENT_ID"; readonly DEFAULT: "DEFAULT"; readonly PRINCIPAL_ID: "PRINCIPAL_ID"; readonly SOURCE_IP: "SOURCE_IP"; readonly THING_GROUP: "THING_GROUP"; }; /** * @public */ export type LogTargetType = (typeof LogTargetType)[keyof typeof LogTargetType]; /** * @public */ export interface DeleteV2LoggingLevelRequest { /** * The type of resource for which you are configuring logging. Must be * <code>THING_Group</code>. * @public */ targetType: LogTargetType | undefined; /** * The name of the resource for which you are configuring logging. * @public */ targetName: string | undefined; } /** * The input for the DeprecateThingType operation. * @public */ export interface DeprecateThingTypeRequest { /** * The name of the thing type to deprecate. * @public */ thingTypeName: string | undefined; /** * Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can * associate it with things. * @public */ undoDeprecate?: boolean; } /** * The output for the DeprecateThingType operation. * @public */ export interface DeprecateThingTypeResponse { } /** * @public */ export interface DescribeAccountAuditConfigurationRequest { } /** * @public */ export interface DescribeAccountAuditConfigurationResponse { /** * 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 <code>UpdateAccountAuditConfiguration</code>, * this parameter is required. * @public */ roleArn?: string; /** * Information about the targets to which audit notifications are sent for * this account. * @public */ auditNotificationTargetConfigurations?: Partial<Record<AuditNotificationType, AuditNotificationTarget>>; /** * Which audit checks are enabled and disabled for this account. * @public */ auditCheckConfigurations?: Record<string, AuditCheckConfiguration>; } /** * @public */ export interface DescribeAuditFindingRequest { /** * A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding. * @public */ findingId: string | undefined; } /** * @public */ export interface DescribeAuditFindingResponse { /** * The findings (results) of the audit. * @public */ finding?: AuditFinding; } /** * @public */ export interface DescribeAuditMitigationActionsTaskRequest { /** * The unique identifier for the audit mitigation task. * @public */ taskId: string | undefined; } /** * Describes which changes should be applied as part of a mitigation action. * @public */ export interface MitigationAction { /** * A user-friendly name for the mitigation action. * @public */ name?: string; /** * A unique identifier for the mitigation action. * @public */ id?: string; /** * The IAM role ARN used to apply this mitigation action. * @public */ roleArn?: string; /** * The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply. * @public */ actionParams?: MitigationActionParams; } /** * @public */ export interface DescribeAuditMitigationActionsTaskResponse { /** * The current status of the task. * @public */ taskStatus?: AuditMitigationActionsTaskStatus; /** * The date and time when the task was started. * @public */ startTime?: Date; /** * The date and time when the task was completed or canceled. * @public */ endTime?: Date; /** * Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task. * @public */ taskStatistics?: Record<string, TaskStatisticsForAuditCheck>; /** * Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings. * @public */ target?: AuditMitigationActionsTaskTarget; /** * Specifies the mitigation actions that should be applied to specific audit checks. * @public */ auditCheckToActionsMapping?: Record<string, string[]>; /** * Specifies the mitigation actions and their parameters that are applied as part of this task. * @public */ actionsDefinition?: MitigationAction[]; } /** * @public */ export interface DescribeAuditSuppressionRequest { /** * An audit check name. Checks must be enabled * for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> * to select which checks are enabled.) * @public */ checkName: string | undefined; /** * Information that identifies the noncompliant resource. * @public */ resourceIdentifier: ResourceIdentifier | undefined; } /** * @public */ export interface DescribeAuditSuppressionResponse { /** * An audit check name. Checks must be enabled * for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> * to select which checks are enabled.) * @public */ checkName?: string; /** * Information that identifies the noncompliant resource. * @public */ resourceIdentifier?: ResourceIdentifier; /** * * The epoch timestamp in seconds at which this suppression expires. * * @public */ expirationDate?: Date; /** * * Indicates whether a suppression should exist indefinitely or not. * * @public */ suppressIndefinitely?: boolean; /** * * The description of the audit suppression. * * @public */ description?: string; } /** * @public */ export interface DescribeAuditTaskRequest { /** * The ID of the audit whose information you want to get. * @public */ taskId: string | undefined; } /** * Statistics for the checks performed during the audit. * @public */ export interface TaskStatistics { /** * The number of checks in this audit. * @public */ totalChecks?: number; /** * The number of checks in progress. * @public */ inProgressChecks?: number; /** * The number of checks waiting for data collection. * @public */ waitingForDataCollectionChecks?: number; /** * The number of checks that found compliant resources. * @public */ compliantChecks?: number; /** * The number of checks that found noncompliant resources. * @public */ nonCompliantChecks?: number; /** * The number of checks. * @public */ failedChecks?: number; /** * The number of checks that did not run because the audit was canceled. * @public */ canceledChecks?: number; } /** * @public */ export interface DescribeAuditTaskResponse { /** * The status of the audit: one of "IN_PROGRESS", "COMPLETED", * "FAILED", or "CANCELED". * @public */ taskStatus?: AuditTaskStatus; /** * The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK". * @public */ taskType?: AuditTaskType; /** * The time the audit started. * @public */ taskStartTime?: Date; /** * Statistical information about the audit. * @public */ taskStatistics?: TaskStatistics; /** * The name of the scheduled audit (only if the audit was a scheduled audit). * @public */ scheduledAuditName?: string; /** * Detailed information about each check performed during this audit. * @public */ auditDetails?: Record<string, AuditCheckDetails>; } /** * @public */ export interface DescribeAuthorizerRequest { /** * The name of the authorizer to describe. * @public */ authorizerName: string | undefined; } /** * @public */ export interface DescribeAuthorizerResponse { /** * The authorizer description. * @public */ authorizerDescription?: AuthorizerDescription; } /** * @public */ export interface DescribeBillingGroupRequest { /** * The name of the billing group. * @public */ billingGroupName: string | undefined; } /** * Additional information about the billing group. * @public */ export interface BillingGroupMetadata { /** * The date the billing group was created. * @public */ creationDate?: Date; } /** * @public */ export interface DescribeBillingGroupResponse { /** * The name of the billing group. * @public */ billingGroupName?: string; /** * The ID of the billing group. * @public */ billingGroupId?: string; /** * The ARN of the billing group. * @public */ billingGroupArn?: string; /** * The version of the billing group. * @public */ version?: number; /** * The properties of the billing group. * @public */ billingGroupProperties?: BillingGroupProperties; /** * Additional information about the billing group. * @public */ billingGroupMetadata?: BillingGroupMetadata; } /** * The input for the DescribeCACertificate operation. * @public */ export interface DescribeCACertificateRequest { /** * The CA certificate identifier. * @public */ certificateId: string | undefined; } /** * @public * @enum */ export declare const CertificateMode: { readonly DEFAULT: "DEFAULT"; readonly SNI_ONLY: "SNI_ONLY"; }; /** * @public */ export type CertificateMode = (typeof CertificateMode)[keyof typeof CertificateMode]; /** * @public * @enum */ export declare const CACertificateStatus: { readonly ACTIVE: "ACTIVE"; readonly INACTIVE: "INACTIVE"; }; /** * @public */ export type CACertificateStatus = (typeof CACertificateStatus)[keyof typeof CACertificateStatus]; /** * When the certificate is valid. * @public */ export interface CertificateValidity { /** * The certificate is not valid before this date. * @public */ notBefore?: Date; /** * The certificate is not valid after this date. * @public */ notAfter?: Date; } /** * Describes a CA certificate. * @public */ export interface CACertificateDescription { /** * The CA certificate ARN. * @public */ certificateArn?: string; /** * The CA certificate ID. * @public */ certificateId?: string; /** * The status of a CA certificate. * @public */ status?: CACertificateStatus; /** * The CA certificate data, in PEM format. * @public */ certificatePem?: string; /** * The owner of the CA certificate. * @public */ ownedBy?: string; /** * The date the CA certificate was created. * @public */ creationDate?: Date; /** * Whether the CA certificate configured for auto registration of device certificates. * Valid values are "ENABLE" and "DISABLE" * @public */ autoRegistrationStatus?: AutoRegistrationStatus; /** * The date the CA certificate was last modified. * @public */ lastModifiedDate?: Date; /** * The customer version of the CA certificate. * @public */ customerVersion?: number; /** * The generation ID of the CA certificate. * @public */ generationId?: string; /** * When the CA certificate is valid. * @public */ validity?: CertificateValidity; /** * The mode of the CA. * All the device certificates that are registered using this CA will be registered * in the same mode as the CA. For more information about certificate mode for device certificates, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode">certificate mode</a>. * @public */ certificateMode?: CertificateMode; } /** * The registration configuration. * @public */ export interface RegistrationConfig { /** * The template body. * @public */ templateBody?: string; /** * The ARN of the role. * @public */ roleArn?: string; /** * The name of the provisioning template. * @public */ templateName?: string; } /** * The output from the DescribeCACertificate operation. * @public */ export interface DescribeCACertificateResponse { /** * The CA certificate description. * @public */ certificateDescription?: CACertificateDescription; /** * Information about the registration configuration. * @public */ registrationConfig?: RegistrationConfig; } /** * The input for the DescribeCertificate operation. * @public */ export interface DescribeCertificateRequest { /** * The ID of the certificate. (The last part of the certificate ARN contains the * certificate ID.) * @public */ certificateId: string | undefined; } /** * @public * @enum */ export declare const CertificateStatus: { readonly ACTIVE: "ACTIVE"; readonly INACTIVE: "INACTIVE"; readonly PENDING_ACTIVATION: "PENDING_ACTIVATION"; readonly PENDING_TRANSFER: "PENDING_TRANSFER"; readonly REGISTER_INACTIVE: "REGISTER_INACTIVE"; readonly REVOKED: "REVOKED"; }; /** * @public */ export type CertificateStatus = (typeof CertificateStatus)[keyof typeof CertificateStatus]; /** * Data used to transfer a certificate to an Amazon Web Services account. * @public */ export interface TransferData { /** * The transfer message. * @public */ transferMessage?: string; /** * The reason why the transfer was rejected. * @public */ rejectReason?: string; /** * The date the transfer took place. * @public */ transferDate?: Date; /** * The date the transfer was accepted. * @public */ acceptDate?: Date; /** * The date the transfer was rejected. * @public */ rejectDate?: Date; } /** * Describes a certificate. * @public */ export interface CertificateDescription { /** * The ARN of the certificate. * @public */ certificateArn?: string; /** * The ID of the certificate. * @public */ certificateId?: string; /** * The certificate ID of the CA certificate used to sign this certificate. * @public */ caCertificateId?: string; /** * The status of the certificate. * @public */ status?: CertificateStatus; /** * The certificate data, in PEM format. * @public */ certificatePem?: string; /** * The ID of the Amazon Web Services account that owns the certificate. * @public */ ownedBy?: string; /** * The ID of the Amazon Web Services account of the previous owner of the certificate. * @public */ previousOwnedBy?: string; /** * The date and time the certificate was created. * @public */ creationDate?: Date; /** * The date and time the certificate was last modified. * @public */ lastModifiedDate?: Date; /** * The customer version of the certificate. * @public */ customerVersion?: number; /** * The transfer data. * @public */ transferData?: TransferData; /** * The generation ID of the certificate. * @public */ generationId?: string; /** * When the certificate is valid. * @public */ validity?: CertificateValidity; /** * The mode of the certificate. * * <code>DEFAULT</code>: A certificate in <code>DEFAULT</code> mode is either generated by * Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in <code>DEFAULT</code> mode. Devices with * certificates in <code>DEFAULT</code> mode aren't required to send the Server Name * Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as * custom domains and VPC endpoints, we recommend that you use the SNI extension when * connecting to Amazon Web Services IoT Core. * * <code>SNI_ONLY</code>: A certificate in <code>SNI_ONLY</code> mode is registered without an issuer CA. Devices with certificates * in <code>SNI_ONLY</code> mode must send the SNI extension when connecting to Amazon Web Services IoT Core. * For more information about the value for SNI extension, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html">Transport security in IoT</a>. * @public */ certificateMode?: CertificateMode; } /** * The output of the DescribeCertificate operation. * @public */ export interface DescribeCertificateResponse { /** * The description of the certificate. * @public */ certificateDescription?: CertificateDescription; } /** * @public */ export interface DescribeCertificateProviderRequest { /** * The name of the certificate provider. * @public */ certificateProviderName: string | undefined; } /** * @public */ export interface DescribeCertificateProviderResponse { /** * The name of the certificate provider. * @public */ certificateProviderName?: string; /** * The ARN of the certificate provider. * @public */ certificateProviderArn?: string; /** * The Lambda function ARN that's associated with the certificate provider. * @public */ lambdaFunctionArn?: string; /** * A list of the operations that the certificate provider will use to generate certificates. * Valid value: <code>CreateCertificateFromCsr</code>. * @public */ accountDefaultForOperations?: CertificateProviderOperation[]; /** * The date-time string that indicates when the certificate provider was created. * @public */ creationDate?: Date; /** * The date-time string that indicates when the certificate provider was last updated. * @public */ lastModifiedDate?: Date; } /** * @public */ export interface DescribeCustomMetricRequest { /** * * The name of the custom metric. * * @public */ metricName: string | undefined; } /** * @public */ export interface DescribeCustomMetricResponse { /** * * The name of the custom metric. * * @public */ metricName?: string; /** * * The Amazon Resource Number (ARN) of the custom metric. * * @public */ metricArn?: string; /** * The type of the custom metric. * <important> * The type <code>number</code> only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value. * </important> * @public */ metricType?: CustomMetricType; /** * * Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated. * * @public */ displayName?: string; /** * * The creation date of the custom metric in milliseconds since epoch. * * @public */ creationDate?: Date; /** * * The time the custom metric was last modified in milliseconds since epoch. * * @public */ lastModifiedDate?: Date; } /** * @public */ export interface DescribeDefaultAuthorizerRequest { } /** * @public */ export interface DescribeDefaultAuthorizerResponse { /** * The default authorizer's description. * @public */ authorizerDescription?: AuthorizerDescription; } /** * @public */ export interface DescribeDetectMitigationActionsTaskRequest { /** * * The unique identifier of the task. * * @public */ taskId: string | undefined; } /** * * The target of a mitigation action task. * * @public */ export interface DetectMitigationActionsTaskTarget { /** * * The unique identifiers of the violations. * * @public */ violationIds?: string[]; /** * * The name of the security profile. * * @public */ securityProfileName?: string; /** * * The name of the behavior. * * @public */ behaviorName?: string; } /** * * The statistics of a mitigation action task. * * @public */ export interface DetectMitigationActionsTaskStatistics { /** * * The actions that were performed. * * @public */ actionsExecuted?: number; /** * * The actions that were skipped. * * @public */ actionsSkipped?: number; /** * * The actions that failed. * * @public */ actionsFailed?: number; } /** * @public * @enum */ export declare const DetectMitigationActionsTaskStatus: { readonly CANCELED: "CANCELED"; readonly FAILED: "FAILED"; readonly IN_PROGRESS: "IN_PROGRESS"; readonly SUCCESSFUL: "SUCCESSFUL"; }; /** * @public */ export type DetectMitigationActionsTaskStatus = (typeof DetectMitigationActionsTaskStatus)[keyof typeof DetectMitigationActionsTaskStatus]; /** * * Specifies the time period of which violation events occurred between. * * @public */ export interface ViolationEventOccurrenceRange { /** * * The start date and time of a time period in which violation events occurred. * * @public */ startTime: Date | undefined; /** * * The end date and time of a time period in which violation events occurred. * * @public */ endTime: Date | undefined; } /** * * The summary of the mitigation action tasks. * * @public */ export interface DetectMitigationActionsTaskSummary { /** * * The unique identifier of the task. * * @public */ taskId?: string; /** * * The status of the task. * * @public */ taskStatus?: DetectMitigationActionsTaskStatus; /** * * The date the task started. * * @public */ taskStartTime?: Date; /** * * The date the task ended. * * @public */ taskEndTime?: Date; /** * * Specifies the ML Detect findings to which the mitigation actions are applied. * * @public */ target?: DetectMitigationActionsTaskTarget; /** * * Specifies the time period of which violation events occurred between. * * @public */ violationEventOccurrenceRange?: ViolationEventOccurrenceRange; /** * * Includes only active violations. * * @public */ onlyActiveViolationsIncluded?: boolean; /** * * Includes suppressed alerts. * * @public */ suppressedAlertsIncluded?: boolean; /** * * The definition of the actions. * * @public */ actionsDefinition?: MitigationAction[]; /** * * The statistics of a mitigation action task. * * @public */ taskStatistics?: DetectMitigationActionsTaskStatistics; } /** * @public */ export interface DescribeDetectMitigationActionsTaskResponse { /** * * The description of a task. * * @public */ taskSummary?: DetectMitigationActionsTaskSummary; } /** * @public */ export interface DescribeDimensionRequest { /** * The unique identifier for the dimension. * @public */ name: string | undefined; } /** * @public */ export interface DescribeDimensionResponse { /** * The unique identifier for the dimension. * @public */ name?: string; /** * The Amazon Resource Name * (ARN) * for * the dimension. * @public */ arn?: string; /** * The type of the dimension. * @public */ type?: DimensionType; /** * The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name. * @public */ stringValues?: string[]; /** * The date the dimension was created. * @public */ creationDate?: Date; /** * The date the dimension was last modified. * @public */ lastModifiedDate?: Date; } /** * @public */ export interface DescribeDomainConfigurationRequest { /** * The name of the domain configuration. * @public */ domainConfigurationName: string | undefined; } /** * @public * @enum */ export declare const DomainConfigurationStatus: { readonly DISABLED: "DISABLED"; readonly ENABLED: "ENABLED"; }; /** * @public */ export type DomainConfigurationStatus = (typeof DomainConfigurationStatus)[keyof typeof DomainConfigurationStatus]; /** * @public * @enum */ export declare const DomainType: { readonly AWS_MANAGED: "AWS_MANAGED"; readonly CUSTOMER_MANAGED: "CUSTOMER_MANAGED"; readonly ENDPOINT: "ENDPOINT"; }; /** * @public */ export type DomainType = (typeof DomainType)[keyof typeof DomainType]; /** * @public * @enum */ export declare const ServerCertificateStatus: { readonly INVALID: "INVALID"; readonly VALID: "VALID"; }; /** * @public */ export type ServerCertificateStatus = (typeof ServerCertificateStatus)[keyof typeof ServerCertificateStatus]; /** * An object that contains information about a server certificate. * @public */ export interface ServerCertificateSummary { /** * The ARN of the server certificate. * @public */ serverCertificateArn?: string; /** * The status of the server certificate. * @public */ serverCertificateStatus?: ServerCertificateStatus; /** * Details that explain the status of the server certificate. * @public */ serverCertificateStatusDetail?: string; } /** * @public */ export interface DescribeDomainConfigurationResponse { /** * The name of the domain configuration. * @public */ domainConfigurationName?: string; /** * The ARN of the domain configuration. * @public */ domainConfigurationArn?: string; /** * The name of the domain. * @public */ domainName?: string; /** * A list containing summary information about the server certificate included in the domain configuration. * @public */ serverCertificates?: ServerCertificateSummary[]; /** * An object that specifies the authorization service for a domain. * @public */ authorizerConfig?: AuthorizerConfig; /** * A Boolean value that specifies the current state of the domain configuration. * @public */ domainConfigurationStatus?: DomainConfigurationStatus; /** * The type of service delivered by the endpoint. * @public */ serviceType?: ServiceType; /** * The type of the domain. * @public */ domainType?: DomainType; /** * The date and time the domain configuration's status was last changed. * @public */ lastStatusChangeDate?: Date; /** * An object that specifies the TLS configuration for a domain. * @public */ tlsConfig?: TlsConfig; /** * The server certificate configuration. * @public */ serverCertificateConfig?: ServerCertificateConfig; } /** * The input for the DescribeEndpoint operation. * @public */ export interface DescribeEndpointRequest { /** * The endpoint type. Valid endpoint types include: * <ul> * <li> * * <code>iot:Data</code> - Returns a VeriSign signed data endpoint. * </li> * </ul> * <ul> * <li> * * <code>iot:Data-ATS</code> - Returns an ATS signed data endpoint. * </li> * </ul> * <ul> * <li> * * <code>iot:CredentialProvider</code> - Returns an IoT credentials provider API * endpoint. * </li> * </ul> * <ul> * <li> * * <code>iot:Jobs</code> - Returns an IoT device management Jobs API * endpoint. * </li> * </ul> * We strongly recommend that customers use the newer <code>iot:Data-ATS</code> endpoint type to avoid * issues related to the widespread distrust of Symantec certificate authorities. ATS Signed Certificates * are more secure and are trusted by most popular browsers. * @public */ endpointType?: string; } /** * The output from the DescribeEndpoint operation. * @public */ export interface DescribeEndpointResponse { /** * The endpoint. The format of the endpoint is as follows: * identifier.iot.region.amazonaws.com. * @public */ endpointAddress?: string; } /** * @public */ export interface DescribeEventConfigurationsRequest { } /** * @public * @enum */ export declare const EventType: { readonly CA_CERTIFICATE: "CA_CERTIFICATE"; readonly CERTIFICATE: "CERTIFICATE"; readonly JOB: "JOB"; readonly JOB_EXECUTION: "JOB_EXECUTION"; readonly POLICY: "POLICY"; readonly THING: "THING"; readonly THING_GROUP: "THING_GROUP"; readonly THING_GROUP_HIERARCHY: "THING_GROUP_HIERARCHY"; readonly THING_GROUP_MEMBERSHIP: "THING_GROUP_MEMBERSHIP"; readonly THING_TYPE: "THING_TYPE"; readonly THING_TYPE_ASSOCIATION: "THING_TYPE_ASSOCIATION"; }; /** * @public */ export type EventType = (typeof EventType)[keyof typeof EventType]; /** * Configuration. * @public */ export interface Configuration { /** * True to enable the configuration. * @public */ Enabled?: boolean; } /** * @public */ export interface DescribeEventConfigurationsResponse { /** * The event configurations. * @public */ eventConfigurations?: Partial<Record<EventType, Configuration>>; /** * The creation date of the event configuration. * @public */ creationDate?: Date; /** * The date the event configurations were last modified. * @public */ lastModifiedDate?: Date; } /** * @public */ export interface DescribeFleetMetricRequest { /** * The name of the fleet metric to describe. * @public */ metricName: string | undefined; } /** * @public */ export interface DescribeFleetMetricResponse { /** * The name of the fleet metric to describe. * @public */ metricName?: string; /** * The search query string. * @public */ queryString?: string; /** * The type of the aggregation query. * @public */ aggregationType?: AggregationType; /** * The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60. * @public */ period?: number; /** * The field to aggregate. * @public */ aggregationField?: string; /** * The fleet metric description. * @public */ description?: string; /** * The query version. * @public */ queryVersion?: string; /** * The name of the index to search. * @public */ indexName?: string; /** * The date when the fleet metric is created. * @public */ creationDate?: Date; /** * The date when the fleet metric is last modified. * @public */ lastModifiedDate?: Date; /** * Used to support unit transformation such as milliseconds to seconds. The unit must be * supported by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CW metric</a>. * @public */ unit?: FleetMetricUnit; /** * The version of the fleet metric.</