@aws-sdk/client-iot 3.692.0 → 3.694.0

package/dist-types/commands/ListThingPrincipalsV2Command.d.ts

@@ -0,0 +1,100 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
+import { ListThingPrincipalsV2Request, ListThingPrincipalsV2Response } from "../models/models_2";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListThingPrincipalsV2Command}.
+ */
+export interface ListThingPrincipalsV2CommandInput extends ListThingPrincipalsV2Request {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListThingPrincipalsV2Command}.
+ */
+export interface ListThingPrincipalsV2CommandOutput extends ListThingPrincipalsV2Response, __MetadataBearer {
+}
+declare const ListThingPrincipalsV2Command_base: {
+    new (input: ListThingPrincipalsV2CommandInput): import("@smithy/smithy-client").CommandImpl<ListThingPrincipalsV2CommandInput, ListThingPrincipalsV2CommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListThingPrincipalsV2CommandInput): import("@smithy/smithy-client").CommandImpl<ListThingPrincipalsV2CommandInput, ListThingPrincipalsV2CommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists the principals associated with the specified thing. A principal can be an X.509
+ * 			certificate or an Amazon Cognito ID.</p>
+ *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingPrincipals</a> action.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTClient, ListThingPrincipalsV2Command } from "@aws-sdk/client-iot"; // ES Modules import
+ * // const { IoTClient, ListThingPrincipalsV2Command } = require("@aws-sdk/client-iot"); // CommonJS import
+ * const client = new IoTClient(config);
+ * const input = { // ListThingPrincipalsV2Request
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   thingName: "STRING_VALUE", // required
+ *   thingPrincipalType: "EXCLUSIVE_THING" || "NON_EXCLUSIVE_THING",
+ * };
+ * const command = new ListThingPrincipalsV2Command(input);
+ * const response = await client.send(command);
+ * // { // ListThingPrincipalsV2Response
+ * //   thingPrincipalObjects: [ // ThingPrincipalObjects
+ * //     { // ThingPrincipalObject
+ * //       principal: "STRING_VALUE", // required
+ * //       thingPrincipalType: "EXCLUSIVE_THING" || "NON_EXCLUSIVE_THING",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListThingPrincipalsV2CommandInput - {@link ListThingPrincipalsV2CommandInput}
+ * @returns {@link ListThingPrincipalsV2CommandOutput}
+ * @see {@link ListThingPrincipalsV2CommandInput} for command's `input` shape.
+ * @see {@link ListThingPrincipalsV2CommandOutput} for command's `response` shape.
+ * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape.
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>An unexpected error has occurred.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is not valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is temporarily unavailable.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The rate exceeds the limit.</p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>You are not authorized to perform this operation.</p>
+ *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
+ *
+ * @public
+ */
+export declare class ListThingPrincipalsV2Command extends ListThingPrincipalsV2Command_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListThingPrincipalsV2Request;
+            output: ListThingPrincipalsV2Response;
+        };
+        sdk: {
+            input: ListThingPrincipalsV2CommandInput;
+            output: ListThingPrincipalsV2CommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListThingTypesCommand.d.ts

@@ -52,6 +52,15 @@ declare const ListThingTypesCommand_base: {
  * //         searchableAttributes: [ // SearchableAttributes
  * //           "STRING_VALUE",
  * //         ],
+ * //         mqtt5Configuration: { // Mqtt5Configuration
+ * //           propagatingAttributes: [ // PropagatingAttributeList
+ * //             { // PropagatingAttribute
+ * //               userPropertyKey: "STRING_VALUE",
+ * //               thingAttribute: "STRING_VALUE",
+ * //               connectionAttribute: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //         },
  * //       },
  * //       thingTypeMetadata: { // ThingTypeMetadata
  * //         deprecated: true || false,

package/dist-types/commands/UpdateDomainConfigurationCommand.d.ts

@@ -49,6 +49,8 @@ declare const UpdateDomainConfigurationCommand_base: {
  *   },
  *   serverCertificateConfig: { // ServerCertificateConfig
  *     enableOCSPCheck: true || false,
+ *     ocspLambdaArn: "STRING_VALUE",
+ *     ocspAuthorizedResponderArn: "STRING_VALUE",
  *   },
  *   authenticationType: "CUSTOM_AUTH_X509" || "CUSTOM_AUTH" || "AWS_X509" || "AWS_SIGV4" || "DEFAULT",
  *   applicationProtocol: "SECURE_MQTT" || "MQTT_WSS" || "HTTPS" || "DEFAULT",

package/dist-types/commands/UpdateThingTypeCommand.d.ts

@@ -0,0 +1,102 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
+import { UpdateThingTypeRequest, UpdateThingTypeResponse } from "../models/models_2";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateThingTypeCommand}.
+ */
+export interface UpdateThingTypeCommandInput extends UpdateThingTypeRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateThingTypeCommand}.
+ */
+export interface UpdateThingTypeCommandOutput extends UpdateThingTypeResponse, __MetadataBearer {
+}
+declare const UpdateThingTypeCommand_base: {
+    new (input: UpdateThingTypeCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateThingTypeCommandInput, UpdateThingTypeCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateThingTypeCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateThingTypeCommandInput, UpdateThingTypeCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a thing type.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTClient, UpdateThingTypeCommand } from "@aws-sdk/client-iot"; // ES Modules import
+ * // const { IoTClient, UpdateThingTypeCommand } = require("@aws-sdk/client-iot"); // CommonJS import
+ * const client = new IoTClient(config);
+ * const input = { // UpdateThingTypeRequest
+ *   thingTypeName: "STRING_VALUE", // required
+ *   thingTypeProperties: { // ThingTypeProperties
+ *     thingTypeDescription: "STRING_VALUE",
+ *     searchableAttributes: [ // SearchableAttributes
+ *       "STRING_VALUE",
+ *     ],
+ *     mqtt5Configuration: { // Mqtt5Configuration
+ *       propagatingAttributes: [ // PropagatingAttributeList
+ *         { // PropagatingAttribute
+ *           userPropertyKey: "STRING_VALUE",
+ *           thingAttribute: "STRING_VALUE",
+ *           connectionAttribute: "STRING_VALUE",
+ *         },
+ *       ],
+ *     },
+ *   },
+ * };
+ * const command = new UpdateThingTypeCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateThingTypeCommandInput - {@link UpdateThingTypeCommandInput}
+ * @returns {@link UpdateThingTypeCommandOutput}
+ * @see {@link UpdateThingTypeCommandInput} for command's `input` shape.
+ * @see {@link UpdateThingTypeCommandOutput} for command's `response` shape.
+ * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape.
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>An unexpected error has occurred.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is not valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is temporarily unavailable.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The rate exceeds the limit.</p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>You are not authorized to perform this operation.</p>
+ *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
+ *
+ * @public
+ */
+export declare class UpdateThingTypeCommand extends UpdateThingTypeCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateThingTypeRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdateThingTypeCommandInput;
+            output: UpdateThingTypeCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -177,6 +177,7 @@ export * from "./ListPolicyPrincipalsCommand";
 export * from "./ListPolicyVersionsCommand";
 export * from "./ListPrincipalPoliciesCommand";
 export * from "./ListPrincipalThingsCommand";
+export * from "./ListPrincipalThingsV2Command";
 export * from "./ListProvisioningTemplateVersionsCommand";
 export * from "./ListProvisioningTemplatesCommand";
 export * from "./ListRelatedResourcesForAuditFindingCommand";
@@ -192,6 +193,7 @@ export * from "./ListTargetsForSecurityProfileCommand";
 export * from "./ListThingGroupsCommand";
 export * from "./ListThingGroupsForThingCommand";
 export * from "./ListThingPrincipalsCommand";
+export * from "./ListThingPrincipalsV2Command";
 export * from "./ListThingRegistrationTaskReportsCommand";
 export * from "./ListThingRegistrationTasksCommand";
 export * from "./ListThingTypesCommand";
@@ -254,5 +256,6 @@ export * from "./UpdateStreamCommand";
 export * from "./UpdateThingCommand";
 export * from "./UpdateThingGroupCommand";
 export * from "./UpdateThingGroupsForThingCommand";
+export * from "./UpdateThingTypeCommand";
 export * from "./UpdateTopicRuleDestinationCommand";
 export * from "./ValidateSecurityProfileBehaviorsCommand";

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

@@ -2288,6 +2288,18 @@ export declare class VersionConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<VersionConflictException, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ThingPrincipalType: {
+    readonly EXCLUSIVE_THING: "EXCLUSIVE_THING";
+    readonly NON_EXCLUSIVE_THING: "NON_EXCLUSIVE_THING";
+};
+/**
+ * @public
+ */
+export type ThingPrincipalType = (typeof ThingPrincipalType)[keyof typeof ThingPrincipalType];
 /**
  * <p>The input for the AttachThingPrincipal operation.</p>
  * @public
@@ -2304,6 +2316,25 @@ export interface AttachThingPrincipalRequest {
      * @public
      */
     principal: string | undefined;
+    /**
+     * <p>The type of the relation you want to specify when you attach a principal to a thing.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <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.</p>
+     *             </li>
+     *          </ul>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>NON_EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing.
+     * 						Multiple things can be attached to the principal.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    thingPrincipalType?: ThingPrincipalType | undefined;
 }
 /**
  * <p>The output from the AttachThingPrincipal operation.</p>
@@ -3861,11 +3892,32 @@ 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-endpoints-cert-config.html">Configuring OCSP server-certificate stapling in domain
-     *          configuration</a> from Amazon Web Services IoT Core Developer Guide.</p>
+     *          <p>For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-cert-config.html">
+     *          Server certificate configuration for OCSP stapling</a> from Amazon Web Services IoT Core Developer Guide.</p>
      * @public
      */
     enableOCSPCheck?: boolean | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) for a Lambda function that acts as a Request for Comments
+     *          (RFC) 6960-compliant Online Certificate Status Protocol (OCSP) responder, supporting basic
+     *          OCSP responses.  The Lambda function accepts a JSON string that's Base64-encoded.
+     *          Therefore, you must convert your OCSP response, which is typically in the Distinguished
+     *          Encoding Rules (DER) format, into a JSON string that's Base64-encoded. The Lambda
+     *          function's response is also a Base64-encoded JSON string and the response payload must not
+     *          exceed 8 kilobytes (KiB) in size. The Lambda function must be in the same Amazon Web Services region and
+     *          account as the domain configuration.</p>
+     * @public
+     */
+    ocspLambdaArn?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) for an X.509 certificate stored in Amazon Web Services Certificate Manager (ACM).
+     *          If provided, Amazon Web Services IoT Core will use this certificate to validate the signature of the received OCSP response.
+     *          The OCSP responder must sign responses using either this authorized responder certificate or the issuing certificate,
+     *          depending on whether the ARN is provided or not. The certificate must be in the same Amazon Web Services region and account as the domain configuration.
+     *       </p>
+     * @public
+     */
+    ocspAuthorizedResponderArn?: string | undefined;
 }
 /**
  * @public
@@ -6358,6 +6410,38 @@ export interface CreateThingGroupResponse {
      */
     thingGroupId?: string | undefined;
 }
+/**
+ * <p>An object that represents the connection attribute, thing attribute, and the user property key.</p>
+ * @public
+ */
+export interface PropagatingAttribute {
+    /**
+     * <p>The key of the user property key-value pair.</p>
+     * @public
+     */
+    userPropertyKey?: string | undefined;
+    /**
+     * <p>The user-defined thing attribute that is propagating for MQTT 5 message enrichment.</p>
+     * @public
+     */
+    thingAttribute?: string | undefined;
+    /**
+     * <p>The attribute associated with the connection between a device and Amazon Web Services IoT Core.</p>
+     * @public
+     */
+    connectionAttribute?: string | undefined;
+}
+/**
+ * <p>The configuration to add user-defined properties to enrich MQTT 5 messages.</p>
+ * @public
+ */
+export interface Mqtt5Configuration {
+    /**
+     * <p>An object that represents the propagating thing attributes and the connection attributes.</p>
+     * @public
+     */
+    propagatingAttributes?: PropagatingAttribute[] | undefined;
+}
 /**
  * <p>The ThingTypeProperties contains information about the thing type including: a thing type description,
  * 			and a list of searchable thing attribute names.</p>
@@ -6374,6 +6458,11 @@ export interface ThingTypeProperties {
      * @public
      */
     searchableAttributes?: string[] | undefined;
+    /**
+     * <p>The configuration to add user-defined properties to enrich MQTT 5 messages.</p>
+     * @public
+     */
+    mqtt5Configuration?: Mqtt5Configuration | undefined;
 }
 /**
  * <p>The input for the CreateThingType operation.</p>
@@ -6733,34 +6822,6 @@ export interface DeleteAuditSuppressionRequest {
  */
 export interface DeleteAuditSuppressionResponse {
 }
-/**
- * @public
- */
-export interface DeleteAuthorizerRequest {
-    /**
-     * <p>The name of the authorizer to delete.</p>
-     * @public
-     */
-    authorizerName: string | undefined;
-}
-/**
- * @public
- */
-export interface DeleteAuthorizerResponse {
-}
-/**
- * <p>You can't delete the resource because it is attached to one or more
- *          resources.</p>
- * @public
- */
-export declare class DeleteConflictException extends __BaseException {
-    readonly name: "DeleteConflictException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<DeleteConflictException, __BaseException>);
-}
 /**
  * @internal
  */

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

@@ -1,6 +1,34 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { IoTServiceException as __BaseException } from "./IoTServiceException";
 import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AlertTargetType, ApplicationProtocol, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthenticationType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CertificateProviderOperation, ClientCertificateConfig, CustomMetricType, DayOfWeek, DimensionType, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MaintenanceWindow, MetricsExportConfig, MetricToRetain, 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";
+/**
+ * @public
+ */
+export interface DeleteAuthorizerRequest {
+    /**
+     * <p>The name of the authorizer to delete.</p>
+     * @public
+     */
+    authorizerName: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteAuthorizerResponse {
+}
+/**
+ * <p>You can't delete the resource because it is attached to one or more
+ *          resources.</p>
+ * @public
+ */
+export declare class DeleteConflictException extends __BaseException {
+    readonly name: "DeleteConflictException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<DeleteConflictException, __BaseException>);
+}
 /**
  * @public
  */
@@ -3514,7 +3542,7 @@ export interface DescribeThingTypeResponse {
     thingTypeArn?: string | undefined;
     /**
      * <p>The ThingTypeProperties contains information about the thing type including
-     * 			description, and a list of searchable thing attribute names.</p>
+     * 			description, a list of searchable thing attribute names, and MQTT5 configuration.</p>
      * @public
      */
     thingTypeProperties?: ThingTypeProperties | undefined;
@@ -6479,74 +6507,6 @@ export interface JobTemplateSummary {
      */
     createdAt?: Date | undefined;
 }
-/**
- * @public
- */
-export interface ListJobTemplatesResponse {
-    /**
-     * <p>A list of objects that contain information about the job templates.</p>
-     * @public
-     */
-    jobTemplates?: JobTemplateSummary[] | undefined;
-    /**
-     * <p>The token for the next set of results, or <b>null</b> if there are no
-     *             additional results.</p>
-     * @public
-     */
-    nextToken?: string | undefined;
-}
-/**
- * @public
- */
-export interface ListManagedJobTemplatesRequest {
-    /**
-     * <p>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.</p>
-     * @public
-     */
-    templateName?: string | undefined;
-    /**
-     * <p>Maximum number of entries that can be returned.</p>
-     * @public
-     */
-    maxResults?: number | undefined;
-    /**
-     * <p>The token to retrieve the next set of results.</p>
-     * @public
-     */
-    nextToken?: string | undefined;
-}
-/**
- * <p>An object that contains information about the managed template.</p>
- * @public
- */
-export interface ManagedJobTemplateSummary {
-    /**
-     * <p>The Amazon Resource Name (ARN) for a managed template.</p>
-     * @public
-     */
-    templateArn?: string | undefined;
-    /**
-     * <p>The unique Name for a managed template.</p>
-     * @public
-     */
-    templateName?: string | undefined;
-    /**
-     * <p>The description for a managed template.</p>
-     * @public
-     */
-    description?: string | undefined;
-    /**
-     * <p>A list of environments that are supported with the managed job template.</p>
-     * @public
-     */
-    environments?: string[] | undefined;
-    /**
-     * <p>The version for a managed template.</p>
-     * @public
-     */
-    templateVersion?: string | undefined;
-}
 /**
  * @internal
  */