Lists the things associated with the specified principal. A principal can be an X.509 + * certificate or an Amazon Cognito ID.
+ *Requires permission to access the ListPrincipalThings action.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListPrincipalThingsV2Command } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListPrincipalThingsV2Command } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const input = { // ListPrincipalThingsV2Request + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * principal: "STRING_VALUE", // required + * thingPrincipalType: "EXCLUSIVE_THING" || "NON_EXCLUSIVE_THING", + * }; + * const command = new ListPrincipalThingsV2Command(input); + * const response = await client.send(command); + * // { // ListPrincipalThingsV2Response + * // principalThingObjects: [ // PrincipalThingObjects + * // { // PrincipalThingObject + * // thingName: "STRING_VALUE", // required + * // thingPrincipalType: "EXCLUSIVE_THING" || "NON_EXCLUSIVE_THING", + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListPrincipalThingsV2CommandInput - {@link ListPrincipalThingsV2CommandInput} + * @returns {@link ListPrincipalThingsV2CommandOutput} + * @see {@link ListPrincipalThingsV2CommandInput} for command's `input` shape. + * @see {@link ListPrincipalThingsV2CommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape. + * + * @throws {@link InternalFailureException} (server fault) + *An unexpected error has occurred.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service is temporarily unavailable.
+ * + * @throws {@link ThrottlingException} (client fault) + *The rate exceeds the limit.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You are not authorized to perform this operation.
+ * + * @throws {@link IoTServiceException} + *Base exception class for all service exceptions from IoT service.
+ * + * @public + */ +export class ListPrincipalThingsV2Command extends $Command + .classBuilder< + ListPrincipalThingsV2CommandInput, + ListPrincipalThingsV2CommandOutput, + IoTClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: IoTClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSIotService", "ListPrincipalThingsV2", {}) + .n("IoTClient", "ListPrincipalThingsV2Command") + .f(void 0, void 0) + .ser(se_ListPrincipalThingsV2Command) + .de(de_ListPrincipalThingsV2Command) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListPrincipalThingsV2Request; + output: ListPrincipalThingsV2Response; + }; + sdk: { + input: ListPrincipalThingsV2CommandInput; + output: ListPrincipalThingsV2CommandOutput; + }; + }; +} diff --git a/clients/client-iot/src/commands/ListThingPrincipalsV2Command.ts b/clients/client-iot/src/commands/ListThingPrincipalsV2Command.ts new file mode 100644 index 000000000000..1ba49e406209 --- /dev/null +++ b/clients/client-iot/src/commands/ListThingPrincipalsV2Command.ts @@ -0,0 +1,121 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; +import { ListThingPrincipalsV2Request, ListThingPrincipalsV2Response } from "../models/models_2"; +import { de_ListThingPrincipalsV2Command, se_ListThingPrincipalsV2Command } from "../protocols/Aws_restJson1"; + +/** + * @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 {} + +/** + *Lists the principals associated with the specified thing. A principal can be an X.509 + * certificate or an Amazon Cognito ID.
+ *Requires permission to access the ListThingPrincipals action.
+ * @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) + *An unexpected error has occurred.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service is temporarily unavailable.
+ * + * @throws {@link ThrottlingException} (client fault) + *The rate exceeds the limit.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You are not authorized to perform this operation.
+ * + * @throws {@link IoTServiceException} + *Base exception class for all service exceptions from IoT service.
+ * + * @public + */ +export class ListThingPrincipalsV2Command extends $Command + .classBuilder< + ListThingPrincipalsV2CommandInput, + ListThingPrincipalsV2CommandOutput, + IoTClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: IoTClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSIotService", "ListThingPrincipalsV2", {}) + .n("IoTClient", "ListThingPrincipalsV2Command") + .f(void 0, void 0) + .ser(se_ListThingPrincipalsV2Command) + .de(de_ListThingPrincipalsV2Command) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListThingPrincipalsV2Request; + output: ListThingPrincipalsV2Response; + }; + sdk: { + input: ListThingPrincipalsV2CommandInput; + output: ListThingPrincipalsV2CommandOutput; + }; + }; +} diff --git a/clients/client-iot/src/commands/ListThingTypesCommand.ts b/clients/client-iot/src/commands/ListThingTypesCommand.ts index 25c994e2415d..df67309e38aa 100644 --- a/clients/client-iot/src/commands/ListThingTypesCommand.ts +++ b/clients/client-iot/src/commands/ListThingTypesCommand.ts @@ -53,6 +53,15 @@ export interface ListThingTypesCommandOutput extends ListThingTypesResponse, __M * // searchableAttributes: [ // SearchableAttributes * // "STRING_VALUE", * // ], + * // mqtt5Configuration: { // Mqtt5Configuration + * // propagatingAttributes: [ // PropagatingAttributeList + * // { // PropagatingAttribute + * // userPropertyKey: "STRING_VALUE", + * // thingAttribute: "STRING_VALUE", + * // connectionAttribute: "STRING_VALUE", + * // }, + * // ], + * // }, * // }, * // thingTypeMetadata: { // ThingTypeMetadata * // deprecated: true || false, diff --git a/clients/client-iot/src/commands/UpdateDomainConfigurationCommand.ts b/clients/client-iot/src/commands/UpdateDomainConfigurationCommand.ts index 8fdb6688abeb..162ec847b0d0 100644 --- a/clients/client-iot/src/commands/UpdateDomainConfigurationCommand.ts +++ b/clients/client-iot/src/commands/UpdateDomainConfigurationCommand.ts @@ -50,6 +50,8 @@ export interface UpdateDomainConfigurationCommandOutput extends UpdateDomainConf * }, * 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", diff --git a/clients/client-iot/src/commands/UpdateThingTypeCommand.ts b/clients/client-iot/src/commands/UpdateThingTypeCommand.ts new file mode 100644 index 000000000000..c29e052cd71f --- /dev/null +++ b/clients/client-iot/src/commands/UpdateThingTypeCommand.ts @@ -0,0 +1,123 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; +import { UpdateThingTypeRequest, UpdateThingTypeResponse } from "../models/models_2"; +import { de_UpdateThingTypeCommand, se_UpdateThingTypeCommand } from "../protocols/Aws_restJson1"; + +/** + * @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 {} + +/** + *Updates a thing type.
+ * @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) + *An unexpected error has occurred.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service is temporarily unavailable.
+ * + * @throws {@link ThrottlingException} (client fault) + *The rate exceeds the limit.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You are not authorized to perform this operation.
+ * + * @throws {@link IoTServiceException} + *Base exception class for all service exceptions from IoT service.
+ * + * @public + */ +export class UpdateThingTypeCommand extends $Command + .classBuilder< + UpdateThingTypeCommandInput, + UpdateThingTypeCommandOutput, + IoTClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: IoTClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSIotService", "UpdateThingType", {}) + .n("IoTClient", "UpdateThingTypeCommand") + .f(void 0, void 0) + .ser(se_UpdateThingTypeCommand) + .de(de_UpdateThingTypeCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateThingTypeRequest; + output: {}; + }; + sdk: { + input: UpdateThingTypeCommandInput; + output: UpdateThingTypeCommandOutput; + }; + }; +} diff --git a/clients/client-iot/src/commands/index.ts b/clients/client-iot/src/commands/index.ts index 959eb509086a..502a121a9b86 100644 --- a/clients/client-iot/src/commands/index.ts +++ b/clients/client-iot/src/commands/index.ts @@ -178,6 +178,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"; @@ -193,6 +194,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"; @@ -255,5 +257,6 @@ export * from "./UpdateStreamCommand"; export * from "./UpdateThingCommand"; export * from "./UpdateThingGroupCommand"; export * from "./UpdateThingGroupsForThingCommand"; +export * from "./UpdateThingTypeCommand"; export * from "./UpdateTopicRuleDestinationCommand"; export * from "./ValidateSecurityProfileBehaviorsCommand"; diff --git a/clients/client-iot/src/models/models_0.ts b/clients/client-iot/src/models/models_0.ts index e280b78e55ba..71f863d41ffd 100644 --- a/clients/client-iot/src/models/models_0.ts +++ b/clients/client-iot/src/models/models_0.ts @@ -2680,6 +2680,20 @@ export class VersionConflictException extends __BaseException { } } +/** + * @public + * @enum + */ +export const ThingPrincipalType = { + EXCLUSIVE_THING: "EXCLUSIVE_THING", + NON_EXCLUSIVE_THING: "NON_EXCLUSIVE_THING", +} as const; + +/** + * @public + */ +export type ThingPrincipalType = (typeof ThingPrincipalType)[keyof typeof ThingPrincipalType]; + /** *The input for the AttachThingPrincipal operation.
* @public @@ -2697,6 +2711,26 @@ export interface AttachThingPrincipalRequest { * @public */ principal: string | undefined; + + /** + *The type of the relation you want to specify when you attach a principal to a thing.
+ *
+ * EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively.
+ * The thing will be the only thing that’s attached to the principal.
+ * NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.
+ * Multiple things can be attached to the principal.
A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server * certificate check is enabled or not.
- *For more information, see Configuring OCSP server-certificate stapling in domain - * configuration from Amazon Web Services IoT Core Developer Guide.
+ *For more information, see + * Server certificate configuration for OCSP stapling from Amazon Web Services IoT Core Developer Guide.
* @public */ enableOCSPCheck?: boolean | undefined; + + /** + *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.
+ * @public + */ + ocspLambdaArn?: string | undefined; + + /** + *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. + *
+ * @public + */ + ocspAuthorizedResponderArn?: string | undefined; } /** @@ -7367,6 +7424,42 @@ export interface CreateThingGroupResponse { thingGroupId?: string | undefined; } +/** + *An object that represents the connection attribute, thing attribute, and the user property key.
+ * @public + */ +export interface PropagatingAttribute { + /** + *The key of the user property key-value pair.
+ * @public + */ + userPropertyKey?: string | undefined; + + /** + *The user-defined thing attribute that is propagating for MQTT 5 message enrichment.
+ * @public + */ + thingAttribute?: string | undefined; + + /** + *The attribute associated with the connection between a device and Amazon Web Services IoT Core.
+ * @public + */ + connectionAttribute?: string | undefined; +} + +/** + *The configuration to add user-defined properties to enrich MQTT 5 messages.
+ * @public + */ +export interface Mqtt5Configuration { + /** + *An object that represents the propagating thing attributes and the connection attributes.
+ * @public + */ + propagatingAttributes?: PropagatingAttribute[] | undefined; +} + /** *The ThingTypeProperties contains information about the thing type including: a thing type description, * and a list of searchable thing attribute names.
@@ -7384,6 +7477,12 @@ export interface ThingTypeProperties { * @public */ searchableAttributes?: string[] | undefined; + + /** + *The configuration to add user-defined properties to enrich MQTT 5 messages.
+ * @public + */ + mqtt5Configuration?: Mqtt5Configuration | undefined; } /** @@ -7793,43 +7892,6 @@ export interface DeleteAuditSuppressionRequest { */ export interface DeleteAuditSuppressionResponse {} -/** - * @public - */ -export interface DeleteAuthorizerRequest { - /** - *The name of the authorizer to delete.
- * @public - */ - authorizerName: string | undefined; -} - -/** - * @public - */ -export interface DeleteAuthorizerResponse {} - -/** - *You can't delete the resource because it is attached to one or more - * resources.
- * @public - */ -export class DeleteConflictException extends __BaseException { - readonly name: "DeleteConflictException" = "DeleteConflictException"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe name of the authorizer to delete.
+ * @public + */ + authorizerName: string | undefined; +} + +/** + * @public + */ +export interface DeleteAuthorizerResponse {} + +/** + *You can't delete the resource because it is attached to one or more + * resources.
+ * @public + */ +export class DeleteConflictException extends __BaseException { + readonly name: "DeleteConflictException" = "DeleteConflictException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe ThingTypeProperties contains information about the thing type including - * description, and a list of searchable thing attribute names.
+ * description, a list of searchable thing attribute names, and MQTT5 configuration. * @public */ thingTypeProperties?: ThingTypeProperties | undefined; @@ -7411,84 +7448,6 @@ export interface JobTemplateSummary { 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; -} - /** * @internal */ diff --git a/clients/client-iot/src/models/models_2.ts b/clients/client-iot/src/models/models_2.ts index cde47a5a38a5..c9d4d0e245ef 100644 --- a/clients/client-iot/src/models/models_2.ts +++ b/clients/client-iot/src/models/models_2.ts @@ -50,6 +50,7 @@ import { Tag, TemplateType, ThingGroupProperties, + ThingPrincipalType, ThingTypeProperties, TimeoutConfig, TlsConfig, @@ -69,8 +70,8 @@ import { DomainConfigurationStatus, EventType, GroupNameAndArn, + JobTemplateSummary, LogTargetType, - ManagedJobTemplateSummary, MitigationActionType, RegistrationConfig, Status, @@ -81,6 +82,84 @@ import { ViolationEventOccurrenceRange, } from "./models_1"; +/** + * @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 */ @@ -782,6 +861,104 @@ export interface ListPrincipalThingsResponse { nextToken?: string | undefined; } +/** + * @public + */ +export interface ListPrincipalThingsV2Request { + /** + *To retrieve the next set of results, the nextToken
+ * value from a previous response; otherwise null to receive
+ * the first set of results.
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
+ * EXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment
+ * types.
+ * EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively.
+ * The thing will be the only thing that’s attached to the principal.
+ * NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.
+ * Multiple things can be attached to the principal.
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 NON_EXCLUSIVE_THING.
+ * EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively.
+ * The thing will be the only thing that’s attached to the principal.
+ * NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.
+ * Multiple things can be attached to the principal.
A list of thingPrincipalObject that represents the principal and the type of relation it has with the thing.
The token to use to get the next set of results, or null if there are no additional results.
+ * @public + */ + nextToken?: string | undefined; +} + /** * @public */ @@ -1674,6 +1851,105 @@ export interface ListThingPrincipalsResponse { nextToken?: string | undefined; } +/** + * @public + */ +export interface ListThingPrincipalsV2Request { + /** + *To retrieve the next set of results, the nextToken
+ * value from a previous response; otherwise null to receive
+ * the first set of results.
The maximum number of results to return in this operation.
+ * @public + */ + maxResults?: number | undefined; + + /** + *The name of the thing.
+ * @public + */ + thingName: 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 principals, including both the
+ * EXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment
+ * types.
+ * EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively.
+ * The thing will be the only thing that’s attached to the principal.
+ * NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.
+ * Multiple things can be attached to the principal.
An object that represents the principal and the type of relation it has with the thing.
+ * @public + */ +export interface ThingPrincipalObject { + /** + *The principal of the thing principal object.
+ * @public + */ + principal: string | undefined; + + /** + *The type of the relation you want to specify when you attach a principal to a thing.
+ * The value defaults to NON_EXCLUSIVE_THING.
+ * EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively.
+ * The thing will be the only thing that’s attached to the principal.
+ * NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.
+ * Multiple things can be attached to the principal.
A list of thingPrincipalObject that represents the principal and the type of relation it has
+ * with the thing.
The token to use to get the next set of results, or null if there are no additional results.
+ * @public + */ + nextToken?: string | undefined; +} + /** * @public * @enum @@ -5288,6 +5564,29 @@ export interface UpdateThingGroupsForThingRequest { */ export interface UpdateThingGroupsForThingResponse {} +/** + * @public + */ +export interface UpdateThingTypeRequest { + /** + *The name of a thing type.
+ * @public + */ + thingTypeName: string | undefined; + + /** + *The ThingTypeProperties contains information about the thing type including: a thing type description, + * and a list of searchable thing attribute names.
+ * @public + */ + thingTypeProperties?: ThingTypeProperties | undefined; +} + +/** + * @public + */ +export interface UpdateThingTypeResponse {} + /** * @public */ diff --git a/clients/client-iot/src/pagination/ListPrincipalThingsV2Paginator.ts b/clients/client-iot/src/pagination/ListPrincipalThingsV2Paginator.ts new file mode 100644 index 000000000000..b7861768e1e4 --- /dev/null +++ b/clients/client-iot/src/pagination/ListPrincipalThingsV2Paginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListPrincipalThingsV2Command, + ListPrincipalThingsV2CommandInput, + ListPrincipalThingsV2CommandOutput, +} from "../commands/ListPrincipalThingsV2Command"; +import { IoTClient } from "../IoTClient"; +import { IoTPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListPrincipalThingsV2: ( + config: IoTPaginationConfiguration, + input: ListPrincipalThingsV2CommandInput, + ...rest: any[] +) => PaginatorThe type of the relation you want to specify when you attach a principal to a thing.
\n\n EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. \n\t\t\t\t\t\tThe thing will be the only thing that’s attached to the principal.
\n NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.\n\t\t\t\t\t\tMultiple things can be attached to the principal.
The ThingTypeProperties contains information about the thing type including\n\t\t\tdescription, and a list of searchable thing attribute names.
" + "smithy.api#documentation": "The ThingTypeProperties contains information about the thing type including\n\t\t\tdescription, a list of searchable thing attribute names, and MQTT5 configuration.
" } }, "thingTypeMetadata": { @@ -23771,6 +23797,106 @@ "smithy.api#output": {} } }, + "com.amazonaws.iot#ListPrincipalThingsV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#ListPrincipalThingsV2Request" + }, + "output": { + "target": "com.amazonaws.iot#ListPrincipalThingsV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the things associated with the specified principal. A principal can be an X.509\n\t\t\tcertificate or an Amazon Cognito ID.
\nRequires permission to access the ListPrincipalThings action.
", + "smithy.api#http": { + "method": "GET", + "uri": "/principals/things-v2", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "principalThingObjects", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iot#ListPrincipalThingsV2Request": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "To retrieve the next set of results, the nextToken\n\t\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\t\tthe first set of results.
The maximum number of results to return in this operation.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "principal": { + "target": "com.amazonaws.iot#Principal", + "traits": { + "smithy.api#documentation": "The principal. A principal can be an X.509 certificate or an Amazon Cognito ID.
", + "smithy.api#httpHeader": "x-amzn-principal", + "smithy.api#required": {} + } + }, + "thingPrincipalType": { + "target": "com.amazonaws.iot#ThingPrincipalType", + "traits": { + "smithy.api#documentation": "The type of the relation you want to filter in the response. If no value is provided in\n\t\t\tthis field, the response will list all things, including both the\n\t\t\t\tEXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment\n\t\t\ttypes.
\n EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. \n\t\t\t\t\t\tThe thing will be the only thing that’s attached to the principal.
\n NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.\n\t\t\t\t\t\tMultiple things can be attached to the principal.
A list of thingPrincipalObject that represents the principal and the type of relation it has with the thing.
The token to use to get the next set of results, or null if there are no additional results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iot#ListProvisioningTemplateVersions": { "type": "operation", "input": { @@ -25126,6 +25252,106 @@ "smithy.api#output": {} } }, + "com.amazonaws.iot#ListThingPrincipalsV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#ListThingPrincipalsV2Request" + }, + "output": { + "target": "com.amazonaws.iot#ListThingPrincipalsV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the principals associated with the specified thing. A principal can be an X.509\n\t\t\tcertificate or an Amazon Cognito ID.
\nRequires permission to access the ListThingPrincipals action.
", + "smithy.api#http": { + "method": "GET", + "uri": "/things/{thingName}/principals-v2", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "thingPrincipalObjects", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iot#ListThingPrincipalsV2Request": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "To retrieve the next set of results, the nextToken\n\t\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\t\tthe first set of results.
The maximum number of results to return in this operation.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "thingName": { + "target": "com.amazonaws.iot#ThingName", + "traits": { + "smithy.api#documentation": "The name of the thing.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "thingPrincipalType": { + "target": "com.amazonaws.iot#ThingPrincipalType", + "traits": { + "smithy.api#documentation": "The type of the relation you want to filter in the response. If no value is provided in\n\t\t\tthis field, the response will list all principals, including both the\n\t\t\t\tEXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment\n\t\t\ttypes.
\n EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. \n\t\t\t\t\t\tThe thing will be the only thing that’s attached to the principal.
\n NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.\n\t\t\t\t\t\tMultiple things can be attached to the principal.
A list of thingPrincipalObject that represents the principal and the type of relation it has \n\t\t\t\twith the thing.
The token to use to get the next set of results, or null if there are no additional results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iot#ListThingRegistrationTaskReports": { "type": "operation", "input": { @@ -26906,6 +27132,20 @@ } } }, + "com.amazonaws.iot#Mqtt5Configuration": { + "type": "structure", + "members": { + "propagatingAttributes": { + "target": "com.amazonaws.iot#PropagatingAttributeList", + "traits": { + "smithy.api#documentation": "An object that represents the propagating thing attributes and the connection attributes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration to add user-defined properties to enrich MQTT 5 messages.
" + } + }, "com.amazonaws.iot#MqttClientId": { "type": "string", "traits": { @@ -27123,6 +27363,15 @@ } } }, + "com.amazonaws.iot#OCSPLambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 140 + } + } + }, "com.amazonaws.iot#OTAUpdateArn": { "type": "string" }, @@ -28015,6 +28264,33 @@ "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, + "com.amazonaws.iot#PrincipalThingObject": { + "type": "structure", + "members": { + "thingName": { + "target": "com.amazonaws.iot#ThingName", + "traits": { + "smithy.api#documentation": "The name of the thing.
", + "smithy.api#required": {} + } + }, + "thingPrincipalType": { + "target": "com.amazonaws.iot#ThingPrincipalType", + "traits": { + "smithy.api#documentation": "The type of the relation you want to specify when you attach a principal to a thing.\n\t\t\t\tThe value defaults to NON_EXCLUSIVE_THING.
\n EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. \n\t\t\t\t\t\tThe thing will be the only thing that’s attached to the principal.
\n NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.\n\t\t\t\t\t\tMultiple things can be attached to the principal.
An object that represents the thing and the type of relation it has with the principal.
" + } + }, + "com.amazonaws.iot#PrincipalThingObjects": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#PrincipalThingObject" + } + }, "com.amazonaws.iot#Principals": { "type": "list", "member": { @@ -28039,6 +28315,38 @@ "target": "com.amazonaws.iot#ProcessingTargetName" } }, + "com.amazonaws.iot#PropagatingAttribute": { + "type": "structure", + "members": { + "userPropertyKey": { + "target": "com.amazonaws.iot#UserPropertyKeyName", + "traits": { + "smithy.api#documentation": "The key of the user property key-value pair.
" + } + }, + "thingAttribute": { + "target": "com.amazonaws.iot#AttributeName", + "traits": { + "smithy.api#documentation": "The user-defined thing attribute that is propagating for MQTT 5 message enrichment.
" + } + }, + "connectionAttribute": { + "target": "com.amazonaws.iot#ConnectionAttributeName", + "traits": { + "smithy.api#documentation": "The attribute associated with the connection between a device and Amazon Web Services IoT Core.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that represents the connection attribute, thing attribute, and the user property key.
" + } + }, + "com.amazonaws.iot#PropagatingAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#PropagatingAttribute" + } + }, "com.amazonaws.iot#Protocol": { "type": "enum", "members": { @@ -30388,7 +30696,19 @@ "enableOCSPCheck": { "target": "com.amazonaws.iot#EnableOCSPCheck", "traits": { - "smithy.api#documentation": "A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server\n certificate check is enabled or not.
\nFor more information, see Configuring OCSP server-certificate stapling in domain\n configuration from Amazon Web Services IoT Core Developer Guide.
" + "smithy.api#documentation": "A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server\n certificate check is enabled or not.
\nFor more information, see \n Server certificate configuration for OCSP stapling from Amazon Web Services IoT Core Developer Guide.
" + } + }, + "ocspLambdaArn": { + "target": "com.amazonaws.iot#OCSPLambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a Lambda function that acts as a Request for Comments\n (RFC) 6960-compliant Online Certificate Status Protocol (OCSP) responder, supporting basic\n OCSP responses. The Lambda function accepts a JSON string that's Base64-encoded.\n Therefore, you must convert your OCSP response, which is typically in the Distinguished\n Encoding Rules (DER) format, into a JSON string that's Base64-encoded. The Lambda\n function's response is also a Base64-encoded JSON string and the response payload must not\n exceed 8 kilobytes (KiB) in size. The Lambda function must be in the same Amazon Web Services region and\n account as the domain configuration.
" + } + }, + "ocspAuthorizedResponderArn": { + "target": "com.amazonaws.iot#AcmCertificateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for an X.509 certificate stored in Amazon Web Services Certificate Manager (ACM). \n If provided, Amazon Web Services IoT Core will use this certificate to validate the signature of the received OCSP response. \n The OCSP responder must sign responses using either this authorized responder certificate or the issuing certificate, \n 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.\n
" } } }, @@ -32869,6 +33189,50 @@ "target": "com.amazonaws.iot#ThingName" } }, + "com.amazonaws.iot#ThingPrincipalObject": { + "type": "structure", + "members": { + "principal": { + "target": "com.amazonaws.iot#Principal", + "traits": { + "smithy.api#documentation": "The principal of the thing principal object.
", + "smithy.api#required": {} + } + }, + "thingPrincipalType": { + "target": "com.amazonaws.iot#ThingPrincipalType", + "traits": { + "smithy.api#documentation": "The type of the relation you want to specify when you attach a principal to a thing.\n\t\t\t\tThe value defaults to NON_EXCLUSIVE_THING.
\n EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. \n\t\t\t\t\t\tThe thing will be the only thing that’s attached to the principal.
\n NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing.\n\t\t\t\t\t\tMultiple things can be attached to the principal.
An object that represents the principal and the type of relation it has with the thing.
" + } + }, + "com.amazonaws.iot#ThingPrincipalObjects": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#ThingPrincipalObject" + } + }, + "com.amazonaws.iot#ThingPrincipalType": { + "type": "enum", + "members": { + "EXCLUSIVE_THING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUSIVE_THING" + } + }, + "NON_EXCLUSIVE_THING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_EXCLUSIVE_THING" + } + } + } + }, "com.amazonaws.iot#ThingTypeArn": { "type": "string" }, @@ -32974,6 +33338,12 @@ "traits": { "smithy.api#documentation": "A list of searchable thing attribute names.
" } + }, + "mqtt5Configuration": { + "target": "com.amazonaws.iot#Mqtt5Configuration", + "traits": { + "smithy.api#documentation": "The configuration to add user-defined properties to enrich MQTT 5 messages.
" + } } }, "traits": { @@ -36251,6 +36621,69 @@ "smithy.api#output": {} } }, + "com.amazonaws.iot#UpdateThingType": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#UpdateThingTypeRequest" + }, + "output": { + "target": "com.amazonaws.iot#UpdateThingTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a thing type.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/thing-types/{thingTypeName}", + "code": 200 + } + } + }, + "com.amazonaws.iot#UpdateThingTypeRequest": { + "type": "structure", + "members": { + "thingTypeName": { + "target": "com.amazonaws.iot#ThingTypeName", + "traits": { + "smithy.api#documentation": "The name of a thing type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "thingTypeProperties": { + "target": "com.amazonaws.iot#ThingTypeProperties" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#UpdateThingTypeResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iot#UpdateTopicRuleDestination": { "type": "operation", "input": { @@ -36369,6 +36802,16 @@ } } }, + "com.amazonaws.iot#UserPropertyKeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:$.]+$" + } + }, "com.amazonaws.iot#UserPropertyValue": { "type": "string", "traits": {