@aws-sdk/client-iot 3.473.0 → 3.474.0

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

@@ -0,0 +1,98 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
+import { UpdateCertificateProviderRequest, UpdateCertificateProviderResponse } from "../models/models_2";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateCertificateProviderCommand}.
+ */
+export interface UpdateCertificateProviderCommandInput extends UpdateCertificateProviderRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateCertificateProviderCommand}.
+ */
+export interface UpdateCertificateProviderCommandOutput extends UpdateCertificateProviderResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates a certificate provider.</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">UpdateCertificateProvider</a> action.
+ *       </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTClient, UpdateCertificateProviderCommand } from "@aws-sdk/client-iot"; // ES Modules import
+ * // const { IoTClient, UpdateCertificateProviderCommand } = require("@aws-sdk/client-iot"); // CommonJS import
+ * const client = new IoTClient(config);
+ * const input = { // UpdateCertificateProviderRequest
+ *   certificateProviderName: "STRING_VALUE", // required
+ *   lambdaFunctionArn: "STRING_VALUE",
+ *   accountDefaultForOperations: [ // CertificateProviderAccountDefaultForOperations
+ *     "CreateCertificateFromCsr",
+ *   ],
+ * };
+ * const command = new UpdateCertificateProviderCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateCertificateProviderResponse
+ * //   certificateProviderName: "STRING_VALUE",
+ * //   certificateProviderArn: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateCertificateProviderCommandInput - {@link UpdateCertificateProviderCommandInput}
+ * @returns {@link UpdateCertificateProviderCommandOutput}
+ * @see {@link UpdateCertificateProviderCommandInput} for command's `input` shape.
+ * @see {@link UpdateCertificateProviderCommandOutput} 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>
+ *
+ */
+export declare class UpdateCertificateProviderCommand extends $Command<UpdateCertificateProviderCommandInput, UpdateCertificateProviderCommandOutput, IoTClientResolvedConfig> {
+    readonly input: UpdateCertificateProviderCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateCertificateProviderCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateCertificateProviderCommandInput, UpdateCertificateProviderCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -18,6 +18,7 @@ export * from "./CreateAuditSuppressionCommand";
 export * from "./CreateAuthorizerCommand";
 export * from "./CreateBillingGroupCommand";
 export * from "./CreateCertificateFromCsrCommand";
+export * from "./CreateCertificateProviderCommand";
 export * from "./CreateCustomMetricCommand";
 export * from "./CreateDimensionCommand";
 export * from "./CreateDomainConfigurationCommand";
@@ -50,6 +51,7 @@ export * from "./DeleteAuthorizerCommand";
 export * from "./DeleteBillingGroupCommand";
 export * from "./DeleteCACertificateCommand";
 export * from "./DeleteCertificateCommand";
+export * from "./DeleteCertificateProviderCommand";
 export * from "./DeleteCustomMetricCommand";
 export * from "./DeleteDimensionCommand";
 export * from "./DeleteDomainConfigurationCommand";
@@ -87,6 +89,7 @@ export * from "./DescribeAuthorizerCommand";
 export * from "./DescribeBillingGroupCommand";
 export * from "./DescribeCACertificateCommand";
 export * from "./DescribeCertificateCommand";
+export * from "./DescribeCertificateProviderCommand";
 export * from "./DescribeCustomMetricCommand";
 export * from "./DescribeDefaultAuthorizerCommand";
 export * from "./DescribeDetectMitigationActionsTaskCommand";
@@ -146,6 +149,7 @@ export * from "./ListAuditTasksCommand";
 export * from "./ListAuthorizersCommand";
 export * from "./ListBillingGroupsCommand";
 export * from "./ListCACertificatesCommand";
+export * from "./ListCertificateProvidersCommand";
 export * from "./ListCertificatesByCACommand";
 export * from "./ListCertificatesCommand";
 export * from "./ListCustomMetricsCommand";
@@ -226,6 +230,7 @@ export * from "./UpdateAuthorizerCommand";
 export * from "./UpdateBillingGroupCommand";
 export * from "./UpdateCACertificateCommand";
 export * from "./UpdateCertificateCommand";
+export * from "./UpdateCertificateProviderCommand";
 export * from "./UpdateCustomMetricCommand";
 export * from "./UpdateDimensionCommand";
 export * from "./UpdateDomainConfigurationCommand";

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

@@ -1813,8 +1813,7 @@ export interface MetricToRetain {
     metricDimension?: MetricDimension;
     /**
      * @public
-     * <p>Value added in both Behavior and AdditionalMetricsToRetainV2 to indicate if Device
-     *             Defender Detect should export the corresponding metrics.</p>
+     * <p>The value indicates exporting metrics related to the <code>MetricToRetain </code> when it's true.</p>
      */
     exportMetric?: boolean;
 }
@@ -3449,6 +3448,64 @@ export interface CreateCertificateFromCsrResponse {
      */
     certificatePem?: string;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const CertificateProviderOperation: {
+    readonly CreateCertificateFromCsr: "CreateCertificateFromCsr";
+};
+/**
+ * @public
+ */
+export type CertificateProviderOperation = (typeof CertificateProviderOperation)[keyof typeof CertificateProviderOperation];
+/**
+ * @public
+ */
+export interface CreateCertificateProviderRequest {
+    /**
+     * @public
+     * <p>The name of the certificate provider.</p>
+     */
+    certificateProviderName: string | undefined;
+    /**
+     * @public
+     * <p>The ARN of the Lambda function that defines the authentication logic.</p>
+     */
+    lambdaFunctionArn: string | undefined;
+    /**
+     * @public
+     * <p>A list of the operations that the certificate provider will use to generate certificates.
+     *          Valid value: <code>CreateCertificateFromCsr</code>.</p>
+     */
+    accountDefaultForOperations: CertificateProviderOperation[] | undefined;
+    /**
+     * @public
+     * <p>A string that you can optionally pass in the <code>CreateCertificateProvider</code> request to make sure
+     *          the request is idempotent.</p>
+     */
+    clientToken?: string;
+    /**
+     * @public
+     * <p>Metadata which can be used to manage the certificate provider.</p>
+     */
+    tags?: Tag[];
+}
+/**
+ * @public
+ */
+export interface CreateCertificateProviderResponse {
+    /**
+     * @public
+     * <p>The name of the certificate provider.</p>
+     */
+    certificateProviderName?: string;
+    /**
+     * @public
+     * <p>The ARN of the certificate provider.</p>
+     */
+    certificateProviderArn?: string;
+}
 /**
  * @public
  * @enum
@@ -6540,49 +6597,29 @@ export interface DeleteCertificateRequest {
 /**
  * @public
  */
-export interface DeleteCustomMetricRequest {
+export interface DeleteCertificateProviderRequest {
     /**
      * @public
-     * <p>
-     *       The name of the custom metric.
-     *     </p>
+     * <p>The name of the certificate provider.</p>
      */
-    metricName: string | undefined;
+    certificateProviderName: string | undefined;
 }
 /**
  * @public
  */
-export interface DeleteCustomMetricResponse {
+export interface DeleteCertificateProviderResponse {
 }
 /**
  * @public
  */
-export interface DeleteDimensionRequest {
-    /**
-     * @public
-     * <p>The unique identifier for the dimension that you want to delete.</p>
-     */
-    name: string | undefined;
-}
-/**
- * @public
- */
-export interface DeleteDimensionResponse {
-}
-/**
- * @public
- */
-export interface DeleteDomainConfigurationRequest {
+export interface DeleteCustomMetricRequest {
     /**
      * @public
-     * <p>The name of the domain configuration to be deleted.</p>
+     * <p>
+     *       The name of the custom metric.
+     *     </p>
      */
-    domainConfigurationName: string | undefined;
-}
-/**
- * @public
- */
-export interface DeleteDomainConfigurationResponse {
+    metricName: string | undefined;
 }
 /**
  * @internal

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

@@ -1,6 +1,41 @@
 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, CustomMetricType, DayOfWeek, DimensionType, DimensionValueOperator, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MaintenanceWindow, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, PackageVersionStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, SchedulingConfig, 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, PackageVersionStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, SchedulingConfig, ServiceType, StreamFile, TargetSelection, TaskStatisticsForAuditCheck, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestination, VerificationState } from "./models_0";
+/**
+ * @public
+ */
+export interface DeleteCustomMetricResponse {
+}
+/**
+ * @public
+ */
+export interface DeleteDimensionRequest {
+    /**
+     * @public
+     * <p>The unique identifier for the dimension that you want to delete.</p>
+     */
+    name: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteDimensionResponse {
+}
+/**
+ * @public
+ */
+export interface DeleteDomainConfigurationRequest {
+    /**
+     * @public
+     * <p>The name of the domain configuration to be deleted.</p>
+     */
+    domainConfigurationName: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteDomainConfigurationResponse {
+}
 /**
  * @public
  */
@@ -1167,6 +1202,52 @@ export interface DescribeCertificateResponse {
      */
     certificateDescription?: CertificateDescription;
 }
+/**
+ * @public
+ */
+export interface DescribeCertificateProviderRequest {
+    /**
+     * @public
+     * <p>The name of the certificate provider.</p>
+     */
+    certificateProviderName: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeCertificateProviderResponse {
+    /**
+     * @public
+     * <p>The name of the certificate provider.</p>
+     */
+    certificateProviderName?: string;
+    /**
+     * @public
+     * <p>The ARN of the certificate provider.</p>
+     */
+    certificateProviderArn?: string;
+    /**
+     * @public
+     * <p>The Lambda function ARN that's associated with the certificate provider.</p>
+     */
+    lambdaFunctionArn?: string;
+    /**
+     * @public
+     * <p>A list of the operations that the certificate provider will use to generate certificates.
+     *          Valid value: <code>CreateCertificateFromCsr</code>.</p>
+     */
+    accountDefaultForOperations?: CertificateProviderOperation[];
+    /**
+     * @public
+     * <p>The date-time string that indicates when the certificate provider was created.</p>
+     */
+    creationDate?: Date;
+    /**
+     * @public
+     * <p>The date-time string that indicates when the certificate provider was last updated.</p>
+     */
+    lastModifiedDate?: Date;
+}
 /**
  * @public
  */
@@ -5207,6 +5288,52 @@ export interface ListCACertificatesResponse {
      */
     nextMarker?: string;
 }
+/**
+ * @public
+ */
+export interface ListCertificateProvidersRequest {
+    /**
+     * @public
+     * <p>The token for the next set of results, or <code>null</code> if there are no more results.</p>
+     */
+    nextToken?: string;
+    /**
+     * @public
+     * <p>Returns the list of certificate providers in ascending alphabetical order.</p>
+     */
+    ascendingOrder?: boolean;
+}
+/**
+ * @public
+ * <p>The certificate provider summary.</p>
+ */
+export interface CertificateProviderSummary {
+    /**
+     * @public
+     * <p>The name of the certificate provider.</p>
+     */
+    certificateProviderName?: string;
+    /**
+     * @public
+     * <p>The ARN of the certificate provider.</p>
+     */
+    certificateProviderArn?: string;
+}
+/**
+ * @public
+ */
+export interface ListCertificateProvidersResponse {
+    /**
+     * @public
+     * <p>The list of certificate providers in your Amazon Web Services account.</p>
+     */
+    certificateProviders?: CertificateProviderSummary[];
+    /**
+     * @public
+     * <p>The token for the next set of results, or <code>null</code> if there are no more results.</p>
+     */
+    nextToken?: string;
+}
 /**
  * @public
  * <p>The input for the ListCertificates operation.</p>
@@ -6401,224 +6528,6 @@ export interface ListOutgoingCertificatesRequest {
      */
     ascendingOrder?: boolean;
 }
-/**
- * @public
- * <p>A certificate that has been transferred but not yet accepted.</p>
- */
-export interface OutgoingCertificate {
-    /**
-     * @public
-     * <p>The certificate ARN.</p>
-     */
-    certificateArn?: string;
-    /**
-     * @public
-     * <p>The certificate ID.</p>
-     */
-    certificateId?: string;
-    /**
-     * @public
-     * <p>The Amazon Web Services account to which the transfer was made.</p>
-     */
-    transferredTo?: string;
-    /**
-     * @public
-     * <p>The date the transfer was initiated.</p>
-     */
-    transferDate?: Date;
-    /**
-     * @public
-     * <p>The transfer message.</p>
-     */
-    transferMessage?: string;
-    /**
-     * @public
-     * <p>The certificate creation date.</p>
-     */
-    creationDate?: Date;
-}
-/**
- * @public
- * <p>The output from the ListOutgoingCertificates operation.</p>
- */
-export interface ListOutgoingCertificatesResponse {
-    /**
-     * @public
-     * <p>The certificates that are being transferred but not yet accepted.</p>
-     */
-    outgoingCertificates?: OutgoingCertificate[];
-    /**
-     * @public
-     * <p>The marker for the next set of results.</p>
-     */
-    nextMarker?: string;
-}
-/**
- * @public
- */
-export interface ListPackagesRequest {
-    /**
-     * @public
-     * <p>The maximum number of results returned at one time.</p>
-     */
-    maxResults?: number;
-    /**
-     * @public
-     * <p>The token for the next set of results.</p>
-     */
-    nextToken?: string;
-}
-/**
- * @public
- * <p>A summary of information about a software package.</p>
- */
-export interface PackageSummary {
-    /**
-     * @public
-     * <p>The name for the target software package.</p>
-     */
-    packageName?: string;
-    /**
-     * @public
-     * <p>The name of the default package version.</p>
-     */
-    defaultVersionName?: string;
-    /**
-     * @public
-     * <p>The date that the package was created.</p>
-     */
-    creationDate?: Date;
-    /**
-     * @public
-     * <p>The date that the package was last updated.</p>
-     */
-    lastModifiedDate?: Date;
-}
-/**
- * @public
- */
-export interface ListPackagesResponse {
-    /**
-     * @public
-     * <p>The software package summary.</p>
-     */
-    packageSummaries?: PackageSummary[];
-    /**
-     * @public
-     * <p>The token for the next set of results.</p>
-     */
-    nextToken?: string;
-}
-/**
- * @public
- */
-export interface ListPackageVersionsRequest {
-    /**
-     * @public
-     * <p>The name of the target software package.</p>
-     */
-    packageName: string | undefined;
-    /**
-     * @public
-     * <p>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>.</p>
-     */
-    status?: PackageVersionStatus;
-    /**
-     * @public
-     * <p>The maximum number of results to return at one time.</p>
-     */
-    maxResults?: number;
-    /**
-     * @public
-     * <p>The token for the next set of results.</p>
-     */
-    nextToken?: string;
-}
-/**
- * @public
- * <p>A summary of information about a package version.</p>
- */
-export interface PackageVersionSummary {
-    /**
-     * @public
-     * <p>The name of the associated software package.</p>
-     */
-    packageName?: string;
-    /**
-     * @public
-     * <p>The name of the target package version.</p>
-     */
-    versionName?: string;
-    /**
-     * @public
-     * <p>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>.</p>
-     */
-    status?: PackageVersionStatus;
-    /**
-     * @public
-     * <p>The date that the package version was created.</p>
-     */
-    creationDate?: Date;
-    /**
-     * @public
-     * <p>The date that the package version was last updated.</p>
-     */
-    lastModifiedDate?: Date;
-}
-/**
- * @public
- */
-export interface ListPackageVersionsResponse {
-    /**
-     * @public
-     * <p>Lists the package versions associated to the package.</p>
-     */
-    packageVersionSummaries?: PackageVersionSummary[];
-    /**
-     * @public
-     * <p>The token for the next set of results.</p>
-     */
-    nextToken?: string;
-}
-/**
- * @public
- * <p>The input for the ListPolicies operation.</p>
- */
-export interface ListPoliciesRequest {
-    /**
-     * @public
-     * <p>The marker for the next set of results.</p>
-     */
-    marker?: string;
-    /**
-     * @public
-     * <p>The result page size.</p>
-     */
-    pageSize?: number;
-    /**
-     * @public
-     * <p>Specifies the order for results. If true, the results are returned in ascending
-     *          creation order.</p>
-     */
-    ascendingOrder?: boolean;
-}
-/**
- * @public
- * <p>The output from the ListPolicies operation.</p>
- */
-export interface ListPoliciesResponse {
-    /**
-     * @public
-     * <p>The descriptions of the policies.</p>
-     */
-    policies?: Policy[];
-    /**
-     * @public
-     * <p>The marker for the next set of results, or null if there are no additional
-     *          results.</p>
-     */
-    nextMarker?: string;
-}
 /**
  * @internal
  */