@aws-sdk/client-iot 3.933.0 → 3.935.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +514 -515
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +491 -0
- package/dist-es/models/errors.js +403 -0
- package/dist-es/models/models_0.js +1 -586
- package/dist-es/models/models_1.js +1 -210
- package/dist-es/models/models_2.js +1 -100
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/CreateTopicRuleDestinationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteAccountAuditConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAuditSuppressionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAuthorizerCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBillingGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCACertificateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCertificateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCertificateProviderCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCommandCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCommandExecutionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCustomMetricCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDimensionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDomainConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDynamicThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFleetMetricCommand.d.ts +1 -1
- package/dist-types/commands/DeleteJobCommand.d.ts +1 -1
- package/dist-types/commands/DeleteJobExecutionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteJobTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMitigationActionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteOTAUpdateCommand.d.ts +1 -1
- package/dist-types/commands/DeletePackageCommand.d.ts +1 -1
- package/dist-types/commands/DeletePackageVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeletePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeletePolicyVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteProvisioningTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteProvisioningTemplateVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRegistrationCodeCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRoleAliasCommand.d.ts +1 -1
- package/dist-types/commands/DeleteScheduledAuditCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSecurityProfileCommand.d.ts +1 -1
- package/dist-types/commands/DeleteStreamCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThingTypeCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTopicRuleCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTopicRuleDestinationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteV2LoggingLevelCommand.d.ts +1 -1
- package/dist-types/commands/DeprecateThingTypeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountAuditConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAuditFindingCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAuditMitigationActionsTaskCommand.d.ts +2 -1
- package/dist-types/commands/ListCommandExecutionsCommand.d.ts +1 -2
- package/dist-types/commands/ListCommandsCommand.d.ts +1 -1
- package/dist-types/commands/ListCustomMetricsCommand.d.ts +1 -1
- package/dist-types/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -1
- package/dist-types/commands/ListDimensionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDomainConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListFleetMetricsCommand.d.ts +1 -1
- package/dist-types/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/commands/ListJobExecutionsForJobCommand.d.ts +1 -1
- package/dist-types/commands/ListJobExecutionsForThingCommand.d.ts +1 -1
- package/dist-types/commands/ListJobTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListManagedJobTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListMetricValuesCommand.d.ts +1 -1
- package/dist-types/commands/ListMitigationActionsCommand.d.ts +1 -1
- package/dist-types/commands/ListOTAUpdatesCommand.d.ts +1 -1
- package/dist-types/commands/ListOutgoingCertificatesCommand.d.ts +1 -1
- package/dist-types/commands/ListPackageVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListPackagesCommand.d.ts +1 -1
- package/dist-types/commands/ListPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListPolicyPrincipalsCommand.d.ts +1 -1
- package/dist-types/commands/ListPolicyVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListPrincipalPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListPrincipalThingsCommand.d.ts +1 -1
- package/dist-types/commands/ListPrincipalThingsV2Command.d.ts +1 -1
- package/dist-types/commands/ListProvisioningTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListProvisioningTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListRelatedResourcesForAuditFindingCommand.d.ts +1 -1
- package/dist-types/commands/ListRoleAliasesCommand.d.ts +1 -1
- package/dist-types/commands/ListSbomValidationResultsCommand.d.ts +1 -1
- package/dist-types/commands/ListScheduledAuditsCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityProfilesCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityProfilesForTargetCommand.d.ts +1 -1
- package/dist-types/commands/ListStreamsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTargetsForPolicyCommand.d.ts +1 -1
- package/dist-types/commands/ListTargetsForSecurityProfileCommand.d.ts +1 -1
- package/dist-types/commands/ListThingGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListThingGroupsForThingCommand.d.ts +1 -1
- package/dist-types/commands/ListThingPrincipalsCommand.d.ts +2 -1
- package/dist-types/index.d.ts +5 -1
- package/dist-types/models/enums.d.ts +1171 -0
- package/dist-types/models/errors.d.ts +426 -0
- package/dist-types/models/models_0.d.ts +916 -997
- package/dist-types/models/models_1.d.ts +4566 -3536
- package/dist-types/models/models_2.d.ts +3 -2550
- package/dist-types/ts3.4/commands/CreateTopicRuleDestinationCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DeleteAccountAuditConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAuditSuppressionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAuthorizerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteBillingGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCACertificateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCertificateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCertificateProviderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCommandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCommandExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCustomMetricCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDimensionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDomainConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDynamicThingGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteFleetMetricCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteJobExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteJobTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMitigationActionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteOTAUpdateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePackageCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePackageVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePolicyVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteProvisioningTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteProvisioningTemplateVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteRegistrationCodeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteRoleAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteScheduledAuditCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteSecurityProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteStreamCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteThingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteThingGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteThingTypeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteTopicRuleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteTopicRuleDestinationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteV2LoggingLevelCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeprecateThingTypeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAccountAuditConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAuditFindingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAuditMitigationActionsTaskCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListCommandExecutionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListCommandsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListCustomMetricsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDimensionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDomainConfigurationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFleetMetricsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobExecutionsForJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobExecutionsForThingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListManagedJobTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMetricValuesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMitigationActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListOTAUpdatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListOutgoingCertificatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPackageVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPackagesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPoliciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPolicyPrincipalsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPolicyVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPrincipalPoliciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPrincipalThingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPrincipalThingsV2Command.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListProvisioningTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListProvisioningTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRelatedResourcesForAuditFindingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRoleAliasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSbomValidationResultsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListScheduledAuditsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSecurityProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSecurityProfilesForTargetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListStreamsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTargetsForPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTargetsForSecurityProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListThingGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListThingGroupsForThingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListThingPrincipalsCommand.d.ts +2 -4
- package/dist-types/ts3.4/index.d.ts +5 -1
- package/dist-types/ts3.4/models/enums.d.ts +637 -0
- package/dist-types/ts3.4/models/errors.d.ts +245 -0
- package/dist-types/ts3.4/models/models_0.d.ts +258 -553
- package/dist-types/ts3.4/models/models_1.d.ts +600 -481
- package/dist-types/ts3.4/models/models_2.d.ts +30 -664
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -3
- package/dist-types/models/index.d.ts +0 -3
- package/dist-types/ts3.4/models/index.d.ts +0 -3
|
@@ -1,2439 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import { BehaviorCriteriaType, CACertificateStatus, CertificateMode, CertificateStatus, CommandExecutionSummary, Configuration, DetectMitigationActionsTaskSummary, DetectMitigationActionsTaskTarget, DomainConfigurationStatus, EncryptionType, EventType, GroupNameAndArn, JobExecutionStatus, JobStatus, LogTargetType, MitigationActionType, RegistrationConfig, SortOrder, Status, ThingGroupIndexingConfiguration, ThingIndexingConfiguration, ThingTypeMetadata, VersionUpdateByJobsConfig, ViolationEventOccurrenceRange } from "./models_1";
|
|
5
|
-
/**
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export interface ListCommandExecutionsResponse {
|
|
9
|
-
/**
|
|
10
|
-
* <p>The list of command executions.</p>
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
|
-
commandExecutions?: CommandExecutionSummary[] | undefined;
|
|
14
|
-
/**
|
|
15
|
-
* <p>The token to use to get the next set of results, or <code>null</code> if there are no
|
|
16
|
-
* additional results.</p>
|
|
17
|
-
* @public
|
|
18
|
-
*/
|
|
19
|
-
nextToken?: string | undefined;
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
* @public
|
|
23
|
-
*/
|
|
24
|
-
export interface ListCommandsRequest {
|
|
25
|
-
/**
|
|
26
|
-
* <p>The maximum number of results to return in this operation. By default, the API returns
|
|
27
|
-
* up to a maximum of 25 results. You can override this default value to return up to a
|
|
28
|
-
* maximum of 100 results for this operation.</p>
|
|
29
|
-
* @public
|
|
30
|
-
*/
|
|
31
|
-
maxResults?: number | undefined;
|
|
32
|
-
/**
|
|
33
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
|
|
34
|
-
* response; otherwise <code>null</code> to receive the first set of results.</p>
|
|
35
|
-
* @public
|
|
36
|
-
*/
|
|
37
|
-
nextToken?: string | undefined;
|
|
38
|
-
/**
|
|
39
|
-
* <p>The namespace of the command. By default, the API returns all commands that have been
|
|
40
|
-
* created for both <code>AWS-IoT</code> and <code>AWS-IoT-FleetWise</code> namespaces. You
|
|
41
|
-
* can override this default value if you want to return all commands that have been
|
|
42
|
-
* created only for a specific namespace.</p>
|
|
43
|
-
* @public
|
|
44
|
-
*/
|
|
45
|
-
namespace?: CommandNamespace | undefined;
|
|
46
|
-
/**
|
|
47
|
-
* <p>A filter that can be used to display the list of commands that have a specific command
|
|
48
|
-
* parameter name.</p>
|
|
49
|
-
* @public
|
|
50
|
-
*/
|
|
51
|
-
commandParameterName?: string | undefined;
|
|
52
|
-
/**
|
|
53
|
-
* <p>Specify whether to list the commands that you have created in the ascending or
|
|
54
|
-
* descending order. By default, the API returns all commands in the descending order based
|
|
55
|
-
* on the time that they were created.</p>
|
|
56
|
-
* @public
|
|
57
|
-
*/
|
|
58
|
-
sortOrder?: SortOrder | undefined;
|
|
59
|
-
}
|
|
60
|
-
/**
|
|
61
|
-
* <p>Summary information about a particular command resource.</p>
|
|
62
|
-
* @public
|
|
63
|
-
*/
|
|
64
|
-
export interface CommandSummary {
|
|
65
|
-
/**
|
|
66
|
-
* <p>The Amazon Resource Name (ARN) of the command.</p>
|
|
67
|
-
* @public
|
|
68
|
-
*/
|
|
69
|
-
commandArn?: string | undefined;
|
|
70
|
-
/**
|
|
71
|
-
* <p>The unique identifier of the command.</p>
|
|
72
|
-
* @public
|
|
73
|
-
*/
|
|
74
|
-
commandId?: string | undefined;
|
|
75
|
-
/**
|
|
76
|
-
* <p>The display name of the command.</p>
|
|
77
|
-
* @public
|
|
78
|
-
*/
|
|
79
|
-
displayName?: string | undefined;
|
|
80
|
-
/**
|
|
81
|
-
* <p>Indicates whether the command has been deprecated.</p>
|
|
82
|
-
* @public
|
|
83
|
-
*/
|
|
84
|
-
deprecated?: boolean | undefined;
|
|
85
|
-
/**
|
|
86
|
-
* <p>The timestamp, when the command was created.</p>
|
|
87
|
-
* @public
|
|
88
|
-
*/
|
|
89
|
-
createdAt?: Date | undefined;
|
|
90
|
-
/**
|
|
91
|
-
* <p>The timestamp, when the command was last updated.</p>
|
|
92
|
-
* @public
|
|
93
|
-
*/
|
|
94
|
-
lastUpdatedAt?: Date | undefined;
|
|
95
|
-
/**
|
|
96
|
-
* <p>Indicates whether the command is pending deletion.</p>
|
|
97
|
-
* @public
|
|
98
|
-
*/
|
|
99
|
-
pendingDeletion?: boolean | undefined;
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* @public
|
|
103
|
-
*/
|
|
104
|
-
export interface ListCommandsResponse {
|
|
105
|
-
/**
|
|
106
|
-
* <p>The list of commands.</p>
|
|
107
|
-
* @public
|
|
108
|
-
*/
|
|
109
|
-
commands?: CommandSummary[] | undefined;
|
|
110
|
-
/**
|
|
111
|
-
* <p>The token to use to get the next set of results, or <code>null</code> if there are no
|
|
112
|
-
* additional results.</p>
|
|
113
|
-
* @public
|
|
114
|
-
*/
|
|
115
|
-
nextToken?: string | undefined;
|
|
116
|
-
}
|
|
117
|
-
/**
|
|
118
|
-
* @public
|
|
119
|
-
*/
|
|
120
|
-
export interface ListCustomMetricsRequest {
|
|
121
|
-
/**
|
|
122
|
-
* <p>
|
|
123
|
-
* The token for the next set of results.
|
|
124
|
-
* </p>
|
|
125
|
-
* @public
|
|
126
|
-
*/
|
|
127
|
-
nextToken?: string | undefined;
|
|
128
|
-
/**
|
|
129
|
-
* <p>
|
|
130
|
-
* The maximum number of results to return at one time. The default is 25.
|
|
131
|
-
* </p>
|
|
132
|
-
* @public
|
|
133
|
-
*/
|
|
134
|
-
maxResults?: number | undefined;
|
|
135
|
-
}
|
|
136
|
-
/**
|
|
137
|
-
* @public
|
|
138
|
-
*/
|
|
139
|
-
export interface ListCustomMetricsResponse {
|
|
140
|
-
/**
|
|
141
|
-
* <p>
|
|
142
|
-
* The name of the custom metric.
|
|
143
|
-
* </p>
|
|
144
|
-
* @public
|
|
145
|
-
*/
|
|
146
|
-
metricNames?: string[] | undefined;
|
|
147
|
-
/**
|
|
148
|
-
* <p>
|
|
149
|
-
* A token that can be used to retrieve the next set of results,
|
|
150
|
-
* or <code>null</code> if there are no additional results.
|
|
151
|
-
* </p>
|
|
152
|
-
* @public
|
|
153
|
-
*/
|
|
154
|
-
nextToken?: string | undefined;
|
|
155
|
-
}
|
|
156
|
-
/**
|
|
157
|
-
* @public
|
|
158
|
-
*/
|
|
159
|
-
export interface ListDetectMitigationActionsExecutionsRequest {
|
|
160
|
-
/**
|
|
161
|
-
* <p>
|
|
162
|
-
* The unique identifier of the task.
|
|
163
|
-
* </p>
|
|
164
|
-
* @public
|
|
165
|
-
*/
|
|
166
|
-
taskId?: string | undefined;
|
|
167
|
-
/**
|
|
168
|
-
* <p>
|
|
169
|
-
* The unique identifier of the violation.
|
|
170
|
-
* </p>
|
|
171
|
-
* @public
|
|
172
|
-
*/
|
|
173
|
-
violationId?: string | undefined;
|
|
174
|
-
/**
|
|
175
|
-
* <p>
|
|
176
|
-
* The name of the thing whose mitigation actions are listed.
|
|
177
|
-
* </p>
|
|
178
|
-
* @public
|
|
179
|
-
*/
|
|
180
|
-
thingName?: string | undefined;
|
|
181
|
-
/**
|
|
182
|
-
* <p>
|
|
183
|
-
* A filter to limit results to those found after the specified time. You must
|
|
184
|
-
* specify either the startTime and endTime or the taskId, but not both.
|
|
185
|
-
* </p>
|
|
186
|
-
* @public
|
|
187
|
-
*/
|
|
188
|
-
startTime?: Date | undefined;
|
|
189
|
-
/**
|
|
190
|
-
* <p>
|
|
191
|
-
* The end of the time period for which ML Detect mitigation actions executions are returned.
|
|
192
|
-
* </p>
|
|
193
|
-
* @public
|
|
194
|
-
*/
|
|
195
|
-
endTime?: Date | undefined;
|
|
196
|
-
/**
|
|
197
|
-
* <p>
|
|
198
|
-
* The maximum number of results to return at one time. The default is 25.
|
|
199
|
-
* </p>
|
|
200
|
-
* @public
|
|
201
|
-
*/
|
|
202
|
-
maxResults?: number | undefined;
|
|
203
|
-
/**
|
|
204
|
-
* <p>
|
|
205
|
-
* The token for the next set of results.
|
|
206
|
-
* </p>
|
|
207
|
-
* @public
|
|
208
|
-
*/
|
|
209
|
-
nextToken?: string | undefined;
|
|
210
|
-
}
|
|
211
|
-
/**
|
|
212
|
-
* @public
|
|
213
|
-
* @enum
|
|
214
|
-
*/
|
|
215
|
-
export declare const DetectMitigationActionExecutionStatus: {
|
|
216
|
-
readonly FAILED: "FAILED";
|
|
217
|
-
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
218
|
-
readonly SKIPPED: "SKIPPED";
|
|
219
|
-
readonly SUCCESSFUL: "SUCCESSFUL";
|
|
220
|
-
};
|
|
221
|
-
/**
|
|
222
|
-
* @public
|
|
223
|
-
*/
|
|
224
|
-
export type DetectMitigationActionExecutionStatus = (typeof DetectMitigationActionExecutionStatus)[keyof typeof DetectMitigationActionExecutionStatus];
|
|
225
|
-
/**
|
|
226
|
-
* <p>
|
|
227
|
-
* Describes which mitigation actions should be executed.
|
|
228
|
-
* </p>
|
|
229
|
-
* @public
|
|
230
|
-
*/
|
|
231
|
-
export interface DetectMitigationActionExecution {
|
|
232
|
-
/**
|
|
233
|
-
* <p>
|
|
234
|
-
* The unique identifier of the task.
|
|
235
|
-
* </p>
|
|
236
|
-
* @public
|
|
237
|
-
*/
|
|
238
|
-
taskId?: string | undefined;
|
|
239
|
-
/**
|
|
240
|
-
* <p>
|
|
241
|
-
* The unique identifier of the violation.
|
|
242
|
-
* </p>
|
|
243
|
-
* @public
|
|
244
|
-
*/
|
|
245
|
-
violationId?: string | undefined;
|
|
246
|
-
/**
|
|
247
|
-
* <p>
|
|
248
|
-
* The friendly name that uniquely identifies the mitigation action.
|
|
249
|
-
* </p>
|
|
250
|
-
* @public
|
|
251
|
-
*/
|
|
252
|
-
actionName?: string | undefined;
|
|
253
|
-
/**
|
|
254
|
-
* <p>
|
|
255
|
-
* The name of the thing.
|
|
256
|
-
* </p>
|
|
257
|
-
* @public
|
|
258
|
-
*/
|
|
259
|
-
thingName?: string | undefined;
|
|
260
|
-
/**
|
|
261
|
-
* <p>
|
|
262
|
-
* The date a mitigation action was started.
|
|
263
|
-
* </p>
|
|
264
|
-
* @public
|
|
265
|
-
*/
|
|
266
|
-
executionStartDate?: Date | undefined;
|
|
267
|
-
/**
|
|
268
|
-
* <p>
|
|
269
|
-
* The date a mitigation action ended.
|
|
270
|
-
* </p>
|
|
271
|
-
* @public
|
|
272
|
-
*/
|
|
273
|
-
executionEndDate?: Date | undefined;
|
|
274
|
-
/**
|
|
275
|
-
* <p>
|
|
276
|
-
* The status of a mitigation action.
|
|
277
|
-
* </p>
|
|
278
|
-
* @public
|
|
279
|
-
*/
|
|
280
|
-
status?: DetectMitigationActionExecutionStatus | undefined;
|
|
281
|
-
/**
|
|
282
|
-
* <p>
|
|
283
|
-
* The error code of a mitigation action.
|
|
284
|
-
* </p>
|
|
285
|
-
* @public
|
|
286
|
-
*/
|
|
287
|
-
errorCode?: string | undefined;
|
|
288
|
-
/**
|
|
289
|
-
* <p>
|
|
290
|
-
* The message of a mitigation action.
|
|
291
|
-
* </p>
|
|
292
|
-
* @public
|
|
293
|
-
*/
|
|
294
|
-
message?: string | undefined;
|
|
295
|
-
}
|
|
296
|
-
/**
|
|
297
|
-
* @public
|
|
298
|
-
*/
|
|
299
|
-
export interface ListDetectMitigationActionsExecutionsResponse {
|
|
300
|
-
/**
|
|
301
|
-
* <p>
|
|
302
|
-
* List of actions executions.
|
|
303
|
-
* </p>
|
|
304
|
-
* @public
|
|
305
|
-
*/
|
|
306
|
-
actionsExecutions?: DetectMitigationActionExecution[] | undefined;
|
|
307
|
-
/**
|
|
308
|
-
* <p>
|
|
309
|
-
* A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
|
|
310
|
-
* </p>
|
|
311
|
-
* @public
|
|
312
|
-
*/
|
|
313
|
-
nextToken?: string | undefined;
|
|
314
|
-
}
|
|
315
|
-
/**
|
|
316
|
-
* @public
|
|
317
|
-
*/
|
|
318
|
-
export interface ListDetectMitigationActionsTasksRequest {
|
|
319
|
-
/**
|
|
320
|
-
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
321
|
-
* @public
|
|
322
|
-
*/
|
|
323
|
-
maxResults?: number | undefined;
|
|
324
|
-
/**
|
|
325
|
-
* <p>
|
|
326
|
-
* The token for the next set of results.
|
|
327
|
-
* </p>
|
|
328
|
-
* @public
|
|
329
|
-
*/
|
|
330
|
-
nextToken?: string | undefined;
|
|
331
|
-
/**
|
|
332
|
-
* <p>
|
|
333
|
-
* A filter to limit results to those found after the specified time. You must
|
|
334
|
-
* specify either the startTime and endTime or the taskId, but not both.
|
|
335
|
-
* </p>
|
|
336
|
-
* @public
|
|
337
|
-
*/
|
|
338
|
-
startTime: Date | undefined;
|
|
339
|
-
/**
|
|
340
|
-
* <p>
|
|
341
|
-
* The end of the time period for which ML Detect mitigation actions tasks are returned.
|
|
342
|
-
* </p>
|
|
343
|
-
* @public
|
|
344
|
-
*/
|
|
345
|
-
endTime: Date | undefined;
|
|
346
|
-
}
|
|
347
|
-
/**
|
|
348
|
-
* @public
|
|
349
|
-
*/
|
|
350
|
-
export interface ListDetectMitigationActionsTasksResponse {
|
|
351
|
-
/**
|
|
352
|
-
* <p>
|
|
353
|
-
* The collection of ML Detect mitigation tasks that matched the filter criteria.
|
|
354
|
-
* </p>
|
|
355
|
-
* @public
|
|
356
|
-
*/
|
|
357
|
-
tasks?: DetectMitigationActionsTaskSummary[] | undefined;
|
|
358
|
-
/**
|
|
359
|
-
* <p>
|
|
360
|
-
* A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
|
|
361
|
-
* </p>
|
|
362
|
-
* @public
|
|
363
|
-
*/
|
|
364
|
-
nextToken?: string | undefined;
|
|
365
|
-
}
|
|
366
|
-
/**
|
|
367
|
-
* @public
|
|
368
|
-
*/
|
|
369
|
-
export interface ListDimensionsRequest {
|
|
370
|
-
/**
|
|
371
|
-
* <p>The token for the next set of results.</p>
|
|
372
|
-
* @public
|
|
373
|
-
*/
|
|
374
|
-
nextToken?: string | undefined;
|
|
375
|
-
/**
|
|
376
|
-
* <p>The maximum number of results to retrieve at one time.</p>
|
|
377
|
-
* @public
|
|
378
|
-
*/
|
|
379
|
-
maxResults?: number | undefined;
|
|
380
|
-
}
|
|
381
|
-
/**
|
|
382
|
-
* @public
|
|
383
|
-
*/
|
|
384
|
-
export interface ListDimensionsResponse {
|
|
385
|
-
/**
|
|
386
|
-
* <p>A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get details for a dimension.</p>
|
|
387
|
-
* @public
|
|
388
|
-
*/
|
|
389
|
-
dimensionNames?: string[] | undefined;
|
|
390
|
-
/**
|
|
391
|
-
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>
|
|
392
|
-
* @public
|
|
393
|
-
*/
|
|
394
|
-
nextToken?: string | undefined;
|
|
395
|
-
}
|
|
396
|
-
/**
|
|
397
|
-
* @public
|
|
398
|
-
*/
|
|
399
|
-
export interface ListDomainConfigurationsRequest {
|
|
400
|
-
/**
|
|
401
|
-
* <p>The marker for the next set of results.</p>
|
|
402
|
-
* @public
|
|
403
|
-
*/
|
|
404
|
-
marker?: string | undefined;
|
|
405
|
-
/**
|
|
406
|
-
* <p>The result page size.</p>
|
|
407
|
-
* @public
|
|
408
|
-
*/
|
|
409
|
-
pageSize?: number | undefined;
|
|
410
|
-
/**
|
|
411
|
-
* <p>The type of service delivered by the endpoint.</p>
|
|
412
|
-
* @public
|
|
413
|
-
*/
|
|
414
|
-
serviceType?: ServiceType | undefined;
|
|
415
|
-
}
|
|
416
|
-
/**
|
|
417
|
-
* <p>The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain.
|
|
418
|
-
* A domain configuration can be associated with an Amazon Web Services-managed domain
|
|
419
|
-
* (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.</p>
|
|
420
|
-
* <ul>
|
|
421
|
-
* <li>
|
|
422
|
-
* <p>Data</p>
|
|
423
|
-
* </li>
|
|
424
|
-
* <li>
|
|
425
|
-
* <p>Jobs</p>
|
|
426
|
-
* </li>
|
|
427
|
-
* <li>
|
|
428
|
-
* <p>CredentialProvider</p>
|
|
429
|
-
* </li>
|
|
430
|
-
* </ul>
|
|
431
|
-
* @public
|
|
432
|
-
*/
|
|
433
|
-
export interface DomainConfigurationSummary {
|
|
434
|
-
/**
|
|
435
|
-
* <p>The name of the domain configuration. This value must be unique to a region.</p>
|
|
436
|
-
* @public
|
|
437
|
-
*/
|
|
438
|
-
domainConfigurationName?: string | undefined;
|
|
439
|
-
/**
|
|
440
|
-
* <p>The ARN of the domain configuration.</p>
|
|
441
|
-
* @public
|
|
442
|
-
*/
|
|
443
|
-
domainConfigurationArn?: string | undefined;
|
|
444
|
-
/**
|
|
445
|
-
* <p>The type of service delivered by the endpoint.</p>
|
|
446
|
-
* @public
|
|
447
|
-
*/
|
|
448
|
-
serviceType?: ServiceType | undefined;
|
|
449
|
-
}
|
|
450
|
-
/**
|
|
451
|
-
* @public
|
|
452
|
-
*/
|
|
453
|
-
export interface ListDomainConfigurationsResponse {
|
|
454
|
-
/**
|
|
455
|
-
* <p>A list of objects that contain summary information about the user's domain configurations.</p>
|
|
456
|
-
* @public
|
|
457
|
-
*/
|
|
458
|
-
domainConfigurations?: DomainConfigurationSummary[] | undefined;
|
|
459
|
-
/**
|
|
460
|
-
* <p>The marker for the next set of results.</p>
|
|
461
|
-
* @public
|
|
462
|
-
*/
|
|
463
|
-
nextMarker?: string | undefined;
|
|
464
|
-
}
|
|
465
|
-
/**
|
|
466
|
-
* @public
|
|
467
|
-
*/
|
|
468
|
-
export interface ListFleetMetricsRequest {
|
|
469
|
-
/**
|
|
470
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response;
|
|
471
|
-
* otherwise <code>null</code> to receive the first set of results.</p>
|
|
472
|
-
* @public
|
|
473
|
-
*/
|
|
474
|
-
nextToken?: string | undefined;
|
|
475
|
-
/**
|
|
476
|
-
* <p>The maximum number of results to return in this operation.</p>
|
|
477
|
-
* @public
|
|
478
|
-
*/
|
|
479
|
-
maxResults?: number | undefined;
|
|
480
|
-
}
|
|
481
|
-
/**
|
|
482
|
-
* <p>The name and ARN of a fleet metric.</p>
|
|
483
|
-
* @public
|
|
484
|
-
*/
|
|
485
|
-
export interface FleetMetricNameAndArn {
|
|
486
|
-
/**
|
|
487
|
-
* <p>The fleet metric name.</p>
|
|
488
|
-
* @public
|
|
489
|
-
*/
|
|
490
|
-
metricName?: string | undefined;
|
|
491
|
-
/**
|
|
492
|
-
* <p>The fleet metric ARN.</p>
|
|
493
|
-
* @public
|
|
494
|
-
*/
|
|
495
|
-
metricArn?: string | undefined;
|
|
496
|
-
}
|
|
497
|
-
/**
|
|
498
|
-
* @public
|
|
499
|
-
*/
|
|
500
|
-
export interface ListFleetMetricsResponse {
|
|
501
|
-
/**
|
|
502
|
-
* <p>The list of fleet metrics objects.</p>
|
|
503
|
-
* @public
|
|
504
|
-
*/
|
|
505
|
-
fleetMetrics?: FleetMetricNameAndArn[] | undefined;
|
|
506
|
-
/**
|
|
507
|
-
* <p>The token for the next set of results. Will not be returned if the operation has returned
|
|
508
|
-
* all results.</p>
|
|
509
|
-
* @public
|
|
510
|
-
*/
|
|
511
|
-
nextToken?: string | undefined;
|
|
512
|
-
}
|
|
513
|
-
/**
|
|
514
|
-
* @public
|
|
515
|
-
*/
|
|
516
|
-
export interface ListIndicesRequest {
|
|
517
|
-
/**
|
|
518
|
-
* <p>The token used to get the next set of results, or <code>null</code> if there are no additional
|
|
519
|
-
* results.</p>
|
|
520
|
-
* @public
|
|
521
|
-
*/
|
|
522
|
-
nextToken?: string | undefined;
|
|
523
|
-
/**
|
|
524
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
525
|
-
* @public
|
|
526
|
-
*/
|
|
527
|
-
maxResults?: number | undefined;
|
|
528
|
-
}
|
|
529
|
-
/**
|
|
530
|
-
* @public
|
|
531
|
-
*/
|
|
532
|
-
export interface ListIndicesResponse {
|
|
533
|
-
/**
|
|
534
|
-
* <p>The index names.</p>
|
|
535
|
-
* @public
|
|
536
|
-
*/
|
|
537
|
-
indexNames?: string[] | undefined;
|
|
538
|
-
/**
|
|
539
|
-
* <p>The token used to get the next set of results, or <code>null</code> if there are no additional
|
|
540
|
-
* results.</p>
|
|
541
|
-
* @public
|
|
542
|
-
*/
|
|
543
|
-
nextToken?: string | undefined;
|
|
544
|
-
}
|
|
545
|
-
/**
|
|
546
|
-
* @public
|
|
547
|
-
*/
|
|
548
|
-
export interface ListJobExecutionsForJobRequest {
|
|
549
|
-
/**
|
|
550
|
-
* <p>The unique identifier you assigned to this job when it was created.</p>
|
|
551
|
-
* @public
|
|
552
|
-
*/
|
|
553
|
-
jobId: string | undefined;
|
|
554
|
-
/**
|
|
555
|
-
* <p>The status of the job.</p>
|
|
556
|
-
* @public
|
|
557
|
-
*/
|
|
558
|
-
status?: JobExecutionStatus | undefined;
|
|
559
|
-
/**
|
|
560
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
561
|
-
* @public
|
|
562
|
-
*/
|
|
563
|
-
maxResults?: number | undefined;
|
|
564
|
-
/**
|
|
565
|
-
* <p>The token to retrieve the next set of results.</p>
|
|
566
|
-
* @public
|
|
567
|
-
*/
|
|
568
|
-
nextToken?: string | undefined;
|
|
569
|
-
}
|
|
570
|
-
/**
|
|
571
|
-
* <p>The job execution summary.</p>
|
|
572
|
-
* @public
|
|
573
|
-
*/
|
|
574
|
-
export interface JobExecutionSummary {
|
|
575
|
-
/**
|
|
576
|
-
* <p>The status of the job execution.</p>
|
|
577
|
-
* @public
|
|
578
|
-
*/
|
|
579
|
-
status?: JobExecutionStatus | undefined;
|
|
580
|
-
/**
|
|
581
|
-
* <p>The time, in seconds since the epoch, when the job execution was queued.</p>
|
|
582
|
-
* @public
|
|
583
|
-
*/
|
|
584
|
-
queuedAt?: Date | undefined;
|
|
585
|
-
/**
|
|
586
|
-
* <p>The time, in seconds since the epoch, when the job execution started.</p>
|
|
587
|
-
* @public
|
|
588
|
-
*/
|
|
589
|
-
startedAt?: Date | undefined;
|
|
590
|
-
/**
|
|
591
|
-
* <p>The time, in seconds since the epoch, when the job execution was last
|
|
592
|
-
* updated.</p>
|
|
593
|
-
* @public
|
|
594
|
-
*/
|
|
595
|
-
lastUpdatedAt?: Date | undefined;
|
|
596
|
-
/**
|
|
597
|
-
* <p>A string (consisting of the digits "0" through "9") which identifies this
|
|
598
|
-
* particular job execution on this particular device. It can be used later in commands
|
|
599
|
-
* which return or update job execution information.</p>
|
|
600
|
-
* @public
|
|
601
|
-
*/
|
|
602
|
-
executionNumber?: number | undefined;
|
|
603
|
-
/**
|
|
604
|
-
* <p>The number that indicates how many retry attempts have been completed for this job on
|
|
605
|
-
* this device.</p>
|
|
606
|
-
* @public
|
|
607
|
-
*/
|
|
608
|
-
retryAttempt?: number | undefined;
|
|
609
|
-
}
|
|
610
|
-
/**
|
|
611
|
-
* <p>Contains a summary of information about job executions for a specific
|
|
612
|
-
* job.</p>
|
|
613
|
-
* @public
|
|
614
|
-
*/
|
|
615
|
-
export interface JobExecutionSummaryForJob {
|
|
616
|
-
/**
|
|
617
|
-
* <p>The ARN of the thing on which the job execution is running.</p>
|
|
618
|
-
* @public
|
|
619
|
-
*/
|
|
620
|
-
thingArn?: string | undefined;
|
|
621
|
-
/**
|
|
622
|
-
* <p>Contains a subset of information about a job execution.</p>
|
|
623
|
-
* @public
|
|
624
|
-
*/
|
|
625
|
-
jobExecutionSummary?: JobExecutionSummary | undefined;
|
|
626
|
-
}
|
|
627
|
-
/**
|
|
628
|
-
* @public
|
|
629
|
-
*/
|
|
630
|
-
export interface ListJobExecutionsForJobResponse {
|
|
631
|
-
/**
|
|
632
|
-
* <p>A list of job execution summaries.</p>
|
|
633
|
-
* @public
|
|
634
|
-
*/
|
|
635
|
-
executionSummaries?: JobExecutionSummaryForJob[] | undefined;
|
|
636
|
-
/**
|
|
637
|
-
* <p>The token for the next set of results, or <b>null</b> if
|
|
638
|
-
* there are no additional results.</p>
|
|
639
|
-
* @public
|
|
640
|
-
*/
|
|
641
|
-
nextToken?: string | undefined;
|
|
642
|
-
}
|
|
643
|
-
/**
|
|
644
|
-
* @public
|
|
645
|
-
*/
|
|
646
|
-
export interface ListJobExecutionsForThingRequest {
|
|
647
|
-
/**
|
|
648
|
-
* <p>The thing name.</p>
|
|
649
|
-
* @public
|
|
650
|
-
*/
|
|
651
|
-
thingName: string | undefined;
|
|
652
|
-
/**
|
|
653
|
-
* <p>An optional filter that lets you search for jobs that have the specified
|
|
654
|
-
* status.</p>
|
|
655
|
-
* @public
|
|
656
|
-
*/
|
|
657
|
-
status?: JobExecutionStatus | undefined;
|
|
658
|
-
/**
|
|
659
|
-
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
660
|
-
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
661
|
-
* MQTT topics that contain the value in the following format.</p>
|
|
662
|
-
* <p>
|
|
663
|
-
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
664
|
-
* </p>
|
|
665
|
-
* <note>
|
|
666
|
-
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
|
|
667
|
-
* more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
|
|
668
|
-
* </p>
|
|
669
|
-
* </note>
|
|
670
|
-
* @public
|
|
671
|
-
*/
|
|
672
|
-
namespaceId?: string | undefined;
|
|
673
|
-
/**
|
|
674
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
675
|
-
* @public
|
|
676
|
-
*/
|
|
677
|
-
maxResults?: number | undefined;
|
|
678
|
-
/**
|
|
679
|
-
* <p>The token to retrieve the next set of results.</p>
|
|
680
|
-
* @public
|
|
681
|
-
*/
|
|
682
|
-
nextToken?: string | undefined;
|
|
683
|
-
/**
|
|
684
|
-
* <p>The unique identifier you assigned to this job when it was created.</p>
|
|
685
|
-
* @public
|
|
686
|
-
*/
|
|
687
|
-
jobId?: string | undefined;
|
|
688
|
-
}
|
|
689
|
-
/**
|
|
690
|
-
* <p>The job execution summary for a thing.</p>
|
|
691
|
-
* @public
|
|
692
|
-
*/
|
|
693
|
-
export interface JobExecutionSummaryForThing {
|
|
694
|
-
/**
|
|
695
|
-
* <p>The unique identifier you assigned to this job when it was created.</p>
|
|
696
|
-
* @public
|
|
697
|
-
*/
|
|
698
|
-
jobId?: string | undefined;
|
|
699
|
-
/**
|
|
700
|
-
* <p>Contains a subset of information about a job execution.</p>
|
|
701
|
-
* @public
|
|
702
|
-
*/
|
|
703
|
-
jobExecutionSummary?: JobExecutionSummary | undefined;
|
|
704
|
-
}
|
|
705
|
-
/**
|
|
706
|
-
* @public
|
|
707
|
-
*/
|
|
708
|
-
export interface ListJobExecutionsForThingResponse {
|
|
709
|
-
/**
|
|
710
|
-
* <p>A list of job execution summaries.</p>
|
|
711
|
-
* @public
|
|
712
|
-
*/
|
|
713
|
-
executionSummaries?: JobExecutionSummaryForThing[] | undefined;
|
|
714
|
-
/**
|
|
715
|
-
* <p>The token for the next set of results, or <b>null</b> if
|
|
716
|
-
* there are no additional results.</p>
|
|
717
|
-
* @public
|
|
718
|
-
*/
|
|
719
|
-
nextToken?: string | undefined;
|
|
720
|
-
}
|
|
721
|
-
/**
|
|
722
|
-
* @public
|
|
723
|
-
*/
|
|
724
|
-
export interface ListJobsRequest {
|
|
725
|
-
/**
|
|
726
|
-
* <p>An optional filter that lets you search for jobs that have the specified
|
|
727
|
-
* status.</p>
|
|
728
|
-
* @public
|
|
729
|
-
*/
|
|
730
|
-
status?: JobStatus | undefined;
|
|
731
|
-
/**
|
|
732
|
-
* <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete
|
|
733
|
-
* after all those things specified as targets have completed the job (SNAPSHOT). If
|
|
734
|
-
* continuous, the job may also be run on a thing when a change is detected in a target.
|
|
735
|
-
* For example, a job will run on a thing when the thing is added to a target group, even
|
|
736
|
-
* after the job was completed by all things originally in the group. </p>
|
|
737
|
-
* <note>
|
|
738
|
-
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic
|
|
739
|
-
* thing group targets. By using continuous jobs, devices that join the group receive
|
|
740
|
-
* the job execution even after the job has been created.</p>
|
|
741
|
-
* </note>
|
|
742
|
-
* @public
|
|
743
|
-
*/
|
|
744
|
-
targetSelection?: TargetSelection | undefined;
|
|
745
|
-
/**
|
|
746
|
-
* <p>The maximum number of results to return per request.</p>
|
|
747
|
-
* @public
|
|
748
|
-
*/
|
|
749
|
-
maxResults?: number | undefined;
|
|
750
|
-
/**
|
|
751
|
-
* <p>The token to retrieve the next set of results.</p>
|
|
752
|
-
* @public
|
|
753
|
-
*/
|
|
754
|
-
nextToken?: string | undefined;
|
|
755
|
-
/**
|
|
756
|
-
* <p>A filter that limits the returned jobs to those for the specified group.</p>
|
|
757
|
-
* @public
|
|
758
|
-
*/
|
|
759
|
-
thingGroupName?: string | undefined;
|
|
760
|
-
/**
|
|
761
|
-
* <p>A filter that limits the returned jobs to those for the specified group.</p>
|
|
762
|
-
* @public
|
|
763
|
-
*/
|
|
764
|
-
thingGroupId?: string | undefined;
|
|
765
|
-
/**
|
|
766
|
-
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
767
|
-
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
768
|
-
* MQTT topics that contain the value in the following format.</p>
|
|
769
|
-
* <p>
|
|
770
|
-
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
771
|
-
* </p>
|
|
772
|
-
* <note>
|
|
773
|
-
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
|
|
774
|
-
* more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
|
|
775
|
-
* </p>
|
|
776
|
-
* </note>
|
|
777
|
-
* @public
|
|
778
|
-
*/
|
|
779
|
-
namespaceId?: string | undefined;
|
|
780
|
-
}
|
|
781
|
-
/**
|
|
782
|
-
* <p>The job summary.</p>
|
|
783
|
-
* @public
|
|
784
|
-
*/
|
|
785
|
-
export interface JobSummary {
|
|
786
|
-
/**
|
|
787
|
-
* <p>The job ARN.</p>
|
|
788
|
-
* @public
|
|
789
|
-
*/
|
|
790
|
-
jobArn?: string | undefined;
|
|
791
|
-
/**
|
|
792
|
-
* <p>The unique identifier you assigned to this job when it was created.</p>
|
|
793
|
-
* @public
|
|
794
|
-
*/
|
|
795
|
-
jobId?: string | undefined;
|
|
796
|
-
/**
|
|
797
|
-
* <p>The ID of the thing group.</p>
|
|
798
|
-
* @public
|
|
799
|
-
*/
|
|
800
|
-
thingGroupId?: string | undefined;
|
|
801
|
-
/**
|
|
802
|
-
* <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete
|
|
803
|
-
* after all those things specified as targets have completed the job (SNAPSHOT). If
|
|
804
|
-
* continuous, the job may also be run on a thing when a change is detected in a target.
|
|
805
|
-
* For example, a job will run on a thing when the thing is added to a target group, even
|
|
806
|
-
* after the job was completed by all things originally in the group.</p>
|
|
807
|
-
* <note>
|
|
808
|
-
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic
|
|
809
|
-
* thing group targets. By using continuous jobs, devices that join the group receive
|
|
810
|
-
* the job execution even after the job has been created.</p>
|
|
811
|
-
* </note>
|
|
812
|
-
* @public
|
|
813
|
-
*/
|
|
814
|
-
targetSelection?: TargetSelection | undefined;
|
|
815
|
-
/**
|
|
816
|
-
* <p>The job summary status.</p>
|
|
817
|
-
* @public
|
|
818
|
-
*/
|
|
819
|
-
status?: JobStatus | undefined;
|
|
820
|
-
/**
|
|
821
|
-
* <p>The time, in seconds since the epoch, when the job was created.</p>
|
|
822
|
-
* @public
|
|
823
|
-
*/
|
|
824
|
-
createdAt?: Date | undefined;
|
|
825
|
-
/**
|
|
826
|
-
* <p>The time, in seconds since the epoch, when the job was last updated.</p>
|
|
827
|
-
* @public
|
|
828
|
-
*/
|
|
829
|
-
lastUpdatedAt?: Date | undefined;
|
|
830
|
-
/**
|
|
831
|
-
* <p>The time, in seconds since the epoch, when the job completed.</p>
|
|
832
|
-
* @public
|
|
833
|
-
*/
|
|
834
|
-
completedAt?: Date | undefined;
|
|
835
|
-
/**
|
|
836
|
-
* <p>Indicates whether a job is concurrent. Will be true when a job is rolling out new job
|
|
837
|
-
* executions or canceling previously created executions, otherwise false.</p>
|
|
838
|
-
* @public
|
|
839
|
-
*/
|
|
840
|
-
isConcurrent?: boolean | undefined;
|
|
841
|
-
}
|
|
842
|
-
/**
|
|
843
|
-
* @public
|
|
844
|
-
*/
|
|
845
|
-
export interface ListJobsResponse {
|
|
846
|
-
/**
|
|
847
|
-
* <p>A list of jobs.</p>
|
|
848
|
-
* @public
|
|
849
|
-
*/
|
|
850
|
-
jobs?: JobSummary[] | undefined;
|
|
851
|
-
/**
|
|
852
|
-
* <p>The token for the next set of results, or <b>null</b> if
|
|
853
|
-
* there are no additional results.</p>
|
|
854
|
-
* @public
|
|
855
|
-
*/
|
|
856
|
-
nextToken?: string | undefined;
|
|
857
|
-
}
|
|
858
|
-
/**
|
|
859
|
-
* @public
|
|
860
|
-
*/
|
|
861
|
-
export interface ListJobTemplatesRequest {
|
|
862
|
-
/**
|
|
863
|
-
* <p>The maximum number of results to return in the list.</p>
|
|
864
|
-
* @public
|
|
865
|
-
*/
|
|
866
|
-
maxResults?: number | undefined;
|
|
867
|
-
/**
|
|
868
|
-
* <p>The token to use to return the next set of results in the list.</p>
|
|
869
|
-
* @public
|
|
870
|
-
*/
|
|
871
|
-
nextToken?: string | undefined;
|
|
872
|
-
}
|
|
873
|
-
/**
|
|
874
|
-
* <p>An object that contains information about the job template.</p>
|
|
875
|
-
* @public
|
|
876
|
-
*/
|
|
877
|
-
export interface JobTemplateSummary {
|
|
878
|
-
/**
|
|
879
|
-
* <p>The ARN of the job template.</p>
|
|
880
|
-
* @public
|
|
881
|
-
*/
|
|
882
|
-
jobTemplateArn?: string | undefined;
|
|
883
|
-
/**
|
|
884
|
-
* <p>The unique identifier of the job template.</p>
|
|
885
|
-
* @public
|
|
886
|
-
*/
|
|
887
|
-
jobTemplateId?: string | undefined;
|
|
888
|
-
/**
|
|
889
|
-
* <p>A description of the job template.</p>
|
|
890
|
-
* @public
|
|
891
|
-
*/
|
|
892
|
-
description?: string | undefined;
|
|
893
|
-
/**
|
|
894
|
-
* <p>The time, in seconds since the epoch, when the job template was created.</p>
|
|
895
|
-
* @public
|
|
896
|
-
*/
|
|
897
|
-
createdAt?: Date | undefined;
|
|
898
|
-
}
|
|
899
|
-
/**
|
|
900
|
-
* @public
|
|
901
|
-
*/
|
|
902
|
-
export interface ListJobTemplatesResponse {
|
|
903
|
-
/**
|
|
904
|
-
* <p>A list of objects that contain information about the job templates.</p>
|
|
905
|
-
* @public
|
|
906
|
-
*/
|
|
907
|
-
jobTemplates?: JobTemplateSummary[] | undefined;
|
|
908
|
-
/**
|
|
909
|
-
* <p>The token for the next set of results, or <b>null</b> if
|
|
910
|
-
* there are no additional results.</p>
|
|
911
|
-
* @public
|
|
912
|
-
*/
|
|
913
|
-
nextToken?: string | undefined;
|
|
914
|
-
}
|
|
915
|
-
/**
|
|
916
|
-
* @public
|
|
917
|
-
*/
|
|
918
|
-
export interface ListManagedJobTemplatesRequest {
|
|
919
|
-
/**
|
|
920
|
-
* <p>An optional parameter for template name. If specified, only the versions of the
|
|
921
|
-
* managed job templates that have the specified template name will be returned.</p>
|
|
922
|
-
* @public
|
|
923
|
-
*/
|
|
924
|
-
templateName?: string | undefined;
|
|
925
|
-
/**
|
|
926
|
-
* <p>Maximum number of entries that can be returned.</p>
|
|
927
|
-
* @public
|
|
928
|
-
*/
|
|
929
|
-
maxResults?: number | undefined;
|
|
930
|
-
/**
|
|
931
|
-
* <p>The token to retrieve the next set of results.</p>
|
|
932
|
-
* @public
|
|
933
|
-
*/
|
|
934
|
-
nextToken?: string | undefined;
|
|
935
|
-
}
|
|
936
|
-
/**
|
|
937
|
-
* <p>An object that contains information about the managed template.</p>
|
|
938
|
-
* @public
|
|
939
|
-
*/
|
|
940
|
-
export interface ManagedJobTemplateSummary {
|
|
941
|
-
/**
|
|
942
|
-
* <p>The Amazon Resource Name (ARN) for a managed template.</p>
|
|
943
|
-
* @public
|
|
944
|
-
*/
|
|
945
|
-
templateArn?: string | undefined;
|
|
946
|
-
/**
|
|
947
|
-
* <p>The unique Name for a managed template.</p>
|
|
948
|
-
* @public
|
|
949
|
-
*/
|
|
950
|
-
templateName?: string | undefined;
|
|
951
|
-
/**
|
|
952
|
-
* <p>The description for a managed template.</p>
|
|
953
|
-
* @public
|
|
954
|
-
*/
|
|
955
|
-
description?: string | undefined;
|
|
956
|
-
/**
|
|
957
|
-
* <p>A list of environments that are supported with the managed job template.</p>
|
|
958
|
-
* @public
|
|
959
|
-
*/
|
|
960
|
-
environments?: string[] | undefined;
|
|
961
|
-
/**
|
|
962
|
-
* <p>The version for a managed template.</p>
|
|
963
|
-
* @public
|
|
964
|
-
*/
|
|
965
|
-
templateVersion?: string | undefined;
|
|
966
|
-
}
|
|
967
|
-
/**
|
|
968
|
-
* @public
|
|
969
|
-
*/
|
|
970
|
-
export interface ListManagedJobTemplatesResponse {
|
|
971
|
-
/**
|
|
972
|
-
* <p>A list of managed job templates that are returned.</p>
|
|
973
|
-
* @public
|
|
974
|
-
*/
|
|
975
|
-
managedJobTemplates?: ManagedJobTemplateSummary[] | undefined;
|
|
976
|
-
/**
|
|
977
|
-
* <p>The token to retrieve the next set of results.</p>
|
|
978
|
-
* @public
|
|
979
|
-
*/
|
|
980
|
-
nextToken?: string | undefined;
|
|
981
|
-
}
|
|
982
|
-
/**
|
|
983
|
-
* @public
|
|
984
|
-
*/
|
|
985
|
-
export interface ListMetricValuesRequest {
|
|
986
|
-
/**
|
|
987
|
-
* <p>The name of the thing for which security profile metric values are returned.</p>
|
|
988
|
-
* @public
|
|
989
|
-
*/
|
|
990
|
-
thingName: string | undefined;
|
|
991
|
-
/**
|
|
992
|
-
* <p>The name of the security profile metric for which values are returned.</p>
|
|
993
|
-
* @public
|
|
994
|
-
*/
|
|
995
|
-
metricName: string | undefined;
|
|
996
|
-
/**
|
|
997
|
-
* <p>The dimension name.</p>
|
|
998
|
-
* @public
|
|
999
|
-
*/
|
|
1000
|
-
dimensionName?: string | undefined;
|
|
1001
|
-
/**
|
|
1002
|
-
* <p>The dimension value operator.</p>
|
|
1003
|
-
* @public
|
|
1004
|
-
*/
|
|
1005
|
-
dimensionValueOperator?: DimensionValueOperator | undefined;
|
|
1006
|
-
/**
|
|
1007
|
-
* <p>The start of the time period for which metric values are returned.</p>
|
|
1008
|
-
* @public
|
|
1009
|
-
*/
|
|
1010
|
-
startTime: Date | undefined;
|
|
1011
|
-
/**
|
|
1012
|
-
* <p>The end of the time period for which metric values are returned.</p>
|
|
1013
|
-
* @public
|
|
1014
|
-
*/
|
|
1015
|
-
endTime: Date | undefined;
|
|
1016
|
-
/**
|
|
1017
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
1018
|
-
* @public
|
|
1019
|
-
*/
|
|
1020
|
-
maxResults?: number | undefined;
|
|
1021
|
-
/**
|
|
1022
|
-
* <p>The token for the next set of results.</p>
|
|
1023
|
-
* @public
|
|
1024
|
-
*/
|
|
1025
|
-
nextToken?: string | undefined;
|
|
1026
|
-
}
|
|
1027
|
-
/**
|
|
1028
|
-
* <p>A metric.</p>
|
|
1029
|
-
* @public
|
|
1030
|
-
*/
|
|
1031
|
-
export interface MetricDatum {
|
|
1032
|
-
/**
|
|
1033
|
-
* <p>The time the metric value was reported.</p>
|
|
1034
|
-
* @public
|
|
1035
|
-
*/
|
|
1036
|
-
timestamp?: Date | undefined;
|
|
1037
|
-
/**
|
|
1038
|
-
* <p>The value reported for the metric.</p>
|
|
1039
|
-
* @public
|
|
1040
|
-
*/
|
|
1041
|
-
value?: MetricValue | undefined;
|
|
1042
|
-
}
|
|
1043
|
-
/**
|
|
1044
|
-
* @public
|
|
1045
|
-
*/
|
|
1046
|
-
export interface ListMetricValuesResponse {
|
|
1047
|
-
/**
|
|
1048
|
-
* <p>The data the thing reports for the metric during the specified time period.</p>
|
|
1049
|
-
* @public
|
|
1050
|
-
*/
|
|
1051
|
-
metricDatumList?: MetricDatum[] | undefined;
|
|
1052
|
-
/**
|
|
1053
|
-
* <p>A token that can be used to retrieve the next set of results, or <code>null</code>
|
|
1054
|
-
* if there are no additional results.</p>
|
|
1055
|
-
* @public
|
|
1056
|
-
*/
|
|
1057
|
-
nextToken?: string | undefined;
|
|
1058
|
-
}
|
|
1059
|
-
/**
|
|
1060
|
-
* @public
|
|
1061
|
-
*/
|
|
1062
|
-
export interface ListMitigationActionsRequest {
|
|
1063
|
-
/**
|
|
1064
|
-
* <p>Specify a value to limit the result to mitigation actions with a specific action type.</p>
|
|
1065
|
-
* @public
|
|
1066
|
-
*/
|
|
1067
|
-
actionType?: MitigationActionType | undefined;
|
|
1068
|
-
/**
|
|
1069
|
-
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
1070
|
-
* @public
|
|
1071
|
-
*/
|
|
1072
|
-
maxResults?: number | undefined;
|
|
1073
|
-
/**
|
|
1074
|
-
* <p>The token for the next set of results.</p>
|
|
1075
|
-
* @public
|
|
1076
|
-
*/
|
|
1077
|
-
nextToken?: string | undefined;
|
|
1078
|
-
}
|
|
1079
|
-
/**
|
|
1080
|
-
* <p>Information that identifies a mitigation action. This information is returned by ListMitigationActions.</p>
|
|
1081
|
-
* @public
|
|
1082
|
-
*/
|
|
1083
|
-
export interface MitigationActionIdentifier {
|
|
1084
|
-
/**
|
|
1085
|
-
* <p>The friendly name of the mitigation action.</p>
|
|
1086
|
-
* @public
|
|
1087
|
-
*/
|
|
1088
|
-
actionName?: string | undefined;
|
|
1089
|
-
/**
|
|
1090
|
-
* <p>The IAM role ARN used to apply this mitigation action.</p>
|
|
1091
|
-
* @public
|
|
1092
|
-
*/
|
|
1093
|
-
actionArn?: string | undefined;
|
|
1094
|
-
/**
|
|
1095
|
-
* <p>The date when this mitigation action was created.</p>
|
|
1096
|
-
* @public
|
|
1097
|
-
*/
|
|
1098
|
-
creationDate?: Date | undefined;
|
|
1099
|
-
}
|
|
1100
|
-
/**
|
|
1101
|
-
* @public
|
|
1102
|
-
*/
|
|
1103
|
-
export interface ListMitigationActionsResponse {
|
|
1104
|
-
/**
|
|
1105
|
-
* <p>A set of actions that matched the specified filter criteria.</p>
|
|
1106
|
-
* @public
|
|
1107
|
-
*/
|
|
1108
|
-
actionIdentifiers?: MitigationActionIdentifier[] | undefined;
|
|
1109
|
-
/**
|
|
1110
|
-
* <p>The token for the next set of results.</p>
|
|
1111
|
-
* @public
|
|
1112
|
-
*/
|
|
1113
|
-
nextToken?: string | undefined;
|
|
1114
|
-
}
|
|
1115
|
-
/**
|
|
1116
|
-
* @public
|
|
1117
|
-
*/
|
|
1118
|
-
export interface ListOTAUpdatesRequest {
|
|
1119
|
-
/**
|
|
1120
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
1121
|
-
* @public
|
|
1122
|
-
*/
|
|
1123
|
-
maxResults?: number | undefined;
|
|
1124
|
-
/**
|
|
1125
|
-
* <p>A token used to retrieve the next set of results.</p>
|
|
1126
|
-
* @public
|
|
1127
|
-
*/
|
|
1128
|
-
nextToken?: string | undefined;
|
|
1129
|
-
/**
|
|
1130
|
-
* <p>The OTA update job status.</p>
|
|
1131
|
-
* @public
|
|
1132
|
-
*/
|
|
1133
|
-
otaUpdateStatus?: OTAUpdateStatus | undefined;
|
|
1134
|
-
}
|
|
1135
|
-
/**
|
|
1136
|
-
* <p>An OTA update summary.</p>
|
|
1137
|
-
* @public
|
|
1138
|
-
*/
|
|
1139
|
-
export interface OTAUpdateSummary {
|
|
1140
|
-
/**
|
|
1141
|
-
* <p>The OTA update ID.</p>
|
|
1142
|
-
* @public
|
|
1143
|
-
*/
|
|
1144
|
-
otaUpdateId?: string | undefined;
|
|
1145
|
-
/**
|
|
1146
|
-
* <p>The OTA update ARN.</p>
|
|
1147
|
-
* @public
|
|
1148
|
-
*/
|
|
1149
|
-
otaUpdateArn?: string | undefined;
|
|
1150
|
-
/**
|
|
1151
|
-
* <p>The date when the OTA update was created.</p>
|
|
1152
|
-
* @public
|
|
1153
|
-
*/
|
|
1154
|
-
creationDate?: Date | undefined;
|
|
1155
|
-
}
|
|
1156
|
-
/**
|
|
1157
|
-
* @public
|
|
1158
|
-
*/
|
|
1159
|
-
export interface ListOTAUpdatesResponse {
|
|
1160
|
-
/**
|
|
1161
|
-
* <p>A list of OTA update jobs.</p>
|
|
1162
|
-
* @public
|
|
1163
|
-
*/
|
|
1164
|
-
otaUpdates?: OTAUpdateSummary[] | undefined;
|
|
1165
|
-
/**
|
|
1166
|
-
* <p>A token to use to get the next set of results.</p>
|
|
1167
|
-
* @public
|
|
1168
|
-
*/
|
|
1169
|
-
nextToken?: string | undefined;
|
|
1170
|
-
}
|
|
1171
|
-
/**
|
|
1172
|
-
* <p>The input to the ListOutgoingCertificates operation.</p>
|
|
1173
|
-
* @public
|
|
1174
|
-
*/
|
|
1175
|
-
export interface ListOutgoingCertificatesRequest {
|
|
1176
|
-
/**
|
|
1177
|
-
* <p>The result page size.</p>
|
|
1178
|
-
* @public
|
|
1179
|
-
*/
|
|
1180
|
-
pageSize?: number | undefined;
|
|
1181
|
-
/**
|
|
1182
|
-
* <p>The marker for the next set of results.</p>
|
|
1183
|
-
* @public
|
|
1184
|
-
*/
|
|
1185
|
-
marker?: string | undefined;
|
|
1186
|
-
/**
|
|
1187
|
-
* <p>Specifies the order for results. If True, the results are returned in ascending
|
|
1188
|
-
* order, based on the creation date.</p>
|
|
1189
|
-
* @public
|
|
1190
|
-
*/
|
|
1191
|
-
ascendingOrder?: boolean | undefined;
|
|
1192
|
-
}
|
|
1193
|
-
/**
|
|
1194
|
-
* <p>A certificate that has been transferred but not yet accepted.</p>
|
|
1195
|
-
* @public
|
|
1196
|
-
*/
|
|
1197
|
-
export interface OutgoingCertificate {
|
|
1198
|
-
/**
|
|
1199
|
-
* <p>The certificate ARN.</p>
|
|
1200
|
-
* @public
|
|
1201
|
-
*/
|
|
1202
|
-
certificateArn?: string | undefined;
|
|
1203
|
-
/**
|
|
1204
|
-
* <p>The certificate ID.</p>
|
|
1205
|
-
* @public
|
|
1206
|
-
*/
|
|
1207
|
-
certificateId?: string | undefined;
|
|
1208
|
-
/**
|
|
1209
|
-
* <p>The Amazon Web Services account to which the transfer was made.</p>
|
|
1210
|
-
* @public
|
|
1211
|
-
*/
|
|
1212
|
-
transferredTo?: string | undefined;
|
|
1213
|
-
/**
|
|
1214
|
-
* <p>The date the transfer was initiated.</p>
|
|
1215
|
-
* @public
|
|
1216
|
-
*/
|
|
1217
|
-
transferDate?: Date | undefined;
|
|
1218
|
-
/**
|
|
1219
|
-
* <p>The transfer message.</p>
|
|
1220
|
-
* @public
|
|
1221
|
-
*/
|
|
1222
|
-
transferMessage?: string | undefined;
|
|
1223
|
-
/**
|
|
1224
|
-
* <p>The certificate creation date.</p>
|
|
1225
|
-
* @public
|
|
1226
|
-
*/
|
|
1227
|
-
creationDate?: Date | undefined;
|
|
1228
|
-
}
|
|
1229
|
-
/**
|
|
1230
|
-
* <p>The output from the ListOutgoingCertificates operation.</p>
|
|
1231
|
-
* @public
|
|
1232
|
-
*/
|
|
1233
|
-
export interface ListOutgoingCertificatesResponse {
|
|
1234
|
-
/**
|
|
1235
|
-
* <p>The certificates that are being transferred but not yet accepted.</p>
|
|
1236
|
-
* @public
|
|
1237
|
-
*/
|
|
1238
|
-
outgoingCertificates?: OutgoingCertificate[] | undefined;
|
|
1239
|
-
/**
|
|
1240
|
-
* <p>The marker for the next set of results.</p>
|
|
1241
|
-
* @public
|
|
1242
|
-
*/
|
|
1243
|
-
nextMarker?: string | undefined;
|
|
1244
|
-
}
|
|
1245
|
-
/**
|
|
1246
|
-
* @public
|
|
1247
|
-
*/
|
|
1248
|
-
export interface ListPackagesRequest {
|
|
1249
|
-
/**
|
|
1250
|
-
* <p>The maximum number of results returned at one time.</p>
|
|
1251
|
-
* @public
|
|
1252
|
-
*/
|
|
1253
|
-
maxResults?: number | undefined;
|
|
1254
|
-
/**
|
|
1255
|
-
* <p>The token for the next set of results.</p>
|
|
1256
|
-
* @public
|
|
1257
|
-
*/
|
|
1258
|
-
nextToken?: string | undefined;
|
|
1259
|
-
}
|
|
1260
|
-
/**
|
|
1261
|
-
* <p>A summary of information about a software package.</p>
|
|
1262
|
-
* @public
|
|
1263
|
-
*/
|
|
1264
|
-
export interface PackageSummary {
|
|
1265
|
-
/**
|
|
1266
|
-
* <p>The name for the target software package.</p>
|
|
1267
|
-
* @public
|
|
1268
|
-
*/
|
|
1269
|
-
packageName?: string | undefined;
|
|
1270
|
-
/**
|
|
1271
|
-
* <p>The name of the default package version.</p>
|
|
1272
|
-
* @public
|
|
1273
|
-
*/
|
|
1274
|
-
defaultVersionName?: string | undefined;
|
|
1275
|
-
/**
|
|
1276
|
-
* <p>The date that the package was created.</p>
|
|
1277
|
-
* @public
|
|
1278
|
-
*/
|
|
1279
|
-
creationDate?: Date | undefined;
|
|
1280
|
-
/**
|
|
1281
|
-
* <p>The date that the package was last updated.</p>
|
|
1282
|
-
* @public
|
|
1283
|
-
*/
|
|
1284
|
-
lastModifiedDate?: Date | undefined;
|
|
1285
|
-
}
|
|
1286
|
-
/**
|
|
1287
|
-
* @public
|
|
1288
|
-
*/
|
|
1289
|
-
export interface ListPackagesResponse {
|
|
1290
|
-
/**
|
|
1291
|
-
* <p>The software package summary.</p>
|
|
1292
|
-
* @public
|
|
1293
|
-
*/
|
|
1294
|
-
packageSummaries?: PackageSummary[] | undefined;
|
|
1295
|
-
/**
|
|
1296
|
-
* <p>The token for the next set of results.</p>
|
|
1297
|
-
* @public
|
|
1298
|
-
*/
|
|
1299
|
-
nextToken?: string | undefined;
|
|
1300
|
-
}
|
|
1301
|
-
/**
|
|
1302
|
-
* @public
|
|
1303
|
-
*/
|
|
1304
|
-
export interface ListPackageVersionsRequest {
|
|
1305
|
-
/**
|
|
1306
|
-
* <p>The name of the target software package.</p>
|
|
1307
|
-
* @public
|
|
1308
|
-
*/
|
|
1309
|
-
packageName: string | undefined;
|
|
1310
|
-
/**
|
|
1311
|
-
* <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>
|
|
1312
|
-
* @public
|
|
1313
|
-
*/
|
|
1314
|
-
status?: PackageVersionStatus | undefined;
|
|
1315
|
-
/**
|
|
1316
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
1317
|
-
* @public
|
|
1318
|
-
*/
|
|
1319
|
-
maxResults?: number | undefined;
|
|
1320
|
-
/**
|
|
1321
|
-
* <p>The token for the next set of results.</p>
|
|
1322
|
-
* @public
|
|
1323
|
-
*/
|
|
1324
|
-
nextToken?: string | undefined;
|
|
1325
|
-
}
|
|
1326
|
-
/**
|
|
1327
|
-
* <p>A summary of information about a package version.</p>
|
|
1328
|
-
* @public
|
|
1329
|
-
*/
|
|
1330
|
-
export interface PackageVersionSummary {
|
|
1331
|
-
/**
|
|
1332
|
-
* <p>The name of the associated software package.</p>
|
|
1333
|
-
* @public
|
|
1334
|
-
*/
|
|
1335
|
-
packageName?: string | undefined;
|
|
1336
|
-
/**
|
|
1337
|
-
* <p>The name of the target package version.</p>
|
|
1338
|
-
* @public
|
|
1339
|
-
*/
|
|
1340
|
-
versionName?: string | undefined;
|
|
1341
|
-
/**
|
|
1342
|
-
* <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>
|
|
1343
|
-
* @public
|
|
1344
|
-
*/
|
|
1345
|
-
status?: PackageVersionStatus | undefined;
|
|
1346
|
-
/**
|
|
1347
|
-
* <p>The date that the package version was created.</p>
|
|
1348
|
-
* @public
|
|
1349
|
-
*/
|
|
1350
|
-
creationDate?: Date | undefined;
|
|
1351
|
-
/**
|
|
1352
|
-
* <p>The date that the package version was last updated.</p>
|
|
1353
|
-
* @public
|
|
1354
|
-
*/
|
|
1355
|
-
lastModifiedDate?: Date | undefined;
|
|
1356
|
-
}
|
|
1357
|
-
/**
|
|
1358
|
-
* @public
|
|
1359
|
-
*/
|
|
1360
|
-
export interface ListPackageVersionsResponse {
|
|
1361
|
-
/**
|
|
1362
|
-
* <p>Lists the package versions associated to the package.</p>
|
|
1363
|
-
* @public
|
|
1364
|
-
*/
|
|
1365
|
-
packageVersionSummaries?: PackageVersionSummary[] | undefined;
|
|
1366
|
-
/**
|
|
1367
|
-
* <p>The token for the next set of results.</p>
|
|
1368
|
-
* @public
|
|
1369
|
-
*/
|
|
1370
|
-
nextToken?: string | undefined;
|
|
1371
|
-
}
|
|
1372
|
-
/**
|
|
1373
|
-
* <p>The input for the ListPolicies operation.</p>
|
|
1374
|
-
* @public
|
|
1375
|
-
*/
|
|
1376
|
-
export interface ListPoliciesRequest {
|
|
1377
|
-
/**
|
|
1378
|
-
* <p>The marker for the next set of results.</p>
|
|
1379
|
-
* @public
|
|
1380
|
-
*/
|
|
1381
|
-
marker?: string | undefined;
|
|
1382
|
-
/**
|
|
1383
|
-
* <p>The result page size.</p>
|
|
1384
|
-
* @public
|
|
1385
|
-
*/
|
|
1386
|
-
pageSize?: number | undefined;
|
|
1387
|
-
/**
|
|
1388
|
-
* <p>Specifies the order for results. If true, the results are returned in ascending
|
|
1389
|
-
* creation order.</p>
|
|
1390
|
-
* @public
|
|
1391
|
-
*/
|
|
1392
|
-
ascendingOrder?: boolean | undefined;
|
|
1393
|
-
}
|
|
1394
|
-
/**
|
|
1395
|
-
* <p>The output from the ListPolicies operation.</p>
|
|
1396
|
-
* @public
|
|
1397
|
-
*/
|
|
1398
|
-
export interface ListPoliciesResponse {
|
|
1399
|
-
/**
|
|
1400
|
-
* <p>The descriptions of the policies.</p>
|
|
1401
|
-
* @public
|
|
1402
|
-
*/
|
|
1403
|
-
policies?: Policy[] | undefined;
|
|
1404
|
-
/**
|
|
1405
|
-
* <p>The marker for the next set of results, or null if there are no additional
|
|
1406
|
-
* results.</p>
|
|
1407
|
-
* @public
|
|
1408
|
-
*/
|
|
1409
|
-
nextMarker?: string | undefined;
|
|
1410
|
-
}
|
|
1411
|
-
/**
|
|
1412
|
-
* <p>The input for the ListPolicyPrincipals operation.</p>
|
|
1413
|
-
* @public
|
|
1414
|
-
*/
|
|
1415
|
-
export interface ListPolicyPrincipalsRequest {
|
|
1416
|
-
/**
|
|
1417
|
-
* <p>The policy name.</p>
|
|
1418
|
-
* @public
|
|
1419
|
-
*/
|
|
1420
|
-
policyName: string | undefined;
|
|
1421
|
-
/**
|
|
1422
|
-
* <p>The marker for the next set of results.</p>
|
|
1423
|
-
* @public
|
|
1424
|
-
*/
|
|
1425
|
-
marker?: string | undefined;
|
|
1426
|
-
/**
|
|
1427
|
-
* <p>The result page size.</p>
|
|
1428
|
-
* @public
|
|
1429
|
-
*/
|
|
1430
|
-
pageSize?: number | undefined;
|
|
1431
|
-
/**
|
|
1432
|
-
* <p>Specifies the order for results. If true, the results are returned in ascending
|
|
1433
|
-
* creation order.</p>
|
|
1434
|
-
* @public
|
|
1435
|
-
*/
|
|
1436
|
-
ascendingOrder?: boolean | undefined;
|
|
1437
|
-
}
|
|
1438
|
-
/**
|
|
1439
|
-
* <p>The output from the ListPolicyPrincipals operation.</p>
|
|
1440
|
-
* @public
|
|
1441
|
-
*/
|
|
1442
|
-
export interface ListPolicyPrincipalsResponse {
|
|
1443
|
-
/**
|
|
1444
|
-
* <p>The descriptions of the principals.</p>
|
|
1445
|
-
* @public
|
|
1446
|
-
*/
|
|
1447
|
-
principals?: string[] | undefined;
|
|
1448
|
-
/**
|
|
1449
|
-
* <p>The marker for the next set of results, or null if there are no additional
|
|
1450
|
-
* results.</p>
|
|
1451
|
-
* @public
|
|
1452
|
-
*/
|
|
1453
|
-
nextMarker?: string | undefined;
|
|
1454
|
-
}
|
|
1455
|
-
/**
|
|
1456
|
-
* <p>The input for the ListPolicyVersions operation.</p>
|
|
1457
|
-
* @public
|
|
1458
|
-
*/
|
|
1459
|
-
export interface ListPolicyVersionsRequest {
|
|
1460
|
-
/**
|
|
1461
|
-
* <p>The policy name.</p>
|
|
1462
|
-
* @public
|
|
1463
|
-
*/
|
|
1464
|
-
policyName: string | undefined;
|
|
1465
|
-
}
|
|
1466
|
-
/**
|
|
1467
|
-
* <p>Describes a policy version.</p>
|
|
1468
|
-
* @public
|
|
1469
|
-
*/
|
|
1470
|
-
export interface PolicyVersion {
|
|
1471
|
-
/**
|
|
1472
|
-
* <p>The policy version ID.</p>
|
|
1473
|
-
* @public
|
|
1474
|
-
*/
|
|
1475
|
-
versionId?: string | undefined;
|
|
1476
|
-
/**
|
|
1477
|
-
* <p>Specifies whether the policy version is the default.</p>
|
|
1478
|
-
* @public
|
|
1479
|
-
*/
|
|
1480
|
-
isDefaultVersion?: boolean | undefined;
|
|
1481
|
-
/**
|
|
1482
|
-
* <p>The date and time the policy was created.</p>
|
|
1483
|
-
* @public
|
|
1484
|
-
*/
|
|
1485
|
-
createDate?: Date | undefined;
|
|
1486
|
-
}
|
|
1487
|
-
/**
|
|
1488
|
-
* <p>The output from the ListPolicyVersions operation.</p>
|
|
1489
|
-
* @public
|
|
1490
|
-
*/
|
|
1491
|
-
export interface ListPolicyVersionsResponse {
|
|
1492
|
-
/**
|
|
1493
|
-
* <p>The policy versions.</p>
|
|
1494
|
-
* @public
|
|
1495
|
-
*/
|
|
1496
|
-
policyVersions?: PolicyVersion[] | undefined;
|
|
1497
|
-
}
|
|
1498
|
-
/**
|
|
1499
|
-
* <p>The input for the ListPrincipalPolicies operation.</p>
|
|
1500
|
-
* @public
|
|
1501
|
-
*/
|
|
1502
|
-
export interface ListPrincipalPoliciesRequest {
|
|
1503
|
-
/**
|
|
1504
|
-
* <p>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>
|
|
1505
|
-
* @public
|
|
1506
|
-
*/
|
|
1507
|
-
principal: string | undefined;
|
|
1508
|
-
/**
|
|
1509
|
-
* <p>The marker for the next set of results.</p>
|
|
1510
|
-
* @public
|
|
1511
|
-
*/
|
|
1512
|
-
marker?: string | undefined;
|
|
1513
|
-
/**
|
|
1514
|
-
* <p>The result page size.</p>
|
|
1515
|
-
* @public
|
|
1516
|
-
*/
|
|
1517
|
-
pageSize?: number | undefined;
|
|
1518
|
-
/**
|
|
1519
|
-
* <p>Specifies the order for results. If true, results are returned in ascending creation
|
|
1520
|
-
* order.</p>
|
|
1521
|
-
* @public
|
|
1522
|
-
*/
|
|
1523
|
-
ascendingOrder?: boolean | undefined;
|
|
1524
|
-
}
|
|
1525
|
-
/**
|
|
1526
|
-
* <p>The output from the ListPrincipalPolicies operation.</p>
|
|
1527
|
-
* @public
|
|
1528
|
-
*/
|
|
1529
|
-
export interface ListPrincipalPoliciesResponse {
|
|
1530
|
-
/**
|
|
1531
|
-
* <p>The policies.</p>
|
|
1532
|
-
* @public
|
|
1533
|
-
*/
|
|
1534
|
-
policies?: Policy[] | undefined;
|
|
1535
|
-
/**
|
|
1536
|
-
* <p>The marker for the next set of results, or null if there are no additional
|
|
1537
|
-
* results.</p>
|
|
1538
|
-
* @public
|
|
1539
|
-
*/
|
|
1540
|
-
nextMarker?: string | undefined;
|
|
1541
|
-
}
|
|
1542
|
-
/**
|
|
1543
|
-
* <p>The input for the ListPrincipalThings operation.</p>
|
|
1544
|
-
* @public
|
|
1545
|
-
*/
|
|
1546
|
-
export interface ListPrincipalThingsRequest {
|
|
1547
|
-
/**
|
|
1548
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code>
|
|
1549
|
-
* value from a previous response; otherwise <b>null</b> to receive
|
|
1550
|
-
* the first set of results.</p>
|
|
1551
|
-
* @public
|
|
1552
|
-
*/
|
|
1553
|
-
nextToken?: string | undefined;
|
|
1554
|
-
/**
|
|
1555
|
-
* <p>The maximum number of results to return in this operation.</p>
|
|
1556
|
-
* @public
|
|
1557
|
-
*/
|
|
1558
|
-
maxResults?: number | undefined;
|
|
1559
|
-
/**
|
|
1560
|
-
* <p>The principal.</p>
|
|
1561
|
-
* @public
|
|
1562
|
-
*/
|
|
1563
|
-
principal: string | undefined;
|
|
1564
|
-
}
|
|
1565
|
-
/**
|
|
1566
|
-
* <p>The output from the ListPrincipalThings operation.</p>
|
|
1567
|
-
* @public
|
|
1568
|
-
*/
|
|
1569
|
-
export interface ListPrincipalThingsResponse {
|
|
1570
|
-
/**
|
|
1571
|
-
* <p>The things.</p>
|
|
1572
|
-
* @public
|
|
1573
|
-
*/
|
|
1574
|
-
things?: string[] | undefined;
|
|
1575
|
-
/**
|
|
1576
|
-
* <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
|
|
1577
|
-
* @public
|
|
1578
|
-
*/
|
|
1579
|
-
nextToken?: string | undefined;
|
|
1580
|
-
}
|
|
1581
|
-
/**
|
|
1582
|
-
* @public
|
|
1583
|
-
*/
|
|
1584
|
-
export interface ListPrincipalThingsV2Request {
|
|
1585
|
-
/**
|
|
1586
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code>
|
|
1587
|
-
* value from a previous response; otherwise <b>null</b> to receive
|
|
1588
|
-
* the first set of results.</p>
|
|
1589
|
-
* @public
|
|
1590
|
-
*/
|
|
1591
|
-
nextToken?: string | undefined;
|
|
1592
|
-
/**
|
|
1593
|
-
* <p>The maximum number of results to return in this operation.</p>
|
|
1594
|
-
* @public
|
|
1595
|
-
*/
|
|
1596
|
-
maxResults?: number | undefined;
|
|
1597
|
-
/**
|
|
1598
|
-
* <p>The principal. A principal can be an X.509 certificate or an Amazon Cognito ID.</p>
|
|
1599
|
-
* @public
|
|
1600
|
-
*/
|
|
1601
|
-
principal: string | undefined;
|
|
1602
|
-
/**
|
|
1603
|
-
* <p>The type of the relation you want to filter in the response. If no value is provided in
|
|
1604
|
-
* this field, the response will list all things, including both the
|
|
1605
|
-
* <code>EXCLUSIVE_THING</code> and <code>NON_EXCLUSIVE_THING</code> attachment
|
|
1606
|
-
* types.</p>
|
|
1607
|
-
* <ul>
|
|
1608
|
-
* <li>
|
|
1609
|
-
* <p>
|
|
1610
|
-
* <code>EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing, exclusively.
|
|
1611
|
-
* The thing will be the only thing that’s attached to the principal.</p>
|
|
1612
|
-
* </li>
|
|
1613
|
-
* </ul>
|
|
1614
|
-
* <ul>
|
|
1615
|
-
* <li>
|
|
1616
|
-
* <p>
|
|
1617
|
-
* <code>NON_EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing.
|
|
1618
|
-
* Multiple things can be attached to the principal.</p>
|
|
1619
|
-
* </li>
|
|
1620
|
-
* </ul>
|
|
1621
|
-
* @public
|
|
1622
|
-
*/
|
|
1623
|
-
thingPrincipalType?: ThingPrincipalType | undefined;
|
|
1624
|
-
}
|
|
1625
|
-
/**
|
|
1626
|
-
* <p>An object that represents the thing and the type of relation it has with the principal.</p>
|
|
1627
|
-
* @public
|
|
1628
|
-
*/
|
|
1629
|
-
export interface PrincipalThingObject {
|
|
1630
|
-
/**
|
|
1631
|
-
* <p>The name of the thing.</p>
|
|
1632
|
-
* @public
|
|
1633
|
-
*/
|
|
1634
|
-
thingName: string | undefined;
|
|
1635
|
-
/**
|
|
1636
|
-
* <p>The type of the relation you want to specify when you attach a principal to a thing.
|
|
1637
|
-
* The value defaults to <code>NON_EXCLUSIVE_THING</code>.</p>
|
|
1638
|
-
* <ul>
|
|
1639
|
-
* <li>
|
|
1640
|
-
* <p>
|
|
1641
|
-
* <code>EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing, exclusively.
|
|
1642
|
-
* The thing will be the only thing that’s attached to the principal.</p>
|
|
1643
|
-
* </li>
|
|
1644
|
-
* </ul>
|
|
1645
|
-
* <ul>
|
|
1646
|
-
* <li>
|
|
1647
|
-
* <p>
|
|
1648
|
-
* <code>NON_EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing.
|
|
1649
|
-
* Multiple things can be attached to the principal.</p>
|
|
1650
|
-
* </li>
|
|
1651
|
-
* </ul>
|
|
1652
|
-
* @public
|
|
1653
|
-
*/
|
|
1654
|
-
thingPrincipalType?: ThingPrincipalType | undefined;
|
|
1655
|
-
}
|
|
1656
|
-
/**
|
|
1657
|
-
* @public
|
|
1658
|
-
*/
|
|
1659
|
-
export interface ListPrincipalThingsV2Response {
|
|
1660
|
-
/**
|
|
1661
|
-
* <p>A list of <code>thingPrincipalObject</code> that represents the principal and the type of relation it has with the thing.</p>
|
|
1662
|
-
* @public
|
|
1663
|
-
*/
|
|
1664
|
-
principalThingObjects?: PrincipalThingObject[] | undefined;
|
|
1665
|
-
/**
|
|
1666
|
-
* <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
|
|
1667
|
-
* @public
|
|
1668
|
-
*/
|
|
1669
|
-
nextToken?: string | undefined;
|
|
1670
|
-
}
|
|
1671
|
-
/**
|
|
1672
|
-
* @public
|
|
1673
|
-
*/
|
|
1674
|
-
export interface ListProvisioningTemplatesRequest {
|
|
1675
|
-
/**
|
|
1676
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
1677
|
-
* @public
|
|
1678
|
-
*/
|
|
1679
|
-
maxResults?: number | undefined;
|
|
1680
|
-
/**
|
|
1681
|
-
* <p>A token to retrieve the next set of results.</p>
|
|
1682
|
-
* @public
|
|
1683
|
-
*/
|
|
1684
|
-
nextToken?: string | undefined;
|
|
1685
|
-
}
|
|
1686
|
-
/**
|
|
1687
|
-
* <p>A summary of information about a provisioning template.</p>
|
|
1688
|
-
* @public
|
|
1689
|
-
*/
|
|
1690
|
-
export interface ProvisioningTemplateSummary {
|
|
1691
|
-
/**
|
|
1692
|
-
* <p>The ARN of the provisioning template.</p>
|
|
1693
|
-
* @public
|
|
1694
|
-
*/
|
|
1695
|
-
templateArn?: string | undefined;
|
|
1696
|
-
/**
|
|
1697
|
-
* <p>The name of the provisioning template.</p>
|
|
1698
|
-
* @public
|
|
1699
|
-
*/
|
|
1700
|
-
templateName?: string | undefined;
|
|
1701
|
-
/**
|
|
1702
|
-
* <p>The description of the provisioning template.</p>
|
|
1703
|
-
* @public
|
|
1704
|
-
*/
|
|
1705
|
-
description?: string | undefined;
|
|
1706
|
-
/**
|
|
1707
|
-
* <p>The date when the provisioning template summary was created.</p>
|
|
1708
|
-
* @public
|
|
1709
|
-
*/
|
|
1710
|
-
creationDate?: Date | undefined;
|
|
1711
|
-
/**
|
|
1712
|
-
* <p>The date when the provisioning template summary was last modified.</p>
|
|
1713
|
-
* @public
|
|
1714
|
-
*/
|
|
1715
|
-
lastModifiedDate?: Date | undefined;
|
|
1716
|
-
/**
|
|
1717
|
-
* <p>True if the fleet provision template is enabled, otherwise false.</p>
|
|
1718
|
-
* @public
|
|
1719
|
-
*/
|
|
1720
|
-
enabled?: boolean | undefined;
|
|
1721
|
-
/**
|
|
1722
|
-
* <p>The type you define in a provisioning template. You can create a template with only one type.
|
|
1723
|
-
* You can't change the template type after its creation. The default value is <code>FLEET_PROVISIONING</code>.
|
|
1724
|
-
* For more information about provisioning template, see: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning template</a>.
|
|
1725
|
-
* </p>
|
|
1726
|
-
* @public
|
|
1727
|
-
*/
|
|
1728
|
-
type?: TemplateType | undefined;
|
|
1729
|
-
}
|
|
1730
|
-
/**
|
|
1731
|
-
* @public
|
|
1732
|
-
*/
|
|
1733
|
-
export interface ListProvisioningTemplatesResponse {
|
|
1734
|
-
/**
|
|
1735
|
-
* <p>A list of provisioning templates</p>
|
|
1736
|
-
* @public
|
|
1737
|
-
*/
|
|
1738
|
-
templates?: ProvisioningTemplateSummary[] | undefined;
|
|
1739
|
-
/**
|
|
1740
|
-
* <p>A token to retrieve the next set of results.</p>
|
|
1741
|
-
* @public
|
|
1742
|
-
*/
|
|
1743
|
-
nextToken?: string | undefined;
|
|
1744
|
-
}
|
|
1745
|
-
/**
|
|
1746
|
-
* @public
|
|
1747
|
-
*/
|
|
1748
|
-
export interface ListProvisioningTemplateVersionsRequest {
|
|
1749
|
-
/**
|
|
1750
|
-
* <p>The name of the provisioning template.</p>
|
|
1751
|
-
* @public
|
|
1752
|
-
*/
|
|
1753
|
-
templateName: string | undefined;
|
|
1754
|
-
/**
|
|
1755
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
1756
|
-
* @public
|
|
1757
|
-
*/
|
|
1758
|
-
maxResults?: number | undefined;
|
|
1759
|
-
/**
|
|
1760
|
-
* <p>A token to retrieve the next set of results.</p>
|
|
1761
|
-
* @public
|
|
1762
|
-
*/
|
|
1763
|
-
nextToken?: string | undefined;
|
|
1764
|
-
}
|
|
1765
|
-
/**
|
|
1766
|
-
* <p>A summary of information about a fleet provision template version.</p>
|
|
1767
|
-
* @public
|
|
1768
|
-
*/
|
|
1769
|
-
export interface ProvisioningTemplateVersionSummary {
|
|
1770
|
-
/**
|
|
1771
|
-
* <p>The ID of the fleet provisioning template version.</p>
|
|
1772
|
-
* @public
|
|
1773
|
-
*/
|
|
1774
|
-
versionId?: number | undefined;
|
|
1775
|
-
/**
|
|
1776
|
-
* <p>The date when the provisioning template version was created</p>
|
|
1777
|
-
* @public
|
|
1778
|
-
*/
|
|
1779
|
-
creationDate?: Date | undefined;
|
|
1780
|
-
/**
|
|
1781
|
-
* <p>True if the provisioning template version is the default version, otherwise
|
|
1782
|
-
* false.</p>
|
|
1783
|
-
* @public
|
|
1784
|
-
*/
|
|
1785
|
-
isDefaultVersion?: boolean | undefined;
|
|
1786
|
-
}
|
|
1787
|
-
/**
|
|
1788
|
-
* @public
|
|
1789
|
-
*/
|
|
1790
|
-
export interface ListProvisioningTemplateVersionsResponse {
|
|
1791
|
-
/**
|
|
1792
|
-
* <p>The list of provisioning template versions.</p>
|
|
1793
|
-
* @public
|
|
1794
|
-
*/
|
|
1795
|
-
versions?: ProvisioningTemplateVersionSummary[] | undefined;
|
|
1796
|
-
/**
|
|
1797
|
-
* <p>A token to retrieve the next set of results.</p>
|
|
1798
|
-
* @public
|
|
1799
|
-
*/
|
|
1800
|
-
nextToken?: string | undefined;
|
|
1801
|
-
}
|
|
1802
|
-
/**
|
|
1803
|
-
* @public
|
|
1804
|
-
*/
|
|
1805
|
-
export interface ListRelatedResourcesForAuditFindingRequest {
|
|
1806
|
-
/**
|
|
1807
|
-
* <p>The finding Id.</p>
|
|
1808
|
-
* @public
|
|
1809
|
-
*/
|
|
1810
|
-
findingId: string | undefined;
|
|
1811
|
-
/**
|
|
1812
|
-
* <p>A token that can be used to retrieve the next set of results,
|
|
1813
|
-
* or <code>null</code> if there are no additional results.</p>
|
|
1814
|
-
* @public
|
|
1815
|
-
*/
|
|
1816
|
-
nextToken?: string | undefined;
|
|
1817
|
-
/**
|
|
1818
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
1819
|
-
* @public
|
|
1820
|
-
*/
|
|
1821
|
-
maxResults?: number | undefined;
|
|
1822
|
-
}
|
|
1823
|
-
/**
|
|
1824
|
-
* @public
|
|
1825
|
-
*/
|
|
1826
|
-
export interface ListRelatedResourcesForAuditFindingResponse {
|
|
1827
|
-
/**
|
|
1828
|
-
* <p>The related resources.</p>
|
|
1829
|
-
* @public
|
|
1830
|
-
*/
|
|
1831
|
-
relatedResources?: RelatedResource[] | undefined;
|
|
1832
|
-
/**
|
|
1833
|
-
* <p>A token that can be used to retrieve the next set of results,
|
|
1834
|
-
* or <code>null</code> for the first API call.</p>
|
|
1835
|
-
* @public
|
|
1836
|
-
*/
|
|
1837
|
-
nextToken?: string | undefined;
|
|
1838
|
-
}
|
|
1839
|
-
/**
|
|
1840
|
-
* @public
|
|
1841
|
-
*/
|
|
1842
|
-
export interface ListRoleAliasesRequest {
|
|
1843
|
-
/**
|
|
1844
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
1845
|
-
* @public
|
|
1846
|
-
*/
|
|
1847
|
-
pageSize?: number | undefined;
|
|
1848
|
-
/**
|
|
1849
|
-
* <p>A marker used to get the next set of results.</p>
|
|
1850
|
-
* @public
|
|
1851
|
-
*/
|
|
1852
|
-
marker?: string | undefined;
|
|
1853
|
-
/**
|
|
1854
|
-
* <p>Return the list of role aliases in ascending alphabetical order.</p>
|
|
1855
|
-
* @public
|
|
1856
|
-
*/
|
|
1857
|
-
ascendingOrder?: boolean | undefined;
|
|
1858
|
-
}
|
|
1859
|
-
/**
|
|
1860
|
-
* @public
|
|
1861
|
-
*/
|
|
1862
|
-
export interface ListRoleAliasesResponse {
|
|
1863
|
-
/**
|
|
1864
|
-
* <p>The role aliases.</p>
|
|
1865
|
-
* @public
|
|
1866
|
-
*/
|
|
1867
|
-
roleAliases?: string[] | undefined;
|
|
1868
|
-
/**
|
|
1869
|
-
* <p>A marker used to get the next set of results.</p>
|
|
1870
|
-
* @public
|
|
1871
|
-
*/
|
|
1872
|
-
nextMarker?: string | undefined;
|
|
1873
|
-
}
|
|
1874
|
-
/**
|
|
1875
|
-
* @public
|
|
1876
|
-
* @enum
|
|
1877
|
-
*/
|
|
1878
|
-
export declare const SbomValidationResult: {
|
|
1879
|
-
readonly FAILED: "FAILED";
|
|
1880
|
-
readonly SUCCEEDED: "SUCCEEDED";
|
|
1881
|
-
};
|
|
1882
|
-
/**
|
|
1883
|
-
* @public
|
|
1884
|
-
*/
|
|
1885
|
-
export type SbomValidationResult = (typeof SbomValidationResult)[keyof typeof SbomValidationResult];
|
|
1886
|
-
/**
|
|
1887
|
-
* @public
|
|
1888
|
-
*/
|
|
1889
|
-
export interface ListSbomValidationResultsRequest {
|
|
1890
|
-
/**
|
|
1891
|
-
* <p>The name of the new software package.</p>
|
|
1892
|
-
* @public
|
|
1893
|
-
*/
|
|
1894
|
-
packageName: string | undefined;
|
|
1895
|
-
/**
|
|
1896
|
-
* <p>The name of the new package version.</p>
|
|
1897
|
-
* @public
|
|
1898
|
-
*/
|
|
1899
|
-
versionName: string | undefined;
|
|
1900
|
-
/**
|
|
1901
|
-
* <p>The end result of the </p>
|
|
1902
|
-
* @public
|
|
1903
|
-
*/
|
|
1904
|
-
validationResult?: SbomValidationResult | undefined;
|
|
1905
|
-
/**
|
|
1906
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
1907
|
-
* @public
|
|
1908
|
-
*/
|
|
1909
|
-
maxResults?: number | undefined;
|
|
1910
|
-
/**
|
|
1911
|
-
* <p>A token that can be used to retrieve the next set of results, or null if there are no additional results.</p>
|
|
1912
|
-
* @public
|
|
1913
|
-
*/
|
|
1914
|
-
nextToken?: string | undefined;
|
|
1915
|
-
}
|
|
1916
|
-
/**
|
|
1917
|
-
* @public
|
|
1918
|
-
* @enum
|
|
1919
|
-
*/
|
|
1920
|
-
export declare const SbomValidationErrorCode: {
|
|
1921
|
-
readonly FILE_SIZE_LIMIT_EXCEEDED: "FILE_SIZE_LIMIT_EXCEEDED";
|
|
1922
|
-
readonly INCOMPATIBLE_FORMAT: "INCOMPATIBLE_FORMAT";
|
|
1923
|
-
};
|
|
1924
|
-
/**
|
|
1925
|
-
* @public
|
|
1926
|
-
*/
|
|
1927
|
-
export type SbomValidationErrorCode = (typeof SbomValidationErrorCode)[keyof typeof SbomValidationErrorCode];
|
|
1928
|
-
/**
|
|
1929
|
-
* <p>A summary of the validation results for a specific software bill of materials (SBOM) attached to a software package version.</p>
|
|
1930
|
-
* @public
|
|
1931
|
-
*/
|
|
1932
|
-
export interface SbomValidationResultSummary {
|
|
1933
|
-
/**
|
|
1934
|
-
* <p>The name of the SBOM file.</p>
|
|
1935
|
-
* @public
|
|
1936
|
-
*/
|
|
1937
|
-
fileName?: string | undefined;
|
|
1938
|
-
/**
|
|
1939
|
-
* <p>The end result of the SBOM validation.</p>
|
|
1940
|
-
* @public
|
|
1941
|
-
*/
|
|
1942
|
-
validationResult?: SbomValidationResult | undefined;
|
|
1943
|
-
/**
|
|
1944
|
-
* <p>The <code>errorCode</code> representing the validation failure error if the SBOM
|
|
1945
|
-
* validation failed.</p>
|
|
1946
|
-
* @public
|
|
1947
|
-
*/
|
|
1948
|
-
errorCode?: SbomValidationErrorCode | undefined;
|
|
1949
|
-
/**
|
|
1950
|
-
* <p>The <code>errorMessage</code> representing the validation failure error if the SBOM
|
|
1951
|
-
* validation failed.</p>
|
|
1952
|
-
* @public
|
|
1953
|
-
*/
|
|
1954
|
-
errorMessage?: string | undefined;
|
|
1955
|
-
}
|
|
1956
|
-
/**
|
|
1957
|
-
* @public
|
|
1958
|
-
*/
|
|
1959
|
-
export interface ListSbomValidationResultsResponse {
|
|
1960
|
-
/**
|
|
1961
|
-
* <p>A summary of the validation results for each software bill of materials attached to a software package version.</p>
|
|
1962
|
-
* @public
|
|
1963
|
-
*/
|
|
1964
|
-
validationResultSummaries?: SbomValidationResultSummary[] | undefined;
|
|
1965
|
-
/**
|
|
1966
|
-
* <p>A token that can be used to retrieve the next set of results, or null if there are no additional results.</p>
|
|
1967
|
-
* @public
|
|
1968
|
-
*/
|
|
1969
|
-
nextToken?: string | undefined;
|
|
1970
|
-
}
|
|
1971
|
-
/**
|
|
1972
|
-
* @public
|
|
1973
|
-
*/
|
|
1974
|
-
export interface ListScheduledAuditsRequest {
|
|
1975
|
-
/**
|
|
1976
|
-
* <p>The token for the next set of results.</p>
|
|
1977
|
-
* @public
|
|
1978
|
-
*/
|
|
1979
|
-
nextToken?: string | undefined;
|
|
1980
|
-
/**
|
|
1981
|
-
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
1982
|
-
* @public
|
|
1983
|
-
*/
|
|
1984
|
-
maxResults?: number | undefined;
|
|
1985
|
-
}
|
|
1986
|
-
/**
|
|
1987
|
-
* <p>Information about the scheduled audit.</p>
|
|
1988
|
-
* @public
|
|
1989
|
-
*/
|
|
1990
|
-
export interface ScheduledAuditMetadata {
|
|
1991
|
-
/**
|
|
1992
|
-
* <p>The name of the scheduled audit.</p>
|
|
1993
|
-
* @public
|
|
1994
|
-
*/
|
|
1995
|
-
scheduledAuditName?: string | undefined;
|
|
1996
|
-
/**
|
|
1997
|
-
* <p>The ARN of the scheduled audit.</p>
|
|
1998
|
-
* @public
|
|
1999
|
-
*/
|
|
2000
|
-
scheduledAuditArn?: string | undefined;
|
|
2001
|
-
/**
|
|
2002
|
-
* <p>How often the scheduled audit occurs.</p>
|
|
2003
|
-
* @public
|
|
2004
|
-
*/
|
|
2005
|
-
frequency?: AuditFrequency | undefined;
|
|
2006
|
-
/**
|
|
2007
|
-
* <p>The day of the month on which the scheduled audit is run (if the
|
|
2008
|
-
* <code>frequency</code> is "MONTHLY").
|
|
2009
|
-
* If days 29-31 are specified, and the month does not have that many
|
|
2010
|
-
* days, the audit takes place on the "LAST" day of the month.</p>
|
|
2011
|
-
* @public
|
|
2012
|
-
*/
|
|
2013
|
-
dayOfMonth?: string | undefined;
|
|
2014
|
-
/**
|
|
2015
|
-
* <p>The day of the week on which the scheduled audit is run (if the
|
|
2016
|
-
* <code>frequency</code> is "WEEKLY" or "BIWEEKLY").</p>
|
|
2017
|
-
* @public
|
|
2018
|
-
*/
|
|
2019
|
-
dayOfWeek?: DayOfWeek | undefined;
|
|
2020
|
-
}
|
|
2021
|
-
/**
|
|
2022
|
-
* @public
|
|
2023
|
-
*/
|
|
2024
|
-
export interface ListScheduledAuditsResponse {
|
|
2025
|
-
/**
|
|
2026
|
-
* <p>The list of scheduled audits.</p>
|
|
2027
|
-
* @public
|
|
2028
|
-
*/
|
|
2029
|
-
scheduledAudits?: ScheduledAuditMetadata[] | undefined;
|
|
2030
|
-
/**
|
|
2031
|
-
* <p>A token that can be used to retrieve the next set of results,
|
|
2032
|
-
* or <code>null</code> if there are no additional results.</p>
|
|
2033
|
-
* @public
|
|
2034
|
-
*/
|
|
2035
|
-
nextToken?: string | undefined;
|
|
2036
|
-
}
|
|
2037
|
-
/**
|
|
2038
|
-
* @public
|
|
2039
|
-
*/
|
|
2040
|
-
export interface ListSecurityProfilesRequest {
|
|
2041
|
-
/**
|
|
2042
|
-
* <p>The token for the next set of results.</p>
|
|
2043
|
-
* @public
|
|
2044
|
-
*/
|
|
2045
|
-
nextToken?: string | undefined;
|
|
2046
|
-
/**
|
|
2047
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
2048
|
-
* @public
|
|
2049
|
-
*/
|
|
2050
|
-
maxResults?: number | undefined;
|
|
2051
|
-
/**
|
|
2052
|
-
* <p>A filter to limit results to the security profiles that use the defined dimension.
|
|
2053
|
-
* Cannot be used with <code>metricName</code>
|
|
2054
|
-
* </p>
|
|
2055
|
-
* @public
|
|
2056
|
-
*/
|
|
2057
|
-
dimensionName?: string | undefined;
|
|
2058
|
-
/**
|
|
2059
|
-
* <p> The name of the custom metric.
|
|
2060
|
-
* Cannot be used with <code>dimensionName</code>. </p>
|
|
2061
|
-
* @public
|
|
2062
|
-
*/
|
|
2063
|
-
metricName?: string | undefined;
|
|
2064
|
-
}
|
|
2065
|
-
/**
|
|
2066
|
-
* <p>Identifying information for a Device Defender security profile.</p>
|
|
2067
|
-
* @public
|
|
2068
|
-
*/
|
|
2069
|
-
export interface SecurityProfileIdentifier {
|
|
2070
|
-
/**
|
|
2071
|
-
* <p>The name you've given to the security profile.</p>
|
|
2072
|
-
* @public
|
|
2073
|
-
*/
|
|
2074
|
-
name: string | undefined;
|
|
2075
|
-
/**
|
|
2076
|
-
* <p>The ARN of the security profile.</p>
|
|
2077
|
-
* @public
|
|
2078
|
-
*/
|
|
2079
|
-
arn: string | undefined;
|
|
2080
|
-
}
|
|
2081
|
-
/**
|
|
2082
|
-
* @public
|
|
2083
|
-
*/
|
|
2084
|
-
export interface ListSecurityProfilesResponse {
|
|
2085
|
-
/**
|
|
2086
|
-
* <p>A list of security profile identifiers (names and ARNs).</p>
|
|
2087
|
-
* @public
|
|
2088
|
-
*/
|
|
2089
|
-
securityProfileIdentifiers?: SecurityProfileIdentifier[] | undefined;
|
|
2090
|
-
/**
|
|
2091
|
-
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
|
|
2092
|
-
* additional results.</p>
|
|
2093
|
-
* @public
|
|
2094
|
-
*/
|
|
2095
|
-
nextToken?: string | undefined;
|
|
2096
|
-
}
|
|
2097
|
-
/**
|
|
2098
|
-
* @public
|
|
2099
|
-
*/
|
|
2100
|
-
export interface ListSecurityProfilesForTargetRequest {
|
|
2101
|
-
/**
|
|
2102
|
-
* <p>The token for the next set of results.</p>
|
|
2103
|
-
* @public
|
|
2104
|
-
*/
|
|
2105
|
-
nextToken?: string | undefined;
|
|
2106
|
-
/**
|
|
2107
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
2108
|
-
* @public
|
|
2109
|
-
*/
|
|
2110
|
-
maxResults?: number | undefined;
|
|
2111
|
-
/**
|
|
2112
|
-
* <p>If true, return child groups too.</p>
|
|
2113
|
-
* @public
|
|
2114
|
-
*/
|
|
2115
|
-
recursive?: boolean | undefined;
|
|
2116
|
-
/**
|
|
2117
|
-
* <p>The ARN of the target (thing group) whose attached security profiles you want to get.</p>
|
|
2118
|
-
* @public
|
|
2119
|
-
*/
|
|
2120
|
-
securityProfileTargetArn: string | undefined;
|
|
2121
|
-
}
|
|
2122
|
-
/**
|
|
2123
|
-
* <p>A target to which an alert is sent when a security profile behavior is
|
|
2124
|
-
* violated.</p>
|
|
2125
|
-
* @public
|
|
2126
|
-
*/
|
|
2127
|
-
export interface SecurityProfileTarget {
|
|
2128
|
-
/**
|
|
2129
|
-
* <p>The ARN of the security profile.</p>
|
|
2130
|
-
* @public
|
|
2131
|
-
*/
|
|
2132
|
-
arn: string | undefined;
|
|
2133
|
-
}
|
|
2134
|
-
/**
|
|
2135
|
-
* <p>Information about a security profile and the target associated with it.</p>
|
|
2136
|
-
* @public
|
|
2137
|
-
*/
|
|
2138
|
-
export interface SecurityProfileTargetMapping {
|
|
2139
|
-
/**
|
|
2140
|
-
* <p>Information that identifies the security profile.</p>
|
|
2141
|
-
* @public
|
|
2142
|
-
*/
|
|
2143
|
-
securityProfileIdentifier?: SecurityProfileIdentifier | undefined;
|
|
2144
|
-
/**
|
|
2145
|
-
* <p>Information about the target (thing group) associated with the security profile.</p>
|
|
2146
|
-
* @public
|
|
2147
|
-
*/
|
|
2148
|
-
target?: SecurityProfileTarget | undefined;
|
|
2149
|
-
}
|
|
2150
|
-
/**
|
|
2151
|
-
* @public
|
|
2152
|
-
*/
|
|
2153
|
-
export interface ListSecurityProfilesForTargetResponse {
|
|
2154
|
-
/**
|
|
2155
|
-
* <p>A list of security profiles and their associated targets.</p>
|
|
2156
|
-
* @public
|
|
2157
|
-
*/
|
|
2158
|
-
securityProfileTargetMappings?: SecurityProfileTargetMapping[] | undefined;
|
|
2159
|
-
/**
|
|
2160
|
-
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
|
|
2161
|
-
* additional results.</p>
|
|
2162
|
-
* @public
|
|
2163
|
-
*/
|
|
2164
|
-
nextToken?: string | undefined;
|
|
2165
|
-
}
|
|
2166
|
-
/**
|
|
2167
|
-
* @public
|
|
2168
|
-
*/
|
|
2169
|
-
export interface ListStreamsRequest {
|
|
2170
|
-
/**
|
|
2171
|
-
* <p>The maximum number of results to return at a time.</p>
|
|
2172
|
-
* @public
|
|
2173
|
-
*/
|
|
2174
|
-
maxResults?: number | undefined;
|
|
2175
|
-
/**
|
|
2176
|
-
* <p>A token used to get the next set of results.</p>
|
|
2177
|
-
* @public
|
|
2178
|
-
*/
|
|
2179
|
-
nextToken?: string | undefined;
|
|
2180
|
-
/**
|
|
2181
|
-
* <p>Set to true to return the list of streams in ascending order.</p>
|
|
2182
|
-
* @public
|
|
2183
|
-
*/
|
|
2184
|
-
ascendingOrder?: boolean | undefined;
|
|
2185
|
-
}
|
|
2186
|
-
/**
|
|
2187
|
-
* <p>A summary of a stream.</p>
|
|
2188
|
-
* @public
|
|
2189
|
-
*/
|
|
2190
|
-
export interface StreamSummary {
|
|
2191
|
-
/**
|
|
2192
|
-
* <p>The stream ID.</p>
|
|
2193
|
-
* @public
|
|
2194
|
-
*/
|
|
2195
|
-
streamId?: string | undefined;
|
|
2196
|
-
/**
|
|
2197
|
-
* <p>The stream ARN.</p>
|
|
2198
|
-
* @public
|
|
2199
|
-
*/
|
|
2200
|
-
streamArn?: string | undefined;
|
|
2201
|
-
/**
|
|
2202
|
-
* <p>The stream version.</p>
|
|
2203
|
-
* @public
|
|
2204
|
-
*/
|
|
2205
|
-
streamVersion?: number | undefined;
|
|
2206
|
-
/**
|
|
2207
|
-
* <p>A description of the stream.</p>
|
|
2208
|
-
* @public
|
|
2209
|
-
*/
|
|
2210
|
-
description?: string | undefined;
|
|
2211
|
-
}
|
|
2212
|
-
/**
|
|
2213
|
-
* @public
|
|
2214
|
-
*/
|
|
2215
|
-
export interface ListStreamsResponse {
|
|
2216
|
-
/**
|
|
2217
|
-
* <p>A list of streams.</p>
|
|
2218
|
-
* @public
|
|
2219
|
-
*/
|
|
2220
|
-
streams?: StreamSummary[] | undefined;
|
|
2221
|
-
/**
|
|
2222
|
-
* <p>A token used to get the next set of results.</p>
|
|
2223
|
-
* @public
|
|
2224
|
-
*/
|
|
2225
|
-
nextToken?: string | undefined;
|
|
2226
|
-
}
|
|
2227
|
-
/**
|
|
2228
|
-
* @public
|
|
2229
|
-
*/
|
|
2230
|
-
export interface ListTagsForResourceRequest {
|
|
2231
|
-
/**
|
|
2232
|
-
* <p>The ARN of the resource.</p>
|
|
2233
|
-
* @public
|
|
2234
|
-
*/
|
|
2235
|
-
resourceArn: string | undefined;
|
|
2236
|
-
/**
|
|
2237
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code>
|
|
2238
|
-
* value from a previous response; otherwise <b>null</b> to receive
|
|
2239
|
-
* the first set of results.</p>
|
|
2240
|
-
* @public
|
|
2241
|
-
*/
|
|
2242
|
-
nextToken?: string | undefined;
|
|
2243
|
-
}
|
|
2244
|
-
/**
|
|
2245
|
-
* @public
|
|
2246
|
-
*/
|
|
2247
|
-
export interface ListTagsForResourceResponse {
|
|
2248
|
-
/**
|
|
2249
|
-
* <p>The list of tags assigned to the resource.</p>
|
|
2250
|
-
* @public
|
|
2251
|
-
*/
|
|
2252
|
-
tags?: Tag[] | undefined;
|
|
2253
|
-
/**
|
|
2254
|
-
* <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
|
|
2255
|
-
* @public
|
|
2256
|
-
*/
|
|
2257
|
-
nextToken?: string | undefined;
|
|
2258
|
-
}
|
|
2259
|
-
/**
|
|
2260
|
-
* @public
|
|
2261
|
-
*/
|
|
2262
|
-
export interface ListTargetsForPolicyRequest {
|
|
2263
|
-
/**
|
|
2264
|
-
* <p>The policy name.</p>
|
|
2265
|
-
* @public
|
|
2266
|
-
*/
|
|
2267
|
-
policyName: string | undefined;
|
|
2268
|
-
/**
|
|
2269
|
-
* <p>A marker used to get the next set of results.</p>
|
|
2270
|
-
* @public
|
|
2271
|
-
*/
|
|
2272
|
-
marker?: string | undefined;
|
|
2273
|
-
/**
|
|
2274
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
2275
|
-
* @public
|
|
2276
|
-
*/
|
|
2277
|
-
pageSize?: number | undefined;
|
|
2278
|
-
}
|
|
2279
|
-
/**
|
|
2280
|
-
* @public
|
|
2281
|
-
*/
|
|
2282
|
-
export interface ListTargetsForPolicyResponse {
|
|
2283
|
-
/**
|
|
2284
|
-
* <p>The policy targets.</p>
|
|
2285
|
-
* @public
|
|
2286
|
-
*/
|
|
2287
|
-
targets?: string[] | undefined;
|
|
2288
|
-
/**
|
|
2289
|
-
* <p>A marker used to get the next set of results.</p>
|
|
2290
|
-
* @public
|
|
2291
|
-
*/
|
|
2292
|
-
nextMarker?: string | undefined;
|
|
2293
|
-
}
|
|
2294
|
-
/**
|
|
2295
|
-
* @public
|
|
2296
|
-
*/
|
|
2297
|
-
export interface ListTargetsForSecurityProfileRequest {
|
|
2298
|
-
/**
|
|
2299
|
-
* <p>The security profile.</p>
|
|
2300
|
-
* @public
|
|
2301
|
-
*/
|
|
2302
|
-
securityProfileName: string | undefined;
|
|
2303
|
-
/**
|
|
2304
|
-
* <p>The token for the next set of results.</p>
|
|
2305
|
-
* @public
|
|
2306
|
-
*/
|
|
2307
|
-
nextToken?: string | undefined;
|
|
2308
|
-
/**
|
|
2309
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
2310
|
-
* @public
|
|
2311
|
-
*/
|
|
2312
|
-
maxResults?: number | undefined;
|
|
2313
|
-
}
|
|
2314
|
-
/**
|
|
2315
|
-
* @public
|
|
2316
|
-
*/
|
|
2317
|
-
export interface ListTargetsForSecurityProfileResponse {
|
|
2318
|
-
/**
|
|
2319
|
-
* <p>The thing groups to which the security profile is attached.</p>
|
|
2320
|
-
* @public
|
|
2321
|
-
*/
|
|
2322
|
-
securityProfileTargets?: SecurityProfileTarget[] | undefined;
|
|
2323
|
-
/**
|
|
2324
|
-
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
|
|
2325
|
-
* additional results.</p>
|
|
2326
|
-
* @public
|
|
2327
|
-
*/
|
|
2328
|
-
nextToken?: string | undefined;
|
|
2329
|
-
}
|
|
2330
|
-
/**
|
|
2331
|
-
* @public
|
|
2332
|
-
*/
|
|
2333
|
-
export interface ListThingGroupsRequest {
|
|
2334
|
-
/**
|
|
2335
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code>
|
|
2336
|
-
* value from a previous response; otherwise <b>null</b> to receive
|
|
2337
|
-
* the first set of results.</p>
|
|
2338
|
-
* @public
|
|
2339
|
-
*/
|
|
2340
|
-
nextToken?: string | undefined;
|
|
2341
|
-
/**
|
|
2342
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
2343
|
-
* @public
|
|
2344
|
-
*/
|
|
2345
|
-
maxResults?: number | undefined;
|
|
2346
|
-
/**
|
|
2347
|
-
* <p>A filter that limits the results to those with the specified parent group.</p>
|
|
2348
|
-
* @public
|
|
2349
|
-
*/
|
|
2350
|
-
parentGroup?: string | undefined;
|
|
2351
|
-
/**
|
|
2352
|
-
* <p>A filter that limits the results to those with the specified name prefix.</p>
|
|
2353
|
-
* @public
|
|
2354
|
-
*/
|
|
2355
|
-
namePrefixFilter?: string | undefined;
|
|
2356
|
-
/**
|
|
2357
|
-
* <p>If true, return child groups as well.</p>
|
|
2358
|
-
* @public
|
|
2359
|
-
*/
|
|
2360
|
-
recursive?: boolean | undefined;
|
|
2361
|
-
}
|
|
2362
|
-
/**
|
|
2363
|
-
* @public
|
|
2364
|
-
*/
|
|
2365
|
-
export interface ListThingGroupsResponse {
|
|
2366
|
-
/**
|
|
2367
|
-
* <p>The thing groups.</p>
|
|
2368
|
-
* @public
|
|
2369
|
-
*/
|
|
2370
|
-
thingGroups?: GroupNameAndArn[] | undefined;
|
|
2371
|
-
/**
|
|
2372
|
-
* <p>The token to use to get the next set of results. Will not be returned if operation has returned all results.</p>
|
|
2373
|
-
* @public
|
|
2374
|
-
*/
|
|
2375
|
-
nextToken?: string | undefined;
|
|
2376
|
-
}
|
|
2377
|
-
/**
|
|
2378
|
-
* @public
|
|
2379
|
-
*/
|
|
2380
|
-
export interface ListThingGroupsForThingRequest {
|
|
2381
|
-
/**
|
|
2382
|
-
* <p>The thing name.</p>
|
|
2383
|
-
* @public
|
|
2384
|
-
*/
|
|
2385
|
-
thingName: string | undefined;
|
|
2386
|
-
/**
|
|
2387
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code>
|
|
2388
|
-
* value from a previous response; otherwise <b>null</b> to receive
|
|
2389
|
-
* the first set of results.</p>
|
|
2390
|
-
* @public
|
|
2391
|
-
*/
|
|
2392
|
-
nextToken?: string | undefined;
|
|
2393
|
-
/**
|
|
2394
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
2395
|
-
* @public
|
|
2396
|
-
*/
|
|
2397
|
-
maxResults?: number | undefined;
|
|
2398
|
-
}
|
|
2399
|
-
/**
|
|
2400
|
-
* @public
|
|
2401
|
-
*/
|
|
2402
|
-
export interface ListThingGroupsForThingResponse {
|
|
2403
|
-
/**
|
|
2404
|
-
* <p>The thing groups.</p>
|
|
2405
|
-
* @public
|
|
2406
|
-
*/
|
|
2407
|
-
thingGroups?: GroupNameAndArn[] | undefined;
|
|
2408
|
-
/**
|
|
2409
|
-
* <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
|
|
2410
|
-
* @public
|
|
2411
|
-
*/
|
|
2412
|
-
nextToken?: string | undefined;
|
|
2413
|
-
}
|
|
2414
|
-
/**
|
|
2415
|
-
* <p>The input for the ListThingPrincipal operation.</p>
|
|
2416
|
-
* @public
|
|
2417
|
-
*/
|
|
2418
|
-
export interface ListThingPrincipalsRequest {
|
|
2419
|
-
/**
|
|
2420
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code>
|
|
2421
|
-
* value from a previous response; otherwise <b>null</b> to receive
|
|
2422
|
-
* the first set of results.</p>
|
|
2423
|
-
* @public
|
|
2424
|
-
*/
|
|
2425
|
-
nextToken?: string | undefined;
|
|
2426
|
-
/**
|
|
2427
|
-
* <p>The maximum number of results to return in this operation.</p>
|
|
2428
|
-
* @public
|
|
2429
|
-
*/
|
|
2430
|
-
maxResults?: number | undefined;
|
|
2431
|
-
/**
|
|
2432
|
-
* <p>The name of the thing.</p>
|
|
2433
|
-
* @public
|
|
2434
|
-
*/
|
|
2435
|
-
thingName: string | undefined;
|
|
2436
|
-
}
|
|
1
|
+
import { AlertTargetType, ApplicationProtocol, AuditFrequency, AuditNotificationType, AuthenticationType, AuthorizerStatus, AutoRegistrationStatus, BehaviorCriteriaType, CACertificateStatus, CertificateMode, CertificateProviderOperation, CertificateStatus, CustomMetricType, DayOfWeek, DimensionType, DomainConfigurationStatus, EncryptionType, EventType, FleetMetricUnit, LogLevel, LogTargetType, PackageVersionAction, ReportType, Status, ThingPrincipalType, TopicRuleDestinationStatus, VerificationState, ViolationEventType } from "./enums";
|
|
2
|
+
import { AbortConfig, AggregationType, AlertTarget, AttributePayload, AuditCheckConfiguration, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuthInfo, AuthorizerConfig, AuthResult, Behavior, BillingGroupProperties, ClientCertificateConfig, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, PackageVersionArtifact, PresignedUrlConfig, ProvisioningHook, ResourceIdentifier, ServerCertificateConfig, StreamFile, Tag, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRulePayload, ViolationEventAdditionalInfo } from "./models_0";
|
|
3
|
+
import { Configuration, DetectMitigationActionsTaskTarget, RegistrationConfig, ThingGroupIndexingConfiguration, ThingIndexingConfiguration, ThingTypeMetadata, VersionUpdateByJobsConfig, ViolationEventOccurrenceRange } from "./models_1";
|
|
2437
4
|
/**
|
|
2438
5
|
* <p>The output from the ListThingPrincipals operation.</p>
|
|
2439
6
|
* @public
|
|
@@ -2541,18 +108,6 @@ export interface ListThingPrincipalsV2Response {
|
|
|
2541
108
|
*/
|
|
2542
109
|
nextToken?: string | undefined;
|
|
2543
110
|
}
|
|
2544
|
-
/**
|
|
2545
|
-
* @public
|
|
2546
|
-
* @enum
|
|
2547
|
-
*/
|
|
2548
|
-
export declare const ReportType: {
|
|
2549
|
-
readonly ERRORS: "ERRORS";
|
|
2550
|
-
readonly RESULTS: "RESULTS";
|
|
2551
|
-
};
|
|
2552
|
-
/**
|
|
2553
|
-
* @public
|
|
2554
|
-
*/
|
|
2555
|
-
export type ReportType = (typeof ReportType)[keyof typeof ReportType];
|
|
2556
111
|
/**
|
|
2557
112
|
* @public
|
|
2558
113
|
*/
|
|
@@ -3215,19 +770,6 @@ export interface ListViolationEventsRequest {
|
|
|
3215
770
|
*/
|
|
3216
771
|
maxResults?: number | undefined;
|
|
3217
772
|
}
|
|
3218
|
-
/**
|
|
3219
|
-
* @public
|
|
3220
|
-
* @enum
|
|
3221
|
-
*/
|
|
3222
|
-
export declare const ViolationEventType: {
|
|
3223
|
-
readonly ALARM_CLEARED: "alarm-cleared";
|
|
3224
|
-
readonly ALARM_INVALIDATED: "alarm-invalidated";
|
|
3225
|
-
readonly IN_ALARM: "in-alarm";
|
|
3226
|
-
};
|
|
3227
|
-
/**
|
|
3228
|
-
* @public
|
|
3229
|
-
*/
|
|
3230
|
-
export type ViolationEventType = (typeof ViolationEventType)[keyof typeof ViolationEventType];
|
|
3231
773
|
/**
|
|
3232
774
|
* <p>Information about a Device Defender security profile behavior violation.</p>
|
|
3233
775
|
* @public
|
|
@@ -3406,32 +948,6 @@ export interface RegisterCACertificateResponse {
|
|
|
3406
948
|
*/
|
|
3407
949
|
certificateId?: string | undefined;
|
|
3408
950
|
}
|
|
3409
|
-
/**
|
|
3410
|
-
* <p>The registration code is invalid.</p>
|
|
3411
|
-
* @public
|
|
3412
|
-
*/
|
|
3413
|
-
export declare class RegistrationCodeValidationException extends __BaseException {
|
|
3414
|
-
readonly name: "RegistrationCodeValidationException";
|
|
3415
|
-
readonly $fault: "client";
|
|
3416
|
-
/**
|
|
3417
|
-
* @internal
|
|
3418
|
-
*/
|
|
3419
|
-
constructor(opts: __ExceptionOptionType<RegistrationCodeValidationException, __BaseException>);
|
|
3420
|
-
}
|
|
3421
|
-
/**
|
|
3422
|
-
* <p>Unable to verify the CA certificate used to sign the device certificate you are
|
|
3423
|
-
* attempting to register. This is happens when you have registered more than one CA
|
|
3424
|
-
* certificate that has the same subject field and public key.</p>
|
|
3425
|
-
* @public
|
|
3426
|
-
*/
|
|
3427
|
-
export declare class CertificateConflictException extends __BaseException {
|
|
3428
|
-
readonly name: "CertificateConflictException";
|
|
3429
|
-
readonly $fault: "client";
|
|
3430
|
-
/**
|
|
3431
|
-
* @internal
|
|
3432
|
-
*/
|
|
3433
|
-
constructor(opts: __ExceptionOptionType<CertificateConflictException, __BaseException>);
|
|
3434
|
-
}
|
|
3435
951
|
/**
|
|
3436
952
|
* <p>The input to the RegisterCertificate operation.</p>
|
|
3437
953
|
* @public
|
|
@@ -3540,18 +1056,6 @@ export interface RegisterThingResponse {
|
|
|
3540
1056
|
*/
|
|
3541
1057
|
resourceArns?: Record<string, string> | undefined;
|
|
3542
1058
|
}
|
|
3543
|
-
/**
|
|
3544
|
-
* <p>The resource registration failed.</p>
|
|
3545
|
-
* @public
|
|
3546
|
-
*/
|
|
3547
|
-
export declare class ResourceRegistrationFailureException extends __BaseException {
|
|
3548
|
-
readonly name: "ResourceRegistrationFailureException";
|
|
3549
|
-
readonly $fault: "client";
|
|
3550
|
-
/**
|
|
3551
|
-
* @internal
|
|
3552
|
-
*/
|
|
3553
|
-
constructor(opts: __ExceptionOptionType<ResourceRegistrationFailureException, __BaseException>);
|
|
3554
|
-
}
|
|
3555
1059
|
/**
|
|
3556
1060
|
* <p>The input for the RejectCertificateTransfer operation.</p>
|
|
3557
1061
|
* @public
|
|
@@ -3947,20 +1451,6 @@ export interface StartAuditMitigationActionsTaskResponse {
|
|
|
3947
1451
|
*/
|
|
3948
1452
|
taskId?: string | undefined;
|
|
3949
1453
|
}
|
|
3950
|
-
/**
|
|
3951
|
-
* <p>
|
|
3952
|
-
* This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.
|
|
3953
|
-
* </p>
|
|
3954
|
-
* @public
|
|
3955
|
-
*/
|
|
3956
|
-
export declare class TaskAlreadyExistsException extends __BaseException {
|
|
3957
|
-
readonly name: "TaskAlreadyExistsException";
|
|
3958
|
-
readonly $fault: "client";
|
|
3959
|
-
/**
|
|
3960
|
-
* @internal
|
|
3961
|
-
*/
|
|
3962
|
-
constructor(opts: __ExceptionOptionType<TaskAlreadyExistsException, __BaseException>);
|
|
3963
|
-
}
|
|
3964
1454
|
/**
|
|
3965
1455
|
* @public
|
|
3966
1456
|
*/
|
|
@@ -4170,18 +1660,6 @@ export interface TestAuthorizationResponse {
|
|
|
4170
1660
|
*/
|
|
4171
1661
|
authResults?: AuthResult[] | undefined;
|
|
4172
1662
|
}
|
|
4173
|
-
/**
|
|
4174
|
-
* <p>The response is invalid.</p>
|
|
4175
|
-
* @public
|
|
4176
|
-
*/
|
|
4177
|
-
export declare class InvalidResponseException extends __BaseException {
|
|
4178
|
-
readonly name: "InvalidResponseException";
|
|
4179
|
-
readonly $fault: "client";
|
|
4180
|
-
/**
|
|
4181
|
-
* @internal
|
|
4182
|
-
*/
|
|
4183
|
-
constructor(opts: __ExceptionOptionType<InvalidResponseException, __BaseException>);
|
|
4184
|
-
}
|
|
4185
1663
|
/**
|
|
4186
1664
|
* <p>Specifies the HTTP context to use for the test authorizer request.</p>
|
|
4187
1665
|
* @public
|
|
@@ -4329,19 +1807,6 @@ export interface TransferCertificateResponse {
|
|
|
4329
1807
|
*/
|
|
4330
1808
|
transferredCertificateArn?: string | undefined;
|
|
4331
1809
|
}
|
|
4332
|
-
/**
|
|
4333
|
-
* <p>You can't transfer the certificate because authorization policies are still
|
|
4334
|
-
* attached.</p>
|
|
4335
|
-
* @public
|
|
4336
|
-
*/
|
|
4337
|
-
export declare class TransferConflictException extends __BaseException {
|
|
4338
|
-
readonly name: "TransferConflictException";
|
|
4339
|
-
readonly $fault: "client";
|
|
4340
|
-
/**
|
|
4341
|
-
* @internal
|
|
4342
|
-
*/
|
|
4343
|
-
constructor(opts: __ExceptionOptionType<TransferConflictException, __BaseException>);
|
|
4344
|
-
}
|
|
4345
1810
|
/**
|
|
4346
1811
|
* @public
|
|
4347
1812
|
*/
|
|
@@ -5261,18 +2726,6 @@ export interface UpdatePackageConfigurationRequest {
|
|
|
5261
2726
|
*/
|
|
5262
2727
|
export interface UpdatePackageConfigurationResponse {
|
|
5263
2728
|
}
|
|
5264
|
-
/**
|
|
5265
|
-
* @public
|
|
5266
|
-
* @enum
|
|
5267
|
-
*/
|
|
5268
|
-
export declare const PackageVersionAction: {
|
|
5269
|
-
readonly DEPRECATE: "DEPRECATE";
|
|
5270
|
-
readonly PUBLISH: "PUBLISH";
|
|
5271
|
-
};
|
|
5272
|
-
/**
|
|
5273
|
-
* @public
|
|
5274
|
-
*/
|
|
5275
|
-
export type PackageVersionAction = (typeof PackageVersionAction)[keyof typeof PackageVersionAction];
|
|
5276
2729
|
/**
|
|
5277
2730
|
* @public
|
|
5278
2731
|
*/
|