@aws-sdk/client-iot

import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { IoTServiceException as __BaseException } from "./IoTServiceException"; import { AbortConfig, AggregationType, AlertTarget, AlertTargetType, ApplicationProtocol, AttributePayload, AuditCheckConfiguration, AuditFrequency, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuthenticationType, AuthInfo, AuthorizerConfig, AuthorizerStatus, AuthResult, AutoRegistrationStatus, Behavior, BillingGroupProperties, CertificateProviderOperation, ClientCertificateConfig, CustomMetricType, DayOfWeek, DimensionType, DimensionValueOperator, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, OTAUpdateStatus, PackageVersionArtifact, PackageVersionStatus, Policy, PresignedUrlConfig, ProvisioningHook, RelatedResource, ResourceIdentifier, ServerCertificateConfig, ServiceType, StreamFile, Tag, TargetSelection, TemplateType, ThingGroupProperties, ThingPrincipalType, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestinationStatus, TopicRulePayload, VerificationState, ViolationEventAdditionalInfo } from "./models_0"; import { BehaviorCriteriaType, CACertificateStatus, CertificateMode, CertificateStatus, Configuration, DetectMitigationActionsTaskSummary, DetectMitigationActionsTaskTarget, DomainConfigurationStatus, EventType, GroupNameAndArn, JobExecutionStatus, JobStatus, LogTargetType, MitigationActionType, RegistrationConfig, Status, ThingGroupIndexingConfiguration, ThingIndexingConfiguration, ThingTypeMetadata, VersionUpdateByJobsConfig, ViolationEventOccurrenceRange } from "./models_1"; /** * @public */ export interface ListCustomMetricsResponse { /** * * The name of the custom metric. * * @public */ metricNames?: 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 | undefined; } /** * @public */ export interface ListDetectMitigationActionsExecutionsRequest { /** * * The unique identifier of the task. * * @public */ taskId?: string | undefined; /** * * The unique identifier of the violation. * * @public */ violationId?: string | undefined; /** * * The name of the thing whose mitigation actions are listed. * * @public */ thingName?: string | undefined; /** * * 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. * * @public */ startTime?: Date | undefined; /** * * The end of the time period for which ML Detect mitigation actions executions are returned. * * @public */ endTime?: Date | undefined; /** * * The maximum number of results to return at one time. The default is 25. * * @public */ maxResults?: number | undefined; /** * * The token for the next set of results. * * @public */ nextToken?: string | undefined; } /** * @public * @enum */ export declare const DetectMitigationActionExecutionStatus: { readonly FAILED: "FAILED"; readonly IN_PROGRESS: "IN_PROGRESS"; readonly SKIPPED: "SKIPPED"; readonly SUCCESSFUL: "SUCCESSFUL"; }; /** * @public */ export type DetectMitigationActionExecutionStatus = (typeof DetectMitigationActionExecutionStatus)[keyof typeof DetectMitigationActionExecutionStatus]; /** * * Describes which mitigation actions should be executed. * * @public */ export interface DetectMitigationActionExecution { /** * * The unique identifier of the task. * * @public */ taskId?: string | undefined; /** * * The unique identifier of the violation. * * @public */ violationId?: string | undefined; /** * * The friendly name that uniquely identifies the mitigation action. * * @public */ actionName?: string | undefined; /** * * The name of the thing. * * @public */ thingName?: string | undefined; /** * * The date a mitigation action was started. * * @public */ executionStartDate?: Date | undefined; /** * * The date a mitigation action ended. * * @public */ executionEndDate?: Date | undefined; /** * * The status of a mitigation action. * * @public */ status?: DetectMitigationActionExecutionStatus | undefined; /** * * The error code of a mitigation action. * * @public */ errorCode?: string | undefined; /** * * The message of a mitigation action. * * @public */ message?: string | undefined; } /** * @public */ export interface ListDetectMitigationActionsExecutionsResponse { /** * * List of actions executions. * * @public */ actionsExecutions?: DetectMitigationActionExecution[] | 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 | undefined; } /** * @public */ export interface ListDetectMitigationActionsTasksRequest { /** * The maximum number of results to return at one time. The default is 25. * @public */ maxResults?: number | undefined; /** * * The token for the next set of results. * * @public */ nextToken?: string | undefined; /** * * 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. * * @public */ startTime: Date | undefined; /** * * The end of the time period for which ML Detect mitigation actions tasks are returned. * * @public */ endTime: Date | undefined; } /** * @public */ export interface ListDetectMitigationActionsTasksResponse { /** * * The collection of ML Detect mitigation tasks that matched the filter criteria. * * @public */ tasks?: DetectMitigationActionsTaskSummary[] | 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 | undefined; } /** * @public */ export interface ListDimensionsRequest { /** * The token for the next set of results. * @public */ nextToken?: string | undefined; /** * The maximum number of results to retrieve at one time. * @public */ maxResults?: number | undefined; } /** * @public */ export interface ListDimensionsResponse { /** * A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get details for a dimension. * @public */ dimensionNames?: 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 | undefined; } /** * @public */ export interface ListDomainConfigurationsRequest { /** * The marker for the next set of results. * @public */ marker?: string | undefined; /** * The result page size. * @public */ pageSize?: number | undefined; /** * The type of service delivered by the endpoint. * @public */ serviceType?: ServiceType | undefined; } /** * The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. * A domain configuration can be associated with an Amazon Web Services-managed domain * (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint. * <ul> * <li> * Data * </li> * <li> * Jobs * </li> * <li> * CredentialProvider * </li> * </ul> * @public */ export interface DomainConfigurationSummary { /** * The name of the domain configuration. This value must be unique to a region. * @public */ domainConfigurationName?: string | undefined; /** * The ARN of the domain configuration. * @public */ domainConfigurationArn?: string | undefined; /** * The type of service delivered by the endpoint. * @public */ serviceType?: ServiceType | undefined; } /** * @public */ export interface ListDomainConfigurationsResponse { /** * A list of objects that contain summary information about the user's domain configurations. * @public */ domainConfigurations?: DomainConfigurationSummary[] | undefined; /** * The marker for the next set of results. * @public */ nextMarker?: string | undefined; } /** * @public */ export interface ListFleetMetricsRequest { /** * To retrieve the next set of results, the <code>nextToken</code> value from a previous response; * otherwise <code>null</code> to receive the first set of results. * @public */ nextToken?: string | undefined; /** * The maximum number of results to return in this operation. * @public */ maxResults?: number | undefined; } /** * The name and ARN of a fleet metric. * @public */ export interface FleetMetricNameAndArn { /** * The fleet metric name. * @public */ metricName?: string | undefined; /** * The fleet metric ARN. * @public */ metricArn?: string | undefined; } /** * @public */ export interface ListFleetMetricsResponse { /** * The list of fleet metrics objects. * @public */ fleetMetrics?: FleetMetricNameAndArn[] | undefined; /** * The token for the next set of results. Will not be returned if the operation has returned * all results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListIndicesRequest { /** * The token used to get the next set of results, or <code>null</code> if there are no additional * results. * @public */ nextToken?: string | undefined; /** * The maximum number of results to return at one time. * @public */ maxResults?: number | undefined; } /** * @public */ export interface ListIndicesResponse { /** * The index names. * @public */ indexNames?: string[] | undefined; /** * The token used to get the next set of results, or <code>null</code> if there are no additional * results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListJobExecutionsForJobRequest { /** * The unique identifier you assigned to this job when it was created. * @public */ jobId: string | undefined; /** * The status of the job. * @public */ status?: JobExecutionStatus | undefined; /** * The maximum number of results to be returned per request. * @public */ maxResults?: number | undefined; /** * The token to retrieve the next set of results. * @public */ nextToken?: string | undefined; } /** * The job execution summary. * @public */ export interface JobExecutionSummary { /** * The status of the job execution. * @public */ status?: JobExecutionStatus | undefined; /** * The time, in seconds since the epoch, when the job execution was queued. * @public */ queuedAt?: Date | undefined; /** * The time, in seconds since the epoch, when the job execution started. * @public */ startedAt?: Date | undefined; /** * The time, in seconds since the epoch, when the job execution was last * updated. * @public */ lastUpdatedAt?: Date | undefined; /** * A string (consisting of the digits "0" through "9") which identifies this * particular job execution on this particular device. It can be used later in commands * which return or update job execution information. * @public */ executionNumber?: number | undefined; /** * The number that indicates how many retry attempts have been completed for this job on * this device. * @public */ retryAttempt?: number | undefined; } /** * Contains a summary of information about job executions for a specific * job. * @public */ export interface JobExecutionSummaryForJob { /** * The ARN of the thing on which the job execution is running. * @public */ thingArn?: string | undefined; /** * Contains a subset of information about a job execution. * @public */ jobExecutionSummary?: JobExecutionSummary | undefined; } /** * @public */ export interface ListJobExecutionsForJobResponse { /** * A list of job execution summaries. * @public */ executionSummaries?: JobExecutionSummaryForJob[] | undefined; /** * The token for the next set of results, or null if * there are no additional results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListJobExecutionsForThingRequest { /** * The thing name. * @public */ thingName: string | undefined; /** * An optional filter that lets you search for jobs that have the specified * status. * @public */ status?: JobExecutionStatus | undefined; /** * 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 | undefined; /** * The maximum number of results to be returned per request. * @public */ maxResults?: number | undefined; /** * The token to retrieve the next set of results. * @public */ nextToken?: string | undefined; /** * The unique identifier you assigned to this job when it was created. * @public */ jobId?: string | undefined; } /** * The job execution summary for a thing. * @public */ export interface JobExecutionSummaryForThing { /** * The unique identifier you assigned to this job when it was created. * @public */ jobId?: string | undefined; /** * Contains a subset of information about a job execution. * @public */ jobExecutionSummary?: JobExecutionSummary | undefined; } /** * @public */ export interface ListJobExecutionsForThingResponse { /** * A list of job execution summaries. * @public */ executionSummaries?: JobExecutionSummaryForThing[] | undefined; /** * The token for the next set of results, or null if * there are no additional results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListJobsRequest { /** * An optional filter that lets you search for jobs that have the specified * status. * @public */ status?: JobStatus | undefined; /** * Specifies whether the job will continue to run (CONTINUOUS), or will be complete * after all those things specified as targets have completed the job (SNAPSHOT). If * continuous, the job may also be run on a thing when a change is detected in a target. * For example, a job will run on a thing when the thing is added to a target group, even * after the job was completed by all things originally in the group. * <note> * We recommend that you use continuous jobs instead of snapshot jobs for dynamic * thing group targets. By using continuous jobs, devices that join the group receive * the job execution even after the job has been created. * </note> * @public */ targetSelection?: TargetSelection | undefined; /** * The maximum number of results to return per request. * @public */ maxResults?: number | undefined; /** * The token to retrieve the next set of results. * @public */ nextToken?: string | undefined; /** * A filter that limits the returned jobs to those for the specified group. * @public */ thingGroupName?: string | undefined; /** * A filter that limits the returned jobs to those for the specified group. * @public */ thingGroupId?: string | undefined; /** * 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 | undefined; } /** * The job summary. * @public */ export interface JobSummary { /** * The job ARN. * @public */ jobArn?: string | undefined; /** * The unique identifier you assigned to this job when it was created. * @public */ jobId?: string | undefined; /** * The ID of the thing group. * @public */ thingGroupId?: string | undefined; /** * Specifies whether the job will continue to run (CONTINUOUS), or will be complete * after all those things specified as targets have completed the job (SNAPSHOT). If * continuous, the job may also be run on a thing when a change is detected in a target. * For example, a job will run on a thing when the thing is added to a target group, even * after the job was completed by all things originally in the group. * <note> * We recommend that you use continuous jobs instead of snapshot jobs for dynamic * thing group targets. By using continuous jobs, devices that join the group receive * the job execution even after the job has been created. * </note> * @public */ targetSelection?: TargetSelection | undefined; /** * The job summary status. * @public */ status?: JobStatus | undefined; /** * The time, in seconds since the epoch, when the job was created. * @public */ createdAt?: Date | undefined; /** * The time, in seconds since the epoch, when the job was last updated. * @public */ lastUpdatedAt?: Date | undefined; /** * The time, in seconds since the epoch, when the job completed. * @public */ completedAt?: Date | undefined; /** * Indicates whether a job is concurrent. Will be true when a job is rolling out new job * executions or canceling previously created executions, otherwise false. * @public */ isConcurrent?: boolean | undefined; } /** * @public */ export interface ListJobsResponse { /** * A list of jobs. * @public */ jobs?: JobSummary[] | undefined; /** * The token for the next set of results, or null if * there are no additional results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListJobTemplatesRequest { /** * The maximum number of results to return in the list. * @public */ maxResults?: number | undefined; /** * The token to use to return the next set of results in the list. * @public */ nextToken?: string | undefined; } /** * An object that contains information about the job template. * @public */ export interface JobTemplateSummary { /** * The ARN of the job template. * @public */ jobTemplateArn?: string | undefined; /** * The unique identifier of the job template. * @public */ jobTemplateId?: string | undefined; /** * A description of the job template. * @public */ description?: string | undefined; /** * The time, in seconds since the epoch, when the job template was created. * @public */ createdAt?: Date | undefined; } /** * @public */ export interface ListJobTemplatesResponse { /** * A list of objects that contain information about the job templates. * @public */ jobTemplates?: JobTemplateSummary[] | undefined; /** * The token for the next set of results, or null if * there are no additional results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListManagedJobTemplatesRequest { /** * An optional parameter for template name. If specified, only the versions of the * managed job templates that have the specified template name will be returned. * @public */ templateName?: string | undefined; /** * Maximum number of entries that can be returned. * @public */ maxResults?: number | undefined; /** * The token to retrieve the next set of results. * @public */ nextToken?: string | undefined; } /** * An object that contains information about the managed template. * @public */ export interface ManagedJobTemplateSummary { /** * The Amazon Resource Name (ARN) for a managed template. * @public */ templateArn?: string | undefined; /** * The unique Name for a managed template. * @public */ templateName?: string | undefined; /** * The description for a managed template. * @public */ description?: string | undefined; /** * A list of environments that are supported with the managed job template. * @public */ environments?: string[] | undefined; /** * The version for a managed template. * @public */ templateVersion?: string | undefined; } /** * @public */ export interface ListManagedJobTemplatesResponse { /** * A list of managed job templates that are returned. * @public */ managedJobTemplates?: ManagedJobTemplateSummary[] | undefined; /** * The token to retrieve the next set of results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListMetricValuesRequest { /** * The name of the thing for which security profile metric values are returned. * @public */ thingName: string | undefined; /** * The name of the security profile metric for which values are returned. * @public */ metricName: string | undefined; /** * The dimension name. * @public */ dimensionName?: string | undefined; /** * The dimension value operator. * @public */ dimensionValueOperator?: DimensionValueOperator | undefined; /** * The start of the time period for which metric values are returned. * @public */ startTime: Date | undefined; /** * The end of the time period for which metric values are returned. * @public */ endTime: Date | undefined; /** * The maximum number of results to return at one time. * @public */ maxResults?: number | undefined; /** * The token for the next set of results. * @public */ nextToken?: string | undefined; } /** * A metric. * @public */ export interface MetricDatum { /** * The time the metric value was reported. * @public */ timestamp?: Date | undefined; /** * The value reported for the metric. * @public */ value?: MetricValue | undefined; } /** * @public */ export interface ListMetricValuesResponse { /** * The data the thing reports for the metric during the specified time period. * @public */ metricDatumList?: MetricDatum[] | 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 | undefined; } /** * @public */ export interface ListMitigationActionsRequest { /** * Specify a value to limit the result to mitigation actions with a specific action type. * @public */ actionType?: MitigationActionType | undefined; /** * The maximum number of results to return at one time. The default is 25. * @public */ maxResults?: number | undefined; /** * The token for the next set of results. * @public */ nextToken?: string | undefined; } /** * Information that identifies a mitigation action. This information is returned by ListMitigationActions. * @public */ export interface MitigationActionIdentifier { /** * The friendly name of the mitigation action. * @public */ actionName?: string | undefined; /** * The IAM role ARN used to apply this mitigation action. * @public */ actionArn?: string | undefined; /** * The date when this mitigation action was created. * @public */ creationDate?: Date | undefined; } /** * @public */ export interface ListMitigationActionsResponse { /** * A set of actions that matched the specified filter criteria. * @public */ actionIdentifiers?: MitigationActionIdentifier[] | undefined; /** * The token for the next set of results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListOTAUpdatesRequest { /** * The maximum number of results to return at one time. * @public */ maxResults?: number | undefined; /** * A token used to retrieve the next set of results. * @public */ nextToken?: string | undefined; /** * The OTA update job status. * @public */ otaUpdateStatus?: OTAUpdateStatus | undefined; } /** * An OTA update summary. * @public */ export interface OTAUpdateSummary { /** * The OTA update ID. * @public */ otaUpdateId?: string | undefined; /** * The OTA update ARN. * @public */ otaUpdateArn?: string | undefined; /** * The date when the OTA update was created. * @public */ creationDate?: Date | undefined; } /** * @public */ export interface ListOTAUpdatesResponse { /** * A list of OTA update jobs. * @public */ otaUpdates?: OTAUpdateSummary[] | undefined; /** * A token to use to get the next set of results. * @public */ nextToken?: string | undefined; } /** * The input to the ListOutgoingCertificates operation. * @public */ export interface ListOutgoingCertificatesRequest { /** * The result page size. * @public */ pageSize?: number | undefined; /** * The marker for the next set of results. * @public */ marker?: string | undefined; /** * Specifies the order for results. If True, the results are returned in ascending * order, based on the creation date. * @public */ ascendingOrder?: boolean | undefined; } /** * A certificate that has been transferred but not yet accepted. * @public */ export interface OutgoingCertificate { /** * The certificate ARN. * @public */ certificateArn?: string | undefined; /** * The certificate ID. * @public */ certificateId?: string | undefined; /** * The Amazon Web Services account to which the transfer was made. * @public */ transferredTo?: string | undefined; /** * The date the transfer was initiated. * @public */ transferDate?: Date | undefined; /** * The transfer message. * @public */ transferMessage?: string | undefined; /** * The certificate creation date. * @public */ creationDate?: Date | undefined; } /** * The output from the ListOutgoingCertificates operation. * @public */ export interface ListOutgoingCertificatesResponse { /** * The certificates that are being transferred but not yet accepted. * @public */ outgoingCertificates?: OutgoingCertificate[] | undefined; /** * The marker for the next set of results. * @public */ nextMarker?: string | undefined; } /** * @public */ export interface ListPackagesRequest { /** * The maximum number of results returned at one time. * @public */ maxResults?: number | undefined; /** * The token for the next set of results. * @public */ nextToken?: string | undefined; } /** * A summary of information about a software package. * @public */ export interface PackageSummary { /** * The name for the target software package. * @public */ packageName?: string | undefined; /** * The name of the default package version. * @public */ defaultVersionName?: string | undefined; /** * The date that the package was created. * @public */ creationDate?: Date | undefined; /** * The date that the package was last updated. * @public */ lastModifiedDate?: Date | undefined; } /** * @public */ export interface ListPackagesResponse { /** * The software package summary. * @public */ packageSummaries?: PackageSummary[] | undefined; /** * The token for the next set of results. * @public */ nextToken?: string | undefined; } /** * @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 | undefined; /** * The maximum number of results to return at one time. * @public */ maxResults?: number | undefined; /** * The token for the next set of results. * @public */ nextToken?: string | undefined; } /** * A summary of information about a package version. * @public */ export interface PackageVersionSummary { /** * The name of the associated software package. * @public */ packageName?: string | undefined; /** * The name of the target package version. * @public */ versionName?: 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 | undefined; /** * The date that the package version was created. * @public */ creationDate?: Date | undefined; /** * The date that the package version was last updated. * @public */ lastModifiedDate?: Date | undefined; } /** * @public */ export interface ListPackageVersionsResponse { /** * Lists the package versions associated to the package. * @public */ packageVersionSummaries?: PackageVersionSummary[] | undefined; /** * The token for the next set of results. * @public */ nextToken?: string | undefined; } /** * The input for the ListPolicies operation. * @public */ export interface ListPoliciesRequest { /** * The marker for the next set of results. * @public */ marker?: string | undefined; /** * The result page size. * @public */ pageSize?: number | undefined; /** * Specifies the order for results. If true, the results are returned in ascending * creation order. * @public */ ascendingOrder?: boolean | undefined; } /** * The output from the ListPolicies operation. * @public */ export interface ListPoliciesResponse { /** * The descriptions of the policies. * @public */ policies?: Policy[] | undefined; /** * The marker for the next set of results, or null if there are no additional * results. * @public */ nextMarker?: string | undefined; } /** * 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 | undefined; /** * The result page size. * @public */ pageSize?: number | undefined; /** * Specifies the order for results. If true, the results are returned in ascending * creation order. * @public */ ascendingOrder?: boolean | undefined; } /** * The output from the ListPolicyPrincipals operation. * @public */ export interface ListPolicyPrincipalsResponse { /** * The descriptions of the principals. * @public */ principals?: string[] | undefined; /** * The marker for the next set of results, or null if there are no additional * results. * @public */ nextMarker?: string | undefined; } /** * 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 | undefined; /** * Specifies whether the policy version is the default. * @public */ isDefaultVersion?: boolean | undefined; /** * The date and time the policy was created. * @public */ createDate?: Date | undefined; } /** * The output from the ListPolicyVersions operation. * @public */ export interface ListPolicyVersionsResponse { /** * The policy versions. * @public */ policyVersions?: PolicyVersion[] | undefined; } /** * 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 | undefined; /** * The result page size. * @public */ pageSize?: number | undefined; /** * Specifies the order for results. If true, results are returned in ascending creation * order. * @public */ ascendingOrder?: boolean | undefined; } /** * The output from the ListPrincipalPolicies operation. * @public */ export interface ListPrincipalPoliciesResponse { /** * The policies. * @public */ policies?: Policy[] | undefined; /** * The marker for the next set of results, or null if there are no additional * results. * @public */ nextMarker?: string | undefined; } /** * 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 | undefined; /** * The maximum number of results to return in this operation. * @public */ maxResults?: number | undefined; /** * The principal. * @public */ principal: string | undefined; } /** * The output from the ListPrincipalThings operation. * @public */ export interface ListPrincipalThingsResponse { /** * The things. * @public */ things?: string[] | undefined; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListPrincipalThingsV2Request { /** * 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 | undefined; /** * The maximum number of results to return in this operation. * @public */ maxResults?: number | undefined; /** * The principal. A principal can be an X.509 certificate or an Amazon Cognito ID. * @public */ principal: string | undefined; /** * The type of the relation you want to filter in the response. If no value is provided in * this field, the response will list all things, including both the * <code>EXCLUSIVE_THING</code> and <code>NON_EXCLUSIVE_THING</code> attachment * types. * <ul> * <li> * * <code>EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing, exclusively. * The thing will be the only thing that’s attached to the principal. * </li> * </ul> * <ul> * <li> * * <code>NON_EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing. * Multiple things can be attached to the principal. * </li> * </ul> * @public */ thingPrincipalType?: ThingPrincipalType | undefined; } /** * An object that represents the thing and the type of relation it has with the principal. * @public */ export interface PrincipalThingObject { /** * The name of the thing. * @public */ thingName: string | undefined; /** * The type of the relation you want to specify when you attach a principal to a thing. * The value defaults to <code>NON_EXCLUSIVE_THING</code>. * <ul> * <li> * * <code>EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing, exclusively. * The thing will be the only thing that’s attached to the principal. * </li> * </ul> * <ul> * <li> * * <code>NON_EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing. * Multiple things can be attached to the principal. * </li> * </ul> * @public */ thingPrincipalType?: ThingPrincipalType | undefined; } /** * @public */ export interface ListPrincipalThingsV2Response { /** * A list of <code>thingPrincipalObject</code> that represents the principal and the type of relation it has with the thing. * @public */ principalThingObjects?: PrincipalThingObject[] | undefined; /** * The token to use to get the next set of results, or null if there are no additional results. * @public */ nextToken?: string | undefined; } /** * @public */ export interface ListProvisioningTemplatesRequest { /** * The maximum number of results to return at one time. * @public */ maxResults?: number | undefined; /** * A token to retrieve the next set of results. * @public */ nextToken?: string | undefined; } /** * A summary of information about a provisioning template. * @public */ export interface ProvisioningTemplateSummary { /** * The ARN of the provisioning template. * @public */ templateArn?: string | undefined; /** * The name of the provisioning template. * @public */ templateName?: string | undefined; /** * The description of the provisioning template. * @public */ description?: string | undefined; /** * The date when the provisioning template summary was created. * @public */ creationDate?: Date | undefined; /** * The date when the provisioning template summary was last modified. * @public */ lastModifiedDate?: Date | undefined; /** * True if the fleet provision template is enabled, otherwise false. * @public */ enabled?: boolean | undefined; /** * 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 | undefined; } /** * @public */ export interface ListProvisioningTemplatesResponse { /** * A list of provisioning templates * @public */ templates?: ProvisioningTemplateSummary[] | undefined; /** * A token to retrieve the next set of results. * @public */ nextToken?: string | undefined; } /** * @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 | undefined; /** * A token to retrieve the next set of results. * @public */ nextToken?: string | undefined; } /** * 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 | undefined; /** * The date when the provisioning template version was created * @public */ creationDate?: Date | undefined; /** * True if the provisioning template version is the default version, otherwise * false. * @public */ isDefaultVersion?: boolean | undefined; } /** * @public */ export interface ListProvisioningTemplateVersionsResponse { /** * The list of provisioning template versions. * @public */ versions?: ProvisioningTemplateVersionSummary[] | undefined; /** * A token to retrieve the next set of results. * @public */ nextToken?: string | undefined; } /** * @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 | undefined; /** * The maximum number of results to return at one time. * @public */ maxResults?: number | undefined; } /** * @public */ export interface ListRelatedResourcesForAuditFindingResponse { /** * The related resources. * @public */ relatedResources?: RelatedResource[] | undefined; /** * 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 | undefined; } /** * @public */ export interface ListRoleAliasesRequest { /** * The maximum number of results to return at one time. * @public */ pageSize?: number | undefined; /** * A marker used to get the next set of results. * @public */ marker?: string | undefined; /** * Return the list of role aliases in ascending alphabetical order. * @public */ ascendingOrder?: boolean | undefined; } /** * @public */ export interface ListRoleAliasesResponse { /** * The role aliases. * @public */ roleAliases?: string[] | undefined; /** * A marker used to get the next set of results. * @public */ nextMarker?: string | undefined; } /** * @public * @enum */ export declare const SbomValidationResult: { readonly FAILED: "FAILED"; readonly SUCCEEDED: "SUCCEEDED"; }; /** * @public */ export type SbomValidationResult = (typeof SbomValidationResult)[keyof typeof SbomValidationResult]; /** * @public */ export interface ListSbomValidationResultsRequest { /** * The name of the new software package. * @public */ packageName: string | undefined; /** * The name of the new package version. * @public */ versionName: string | undefined; /** * The end result of the * @public */ validationResult?: SbomValidationResult | undefined; /** * The maximum number of results to return at one time. * @public */ maxResults?: number | undefined; /** * A token that can be used to retrieve the next set of results, or null if there are no additional results. * @public */ nextToken?: string | undefined; } /** * @public * @enum */ export dec