@aws-sdk/client-iot

import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { IoTServiceException as __BaseException } from "./IoTServiceException"; import { AbortConfig, AggregationType, AlertTarget, AlertTargetType, AttributePayload, AuditCheckConfiguration, AuditFrequency, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuthInfo, AuthorizerConfig, AuthorizerStatus, AuthResult, AutoRegistrationStatus, Behavior, BillingGroupProperties, CertificateProviderOperation, CustomMetricType, DayOfWeek, DimensionType, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, PackageVersionStatus, Policy, PresignedUrlConfig, ProvisioningHook, RelatedResource, ResourceIdentifier, ServerCertificateConfig, StreamFile, Tag, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestinationStatus, TopicRulePayload, VerificationState, ViolationEventAdditionalInfo } from "./models_0"; import { BehaviorCriteriaType, CACertificateStatus, CertificateMode, CertificateStatus, Configuration, DetectMitigationActionsTaskTarget, DomainConfigurationStatus, EventType, GroupNameAndArn, LogTargetType, RegistrationConfig, Status, ThingGroupIndexingConfiguration, ThingIndexingConfiguration, ThingTypeMetadata, VersionUpdateByJobsConfig, ViolationEventOccurrenceRange } from "./models_1"; /** * The input to the ListOutgoingCertificates operation. * @public */ export interface ListOutgoingCertificatesRequest { /** * The result page size. * @public */ pageSize?: number; /** * The marker for the next set of results. * @public */ marker?: string; /** * Specifies the order for results. If True, the results are returned in ascending * order, based on the creation date. * @public */ ascendingOrder?: boolean; } /** * A certificate that has been transferred but not yet accepted. * @public */ export interface OutgoingCertificate { /** * The certificate ARN. * @public */ certificateArn?: string; /** * The certificate ID. * @public */ certificateId?: string; /** * The Amazon Web Services account to which the transfer was made. * @public */ transferredTo?: string; /** * The date the transfer was initiated. * @public */ transferDate?: Date; /** * The transfer message. * @public */ transferMessage?: string; /** * The certificate creation date. * @public */ creationDate?: Date; } /** * The output from the ListOutgoingCertificates operation. * @public */ export interface ListOutgoingCertificatesResponse { /** * The certificates that are being transferred but not yet accepted. * @public */ outgoingCertificates?: OutgoingCertificate[]; /** * The marker for the next set of results. * @public */ nextMarker?: string; } /** * @public */ export interface ListPackagesRequest { /** * The maximum number of results returned at one time. * @public */ maxResults?: number; /** * The token for the next set of results. * @public */ nextToken?: string; } /** * A summary of information about a software package. * @public */ export interface PackageSummary { /** * The name for the target software package. * @public */ packageName?: string; /** * The name of the default package version. * @public */ defaultVersionName?: string; /** * The date that the package was created. * @public */ creationDate?: Date; /** * The date that the package was last updated. * @public */ lastModifiedDate?: Date; } /** * @public */ export interface ListPackagesResponse { /** * The software package summary. * @public */ packageSummaries?: PackageSummary[]; /** * The token for the next set of results. * @public */ nextToken?: string; } /** * @public */ export interface ListPackageVersionsRequest { /** * The name of the target software package. * @public */ packageName: string | undefined; /** * The status of the package version. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>. * @public */ status?: PackageVersionStatus; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; /** * The token for the next set of results. * @public */ nextToken?: string; } /** * A summary of information about a package version. * @public */ export interface PackageVersionSummary { /** * The name of the associated software package. * @public */ packageName?: string; /** * The name of the target package version. * @public */ versionName?: string; /** * The status of the package version. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>. * @public */ status?: PackageVersionStatus; /** * The date that the package version was created. * @public */ creationDate?: Date; /** * The date that the package version was last updated. * @public */ lastModifiedDate?: Date; } /** * @public */ export interface ListPackageVersionsResponse { /** * Lists the package versions associated to the package. * @public */ packageVersionSummaries?: PackageVersionSummary[]; /** * The token for the next set of results. * @public */ nextToken?: string; } /** * The input for the ListPolicies operation. * @public */ export interface ListPoliciesRequest { /** * The marker for the next set of results. * @public */ marker?: string; /** * The result page size. * @public */ pageSize?: number; /** * Specifies the order for results. If true, the results are returned in ascending * creation order. * @public */ ascendingOrder?: boolean; } /** * The output from the ListPolicies operation. * @public */ export interface ListPoliciesResponse { /** * The descriptions of the policies. * @public */ policies?: Policy[]; /** * The marker for the next set of results, or null if there are no additional * results. * @public */ nextMarker?: string; } /** * The input for the ListPolicyPrincipals operation. * @public */ export interface ListPolicyPrincipalsRequest { /** * The policy name. * @public */ policyName: string | undefined; /** * The marker for the next set of results. * @public */ marker?: string; /** * The result page size. * @public */ pageSize?: number; /** * Specifies the order for results. If true, the results are returned in ascending * creation order. * @public */ ascendingOrder?: boolean; } /** * The output from the ListPolicyPrincipals operation. * @public */ export interface ListPolicyPrincipalsResponse { /** * The descriptions of the principals. * @public */ principals?: string[]; /** * The marker for the next set of results, or null if there are no additional * results. * @public */ nextMarker?: string; } /** * The input for the ListPolicyVersions operation. * @public */ export interface ListPolicyVersionsRequest { /** * The policy name. * @public */ policyName: string | undefined; } /** * Describes a policy version. * @public */ export interface PolicyVersion { /** * The policy version ID. * @public */ versionId?: string; /** * Specifies whether the policy version is the default. * @public */ isDefaultVersion?: boolean; /** * The date and time the policy was created. * @public */ createDate?: Date; } /** * The output from the ListPolicyVersions operation. * @public */ export interface ListPolicyVersionsResponse { /** * The policy versions. * @public */ policyVersions?: PolicyVersion[]; } /** * The input for the ListPrincipalPolicies operation. * @public */ export interface ListPrincipalPoliciesRequest { /** * The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id). * @public */ principal: string | undefined; /** * The marker for the next set of results. * @public */ marker?: string; /** * The result page size. * @public */ pageSize?: number; /** * Specifies the order for results. If true, results are returned in ascending creation * order. * @public */ ascendingOrder?: boolean; } /** * The output from the ListPrincipalPolicies operation. * @public */ export interface ListPrincipalPoliciesResponse { /** * The policies. * @public */ policies?: Policy[]; /** * The marker for the next set of results, or null if there are no additional * results. * @public */ nextMarker?: string; } /** * The input for the ListPrincipalThings operation. * @public */ export interface ListPrincipalThingsRequest { /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return in this operation. * @public */ maxResults?: number; /** * The principal. * @public */ principal: string | undefined; } /** * The output from the ListPrincipalThings operation. * @public */ export interface ListPrincipalThingsResponse { /** * The things. * @public */ things?: string[]; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * @public */ export interface ListProvisioningTemplatesRequest { /** * The maximum number of results to return at one time. * @public */ maxResults?: number; /** * A token to retrieve the next set of results. * @public */ nextToken?: string; } /** * A summary of information about a provisioning template. * @public */ export interface ProvisioningTemplateSummary { /** * The ARN of the provisioning template. * @public */ templateArn?: string; /** * The name of the provisioning template. * @public */ templateName?: string; /** * The description of the provisioning template. * @public */ description?: string; /** * The date when the provisioning template summary was created. * @public */ creationDate?: Date; /** * The date when the provisioning template summary was last modified. * @public */ lastModifiedDate?: Date; /** * True if the fleet provision template is enabled, otherwise false. * @public */ enabled?: boolean; /** * The type you define in a provisioning template. You can create a template with only one type. * You can't change the template type after its creation. The default value is <code>FLEET_PROVISIONING</code>. * For more information about provisioning template, see: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning template</a>. * * @public */ type?: TemplateType; } /** * @public */ export interface ListProvisioningTemplatesResponse { /** * A list of provisioning templates * @public */ templates?: ProvisioningTemplateSummary[]; /** * A token to retrieve the next set of results. * @public */ nextToken?: string; } /** * @public */ export interface ListProvisioningTemplateVersionsRequest { /** * The name of the provisioning template. * @public */ templateName: string | undefined; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; /** * A token to retrieve the next set of results. * @public */ nextToken?: string; } /** * A summary of information about a fleet provision template version. * @public */ export interface ProvisioningTemplateVersionSummary { /** * The ID of the fleet provisioning template version. * @public */ versionId?: number; /** * The date when the provisioning template version was created * @public */ creationDate?: Date; /** * True if the provisioning template version is the default version, otherwise * false. * @public */ isDefaultVersion?: boolean; } /** * @public */ export interface ListProvisioningTemplateVersionsResponse { /** * The list of provisioning template versions. * @public */ versions?: ProvisioningTemplateVersionSummary[]; /** * A token to retrieve the next set of results. * @public */ nextToken?: string; } /** * @public */ export interface ListRelatedResourcesForAuditFindingRequest { /** * The finding Id. * @public */ findingId: string | undefined; /** * A token that can be used to retrieve the next set of results, * or <code>null</code> if there are no additional results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; } /** * @public */ export interface ListRelatedResourcesForAuditFindingResponse { /** * The related resources. * @public */ relatedResources?: RelatedResource[]; /** * A token that can be used to retrieve the next set of results, * or <code>null</code> for the first API call. * @public */ nextToken?: string; } /** * @public */ export interface ListRoleAliasesRequest { /** * The maximum number of results to return at one time. * @public */ pageSize?: number; /** * A marker used to get the next set of results. * @public */ marker?: string; /** * Return the list of role aliases in ascending alphabetical order. * @public */ ascendingOrder?: boolean; } /** * @public */ export interface ListRoleAliasesResponse { /** * The role aliases. * @public */ roleAliases?: string[]; /** * A marker used to get the next set of results. * @public */ nextMarker?: string; } /** * @public */ export interface ListScheduledAuditsRequest { /** * The token for the next set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. The default is 25. * @public */ maxResults?: number; } /** * Information about the scheduled audit. * @public */ export interface ScheduledAuditMetadata { /** * The name of the scheduled audit. * @public */ scheduledAuditName?: string; /** * The ARN of the scheduled audit. * @public */ scheduledAuditArn?: string; /** * How often the scheduled audit occurs. * @public */ frequency?: AuditFrequency; /** * The day of the month on which the scheduled audit is run (if the * <code>frequency</code> 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. * @public */ dayOfMonth?: string; /** * The day of the week on which the scheduled audit is run (if the * <code>frequency</code> is "WEEKLY" or "BIWEEKLY"). * @public */ dayOfWeek?: DayOfWeek; } /** * @public */ export interface ListScheduledAuditsResponse { /** * The list of scheduled audits. * @public */ scheduledAudits?: ScheduledAuditMetadata[]; /** * A token that can be used to retrieve the next set of results, * or <code>null</code> if there are no additional results. * @public */ nextToken?: string; } /** * @public */ export interface ListSecurityProfilesRequest { /** * The token for the next set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; /** * A filter to limit results to the security profiles that use the defined dimension. * Cannot be used with <code>metricName</code> * * @public */ dimensionName?: string; /** * The name of the custom metric. * Cannot be used with <code>dimensionName</code>. * @public */ metricName?: string; } /** * Identifying information for a Device Defender security profile. * @public */ export interface SecurityProfileIdentifier { /** * The name you've given to the security profile. * @public */ name: string | undefined; /** * The ARN of the security profile. * @public */ arn: string | undefined; } /** * @public */ export interface ListSecurityProfilesResponse { /** * A list of security profile identifiers (names and ARNs). * @public */ securityProfileIdentifiers?: SecurityProfileIdentifier[]; /** * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no * additional results. * @public */ nextToken?: string; } /** * @public */ export interface ListSecurityProfilesForTargetRequest { /** * The token for the next set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; /** * If true, return child groups too. * @public */ recursive?: boolean; /** * The ARN of the target (thing group) whose attached security profiles you want to get. * @public */ securityProfileTargetArn: string | undefined; } /** * A target to which an alert is sent when a security profile behavior is * violated. * @public */ export interface SecurityProfileTarget { /** * The ARN of the security profile. * @public */ arn: string | undefined; } /** * Information about a security profile and the target associated with it. * @public */ export interface SecurityProfileTargetMapping { /** * Information that identifies the security profile. * @public */ securityProfileIdentifier?: SecurityProfileIdentifier; /** * Information about the target (thing group) associated with the security profile. * @public */ target?: SecurityProfileTarget; } /** * @public */ export interface ListSecurityProfilesForTargetResponse { /** * A list of security profiles and their associated targets. * @public */ securityProfileTargetMappings?: SecurityProfileTargetMapping[]; /** * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no * additional results. * @public */ nextToken?: string; } /** * @public */ export interface ListStreamsRequest { /** * The maximum number of results to return at a time. * @public */ maxResults?: number; /** * A token used to get the next set of results. * @public */ nextToken?: string; /** * Set to true to return the list of streams in ascending order. * @public */ ascendingOrder?: boolean; } /** * A summary of a stream. * @public */ export interface StreamSummary { /** * The stream ID. * @public */ streamId?: string; /** * The stream ARN. * @public */ streamArn?: string; /** * The stream version. * @public */ streamVersion?: number; /** * A description of the stream. * @public */ description?: string; } /** * @public */ export interface ListStreamsResponse { /** * A list of streams. * @public */ streams?: StreamSummary[]; /** * A token used to get the next set of results. * @public */ nextToken?: string; } /** * @public */ export interface ListTagsForResourceRequest { /** * The ARN of the resource. * @public */ resourceArn: string | undefined; /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; } /** * @public */ export interface ListTagsForResourceResponse { /** * The list of tags assigned to the resource. * @public */ tags?: Tag[]; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * @public */ export interface ListTargetsForPolicyRequest { /** * The policy name. * @public */ policyName: string | undefined; /** * A marker used to get the next set of results. * @public */ marker?: string; /** * The maximum number of results to return at one time. * @public */ pageSize?: number; } /** * @public */ export interface ListTargetsForPolicyResponse { /** * The policy targets. * @public */ targets?: string[]; /** * A marker used to get the next set of results. * @public */ nextMarker?: string; } /** * @public */ export interface ListTargetsForSecurityProfileRequest { /** * The security profile. * @public */ securityProfileName: string | undefined; /** * The token for the next set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; } /** * @public */ export interface ListTargetsForSecurityProfileResponse { /** * The thing groups to which the security profile is attached. * @public */ securityProfileTargets?: SecurityProfileTarget[]; /** * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no * additional results. * @public */ nextToken?: string; } /** * @public */ export interface ListThingGroupsRequest { /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; /** * A filter that limits the results to those with the specified parent group. * @public */ parentGroup?: string; /** * A filter that limits the results to those with the specified name prefix. * @public */ namePrefixFilter?: string; /** * If true, return child groups as well. * @public */ recursive?: boolean; } /** * @public */ export interface ListThingGroupsResponse { /** * The thing groups. * @public */ thingGroups?: GroupNameAndArn[]; /** * The token to use to get the next set of results. Will not be returned if operation has returned all results. * @public */ nextToken?: string; } /** * @public */ export interface ListThingGroupsForThingRequest { /** * The thing name. * @public */ thingName: string | undefined; /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; } /** * @public */ export interface ListThingGroupsForThingResponse { /** * The thing groups. * @public */ thingGroups?: GroupNameAndArn[]; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * The input for the ListThingPrincipal operation. * @public */ export interface ListThingPrincipalsRequest { /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return in this operation. * @public */ maxResults?: number; /** * The name of the thing. * @public */ thingName: string | undefined; } /** * The output from the ListThingPrincipals operation. * @public */ export interface ListThingPrincipalsResponse { /** * The principals associated with the thing. * @public */ principals?: string[]; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * @public * @enum */ export declare const ReportType: { readonly ERRORS: "ERRORS"; readonly RESULTS: "RESULTS"; }; /** * @public */ export type ReportType = (typeof ReportType)[keyof typeof ReportType]; /** * @public */ export interface ListThingRegistrationTaskReportsRequest { /** * The id of the task. * @public */ taskId: string | undefined; /** * The type of task report. * @public */ reportType: ReportType | undefined; /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return per request. * @public */ maxResults?: number; } /** * @public */ export interface ListThingRegistrationTaskReportsResponse { /** * Links to the task resources. * @public */ resourceLinks?: string[]; /** * The type of task report. * @public */ reportType?: ReportType; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * @public */ export interface ListThingRegistrationTasksRequest { /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; /** * The status of the bulk thing provisioning task. * @public */ status?: Status; } /** * @public */ export interface ListThingRegistrationTasksResponse { /** * A list of bulk thing provisioning task IDs. * @public */ taskIds?: string[]; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * The input for the ListThings operation. * @public */ export interface ListThingsRequest { /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return in this operation. * @public */ maxResults?: number; /** * The attribute name used to search for things. * @public */ attributeName?: string; /** * The attribute value used to search for things. * @public */ attributeValue?: string; /** * The name of the thing type used to search for things. * @public */ thingTypeName?: string; /** * When <code>true</code>, the action returns the thing resources with attribute values * that start with the <code>attributeValue</code> provided. * When <code>false</code>, or not present, the action returns only the thing * resources with attribute values that match the entire <code>attributeValue</code> * provided. * @public */ usePrefixAttributeValue?: boolean; } /** * The properties of the thing, including thing name, thing type name, and a list of thing * attributes. * @public */ export interface ThingAttribute { /** * The name of the thing. * @public */ thingName?: string; /** * The name of the thing type, if the thing has been associated with a type. * @public */ thingTypeName?: string; /** * The thing ARN. * @public */ thingArn?: string; /** * A list of thing attributes which are name-value pairs. * @public */ attributes?: Record<string, string>; /** * The version of the thing record in the registry. * @public */ version?: number; } /** * The output from the ListThings operation. * @public */ export interface ListThingsResponse { /** * The things. * @public */ things?: ThingAttribute[]; /** * The token to use to get the next set of results. Will not be returned if operation has returned all results. * @public */ nextToken?: string; } /** * @public */ export interface ListThingsInBillingGroupRequest { /** * The name of the billing group. * @public */ billingGroupName: string | undefined; /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return per request. * @public */ maxResults?: number; } /** * @public */ export interface ListThingsInBillingGroupResponse { /** * A list of things in the billing group. * @public */ things?: string[]; /** * The token to use to get the next set of results. Will not be returned if operation has returned all results. * @public */ nextToken?: string; } /** * @public */ export interface ListThingsInThingGroupRequest { /** * The thing group name. * @public */ thingGroupName: string | undefined; /** * When true, list things in this thing group and in all child groups as * well. * @public */ recursive?: boolean; /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; } /** * @public */ export interface ListThingsInThingGroupResponse { /** * The things in the specified thing group. * @public */ things?: string[]; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * The input for the ListThingTypes operation. * @public */ export interface ListThingTypesRequest { /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return in this operation. * @public */ maxResults?: number; /** * The name of the thing type. * @public */ thingTypeName?: string; } /** * The definition of the thing type, including thing type name and description. * @public */ export interface ThingTypeDefinition { /** * The name of the thing type. * @public */ thingTypeName?: string; /** * The thing type ARN. * @public */ thingTypeArn?: string; /** * The ThingTypeProperties for the thing type. * @public */ thingTypeProperties?: ThingTypeProperties; /** * The ThingTypeMetadata contains additional information about the thing type including: creation date and * time, a value indicating whether the thing type is deprecated, and a date and time when it was * deprecated. * @public */ thingTypeMetadata?: ThingTypeMetadata; } /** * The output for the ListThingTypes operation. * @public */ export interface ListThingTypesResponse { /** * The thing types. * @public */ thingTypes?: ThingTypeDefinition[]; /** * The token for the next set of results. Will not be returned if operation has returned all results. * @public */ nextToken?: string; } /** * @public */ export interface ListTopicRuleDestinationsRequest { /** * The maximum number of results to return at one time. * @public */ maxResults?: number; /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; } /** * Information about an HTTP URL destination. * @public */ export interface HttpUrlDestinationSummary { /** * The URL used to confirm ownership of or access to the HTTP topic rule destination * URL. * @public */ confirmationUrl?: string; } /** * The summary of a virtual private cloud (VPC) destination. * @public */ export interface VpcDestinationSummary { /** * The subnet IDs of the VPC destination. * @public */ subnetIds?: string[]; /** * The security groups of the VPC destination. * @public */ securityGroups?: string[]; /** * The ID of the VPC. * @public */ vpcId?: string; /** * The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs). * @public */ roleArn?: string; } /** * Information about the topic rule destination. * @public */ export interface TopicRuleDestinationSummary { /** * The topic rule destination ARN. * @public */ arn?: string; /** * The status of the topic rule destination. Valid values are: * <dl> * <dt>IN_PROGRESS</dt> * <dd> * A topic rule destination was created but has not been confirmed. You can set * <code>status</code> to <code>IN_PROGRESS</code> by calling * <code>UpdateTopicRuleDestination</code>. Calling * <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to * be sent to your confirmation endpoint. * </dd> * <dt>ENABLED</dt> * <dd> * Confirmation was completed, and traffic to this destination is allowed. You can * set <code>status</code> to <code>DISABLED</code> by calling * <code>UpdateTopicRuleDestination</code>. * </dd> * <dt>DISABLED</dt> * <dd> * Confirmation was completed, and traffic to this destination is not allowed. You * can set <code>status</code> to <code>ENABLED</code> by calling * <code>UpdateTopicRuleDestination</code>. * </dd> * <dt>ERROR</dt> * <dd> * Confirmation could not be completed, for example if the confirmation timed out. * You can call <code>GetTopicRuleDestination</code> for details about the error. You * can set <code>status</code> to <code>IN_PROGRESS</code> by calling * <code>UpdateTopicRuleDestination</code>. Calling * <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to * be sent to your confirmation endpoint. * </dd> * </dl> * @public */ status?: TopicRuleDestinationStatus; /** * The date and time when the topic rule destination was created. * @public */ createdAt?: Date; /** * The date and time when the topic rule destination was last updated. * @public */ lastUpdatedAt?: Date; /** * The reason the topic rule destination is in the current status. * @public */ statusReason?: string; /** * Information about the HTTP URL. * @public */ httpUrlSummary?: HttpUrlDestinationSummary; /** * Information about the virtual private cloud (VPC) connection. * @public */ vpcDestinationSummary?: VpcDestinationSummary; } /** * @public */ export interface ListTopicRuleDestinationsResponse { /** * Information about a topic rule destination. * @public */ destinationSummaries?: TopicRuleDestinationSummary[]; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * The input for the ListTopicRules operation. * @public */ export interface ListTopicRulesRequest { /** * The topic. * @public */ topic?: string; /** * The maximum number of results to return. * @public */ maxResults?: number; /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * Specifies whether the rule is disabled. * @public */ ruleDisabled?: boolean; } /** * Describes a rule. * @public */ export interface TopicRuleListItem { /** * The rule ARN. * @public */ ruleArn?: string; /** * The name of the rule. * @public */ ruleName?: string; /** * The pattern for the topic names that apply. * @public */ topicPattern?: string; /** * The date and time the rule was created. * @public */ createdAt?: Date; /** * Specifies whether the rule is disabled. * @public */ ruleDisabled?: boolean; } /** * The output from the ListTopicRules operation. * @public */ export interface ListTopicRulesResponse { /** * The rules. * @public */ rules?: TopicRuleListItem[]; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * @public */ export interface ListV2LoggingLevelsRequest { /** * The type of resource for which you are configuring logging. Must be * <code>THING_Group</code>. * @public */ targetType?: LogTargetType; /** * To retrieve the next set of results, the <code>nextToken</code> * value from a previous response; otherwise null to receive * the first set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; } /** * A log target. * @public */ export interface LogTarget { /** * The target type. * @public */ targetType: LogTargetType | undefined; /** * The target name. * @public */ targetName?: string; } /** * The target configuration. * @public */ export interface LogTargetConfiguration { /** * A log target * @public */ logTarget?: LogTarget; /** * The logging level. * @public */ logLevel?: LogLevel; } /** * @public */ export interface ListV2LoggingLevelsResponse { /** * The logging configuration for a target. * @public */ logTargetConfigurations?: LogTargetConfiguration[]; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string; } /** * @public */ export interface ListViolationEventsRequest { /** * The start time for the alerts to be listed. * @public */ startTime: Date | undefined; /** * The end time for the alerts to be listed. * @public */ endTime: Date | undefined; /** * A filter to limit results to those alerts caused by the specified thing. * @public */ thingName?: string; /** * A filter to limit results to those alerts generated by the specified security profile. * @public */ securityProfileName?: string; /** * * The criteria for a behavior. * * @public */ behaviorCriteriaType?: BehaviorCriteriaType; /** * * A list of all suppressed alerts. * * @public */ listSuppressedAlerts?: boolean; /** * The verification state of the violation (detect alarm). * @public */ verificationState?: VerificationState; /** * The token for the next set of results. * @public */ nextToken?: string; /** * The maximum number of results to return at one time. * @public */ maxResults?: number; } /** * @public * @enum */ export declare const ViolationEventType: { readonly ALARM_CLEARED: "alarm-cleared"; readonly ALARM_INVALIDATED: "alarm-invalidated"; readonly IN_ALARM: "in-alarm"; }; /** * @public */ export type ViolationEventType = (typeof ViolationEventType)[keyof typeof ViolationEventType]; /** * Information about a Device Defender security profile behavior violation. * @public */ export interface ViolationEvent { /** * The ID of the violation event. * @public */ violationId?: string; /** * The name of the thing responsible for the violation event. * @public */ thingName?: string; /** * The name of the security profile whose behavior was violated. * @public */ securityProfileName?: string; /** * The behavior that was violated. * @public */ behavior?: Behavior; /** * The value of the metric (the measurement). * @public */ metricValue?: MetricValue; /** * * The details of a violation event. * * @public */ violationEventAdditionalInfo?: ViolationEventAdditionalInfo; /** * The type of violation event. * @public */ violationEventType?: ViolationEventType; /** * The verification state of the violation (detect alarm). * @public */ verificationState?: VerificationState; /** * The description of the verification state of the violation. * @public */ verificationStateDescription?: string; /** * The time the violation event occurred. * @public */ violationEventTime?: Date; } /** * @public */ export interface ListViolationEventsResponse { /** * The security profile violation alerts issued for this account during the given time period, * potentially filtered by security profile, behavior violated, or thing (device) violating. * @public */ violationEvents?: ViolationEvent[]; /** * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no * additional results. * @public */ nextToken?: string; } /** * @public */ export interface PutVerificationStateOnViolationRequest { /** * The violation ID. * @public */ violationId: string | undefined; /** * The verification state of the violation. * @public */ verificationState: VerificationState | undefined; /** * The description of the verification state of the violation (detect alarm). * @public */ verificationStateDescription?: string; } /** * @public */ export interface PutVerificationStateOnViolationResponse { } /** * The input to the RegisterCACertificate operation. * @public */ export interface RegisterCACertificateRequest { /** * The CA certificate. * @public */ caCertificate: string | undefined; /** * The private key verification certificate. If <code>certificateMode</code> is * <code>SNI_ONLY</code>, the <code>verificationCertificate</code> field must be empty. If * <code>certificateMode</code> is <code>DEFAULT</code> or not provided, the * <code>verificationCertificate</code> field must not be empty. * @public */ verificationCertificate?: string; /** * A boolean value that specifies if the CA certificate is set to active. * Valid values: <code>ACTIVE | INACTIVE</code> * * @public */ setAsActive?: boolean; /** * Allows this CA certificate to be used for auto registration of device * certificates. * @public */ allowAutoRegistration?: boolean; /** * Information about the registration configuration. * @public */ registrationConfig?: RegistrationConfig; /** * Metadata which can be used to manage the CA certificate. * <note> * For URI Request parameters use format: ...key1=value1&key2=value2... * For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." * For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." * </note> * @public */ tags?: Tag[]; /** * Describes the certificate mode in which the Certificate Authority (CA) will be