@aws-sdk/client-iot 3.42.0 → 3.46.0

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

@@ -1,5 +1,43 @@
 import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
-import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CustomMetricType, DayOfWeek, DimensionType, FleetMetricUnit, JobExecutionsRolloutConfig, LogLevel, MetricToRetain, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, ServiceType, StreamFile, Tag, TargetSelection, TaskStatisticsForAuditCheck, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TopicRuleDestination, VerificationState } from "./models_0";
+import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CustomMetricType, DayOfWeek, DimensionType, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MetricToRetain, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, ServiceType, StreamFile, Tag, TargetSelection, TaskStatisticsForAuditCheck, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TopicRuleDestination, VerificationState } from "./models_0";
+export interface DeleteScheduledAuditRequest {
+    /**
+     * <p>The name of the scheduled audit you want to delete.</p>
+     */
+    scheduledAuditName: string | undefined;
+}
+export declare namespace DeleteScheduledAuditRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DeleteScheduledAuditRequest) => any;
+}
+export interface DeleteScheduledAuditResponse {
+}
+export declare namespace DeleteScheduledAuditResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DeleteScheduledAuditResponse) => any;
+}
+export interface DeleteSecurityProfileRequest {
+    /**
+     * <p>The name of the security profile to be deleted.</p>
+     */
+    securityProfileName: string | undefined;
+    /**
+     * <p>The expected version of the security profile. A new version is generated whenever
+     *         the security profile is updated. If you specify a value that is different from the actual
+     *         version, a <code>VersionConflictException</code> is thrown.</p>
+     */
+    expectedVersion?: number;
+}
+export declare namespace DeleteSecurityProfileRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DeleteSecurityProfileRequest) => any;
+}
 export interface DeleteSecurityProfileResponse {
 }
 export declare namespace DeleteSecurityProfileResponse {
@@ -1481,6 +1519,10 @@ export interface DescribeIndexResponse {
      *                <p>REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry
      *           data, shadow data, and thing connectivity status data.</p>
      *             </li>
+     *             <li>
+     *                <p>MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see
+     *           <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html">GetIndexingConfiguration</a>.</p>
+     *             </li>
      *          </ul>
      */
     schema?: string;
@@ -1654,6 +1696,18 @@ export interface Job {
      * <p>The ARN of the job template used to create the job.</p>
      */
     jobTemplateArn?: string;
+    /**
+     * <p>The configuration for the criteria to retry the job.</p>
+     */
+    jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
+    /**
+     * <p>A key-value map that pairs the patterns that need to be replaced in a managed
+     *             template job document schema. You can use the description of each key as a guidance
+     *             to specify the inputs during runtime when creating a job.</p>
+     */
+    documentParameters?: {
+        [key: string]: string;
+    };
 }
 export declare namespace Job {
     /**
@@ -1856,6 +1910,11 @@ export interface DescribeJobTemplateResponse {
      *            be automatically set to <code>TIMED_OUT</code>.</p>
      */
     timeoutConfig?: TimeoutConfig;
+    /**
+     * <p>The configuration that determines how many retries are allowed for each failure type
+     *             for a job.</p>
+     */
+    jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
 }
 export declare namespace DescribeJobTemplateResponse {
     /**
@@ -1863,6 +1922,113 @@ export declare namespace DescribeJobTemplateResponse {
      */
     const filterSensitiveLog: (obj: DescribeJobTemplateResponse) => any;
 }
+export interface DescribeManagedJobTemplateRequest {
+    /**
+     * <p>The unique name of a managed job template, which is required.</p>
+     */
+    templateName: string | undefined;
+    /**
+     * <p>An optional parameter to specify version of a managed template. If not specified, the
+     *             pre-defined default version is returned.</p>
+     */
+    templateVersion?: string;
+}
+export declare namespace DescribeManagedJobTemplateRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeManagedJobTemplateRequest) => any;
+}
+/**
+ * <p>A map of key-value pairs containing the patterns that need to be replaced in a managed
+ *             template job document schema. You can use the description of each key as a guidance to specify
+ *             the inputs during runtime when creating a job.</p>
+ */
+export interface DocumentParameter {
+    /**
+     * <p>Key of the map field containing the patterns that need to be replaced in a managed
+     *             template job document schema.</p>
+     */
+    key?: string;
+    /**
+     * <p>Description of the map field containing the patterns that need to be replaced in a
+     *             managed template job document schema.</p>
+     */
+    description?: string;
+    /**
+     * <p>A regular expression of the patterns that need to be replaced in a managed template
+     *             job document schema.</p>
+     */
+    regex?: string;
+    /**
+     * <p>An example illustrating a pattern that need to be replaced in a managed template
+     *             job document schema.</p>
+     */
+    example?: string;
+    /**
+     * <p>Specifies whether a pattern that needs to be replaced in a managed template job document
+     *             schema is optional or required.</p>
+     */
+    optional?: boolean;
+}
+export declare namespace DocumentParameter {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DocumentParameter) => any;
+}
+export interface DescribeManagedJobTemplateResponse {
+    /**
+     * <p>The unique name of a managed template, such as <code>AWS-Reboot</code>.</p>
+     */
+    templateName?: string;
+    /**
+     * <p>The unique Amazon Resource Name (ARN) of the managed template.</p>
+     */
+    templateArn?: string;
+    /**
+     * <p>The unique description of a managed template.</p>
+     */
+    description?: string;
+    /**
+     * <p>The version for a managed template.</p>
+     */
+    templateVersion?: string;
+    /**
+     * <p>A list of environments that are supported with the managed job template.</p>
+     */
+    environments?: string[];
+    /**
+     * <p>A map of key-value pairs that you can use as guidance to specify the inputs for creating
+     *             a job from a managed template.</p>
+     */
+    documentParameters?: DocumentParameter[];
+    /**
+     * <p>The document schema for a managed job template.</p>
+     */
+    document?: string;
+}
+export declare namespace DescribeManagedJobTemplateResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeManagedJobTemplateResponse) => any;
+}
+/**
+ * <p>Internal error from the service that indicates an unexpected error or that the service
+ *             is unavailable.</p>
+ */
+export interface InternalServerException extends __SmithyException, $MetadataBearer {
+    name: "InternalServerException";
+    $fault: "server";
+    message?: string;
+}
+export declare namespace InternalServerException {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: InternalServerException) => any;
+}
 export interface DescribeMitigationActionRequest {
     /**
      * <p>The friendly name that uniquely identifies the mitigation action.</p>
@@ -2919,8 +3085,7 @@ export declare namespace Bucket {
 }
 export interface GetBucketsAggregationResponse {
     /**
-     * <p>The total number of documents that fit the query string criteria and contain a value for
-     *       the Aggregation field targeted in the request.</p>
+     * <p>The total number of things that fit the query string criteria.</p>
      */
     totalCount?: number;
     /**
@@ -3091,6 +3256,14 @@ export declare namespace ThingGroupIndexingConfiguration {
      */
     const filterSensitiveLog: (obj: ThingGroupIndexingConfiguration) => any;
 }
+export declare enum DeviceDefenderIndexingMode {
+    OFF = "OFF",
+    VIOLATIONS = "VIOLATIONS"
+}
+export declare enum NamedShadowIndexingMode {
+    OFF = "OFF",
+    ON = "ON"
+}
 export declare enum ThingConnectivityIndexingMode {
     OFF = "OFF",
     STATUS = "STATUS"
@@ -3134,6 +3307,38 @@ export interface ThingIndexingConfiguration {
      *          </ul>
      */
     thingConnectivityIndexingMode?: ThingConnectivityIndexingMode | string;
+    /**
+     * <p>Device Defender indexing mode. Valid values are:</p>
+     *          <ul>
+     *             <li>
+     *                <p>VIOLATIONS – Your thing index contains Device Defender violations. To enable Device
+     *           Defender indexing, <i>deviceDefenderIndexingMode</i> must not be set to
+     *           OFF.</p>
+     *             </li>
+     *             <li>
+     *                <p>OFF - Device Defender indexing is disabled.</p>
+     *             </li>
+     *          </ul>
+     *         <p>For more information about Device Defender violations, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html">Device Defender Detect.</a>
+     *          </p>
+     */
+    deviceDefenderIndexingMode?: DeviceDefenderIndexingMode | string;
+    /**
+     * <p>Named shadow indexing mode. Valid values are:</p>
+     *          <ul>
+     *             <li>
+     *                <p>ON – Your thing index contains named shadow. To enable thing
+     *           named shadow indexing, <i>namedShadowIndexingMode</i> must not be set to
+     *           OFF.</p>
+     *             </li>
+     *             <li>
+     *                <p>OFF - Named shadow indexing is disabled.</p>
+     *             </li>
+     *          </ul>
+     *          <p>For more information about Shadows, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html">IoT Device Shadow service.</a>
+     *          </p>
+     */
+    namedShadowIndexingMode?: NamedShadowIndexingMode | string;
     /**
      * <p>Contains fields that are indexed and whose types are already known by the Fleet Indexing
      *       service.</p>
@@ -3573,12 +3778,13 @@ export declare namespace GetStatisticsRequest {
     const filterSensitiveLog: (obj: GetStatisticsRequest) => any;
 }
 /**
- * <p>A map of key-value pairs for all supported statistics. Currently, only count is
- *       supported.</p>
+ * <p>A map of key-value pairs for all supported statistics. For issues with missing or unexpected values for this API,
+ *       consult <a href="https://docs.aws.amazon.com/iot/latest/developerguide/fleet-indexing-troubleshooting.html">
+ *         Fleet indexing troubleshooting guide</a>.</p>
  */
 export interface Statistics {
     /**
-     * <p>The count of things that match the query.</p>
+     * <p>The count of things that match the query string criteria and contain a valid aggregation field value.</p>
      */
     count?: number;
     /**
@@ -4898,6 +5104,11 @@ export interface JobExecutionSummary {
      *             information.</p>
      */
     executionNumber?: number;
+    /**
+     * <p>The number that indicates how many retry attempts have been completed for this
+     *         job on this device.</p>
+     */
+    retryAttempt?: number;
 }
 export declare namespace JobExecutionSummary {
     /**
@@ -4970,6 +5181,10 @@ export interface ListJobExecutionsForThingRequest {
      * <p>The token to retrieve the next set of results.</p>
      */
     nextToken?: string;
+    /**
+     * <p>The unique identifier you assigned to this job when it was created.</p>
+     */
+    jobId?: string;
 }
 export declare namespace ListJobExecutionsForThingRequest {
     /**
@@ -5183,6 +5398,74 @@ export declare namespace ListJobTemplatesResponse {
      */
     const filterSensitiveLog: (obj: ListJobTemplatesResponse) => any;
 }
+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>
+     */
+    templateName?: string;
+    /**
+     * <p>Maximum number of entries that can be returned.</p>
+     */
+    maxResults?: number;
+    /**
+     * <p>The token to retrieve the next set of results.</p>
+     */
+    nextToken?: string;
+}
+export declare namespace ListManagedJobTemplatesRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ListManagedJobTemplatesRequest) => any;
+}
+/**
+ * <p>An object that contains information about the managed template.</p>
+ */
+export interface ManagedJobTemplateSummary {
+    /**
+     * <p>The Amazon Resource Name (ARN) for a managed template.</p>
+     */
+    templateArn?: string;
+    /**
+     * <p>The unique Name for a managed template.</p>
+     */
+    templateName?: string;
+    /**
+     * <p>The description for a managed template.</p>
+     */
+    description?: string;
+    /**
+     * <p>A list of environments that are supported with the managed job template.</p>
+     */
+    environments?: string[];
+    /**
+     * <p>The version for a managed template.</p>
+     */
+    templateVersion?: string;
+}
+export declare namespace ManagedJobTemplateSummary {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ManagedJobTemplateSummary) => any;
+}
+export interface ListManagedJobTemplatesResponse {
+    /**
+     * <p>A list of managed job templates that are returned.</p>
+     */
+    managedJobTemplates?: ManagedJobTemplateSummary[];
+    /**
+     * <p>The token to retrieve the next set of results.</p>
+     */
+    nextToken?: string;
+}
+export declare namespace ListManagedJobTemplatesResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ListManagedJobTemplatesResponse) => any;
+}
 export interface ListMitigationActionsRequest {
     /**
      * <p>Specify a value to limit the result to mitigation actions with a specific action type.</p>
@@ -6288,287 +6571,3 @@ export declare enum ReportType {
     ERRORS = "ERRORS",
     RESULTS = "RESULTS"
 }
-export interface ListThingRegistrationTaskReportsRequest {
-    /**
-     * <p>The id of the task.</p>
-     */
-    taskId: string | undefined;
-    /**
-     * <p>The type of task report.</p>
-     */
-    reportType: ReportType | string | undefined;
-    /**
-     * <p>To retrieve the next set of results, the <code>nextToken</code>
-     * 			value from a previous response; otherwise <b>null</b> to receive
-     * 		the first set of results.</p>
-     */
-    nextToken?: string;
-    /**
-     * <p>The maximum number of results to return per request.</p>
-     */
-    maxResults?: number;
-}
-export declare namespace ListThingRegistrationTaskReportsRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingRegistrationTaskReportsRequest) => any;
-}
-export interface ListThingRegistrationTaskReportsResponse {
-    /**
-     * <p>Links to the task resources.</p>
-     */
-    resourceLinks?: string[];
-    /**
-     * <p>The type of task report.</p>
-     */
-    reportType?: ReportType | string;
-    /**
-     * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
-     */
-    nextToken?: string;
-}
-export declare namespace ListThingRegistrationTaskReportsResponse {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingRegistrationTaskReportsResponse) => any;
-}
-export interface ListThingRegistrationTasksRequest {
-    /**
-     * <p>To retrieve the next set of results, the <code>nextToken</code>
-     * 			value from a previous response; otherwise <b>null</b> to receive
-     * 			the first set of results.</p>
-     */
-    nextToken?: string;
-    /**
-     * <p>The maximum number of results to return at one time.</p>
-     */
-    maxResults?: number;
-    /**
-     * <p>The status of the bulk thing provisioning task.</p>
-     */
-    status?: Status | string;
-}
-export declare namespace ListThingRegistrationTasksRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingRegistrationTasksRequest) => any;
-}
-export interface ListThingRegistrationTasksResponse {
-    /**
-     * <p>A list of bulk thing provisioning task IDs.</p>
-     */
-    taskIds?: string[];
-    /**
-     * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
-     */
-    nextToken?: string;
-}
-export declare namespace ListThingRegistrationTasksResponse {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingRegistrationTasksResponse) => any;
-}
-/**
- * <p>The input for the ListThings operation.</p>
- */
-export interface ListThingsRequest {
-    /**
-     * <p>To retrieve the next set of results, the <code>nextToken</code>
-     * 			value from a previous response; otherwise <b>null</b> to receive
-     * 			the first set of results.</p>
-     */
-    nextToken?: string;
-    /**
-     * <p>The maximum number of results to return in this operation.</p>
-     */
-    maxResults?: number;
-    /**
-     * <p>The attribute name used to search for things.</p>
-     */
-    attributeName?: string;
-    /**
-     * <p>The attribute value used to search for things.</p>
-     */
-    attributeValue?: string;
-    /**
-     * <p>The name of the thing type used to search for things.</p>
-     */
-    thingTypeName?: string;
-    /**
-     * <p>When <code>true</code>, the action returns the thing resources with attribute values
-     *                      that start with the <code>attributeValue</code> provided.</p>
-     *             <p>When <code>false</code>, or not present, the action returns only the thing
-     * 			resources with attribute values that match the entire <code>attributeValue</code>
-     * 			provided. </p>
-     */
-    usePrefixAttributeValue?: boolean;
-}
-export declare namespace ListThingsRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingsRequest) => any;
-}
-/**
- * <p>The properties of the thing, including thing name, thing type name, and a list of thing
- * 			attributes.</p>
- */
-export interface ThingAttribute {
-    /**
-     * <p>The name of the thing.</p>
-     */
-    thingName?: string;
-    /**
-     * <p>The name of the thing type, if the thing has been associated with a type.</p>
-     */
-    thingTypeName?: string;
-    /**
-     * <p>The thing ARN.</p>
-     */
-    thingArn?: string;
-    /**
-     * <p>A list of thing attributes which are name-value pairs.</p>
-     */
-    attributes?: {
-        [key: string]: string;
-    };
-    /**
-     * <p>The version of the thing record in the registry.</p>
-     */
-    version?: number;
-}
-export declare namespace ThingAttribute {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ThingAttribute) => any;
-}
-/**
- * <p>The output from the ListThings operation.</p>
- */
-export interface ListThingsResponse {
-    /**
-     * <p>The things.</p>
-     */
-    things?: ThingAttribute[];
-    /**
-     * <p>The token to use to get the next set of results. Will not be returned if operation has returned all results.</p>
-     */
-    nextToken?: string;
-}
-export declare namespace ListThingsResponse {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingsResponse) => any;
-}
-export interface ListThingsInBillingGroupRequest {
-    /**
-     * <p>The name of the billing group.</p>
-     */
-    billingGroupName: string | undefined;
-    /**
-     * <p>To retrieve the next set of results, the <code>nextToken</code>
-     * 			value from a previous response; otherwise <b>null</b> to receive
-     * 			the first set of results.</p>
-     */
-    nextToken?: string;
-    /**
-     * <p>The maximum number of results to return per request.</p>
-     */
-    maxResults?: number;
-}
-export declare namespace ListThingsInBillingGroupRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingsInBillingGroupRequest) => any;
-}
-export interface ListThingsInBillingGroupResponse {
-    /**
-     * <p>A list of things in the billing group.</p>
-     */
-    things?: string[];
-    /**
-     * <p>The token to use to get the next set of results. Will not be returned if operation has returned all results.</p>
-     */
-    nextToken?: string;
-}
-export declare namespace ListThingsInBillingGroupResponse {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingsInBillingGroupResponse) => any;
-}
-export interface ListThingsInThingGroupRequest {
-    /**
-     * <p>The thing group name.</p>
-     */
-    thingGroupName: string | undefined;
-    /**
-     * <p>When true, list things in this thing group and in all child groups as
-     * 			well.</p>
-     */
-    recursive?: boolean;
-    /**
-     * <p>To retrieve the next set of results, the <code>nextToken</code>
-     * 			value from a previous response; otherwise <b>null</b> to receive
-     * 			the first set of results.</p>
-     */
-    nextToken?: string;
-    /**
-     * <p>The maximum number of results to return at one time.</p>
-     */
-    maxResults?: number;
-}
-export declare namespace ListThingsInThingGroupRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingsInThingGroupRequest) => any;
-}
-export interface ListThingsInThingGroupResponse {
-    /**
-     * <p>The things in the specified thing group.</p>
-     */
-    things?: string[];
-    /**
-     * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
-     */
-    nextToken?: string;
-}
-export declare namespace ListThingsInThingGroupResponse {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingsInThingGroupResponse) => any;
-}
-/**
- * <p>The input for the ListThingTypes operation.</p>
- */
-export interface ListThingTypesRequest {
-    /**
-     * <p>To retrieve the next set of results, the <code>nextToken</code>
-     * 			value from a previous response; otherwise <b>null</b> to receive
-     * 			the first set of results.</p>
-     */
-    nextToken?: string;
-    /**
-     * <p>The maximum number of results to return in this operation.</p>
-     */
-    maxResults?: number;
-    /**
-     * <p>The name of the thing type.</p>
-     */
-    thingTypeName?: string;
-}
-export declare namespace ListThingTypesRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ListThingTypesRequest) => any;
-}