@aws-sdk/client-iot 3.650.0 → 3.652.0

package/dist-types/models/models_0.d.ts

@@ -1988,6 +1988,158 @@ export interface Allowed {
      */
     policies?: Policy[];
 }
+/**
+ * <p>The S3 location.</p>
+ * @public
+ */
+export interface S3Location {
+    /**
+     * <p>The S3 bucket.</p>
+     * @public
+     */
+    bucket?: string;
+    /**
+     * <p>The S3 key.</p>
+     * @public
+     */
+    key?: string;
+    /**
+     * <p>The S3 bucket version.</p>
+     * @public
+     */
+    version?: string;
+}
+/**
+ * <p>The Amazon S3 location for the software bill of materials associated with a software
+ *          package version.</p>
+ * @public
+ */
+export interface Sbom {
+    /**
+     * <p>The S3 location.</p>
+     * @public
+     */
+    s3Location?: S3Location;
+}
+/**
+ * @public
+ */
+export interface AssociateSbomWithPackageVersionRequest {
+    /**
+     * <p>The name of the new software package.</p>
+     * @public
+     */
+    packageName: string | undefined;
+    /**
+     * <p>The name of the new package version.</p>
+     * @public
+     */
+    versionName: string | undefined;
+    /**
+     * <p>The Amazon S3 location for the software bill of materials associated with a software
+     *          package version.</p>
+     * @public
+     */
+    sbom: Sbom | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    clientToken?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SbomValidationStatus: {
+    readonly FAILED: "FAILED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly SUCCEEDED: "SUCCEEDED";
+};
+/**
+ * @public
+ */
+export type SbomValidationStatus = (typeof SbomValidationStatus)[keyof typeof SbomValidationStatus];
+/**
+ * @public
+ */
+export interface AssociateSbomWithPackageVersionResponse {
+    /**
+     * <p>The name of the new software package.</p>
+     * @public
+     */
+    packageName?: string;
+    /**
+     * <p>The name of the new package version.</p>
+     * @public
+     */
+    versionName?: string;
+    /**
+     * <p>The Amazon S3 location for the software bill of materials associated with a software
+     *          package version.</p>
+     * @public
+     */
+    sbom?: Sbom;
+    /**
+     * <p>The status of the initial validation for the SBOM against the Software Package Data Exchange (SPDX) and CycloneDX industry standard format.</p>
+     * @public
+     */
+    sbomValidationStatus?: SbomValidationStatus;
+}
+/**
+ * <p>A resource with the same name already exists.</p>
+ * @public
+ */
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    /**
+     * <p>A resource with the same name already exists.</p>
+     * @public
+     */
+    resourceId?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+/**
+ * <p>Internal error from the service that indicates an unexpected error or that the service
+ *             is unavailable.</p>
+ * @public
+ */
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * <p>A limit has been exceeded.</p>
+ * @public
+ */
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}
+/**
+ * <p>The request is not valid.</p>
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
 /**
  * @public
  */
@@ -3669,7 +3821,7 @@ export interface ServerCertificateConfig {
     /**
      * <p>A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server
      *          certificate check is enabled or not.</p>
-     *          <p>For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-domain-ocsp-config.html">Configuring OCSP server-certificate stapling in domain
+     *          <p>For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-cert-config.html">Configuring OCSP server-certificate stapling in domain
      *          configuration</a> from Amazon Web Services IoT Core Developer Guide.</p>
      * @public
      */
@@ -4387,23 +4539,6 @@ export interface CreateJobResponse {
      */
     description?: string;
 }
-/**
- * <p>A resource with the same name already exists.</p>
- * @public
- */
-export declare class ConflictException extends __BaseException {
-    readonly name: "ConflictException";
-    readonly $fault: "client";
-    /**
-     * <p>A resource with the same name already exists.</p>
-     * @public
-     */
-    resourceId?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
-}
 /**
  * @public
  */
@@ -5037,27 +5172,6 @@ export interface CodeSigning {
      */
     customCodeSigning?: CustomCodeSigning;
 }
-/**
- * <p>The S3 location.</p>
- * @public
- */
-export interface S3Location {
-    /**
-     * <p>The S3 bucket.</p>
-     * @public
-     */
-    bucket?: string;
-    /**
-     * <p>The S3 key.</p>
-     * @public
-     */
-    key?: string;
-    /**
-     * <p>The S3 bucket version.</p>
-     * @public
-     */
-    version?: string;
-}
 /**
  * <p>Describes a group of files that can be streamed.</p>
  * @public
@@ -5312,41 +5426,16 @@ export interface CreatePackageResponse {
     description?: string;
 }
 /**
- * <p>Internal error from the service that indicates an unexpected error or that the service
- *             is unavailable.</p>
- * @public
- */
-export declare class InternalServerException extends __BaseException {
-    readonly name: "InternalServerException";
-    readonly $fault: "server";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
-}
-/**
- * <p>A limit has been exceeded.</p>
- * @public
- */
-export declare class ServiceQuotaExceededException extends __BaseException {
-    readonly name: "ServiceQuotaExceededException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
-}
-/**
- * <p>The request is not valid.</p>
+ * <p>The Amazon S3 location for the artifacts associated with a software package
+ *          version.</p>
  * @public
  */
-export declare class ValidationException extends __BaseException {
-    readonly name: "ValidationException";
-    readonly $fault: "client";
+export interface PackageVersionArtifact {
     /**
-     * @internal
+     * <p>The S3 location.</p>
+     * @public
      */
-    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+    s3Location?: S3Location;
 }
 /**
  * @public
@@ -5373,6 +5462,18 @@ export interface CreatePackageVersionRequest {
      * @public
      */
     attributes?: Record<string, string>;
+    /**
+     * <p>The various build components created during the build process such as libraries and
+     *          configuration files that make up a software package version.</p>
+     * @public
+     */
+    artifact?: PackageVersionArtifact;
+    /**
+     * <p>The inline job document associated with a software package version used for a quick job
+     *          deployment via IoT Jobs.</p>
+     * @public
+     */
+    recipe?: string;
     /**
      * <p>Metadata that can be used to manage the package version.</p>
      * @public
@@ -6583,57 +6684,6 @@ export declare class CertificateStateException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<CertificateStateException, __BaseException>);
 }
-/**
- * <p>Input for the DeleteCACertificate operation.</p>
- * @public
- */
-export interface DeleteCACertificateRequest {
-    /**
-     * <p>The ID of the certificate to delete. (The last part of the certificate ARN contains
-     *          the certificate ID.)</p>
-     * @public
-     */
-    certificateId: string | undefined;
-}
-/**
- * <p>The output for the DeleteCACertificate operation.</p>
- * @public
- */
-export interface DeleteCACertificateResponse {
-}
-/**
- * <p>The input for the DeleteCertificate operation.</p>
- * @public
- */
-export interface DeleteCertificateRequest {
-    /**
-     * <p>The ID of the certificate. (The last part of the certificate ARN contains the
-     *          certificate ID.)</p>
-     * @public
-     */
-    certificateId: string | undefined;
-    /**
-     * <p>Forces the deletion of a certificate if it is inactive and is not attached to an IoT
-     *          thing.</p>
-     * @public
-     */
-    forceDelete?: boolean;
-}
-/**
- * @public
- */
-export interface DeleteCertificateProviderRequest {
-    /**
-     * <p>The name of the certificate provider.</p>
-     * @public
-     */
-    certificateProviderName: string | undefined;
-}
-/**
- * @public
- */
-export interface DeleteCertificateProviderResponse {
-}
 /**
  * @internal
  */

package/dist-types/models/models_1.d.ts

@@ -1,6 +1,57 @@
 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";
+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, PackageVersionArtifact, PackageVersionStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, Sbom, SbomValidationStatus, SchedulingConfig, ServerCertificateConfig, ServiceType, StreamFile, TargetSelection, TaskStatisticsForAuditCheck, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestination, VerificationState } from "./models_0";
+/**
+ * <p>Input for the DeleteCACertificate operation.</p>
+ * @public
+ */
+export interface DeleteCACertificateRequest {
+    /**
+     * <p>The ID of the certificate to delete. (The last part of the certificate ARN contains
+     *          the certificate ID.)</p>
+     * @public
+     */
+    certificateId: string | undefined;
+}
+/**
+ * <p>The output for the DeleteCACertificate operation.</p>
+ * @public
+ */
+export interface DeleteCACertificateResponse {
+}
+/**
+ * <p>The input for the DeleteCertificate operation.</p>
+ * @public
+ */
+export interface DeleteCertificateRequest {
+    /**
+     * <p>The ID of the certificate. (The last part of the certificate ARN contains the
+     *          certificate ID.)</p>
+     * @public
+     */
+    certificateId: string | undefined;
+    /**
+     * <p>Forces the deletion of a certificate if it is inactive and is not attached to an IoT
+     *          thing.</p>
+     * @public
+     */
+    forceDelete?: boolean;
+}
+/**
+ * @public
+ */
+export interface DeleteCertificateProviderRequest {
+    /**
+     * <p>The name of the certificate provider.</p>
+     * @public
+     */
+    certificateProviderName: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteCertificateProviderResponse {
+}
 /**
  * @public
  */
@@ -1974,6 +2025,11 @@ export interface DescribeJobRequest {
      * @public
      */
     jobId: string | undefined;
+    /**
+     * <p>A flag that provides a view of the job document before and after the substitution parameters have been resolved with their exact values.</p>
+     * @public
+     */
+    beforeSubstitution?: boolean;
 }
 /**
  * <p>The job process details.</p>
@@ -3449,6 +3505,31 @@ export interface DisableTopicRuleRequest {
      */
     ruleName: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DisassociateSbomFromPackageVersionRequest {
+    /**
+     * <p>The name of the new software package.</p>
+     * @public
+     */
+    packageName: string | undefined;
+    /**
+     * <p>The name of the new package version.</p>
+     * @public
+     */
+    versionName: string | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    clientToken?: string;
+}
+/**
+ * @public
+ */
+export interface DisassociateSbomFromPackageVersionResponse {
+}
 /**
  * <p>The input for the EnableTopicRuleRequest operation.</p>
  * @public
@@ -4064,6 +4145,11 @@ export interface GetJobDocumentRequest {
      * @public
      */
     jobId: string | undefined;
+    /**
+     * <p>A flag that provides a view of the job document before and after the substitution parameters have been resolved with their exact values.</p>
+     * @public
+     */
+    beforeSubstitution?: boolean;
 }
 /**
  * @public
@@ -4349,6 +4435,11 @@ export interface GetPackageVersionResponse {
      * @public
      */
     attributes?: Record<string, string>;
+    /**
+     * <p>The various components that make up a software package version.</p>
+     * @public
+     */
+    artifact?: PackageVersionArtifact;
     /**
      * <p>The status associated to 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>.</p>
      * @public
@@ -4369,6 +4460,23 @@ export interface GetPackageVersionResponse {
      * @public
      */
     lastModifiedDate?: Date;
+    /**
+     * <p>The software bill of materials for a software package version.</p>
+     * @public
+     */
+    sbom?: Sbom;
+    /**
+     * <p>The status of the validation for a new software bill of materials added to a software
+     *          package version.</p>
+     * @public
+     */
+    sbomValidationStatus?: SbomValidationStatus;
+    /**
+     * <p>The inline job document associated with a software package version used for a quick job
+     *          deployment via IoT Jobs.</p>
+     * @public
+     */
+    recipe?: string;
 }
 /**
  * @public
@@ -6407,134 +6515,6 @@ export interface MetricDatum {
      */
     value?: MetricValue;
 }
-/**
- * @public
- */
-export interface ListMetricValuesResponse {
-    /**
-     * <p>The data the thing reports for the metric during the specified time period.</p>
-     * @public
-     */
-    metricDatumList?: MetricDatum[];
-    /**
-     * <p>A token that can be used to retrieve the next set of results, or <code>null</code>
-     *         if there are no additional results.</p>
-     * @public
-     */
-    nextToken?: string;
-}
-/**
- * @public
- */
-export interface ListMitigationActionsRequest {
-    /**
-     * <p>Specify a value to limit the result to mitigation actions with a specific action type.</p>
-     * @public
-     */
-    actionType?: MitigationActionType;
-    /**
-     * <p>The maximum number of results to return at one time. The default is 25.</p>
-     * @public
-     */
-    maxResults?: number;
-    /**
-     * <p>The token for the next set of results.</p>
-     * @public
-     */
-    nextToken?: string;
-}
-/**
- * <p>Information that identifies a mitigation action. This information is returned by ListMitigationActions.</p>
- * @public
- */
-export interface MitigationActionIdentifier {
-    /**
-     * <p>The friendly name of the mitigation action.</p>
-     * @public
-     */
-    actionName?: string;
-    /**
-     * <p>The IAM role ARN used to apply this mitigation action.</p>
-     * @public
-     */
-    actionArn?: string;
-    /**
-     * <p>The date when this mitigation action was created.</p>
-     * @public
-     */
-    creationDate?: Date;
-}
-/**
- * @public
- */
-export interface ListMitigationActionsResponse {
-    /**
-     * <p>A set of actions that matched the specified filter criteria.</p>
-     * @public
-     */
-    actionIdentifiers?: MitigationActionIdentifier[];
-    /**
-     * <p>The token for the next set of results.</p>
-     * @public
-     */
-    nextToken?: string;
-}
-/**
- * @public
- */
-export interface ListOTAUpdatesRequest {
-    /**
-     * <p>The maximum number of results to return at one time.</p>
-     * @public
-     */
-    maxResults?: number;
-    /**
-     * <p>A token used to retrieve the next set of results.</p>
-     * @public
-     */
-    nextToken?: string;
-    /**
-     * <p>The OTA update job status.</p>
-     * @public
-     */
-    otaUpdateStatus?: OTAUpdateStatus;
-}
-/**
- * <p>An OTA update summary.</p>
- * @public
- */
-export interface OTAUpdateSummary {
-    /**
-     * <p>The OTA update ID.</p>
-     * @public
-     */
-    otaUpdateId?: string;
-    /**
-     * <p>The OTA update ARN.</p>
-     * @public
-     */
-    otaUpdateArn?: string;
-    /**
-     * <p>The date when the OTA update was created.</p>
-     * @public
-     */
-    creationDate?: Date;
-}
-/**
- * @public
- */
-export interface ListOTAUpdatesResponse {
-    /**
-     * <p>A list of OTA update jobs.</p>
-     * @public
-     */
-    otaUpdates?: OTAUpdateSummary[];
-    /**
-     * <p>A token to use to get the next set of results.</p>
-     * @public
-     */
-    nextToken?: string;
-}
 /**
  * @internal
  */