@aws-sdk/client-iot-managed-integrations 3.835.0 → 3.839.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/README.md +200 -0
- package/dist-cjs/IoTManagedIntegrations.js +50 -0
- package/dist-cjs/commands/CreateAccountAssociationCommand.js +27 -0
- package/dist-cjs/commands/CreateCloudConnectorCommand.js +26 -0
- package/dist-cjs/commands/CreateConnectorDestinationCommand.js +26 -0
- package/dist-cjs/commands/DeleteAccountAssociationCommand.js +26 -0
- package/dist-cjs/commands/DeleteCloudConnectorCommand.js +26 -0
- package/dist-cjs/commands/DeleteConnectorDestinationCommand.js +26 -0
- package/dist-cjs/commands/DeregisterAccountAssociationCommand.js +26 -0
- package/dist-cjs/commands/GetAccountAssociationCommand.js +27 -0
- package/dist-cjs/commands/GetCloudConnectorCommand.js +26 -0
- package/dist-cjs/commands/GetConnectorDestinationCommand.js +26 -0
- package/dist-cjs/commands/GetOtaTaskCommand.js +2 -1
- package/dist-cjs/commands/ListAccountAssociationsCommand.js +26 -0
- package/dist-cjs/commands/ListCloudConnectorsCommand.js +26 -0
- package/dist-cjs/commands/ListConnectorDestinationsCommand.js +26 -0
- package/dist-cjs/commands/ListDeviceDiscoveriesCommand.js +26 -0
- package/dist-cjs/commands/ListDiscoveredDevicesCommand.js +27 -0
- package/dist-cjs/commands/ListManagedThingAccountAssociationsCommand.js +26 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +27 -0
- package/dist-cjs/commands/RegisterAccountAssociationCommand.js +26 -0
- package/dist-cjs/commands/SendConnectorEventCommand.js +27 -0
- package/dist-cjs/commands/StartAccountAssociationRefreshCommand.js +27 -0
- package/dist-cjs/commands/TagResourceCommand.js +27 -0
- package/dist-cjs/commands/UntagResourceCommand.js +26 -0
- package/dist-cjs/commands/UpdateAccountAssociationCommand.js +26 -0
- package/dist-cjs/commands/UpdateCloudConnectorCommand.js +26 -0
- package/dist-cjs/commands/UpdateConnectorDestinationCommand.js +26 -0
- package/dist-cjs/commands/index.js +25 -0
- package/dist-cjs/models/models_0.js +187 -36
- package/dist-cjs/pagination/ListAccountAssociationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListCloudConnectorsPaginator.js +7 -0
- package/dist-cjs/pagination/ListConnectorDestinationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListDeviceDiscoveriesPaginator.js +7 -0
- package/dist-cjs/pagination/ListDiscoveredDevicesPaginator.js +7 -0
- package/dist-cjs/pagination/ListManagedThingAccountAssociationsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +6 -0
- package/dist-cjs/protocols/Aws_restJson1.js +974 -22
- package/dist-es/IoTManagedIntegrations.js +50 -0
- package/dist-es/commands/CreateAccountAssociationCommand.js +23 -0
- package/dist-es/commands/CreateCloudConnectorCommand.js +22 -0
- package/dist-es/commands/CreateConnectorDestinationCommand.js +22 -0
- package/dist-es/commands/DeleteAccountAssociationCommand.js +22 -0
- package/dist-es/commands/DeleteCloudConnectorCommand.js +22 -0
- package/dist-es/commands/DeleteConnectorDestinationCommand.js +22 -0
- package/dist-es/commands/DeregisterAccountAssociationCommand.js +22 -0
- package/dist-es/commands/GetAccountAssociationCommand.js +23 -0
- package/dist-es/commands/GetCloudConnectorCommand.js +22 -0
- package/dist-es/commands/GetConnectorDestinationCommand.js +22 -0
- package/dist-es/commands/GetOtaTaskCommand.js +2 -1
- package/dist-es/commands/ListAccountAssociationsCommand.js +22 -0
- package/dist-es/commands/ListCloudConnectorsCommand.js +22 -0
- package/dist-es/commands/ListConnectorDestinationsCommand.js +22 -0
- package/dist-es/commands/ListDeviceDiscoveriesCommand.js +22 -0
- package/dist-es/commands/ListDiscoveredDevicesCommand.js +23 -0
- package/dist-es/commands/ListManagedThingAccountAssociationsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +23 -0
- package/dist-es/commands/RegisterAccountAssociationCommand.js +22 -0
- package/dist-es/commands/SendConnectorEventCommand.js +23 -0
- package/dist-es/commands/StartAccountAssociationRefreshCommand.js +23 -0
- package/dist-es/commands/TagResourceCommand.js +23 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/UpdateAccountAssociationCommand.js +22 -0
- package/dist-es/commands/UpdateCloudConnectorCommand.js +22 -0
- package/dist-es/commands/UpdateConnectorDestinationCommand.js +22 -0
- package/dist-es/commands/index.js +25 -0
- package/dist-es/models/models_0.js +168 -32
- package/dist-es/pagination/ListAccountAssociationsPaginator.js +4 -0
- package/dist-es/pagination/ListCloudConnectorsPaginator.js +4 -0
- package/dist-es/pagination/ListConnectorDestinationsPaginator.js +4 -0
- package/dist-es/pagination/ListDeviceDiscoveriesPaginator.js +4 -0
- package/dist-es/pagination/ListDiscoveredDevicesPaginator.js +4 -0
- package/dist-es/pagination/ListManagedThingAccountAssociationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +918 -17
- package/dist-types/IoTManagedIntegrations.d.ts +180 -0
- package/dist-types/IoTManagedIntegrationsClient.d.ts +27 -2
- package/dist-types/commands/CreateAccountAssociationCommand.d.ts +102 -0
- package/dist-types/commands/CreateCloudConnectorCommand.d.ts +159 -0
- package/dist-types/commands/CreateConnectorDestinationCommand.d.ts +108 -0
- package/dist-types/commands/CreateCredentialLockerCommand.d.ts +2 -4
- package/dist-types/commands/CreateDestinationCommand.d.ts +2 -4
- package/dist-types/commands/CreateEventLogConfigurationCommand.d.ts +2 -4
- package/dist-types/commands/CreateManagedThingCommand.d.ts +12 -5
- package/dist-types/commands/CreateNotificationConfigurationCommand.d.ts +4 -6
- package/dist-types/commands/CreateOtaTaskCommand.d.ts +7 -2
- package/dist-types/commands/CreateOtaTaskConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/CreateProvisioningProfileCommand.d.ts +5 -5
- package/dist-types/commands/DeleteAccountAssociationCommand.d.ts +88 -0
- package/dist-types/commands/DeleteCloudConnectorCommand.d.ts +85 -0
- package/dist-types/commands/DeleteConnectorDestinationCommand.d.ts +85 -0
- package/dist-types/commands/DeleteCredentialLockerCommand.d.ts +2 -7
- package/dist-types/commands/DeleteDestinationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteEventLogConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteManagedThingCommand.d.ts +2 -5
- package/dist-types/commands/DeleteNotificationConfigurationCommand.d.ts +2 -3
- package/dist-types/commands/DeleteOtaTaskCommand.d.ts +4 -2
- package/dist-types/commands/DeleteOtaTaskConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteProvisioningProfileCommand.d.ts +1 -2
- package/dist-types/commands/DeregisterAccountAssociationCommand.d.ts +86 -0
- package/dist-types/commands/GetAccountAssociationCommand.d.ts +100 -0
- package/dist-types/commands/GetCloudConnectorCommand.d.ts +151 -0
- package/dist-types/commands/GetConnectorDestinationCommand.d.ts +109 -0
- package/dist-types/commands/GetCredentialLockerCommand.d.ts +1 -2
- package/dist-types/commands/GetCustomEndpointCommand.d.ts +1 -2
- package/dist-types/commands/GetDefaultEncryptionConfigurationCommand.d.ts +1 -3
- package/dist-types/commands/GetDestinationCommand.d.ts +1 -2
- package/dist-types/commands/GetDeviceDiscoveryCommand.d.ts +3 -3
- package/dist-types/commands/GetEventLogConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/GetHubConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/GetManagedThingCapabilitiesCommand.d.ts +1 -2
- package/dist-types/commands/GetManagedThingCommand.d.ts +2 -2
- package/dist-types/commands/GetManagedThingConnectivityDataCommand.d.ts +1 -2
- package/dist-types/commands/GetManagedThingMetaDataCommand.d.ts +2 -3
- package/dist-types/commands/GetNotificationConfigurationCommand.d.ts +3 -4
- package/dist-types/commands/GetOtaTaskCommand.d.ts +4 -2
- package/dist-types/commands/GetOtaTaskConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/GetProvisioningProfileCommand.d.ts +1 -2
- package/dist-types/commands/GetRuntimeLogConfigurationCommand.d.ts +2 -4
- package/dist-types/commands/GetSchemaVersionCommand.d.ts +7 -14
- package/dist-types/commands/ListAccountAssociationsCommand.d.ts +100 -0
- package/dist-types/commands/ListCloudConnectorsCommand.d.ts +150 -0
- package/dist-types/commands/ListConnectorDestinationsCommand.d.ts +94 -0
- package/dist-types/commands/ListCredentialLockersCommand.d.ts +1 -2
- package/dist-types/commands/ListDestinationsCommand.d.ts +1 -2
- package/dist-types/commands/ListDeviceDiscoveriesCommand.d.ts +100 -0
- package/dist-types/commands/ListDiscoveredDevicesCommand.d.ts +110 -0
- package/dist-types/commands/ListEventLogConfigurationsCommand.d.ts +1 -2
- package/dist-types/commands/ListManagedThingAccountAssociationsCommand.d.ts +93 -0
- package/dist-types/commands/ListManagedThingSchemasCommand.d.ts +1 -2
- package/dist-types/commands/ListManagedThingsCommand.d.ts +5 -3
- package/dist-types/commands/ListNotificationConfigurationsCommand.d.ts +2 -3
- package/dist-types/commands/ListOtaTaskConfigurationsCommand.d.ts +1 -2
- package/dist-types/commands/ListOtaTaskExecutionsCommand.d.ts +4 -2
- package/dist-types/commands/ListOtaTasksCommand.d.ts +4 -2
- package/dist-types/commands/ListProvisioningProfilesCommand.d.ts +1 -2
- package/dist-types/commands/ListSchemaVersionsCommand.d.ts +7 -8
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +86 -0
- package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -3
- package/dist-types/commands/PutHubConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/PutRuntimeLogConfigurationCommand.d.ts +2 -4
- package/dist-types/commands/RegisterAccountAssociationCommand.d.ts +94 -0
- package/dist-types/commands/RegisterCustomEndpointCommand.d.ts +2 -4
- package/dist-types/commands/ResetRuntimeLogConfigurationCommand.d.ts +2 -4
- package/dist-types/commands/SendConnectorEventCommand.d.ts +309 -0
- package/dist-types/commands/SendManagedThingCommandCommand.d.ts +5 -2
- package/dist-types/commands/StartAccountAssociationRefreshCommand.d.ts +90 -0
- package/dist-types/commands/StartDeviceDiscoveryCommand.d.ts +7 -6
- package/dist-types/commands/TagResourceCommand.d.ts +88 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +88 -0
- package/dist-types/commands/UpdateAccountAssociationCommand.d.ts +93 -0
- package/dist-types/commands/UpdateCloudConnectorCommand.d.ts +115 -0
- package/dist-types/commands/UpdateConnectorDestinationCommand.d.ts +101 -0
- package/dist-types/commands/UpdateDestinationCommand.d.ts +1 -2
- package/dist-types/commands/UpdateEventLogConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/UpdateManagedThingCommand.d.ts +10 -2
- package/dist-types/commands/UpdateNotificationConfigurationCommand.d.ts +2 -3
- package/dist-types/commands/UpdateOtaTaskCommand.d.ts +1 -2
- package/dist-types/commands/index.d.ts +25 -0
- package/dist-types/models/models_0.d.ts +1953 -394
- package/dist-types/pagination/ListAccountAssociationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCloudConnectorsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListConnectorDestinationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDeviceDiscoveriesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDiscoveredDevicesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListManagedThingAccountAssociationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +225 -0
- package/dist-types/ts3.4/IoTManagedIntegrations.d.ts +436 -0
- package/dist-types/ts3.4/IoTManagedIntegrationsClient.d.ts +150 -0
- package/dist-types/ts3.4/commands/CreateAccountAssociationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateCloudConnectorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateConnectorDestinationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAccountAssociationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteCloudConnectorCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/DeleteConnectorDestinationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeregisterAccountAssociationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetAccountAssociationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetCloudConnectorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetConnectorDestinationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAccountAssociationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCloudConnectorsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListConnectorDestinationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDeviceDiscoveriesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDiscoveredDevicesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListManagedThingAccountAssociationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RegisterAccountAssociationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SendConnectorEventCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartAccountAssociationRefreshCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateAccountAssociationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateCloudConnectorCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/UpdateConnectorDestinationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +25 -0
- package/dist-types/ts3.4/models/models_0.d.ts +510 -54
- package/dist-types/ts3.4/pagination/ListAccountAssociationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCloudConnectorsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListConnectorDestinationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDeviceDiscoveriesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDiscoveredDevicesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListManagedThingAccountAssociationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +300 -0
- package/package.json +11 -11
|
@@ -42,14 +42,12 @@ export interface AbortConfigCriteria {
|
|
|
42
42
|
*/
|
|
43
43
|
FailureType?: AbortCriteriaFailureType | undefined;
|
|
44
44
|
/**
|
|
45
|
-
* <p>The minimum number of things that must receive task execution notifications before the
|
|
46
|
-
* task can be aborted.</p>
|
|
45
|
+
* <p>The minimum number of things that must receive task execution notifications before the task can be aborted.</p>
|
|
47
46
|
* @public
|
|
48
47
|
*/
|
|
49
48
|
MinNumberOfExecutedThings?: number | undefined;
|
|
50
49
|
/**
|
|
51
|
-
* <p>The minimum percentage of over-the-air (OTA) task execution failures that must occur to
|
|
52
|
-
* initiate the last abort.</p>
|
|
50
|
+
* <p>The minimum percentage of over-the-air (OTA) task execution failures that must occur to initiate the last abort.</p>
|
|
53
51
|
* @public
|
|
54
52
|
*/
|
|
55
53
|
ThresholdPercentage?: number | undefined;
|
|
@@ -67,11 +65,459 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
67
65
|
*/
|
|
68
66
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
69
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
* @enum
|
|
71
|
+
*/
|
|
72
|
+
export declare const AssociationState: {
|
|
73
|
+
readonly ASSOCIATION_DELETING: "ASSOCIATION_DELETING";
|
|
74
|
+
readonly ASSOCIATION_FAILED: "ASSOCIATION_FAILED";
|
|
75
|
+
readonly ASSOCIATION_IN_PROGRESS: "ASSOCIATION_IN_PROGRESS";
|
|
76
|
+
readonly ASSOCIATION_SUCCEEDED: "ASSOCIATION_SUCCEEDED";
|
|
77
|
+
readonly REFRESH_TOKEN_EXPIRED: "REFRESH_TOKEN_EXPIRED";
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export type AssociationState = (typeof AssociationState)[keyof typeof AssociationState];
|
|
83
|
+
/**
|
|
84
|
+
* <p>Structure containing information about an account association, including its identifier, state, and related metadata.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
export interface AccountAssociationItem {
|
|
88
|
+
/**
|
|
89
|
+
* <p>The unique identifier of the account association.</p>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
AccountAssociationId: string | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* <p>The current state of the account association, indicating its status in the association lifecycle.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
AssociationState: AssociationState | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* <p>The error message explaining any issues with the account association, if applicable.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
ErrorMessage?: string | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* <p>The identifier of the connector destination associated with this account association.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
ConnectorDestinationId?: string | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* <p>The name of the account association.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
Name?: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>A description of the account association.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
Description?: string | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* <p>The Amazon Resource Name (ARN) of the account association.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
Arn?: string | undefined;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* <p>There is a conflict with the request.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
export declare class ConflictException extends __BaseException {
|
|
129
|
+
readonly name: "ConflictException";
|
|
130
|
+
readonly $fault: "client";
|
|
131
|
+
Message?: string | undefined;
|
|
132
|
+
/**
|
|
133
|
+
* @internal
|
|
134
|
+
*/
|
|
135
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
export interface CreateAccountAssociationRequest {
|
|
141
|
+
/**
|
|
142
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
ClientToken?: string | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <p>The identifier of the connector destination.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
ConnectorDestinationId: string | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>The name of the destination for the new account association.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
Name?: string | undefined;
|
|
156
|
+
/**
|
|
157
|
+
* <p>A description of the account association request.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
Description?: string | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* <p>A set of key/value pairs that are used to manage the account association.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
Tags?: Record<string, string> | undefined;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
export interface CreateAccountAssociationResponse {
|
|
171
|
+
/**
|
|
172
|
+
* <p>Third-party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
OAuthAuthorizationUrl: string | undefined;
|
|
176
|
+
/**
|
|
177
|
+
* <p>The identifier for the account association request.</p>
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
AccountAssociationId: string | undefined;
|
|
181
|
+
/**
|
|
182
|
+
* <p>The current state of the account association request.</p>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
AssociationState: AssociationState | undefined;
|
|
186
|
+
/**
|
|
187
|
+
* <p>The Amazon Resource Name (ARN) of the account association.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
Arn?: string | undefined;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* <p>Internal error from the service that indicates an unexpected error or that the service is unavailable.</p>
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
export declare class InternalServerException extends __BaseException {
|
|
197
|
+
readonly name: "InternalServerException";
|
|
198
|
+
readonly $fault: "server";
|
|
199
|
+
Message?: string | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* @internal
|
|
202
|
+
*/
|
|
203
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* <p>The specified resource does not exist.</p>
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
210
|
+
readonly name: "ResourceNotFoundException";
|
|
211
|
+
readonly $fault: "client";
|
|
212
|
+
Message?: string | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* Id of the affected resource
|
|
215
|
+
* @public
|
|
216
|
+
*/
|
|
217
|
+
ResourceId?: string | undefined;
|
|
218
|
+
/**
|
|
219
|
+
* Type of the affected resource
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
222
|
+
ResourceType?: string | undefined;
|
|
223
|
+
/**
|
|
224
|
+
* @internal
|
|
225
|
+
*/
|
|
226
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* <p>The service is temporarily unavailable.</p>
|
|
230
|
+
* @public
|
|
231
|
+
*/
|
|
232
|
+
export declare class ServiceUnavailableException extends __BaseException {
|
|
233
|
+
readonly name: "ServiceUnavailableException";
|
|
234
|
+
readonly $fault: "server";
|
|
235
|
+
Message?: string | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* @internal
|
|
238
|
+
*/
|
|
239
|
+
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* <p>The rate exceeds the limit.</p>
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export declare class ThrottlingException extends __BaseException {
|
|
246
|
+
readonly name: "ThrottlingException";
|
|
247
|
+
readonly $fault: "client";
|
|
248
|
+
Message?: string | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* @internal
|
|
251
|
+
*/
|
|
252
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* <p>A validation error occurred when performing the API request.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
export declare class ValidationException extends __BaseException {
|
|
259
|
+
readonly name: "ValidationException";
|
|
260
|
+
readonly $fault: "client";
|
|
261
|
+
Message?: string | undefined;
|
|
262
|
+
/**
|
|
263
|
+
* @internal
|
|
264
|
+
*/
|
|
265
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export interface DeleteAccountAssociationRequest {
|
|
271
|
+
/**
|
|
272
|
+
* <p>The unique identifier of the account association to be deleted.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
AccountAssociationId: string | undefined;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
export interface GetAccountAssociationRequest {
|
|
281
|
+
/**
|
|
282
|
+
* <p>The unique identifier of the account association to retrieve.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
AccountAssociationId: string | undefined;
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
export interface GetAccountAssociationResponse {
|
|
291
|
+
/**
|
|
292
|
+
* <p>The unique identifier of the retrieved account association.</p>
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
AccountAssociationId: string | undefined;
|
|
296
|
+
/**
|
|
297
|
+
* <p>The current status state for the account association.</p>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
AssociationState: AssociationState | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* <p>The error message explaining the current account association error.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
ErrorMessage?: string | undefined;
|
|
306
|
+
/**
|
|
307
|
+
* <p>The identifier of the connector destination associated with this account association.</p>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
ConnectorDestinationId?: string | undefined;
|
|
311
|
+
/**
|
|
312
|
+
* <p>The name of the account association.</p>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
Name?: string | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* <p>The description of the account association.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
Description?: string | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* <p>The Amazon Resource Name (ARN) of the account association.</p>
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
Arn?: string | undefined;
|
|
326
|
+
/**
|
|
327
|
+
* <p>Third party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication.</p>
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
OAuthAuthorizationUrl: string | undefined;
|
|
331
|
+
/**
|
|
332
|
+
* <p>A set of key/value pairs that are used to manage the account association.</p>
|
|
333
|
+
* @public
|
|
334
|
+
*/
|
|
335
|
+
Tags?: Record<string, string> | undefined;
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
340
|
+
export interface ListAccountAssociationsRequest {
|
|
341
|
+
/**
|
|
342
|
+
* <p>The identifier of the connector destination to filter account associations by.</p>
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
ConnectorDestinationId?: string | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* <p>The maximum number of account associations to return in a single response.</p>
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
MaxResults?: number | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* <p>A token used for pagination of results.</p>
|
|
353
|
+
* @public
|
|
354
|
+
*/
|
|
355
|
+
NextToken?: string | undefined;
|
|
356
|
+
}
|
|
357
|
+
/**
|
|
358
|
+
* @public
|
|
359
|
+
*/
|
|
360
|
+
export interface ListAccountAssociationsResponse {
|
|
361
|
+
/**
|
|
362
|
+
* <p>The list of account associations that match the specified criteria.</p>
|
|
363
|
+
* @public
|
|
364
|
+
*/
|
|
365
|
+
Items?: AccountAssociationItem[] | undefined;
|
|
366
|
+
/**
|
|
367
|
+
* <p>A token used for pagination of results when there are more account associations than can be returned in a single response.</p>
|
|
368
|
+
* @public
|
|
369
|
+
*/
|
|
370
|
+
NextToken?: string | undefined;
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* @public
|
|
374
|
+
*/
|
|
375
|
+
export interface StartAccountAssociationRefreshRequest {
|
|
376
|
+
/**
|
|
377
|
+
* <p>The unique identifier of the account association to refresh.</p>
|
|
378
|
+
* @public
|
|
379
|
+
*/
|
|
380
|
+
AccountAssociationId: string | undefined;
|
|
381
|
+
}
|
|
382
|
+
/**
|
|
383
|
+
* @public
|
|
384
|
+
*/
|
|
385
|
+
export interface StartAccountAssociationRefreshResponse {
|
|
386
|
+
/**
|
|
387
|
+
* <p>Third-party IoT platform OAuth authorization server URL with all required parameters to perform end-user authentication during the refresh process.</p>
|
|
388
|
+
* @public
|
|
389
|
+
*/
|
|
390
|
+
OAuthAuthorizationUrl: string | undefined;
|
|
391
|
+
}
|
|
392
|
+
/**
|
|
393
|
+
* @public
|
|
394
|
+
*/
|
|
395
|
+
export interface UpdateAccountAssociationRequest {
|
|
396
|
+
/**
|
|
397
|
+
* <p>The unique identifier of the account association to update.</p>
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
AccountAssociationId: string | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* <p>The new name to assign to the account association.</p>
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
Name?: string | undefined;
|
|
406
|
+
/**
|
|
407
|
+
* <p>The new description to assign to the account association.</p>
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
Description?: string | undefined;
|
|
411
|
+
}
|
|
412
|
+
/**
|
|
413
|
+
* <p>Configuration settings for proactively refreshing OAuth tokens before they expire.</p>
|
|
414
|
+
* @public
|
|
415
|
+
*/
|
|
416
|
+
export interface ProactiveRefreshTokenRenewal {
|
|
417
|
+
/**
|
|
418
|
+
* <p>Indicates whether proactive refresh token renewal is enabled.</p>
|
|
419
|
+
* @public
|
|
420
|
+
*/
|
|
421
|
+
enabled?: boolean | undefined;
|
|
422
|
+
/**
|
|
423
|
+
* <p>The days before token expiration when the system should attempt to renew the token, specified in days.</p>
|
|
424
|
+
* @public
|
|
425
|
+
*/
|
|
426
|
+
DaysBeforeRenewal?: number | undefined;
|
|
427
|
+
}
|
|
428
|
+
/**
|
|
429
|
+
* @public
|
|
430
|
+
* @enum
|
|
431
|
+
*/
|
|
432
|
+
export declare const TokenEndpointAuthenticationScheme: {
|
|
433
|
+
readonly HTTP_BASIC: "HTTP_BASIC";
|
|
434
|
+
readonly REQUEST_BODY_CREDENTIALS: "REQUEST_BODY_CREDENTIALS";
|
|
435
|
+
};
|
|
436
|
+
/**
|
|
437
|
+
* @public
|
|
438
|
+
*/
|
|
439
|
+
export type TokenEndpointAuthenticationScheme = (typeof TokenEndpointAuthenticationScheme)[keyof typeof TokenEndpointAuthenticationScheme];
|
|
440
|
+
/**
|
|
441
|
+
* <p>Configuration details for OAuth authentication with a third-party service.</p>
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
export interface OAuthConfig {
|
|
445
|
+
/**
|
|
446
|
+
* <p>The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.</p>
|
|
447
|
+
* @public
|
|
448
|
+
*/
|
|
449
|
+
authUrl: string | undefined;
|
|
450
|
+
/**
|
|
451
|
+
* <p>The token URL for the OAuth service, where authorization codes are exchanged for access tokens.</p>
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
tokenUrl: string | undefined;
|
|
455
|
+
/**
|
|
456
|
+
* <p>The OAuth scopes requested during authorization, which define the permissions granted to the application.</p>
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
scope?: string | undefined;
|
|
460
|
+
/**
|
|
461
|
+
* <p>The authentication scheme used when requesting tokens from the token endpoint.</p>
|
|
462
|
+
* @public
|
|
463
|
+
*/
|
|
464
|
+
tokenEndpointAuthenticationScheme: TokenEndpointAuthenticationScheme | undefined;
|
|
465
|
+
/**
|
|
466
|
+
* <p>The URL where users are redirected after completing the OAuth authorization process.</p>
|
|
467
|
+
* @public
|
|
468
|
+
*/
|
|
469
|
+
oAuthCompleteRedirectUrl?: string | undefined;
|
|
470
|
+
/**
|
|
471
|
+
* <p>Configuration for proactively refreshing OAuth tokens before they expire.</p>
|
|
472
|
+
* @public
|
|
473
|
+
*/
|
|
474
|
+
proactiveRefreshTokenRenewal?: ProactiveRefreshTokenRenewal | undefined;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* <p>The authentication configuration details for a connector destination, including OAuth settings and other authentication parameters.</p>
|
|
478
|
+
* @public
|
|
479
|
+
*/
|
|
480
|
+
export interface AuthConfig {
|
|
481
|
+
/**
|
|
482
|
+
* <p>The OAuth configuration settings used for authentication with the third-party service.</p>
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
oAuth?: OAuthConfig | undefined;
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* <p>Structure containing updated OAuth configuration settings.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
export interface OAuthUpdate {
|
|
492
|
+
/**
|
|
493
|
+
* <p>The updated URL where users are redirected after completing the OAuth authorization process.</p>
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
oAuthCompleteRedirectUrl?: string | undefined;
|
|
497
|
+
/**
|
|
498
|
+
* <p>Updated configuration for proactively refreshing OAuth tokens before they expire.</p>
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
501
|
+
proactiveRefreshTokenRenewal?: ProactiveRefreshTokenRenewal | undefined;
|
|
502
|
+
}
|
|
503
|
+
/**
|
|
504
|
+
* <p>The updated authentication configuration details for a connector destination.</p>
|
|
505
|
+
* @public
|
|
506
|
+
*/
|
|
507
|
+
export interface AuthConfigUpdate {
|
|
508
|
+
/**
|
|
509
|
+
* <p>The updated OAuth configuration settings for the authentication configuration.</p>
|
|
510
|
+
* @public
|
|
511
|
+
*/
|
|
512
|
+
oAuthUpdate?: OAuthUpdate | undefined;
|
|
513
|
+
}
|
|
70
514
|
/**
|
|
71
515
|
* @public
|
|
72
516
|
* @enum
|
|
73
517
|
*/
|
|
74
518
|
export declare const AuthMaterialType: {
|
|
519
|
+
readonly CUSTOM_PROTOCOL_QR_BAR_CODE: "CUSTOM_PROTOCOL_QR_BAR_CODE";
|
|
520
|
+
readonly DISCOVERED_DEVICE: "DISCOVERED_DEVICE";
|
|
75
521
|
readonly WIFI_SETUP_QR_BAR_CODE: "WIFI_SETUP_QR_BAR_CODE";
|
|
76
522
|
readonly ZIGBEE_QR_BAR_CODE: "ZIGBEE_QR_BAR_CODE";
|
|
77
523
|
readonly ZWAVE_QR_BAR_CODE: "ZWAVE_QR_BAR_CODE";
|
|
@@ -79,111 +525,401 @@ export declare const AuthMaterialType: {
|
|
|
79
525
|
/**
|
|
80
526
|
* @public
|
|
81
527
|
*/
|
|
82
|
-
export type AuthMaterialType = (typeof AuthMaterialType)[keyof typeof AuthMaterialType];
|
|
528
|
+
export type AuthMaterialType = (typeof AuthMaterialType)[keyof typeof AuthMaterialType];
|
|
529
|
+
/**
|
|
530
|
+
* @public
|
|
531
|
+
* @enum
|
|
532
|
+
*/
|
|
533
|
+
export declare const AuthType: {
|
|
534
|
+
readonly OAUTH: "OAUTH";
|
|
535
|
+
};
|
|
536
|
+
/**
|
|
537
|
+
* @public
|
|
538
|
+
*/
|
|
539
|
+
export type AuthType = (typeof AuthType)[keyof typeof AuthType];
|
|
540
|
+
/**
|
|
541
|
+
* <p>Action for an Amazon Web Services capability, containing the action parameters for control.</p>
|
|
542
|
+
* @public
|
|
543
|
+
*/
|
|
544
|
+
export interface CapabilityAction {
|
|
545
|
+
/**
|
|
546
|
+
* <p>Describe a capability action with a name.</p>
|
|
547
|
+
* @public
|
|
548
|
+
*/
|
|
549
|
+
name: string | undefined;
|
|
550
|
+
/**
|
|
551
|
+
* <p>Describe a capability action with an reference.</p>
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
ref?: string | undefined;
|
|
555
|
+
/**
|
|
556
|
+
* <p>Describe a capability action with an <code>actionTraceId</code> for a response command.</p>
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
actionTraceId?: string | undefined;
|
|
560
|
+
/**
|
|
561
|
+
* <p>Describe a capability action with a capability property.</p>
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
parameters?: __DocumentType | undefined;
|
|
565
|
+
}
|
|
566
|
+
/**
|
|
567
|
+
* <p>The capability used in capability report.</p>
|
|
568
|
+
* @public
|
|
569
|
+
*/
|
|
570
|
+
export interface CapabilityReportCapability {
|
|
571
|
+
/**
|
|
572
|
+
* <p>The id of the schema version.</p>
|
|
573
|
+
* @public
|
|
574
|
+
*/
|
|
575
|
+
id: string | undefined;
|
|
576
|
+
/**
|
|
577
|
+
* <p>The name of the capability.</p>
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
name: string | undefined;
|
|
581
|
+
/**
|
|
582
|
+
* <p>The version of the capability.</p>
|
|
583
|
+
* @public
|
|
584
|
+
*/
|
|
585
|
+
version: string | undefined;
|
|
586
|
+
/**
|
|
587
|
+
* <p>The capability properties used in the capability report.</p>
|
|
588
|
+
* @public
|
|
589
|
+
*/
|
|
590
|
+
properties: string[] | undefined;
|
|
591
|
+
/**
|
|
592
|
+
* <p>The capability actions used in the capability report.</p>
|
|
593
|
+
* @public
|
|
594
|
+
*/
|
|
595
|
+
actions: string[] | undefined;
|
|
596
|
+
/**
|
|
597
|
+
* <p>The capability events used in the capability report.</p>
|
|
598
|
+
* @public
|
|
599
|
+
*/
|
|
600
|
+
events: string[] | undefined;
|
|
601
|
+
}
|
|
602
|
+
/**
|
|
603
|
+
* <p>The endpoint used in the capability report.</p>
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
export interface CapabilityReportEndpoint {
|
|
607
|
+
/**
|
|
608
|
+
* <p>The id of the endpoint used in the capability report.</p>
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
id: string | undefined;
|
|
612
|
+
/**
|
|
613
|
+
* <p>The type of device.</p>
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
deviceTypes: string[] | undefined;
|
|
617
|
+
/**
|
|
618
|
+
* <p>The capabilities used in the capability report.</p>
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
capabilities: CapabilityReportCapability[] | undefined;
|
|
622
|
+
}
|
|
623
|
+
/**
|
|
624
|
+
* <p>Report of all capabilities supported by the device.</p>
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
export interface CapabilityReport {
|
|
628
|
+
/**
|
|
629
|
+
* <p>The version of the capability report.</p>
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
version: string | undefined;
|
|
633
|
+
/**
|
|
634
|
+
* <p>The numeric identifier of the node.</p>
|
|
635
|
+
* @public
|
|
636
|
+
*/
|
|
637
|
+
nodeId?: string | undefined;
|
|
638
|
+
/**
|
|
639
|
+
* <p>The endpoints used in the capability report.</p>
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
endpoints: CapabilityReportEndpoint[] | undefined;
|
|
643
|
+
}
|
|
644
|
+
/**
|
|
645
|
+
* @public
|
|
646
|
+
* @enum
|
|
647
|
+
*/
|
|
648
|
+
export declare const SchemaVersionFormat: {
|
|
649
|
+
readonly AWS: "AWS";
|
|
650
|
+
readonly CONNECTOR: "CONNECTOR";
|
|
651
|
+
readonly ZCL: "ZCL";
|
|
652
|
+
};
|
|
653
|
+
/**
|
|
654
|
+
* @public
|
|
655
|
+
*/
|
|
656
|
+
export type SchemaVersionFormat = (typeof SchemaVersionFormat)[keyof typeof SchemaVersionFormat];
|
|
657
|
+
/**
|
|
658
|
+
* <p>Structure representing a capability schema item that defines the functionality and features supported by a managed thing.</p>
|
|
659
|
+
* @public
|
|
660
|
+
*/
|
|
661
|
+
export interface CapabilitySchemaItem {
|
|
662
|
+
/**
|
|
663
|
+
* <p>The format of the capability schema, which defines how the schema is structured and interpreted.</p>
|
|
664
|
+
* @public
|
|
665
|
+
*/
|
|
666
|
+
Format: SchemaVersionFormat | undefined;
|
|
667
|
+
/**
|
|
668
|
+
* <p>The unique identifier of the capability defined in the schema.</p>
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
671
|
+
CapabilityId: string | undefined;
|
|
672
|
+
/**
|
|
673
|
+
* <p>The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem.</p>
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
ExtrinsicId: string | undefined;
|
|
677
|
+
/**
|
|
678
|
+
* <p>The version of the external capability definition, used to track compatibility with external systems.</p>
|
|
679
|
+
* @public
|
|
680
|
+
*/
|
|
681
|
+
ExtrinsicVersion: number | undefined;
|
|
682
|
+
/**
|
|
683
|
+
* <p>The actual schema definition that describes the capability's properties, actions, and events.</p>
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
Schema: __DocumentType | undefined;
|
|
687
|
+
}
|
|
688
|
+
/**
|
|
689
|
+
* <p>Configuration details for an AWS Lambda function used as an endpoint for a cloud connector.</p>
|
|
690
|
+
* @public
|
|
691
|
+
*/
|
|
692
|
+
export interface LambdaConfig {
|
|
693
|
+
/**
|
|
694
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function used as an endpoint.</p>
|
|
695
|
+
* @public
|
|
696
|
+
*/
|
|
697
|
+
arn: string | undefined;
|
|
698
|
+
}
|
|
699
|
+
/**
|
|
700
|
+
* <p>The configuration details for an endpoint, which defines how to connect to and communicate with external services.</p>
|
|
701
|
+
* @public
|
|
702
|
+
*/
|
|
703
|
+
export interface EndpointConfig {
|
|
704
|
+
/**
|
|
705
|
+
* <p>The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function.</p>
|
|
706
|
+
* @public
|
|
707
|
+
*/
|
|
708
|
+
lambda?: LambdaConfig | undefined;
|
|
709
|
+
}
|
|
710
|
+
/**
|
|
711
|
+
* @public
|
|
712
|
+
* @enum
|
|
713
|
+
*/
|
|
714
|
+
export declare const EndpointType: {
|
|
715
|
+
readonly LAMBDA: "LAMBDA";
|
|
716
|
+
};
|
|
717
|
+
/**
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
|
|
721
|
+
/**
|
|
722
|
+
* @public
|
|
723
|
+
*/
|
|
724
|
+
export interface CreateCloudConnectorRequest {
|
|
725
|
+
/**
|
|
726
|
+
* <p>The display name of the C2C connector.</p>
|
|
727
|
+
* @public
|
|
728
|
+
*/
|
|
729
|
+
Name: string | undefined;
|
|
730
|
+
/**
|
|
731
|
+
* <p>The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.</p>
|
|
732
|
+
* @public
|
|
733
|
+
*/
|
|
734
|
+
EndpointConfig: EndpointConfig | undefined;
|
|
735
|
+
/**
|
|
736
|
+
* <p>A description of the C2C connector.</p>
|
|
737
|
+
* @public
|
|
738
|
+
*/
|
|
739
|
+
Description?: string | undefined;
|
|
740
|
+
/**
|
|
741
|
+
* <p>The type of endpoint used for the cloud connector, which defines how the connector communicates with external services.</p>
|
|
742
|
+
* @public
|
|
743
|
+
*/
|
|
744
|
+
EndpointType?: EndpointType | undefined;
|
|
745
|
+
/**
|
|
746
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
747
|
+
* @public
|
|
748
|
+
*/
|
|
749
|
+
ClientToken?: string | undefined;
|
|
750
|
+
}
|
|
751
|
+
/**
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
export interface CreateCloudConnectorResponse {
|
|
755
|
+
/**
|
|
756
|
+
* <p>The unique identifier assigned to the newly created cloud connector.</p>
|
|
757
|
+
* @public
|
|
758
|
+
*/
|
|
759
|
+
Id?: string | undefined;
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
export interface DeleteCloudConnectorRequest {
|
|
765
|
+
/**
|
|
766
|
+
* <p>The identifier of the cloud connector.</p>
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
769
|
+
Identifier: string | undefined;
|
|
770
|
+
}
|
|
771
|
+
/**
|
|
772
|
+
* @public
|
|
773
|
+
*/
|
|
774
|
+
export interface GetCloudConnectorRequest {
|
|
775
|
+
/**
|
|
776
|
+
* <p>The identifier of the C2C connector.</p>
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
Identifier: string | undefined;
|
|
780
|
+
}
|
|
781
|
+
/**
|
|
782
|
+
* @public
|
|
783
|
+
* @enum
|
|
784
|
+
*/
|
|
785
|
+
export declare const CloudConnectorType: {
|
|
786
|
+
readonly LISTED: "LISTED";
|
|
787
|
+
readonly UNLISTED: "UNLISTED";
|
|
788
|
+
};
|
|
789
|
+
/**
|
|
790
|
+
* @public
|
|
791
|
+
*/
|
|
792
|
+
export type CloudConnectorType = (typeof CloudConnectorType)[keyof typeof CloudConnectorType];
|
|
83
793
|
/**
|
|
84
|
-
* <p>Action for an Amazon Web Services capability, containing the action parameters for control.</p>
|
|
85
794
|
* @public
|
|
86
795
|
*/
|
|
87
|
-
export interface
|
|
796
|
+
export interface GetCloudConnectorResponse {
|
|
88
797
|
/**
|
|
89
|
-
* <p>
|
|
798
|
+
* <p>The display name of the C2C connector.</p>
|
|
90
799
|
* @public
|
|
91
800
|
*/
|
|
92
|
-
|
|
801
|
+
Name: string | undefined;
|
|
93
802
|
/**
|
|
94
|
-
* <p>
|
|
803
|
+
* <p>The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.</p>
|
|
95
804
|
* @public
|
|
96
805
|
*/
|
|
97
|
-
|
|
806
|
+
EndpointConfig: EndpointConfig | undefined;
|
|
98
807
|
/**
|
|
99
|
-
* <p>
|
|
100
|
-
* command.</p>
|
|
808
|
+
* <p>A description of the C2C connector.</p>
|
|
101
809
|
* @public
|
|
102
810
|
*/
|
|
103
|
-
|
|
811
|
+
Description?: string | undefined;
|
|
104
812
|
/**
|
|
105
|
-
* <p>
|
|
813
|
+
* <p>The type of endpoint used for the cloud connector, which defines how the connector communicates with external services.</p>
|
|
106
814
|
* @public
|
|
107
815
|
*/
|
|
108
|
-
|
|
816
|
+
EndpointType?: EndpointType | undefined;
|
|
817
|
+
/**
|
|
818
|
+
* <p>The unique identifier of the cloud connector.</p>
|
|
819
|
+
* @public
|
|
820
|
+
*/
|
|
821
|
+
Id?: string | undefined;
|
|
822
|
+
/**
|
|
823
|
+
* <p>The type of cloud connector created.</p>
|
|
824
|
+
* @public
|
|
825
|
+
*/
|
|
826
|
+
Type?: CloudConnectorType | undefined;
|
|
109
827
|
}
|
|
110
828
|
/**
|
|
111
|
-
* <p>The capability used in capability report.</p>
|
|
112
829
|
* @public
|
|
113
830
|
*/
|
|
114
|
-
export interface
|
|
831
|
+
export interface ListCloudConnectorsRequest {
|
|
115
832
|
/**
|
|
116
|
-
* <p>The
|
|
833
|
+
* <p>The type of cloud connectors to filter by when listing available connectors.</p>
|
|
117
834
|
* @public
|
|
118
835
|
*/
|
|
119
|
-
|
|
836
|
+
Type?: CloudConnectorType | undefined;
|
|
120
837
|
/**
|
|
121
|
-
* <p>The
|
|
838
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by.</p>
|
|
122
839
|
* @public
|
|
123
840
|
*/
|
|
124
|
-
|
|
841
|
+
LambdaArn?: string | undefined;
|
|
125
842
|
/**
|
|
126
|
-
* <p>The
|
|
843
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
127
844
|
* @public
|
|
128
845
|
*/
|
|
129
|
-
|
|
846
|
+
MaxResults?: number | undefined;
|
|
130
847
|
/**
|
|
131
|
-
* <p>
|
|
848
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
132
849
|
* @public
|
|
133
850
|
*/
|
|
134
|
-
|
|
851
|
+
NextToken?: string | undefined;
|
|
852
|
+
}
|
|
853
|
+
/**
|
|
854
|
+
* <p>Structure describing a connector.</p>
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
export interface ConnectorItem {
|
|
135
858
|
/**
|
|
136
|
-
* <p>The
|
|
859
|
+
* <p>The display name of the C2C connector.</p>
|
|
137
860
|
* @public
|
|
138
861
|
*/
|
|
139
|
-
|
|
862
|
+
Name: string | undefined;
|
|
140
863
|
/**
|
|
141
|
-
* <p>The
|
|
864
|
+
* <p>The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.</p>
|
|
142
865
|
* @public
|
|
143
866
|
*/
|
|
144
|
-
|
|
867
|
+
EndpointConfig: EndpointConfig | undefined;
|
|
868
|
+
/**
|
|
869
|
+
* <p>A description of the C2C connector.</p>
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
Description?: string | undefined;
|
|
873
|
+
/**
|
|
874
|
+
* <p>The type of endpoint used for the C2C connector.</p>
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
EndpointType?: EndpointType | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* <p>The identifier of the C2C connector.</p>
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
Id?: string | undefined;
|
|
883
|
+
/**
|
|
884
|
+
* <p>The type of cloud connector created.</p>
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
Type?: CloudConnectorType | undefined;
|
|
145
888
|
}
|
|
146
889
|
/**
|
|
147
|
-
* <p>The endpoint used in the capability report.</p>
|
|
148
890
|
* @public
|
|
149
891
|
*/
|
|
150
|
-
export interface
|
|
151
|
-
/**
|
|
152
|
-
* <p>The id of the endpoint used in the capability report.</p>
|
|
153
|
-
* @public
|
|
154
|
-
*/
|
|
155
|
-
id: string | undefined;
|
|
892
|
+
export interface ListCloudConnectorsResponse {
|
|
156
893
|
/**
|
|
157
|
-
* <p>The
|
|
894
|
+
* <p>The list of connectors.</p>
|
|
158
895
|
* @public
|
|
159
896
|
*/
|
|
160
|
-
|
|
897
|
+
Items?: ConnectorItem[] | undefined;
|
|
161
898
|
/**
|
|
162
|
-
* <p>
|
|
899
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
163
900
|
* @public
|
|
164
901
|
*/
|
|
165
|
-
|
|
902
|
+
NextToken?: string | undefined;
|
|
166
903
|
}
|
|
167
904
|
/**
|
|
168
|
-
* <p>Report of all capabilities supported by the device.</p>
|
|
169
905
|
* @public
|
|
170
906
|
*/
|
|
171
|
-
export interface
|
|
907
|
+
export interface UpdateCloudConnectorRequest {
|
|
172
908
|
/**
|
|
173
|
-
* <p>The
|
|
909
|
+
* <p>The unique identifier of the cloud connector to update.</p>
|
|
174
910
|
* @public
|
|
175
911
|
*/
|
|
176
|
-
|
|
912
|
+
Identifier: string | undefined;
|
|
177
913
|
/**
|
|
178
|
-
* <p>The
|
|
914
|
+
* <p>The new display name to assign to the cloud connector.</p>
|
|
179
915
|
* @public
|
|
180
916
|
*/
|
|
181
|
-
|
|
917
|
+
Name?: string | undefined;
|
|
182
918
|
/**
|
|
183
|
-
* <p>The
|
|
919
|
+
* <p>The new description to assign to the cloud connector.</p>
|
|
184
920
|
* @public
|
|
185
921
|
*/
|
|
186
|
-
|
|
922
|
+
Description?: string | undefined;
|
|
187
923
|
}
|
|
188
924
|
/**
|
|
189
925
|
* <p>The command capabilities added for the managed thing</p>
|
|
@@ -222,8 +958,7 @@ export interface CommandEndpoint {
|
|
|
222
958
|
*/
|
|
223
959
|
endpointId: string | undefined;
|
|
224
960
|
/**
|
|
225
|
-
* <p>Describe the endpoint with an id, a name, and the relevant capabilities for sending
|
|
226
|
-
* commands.</p>
|
|
961
|
+
* <p>Describe the endpoint with an id, a name, and the relevant capabilities for sending commands.</p>
|
|
227
962
|
* @public
|
|
228
963
|
*/
|
|
229
964
|
capabilities: CommandCapability[] | undefined;
|
|
@@ -239,8 +974,7 @@ export interface ConfigurationError {
|
|
|
239
974
|
*/
|
|
240
975
|
code?: string | undefined;
|
|
241
976
|
/**
|
|
242
|
-
* <p>The error message returned when the default encryption configuration update
|
|
243
|
-
* fails.</p>
|
|
977
|
+
* <p>The error message returned when the default encryption configuration update fails.</p>
|
|
244
978
|
* @public
|
|
245
979
|
*/
|
|
246
980
|
message?: string | undefined;
|
|
@@ -275,18 +1009,246 @@ export interface ConfigurationStatus {
|
|
|
275
1009
|
state: ConfigurationState | undefined;
|
|
276
1010
|
}
|
|
277
1011
|
/**
|
|
278
|
-
* <p>
|
|
1012
|
+
* <p>Structure containing summary information about a connector destination, which defines how a cloud-to-cloud connector connects to a customer's AWS account.</p>
|
|
1013
|
+
* @public
|
|
1014
|
+
*/
|
|
1015
|
+
export interface ConnectorDestinationSummary {
|
|
1016
|
+
/**
|
|
1017
|
+
* <p>The display name of the connector destination.</p>
|
|
1018
|
+
* @public
|
|
1019
|
+
*/
|
|
1020
|
+
Name?: string | undefined;
|
|
1021
|
+
/**
|
|
1022
|
+
* <p>A description of the connector destination.</p>
|
|
1023
|
+
* @public
|
|
1024
|
+
*/
|
|
1025
|
+
Description?: string | undefined;
|
|
1026
|
+
/**
|
|
1027
|
+
* <p>The identifier of the cloud connector associated with this connector destination.</p>
|
|
1028
|
+
* @public
|
|
1029
|
+
*/
|
|
1030
|
+
CloudConnectorId?: string | undefined;
|
|
1031
|
+
/**
|
|
1032
|
+
* <p>The unique identifier of the connector destination.</p>
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
Id?: string | undefined;
|
|
1036
|
+
}
|
|
1037
|
+
/**
|
|
1038
|
+
* <p>Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.</p>
|
|
1039
|
+
* @public
|
|
1040
|
+
*/
|
|
1041
|
+
export interface SecretsManager {
|
|
1042
|
+
/**
|
|
1043
|
+
* <p>The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.</p>
|
|
1044
|
+
* @public
|
|
1045
|
+
*/
|
|
1046
|
+
arn: string | undefined;
|
|
1047
|
+
/**
|
|
1048
|
+
* <p>The version ID of the AWS Secrets Manager secret.</p>
|
|
1049
|
+
* @public
|
|
1050
|
+
*/
|
|
1051
|
+
versionId: string | undefined;
|
|
1052
|
+
}
|
|
1053
|
+
/**
|
|
1054
|
+
* @public
|
|
1055
|
+
*/
|
|
1056
|
+
export interface CreateConnectorDestinationRequest {
|
|
1057
|
+
/**
|
|
1058
|
+
* <p>The display name of the connector destination.</p>
|
|
1059
|
+
* @public
|
|
1060
|
+
*/
|
|
1061
|
+
Name?: string | undefined;
|
|
1062
|
+
/**
|
|
1063
|
+
* <p>A description of the connector destination.</p>
|
|
1064
|
+
* @public
|
|
1065
|
+
*/
|
|
1066
|
+
Description?: string | undefined;
|
|
1067
|
+
/**
|
|
1068
|
+
* <p>The identifier of the C2C connector.</p>
|
|
1069
|
+
* @public
|
|
1070
|
+
*/
|
|
1071
|
+
CloudConnectorId: string | undefined;
|
|
1072
|
+
/**
|
|
1073
|
+
* <p>The authentication type used for the connector destination, which determines how credentials and access are managed.</p>
|
|
1074
|
+
* @public
|
|
1075
|
+
*/
|
|
1076
|
+
AuthType: AuthType | undefined;
|
|
1077
|
+
/**
|
|
1078
|
+
* <p>The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.</p>
|
|
1079
|
+
* @public
|
|
1080
|
+
*/
|
|
1081
|
+
AuthConfig: AuthConfig | undefined;
|
|
1082
|
+
/**
|
|
1083
|
+
* <p>The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.</p>
|
|
1084
|
+
* @public
|
|
1085
|
+
*/
|
|
1086
|
+
SecretsManager: SecretsManager | undefined;
|
|
1087
|
+
/**
|
|
1088
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
1089
|
+
* @public
|
|
1090
|
+
*/
|
|
1091
|
+
ClientToken?: string | undefined;
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* @public
|
|
1095
|
+
*/
|
|
1096
|
+
export interface CreateConnectorDestinationResponse {
|
|
1097
|
+
/**
|
|
1098
|
+
* <p>The identifier of the C2C connector destination creation request.</p>
|
|
1099
|
+
* @public
|
|
1100
|
+
*/
|
|
1101
|
+
Id?: string | undefined;
|
|
1102
|
+
}
|
|
1103
|
+
/**
|
|
1104
|
+
* @public
|
|
1105
|
+
*/
|
|
1106
|
+
export interface DeleteConnectorDestinationRequest {
|
|
1107
|
+
/**
|
|
1108
|
+
* <p>The identifier of the connector destination.</p>
|
|
1109
|
+
* @public
|
|
1110
|
+
*/
|
|
1111
|
+
Identifier: string | undefined;
|
|
1112
|
+
}
|
|
1113
|
+
/**
|
|
1114
|
+
* @public
|
|
1115
|
+
*/
|
|
1116
|
+
export interface GetConnectorDestinationRequest {
|
|
1117
|
+
/**
|
|
1118
|
+
* <p>The identifier of the C2C connector destination.</p>
|
|
1119
|
+
* @public
|
|
1120
|
+
*/
|
|
1121
|
+
Identifier: string | undefined;
|
|
1122
|
+
}
|
|
1123
|
+
/**
|
|
1124
|
+
* @public
|
|
1125
|
+
*/
|
|
1126
|
+
export interface GetConnectorDestinationResponse {
|
|
1127
|
+
/**
|
|
1128
|
+
* <p>The display name of the connector destination.</p>
|
|
1129
|
+
* @public
|
|
1130
|
+
*/
|
|
1131
|
+
Name?: string | undefined;
|
|
1132
|
+
/**
|
|
1133
|
+
* <p>A description of the connector destination.</p>
|
|
1134
|
+
* @public
|
|
1135
|
+
*/
|
|
1136
|
+
Description?: string | undefined;
|
|
1137
|
+
/**
|
|
1138
|
+
* <p>The identifier of the C2C connector.</p>
|
|
1139
|
+
* @public
|
|
1140
|
+
*/
|
|
1141
|
+
CloudConnectorId?: string | undefined;
|
|
1142
|
+
/**
|
|
1143
|
+
* <p>The unique identifier of the connector destination.</p>
|
|
1144
|
+
* @public
|
|
1145
|
+
*/
|
|
1146
|
+
Id?: string | undefined;
|
|
1147
|
+
/**
|
|
1148
|
+
* <p>The authentication type used for the connector destination, which determines how credentials and access are managed.</p>
|
|
1149
|
+
* @public
|
|
1150
|
+
*/
|
|
1151
|
+
AuthType?: AuthType | undefined;
|
|
1152
|
+
/**
|
|
1153
|
+
* <p>The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.</p>
|
|
1154
|
+
* @public
|
|
1155
|
+
*/
|
|
1156
|
+
AuthConfig?: AuthConfig | undefined;
|
|
1157
|
+
/**
|
|
1158
|
+
* <p>The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.</p>
|
|
1159
|
+
* @public
|
|
1160
|
+
*/
|
|
1161
|
+
SecretsManager?: SecretsManager | undefined;
|
|
1162
|
+
/**
|
|
1163
|
+
* <p>The URL where users are redirected after completing the OAuth authorization process for the connector destination.</p>
|
|
1164
|
+
* @public
|
|
1165
|
+
*/
|
|
1166
|
+
OAuthCompleteRedirectUrl?: string | undefined;
|
|
1167
|
+
}
|
|
1168
|
+
/**
|
|
1169
|
+
* @public
|
|
1170
|
+
*/
|
|
1171
|
+
export interface ListConnectorDestinationsRequest {
|
|
1172
|
+
/**
|
|
1173
|
+
* <p>The identifier of the cloud connector to filter connector destinations by.</p>
|
|
1174
|
+
* @public
|
|
1175
|
+
*/
|
|
1176
|
+
CloudConnectorId?: string | undefined;
|
|
1177
|
+
/**
|
|
1178
|
+
* <p>A token used for pagination of results.</p>
|
|
1179
|
+
* @public
|
|
1180
|
+
*/
|
|
1181
|
+
NextToken?: string | undefined;
|
|
1182
|
+
/**
|
|
1183
|
+
* <p>The maximum number of connector destinations to return in a single response.</p>
|
|
1184
|
+
* @public
|
|
1185
|
+
*/
|
|
1186
|
+
MaxResults?: number | undefined;
|
|
1187
|
+
}
|
|
1188
|
+
/**
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
export interface ListConnectorDestinationsResponse {
|
|
1192
|
+
/**
|
|
1193
|
+
* <p>The list of connector destinations that match the specified criteria.</p>
|
|
1194
|
+
* @public
|
|
1195
|
+
*/
|
|
1196
|
+
ConnectorDestinationList?: ConnectorDestinationSummary[] | undefined;
|
|
1197
|
+
/**
|
|
1198
|
+
* <p>A token used for pagination of results when there are more connector destinations than can be returned in a single response.</p>
|
|
1199
|
+
* @public
|
|
1200
|
+
*/
|
|
1201
|
+
NextToken?: string | undefined;
|
|
1202
|
+
}
|
|
1203
|
+
/**
|
|
1204
|
+
* @public
|
|
1205
|
+
*/
|
|
1206
|
+
export interface UpdateConnectorDestinationRequest {
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>The unique identifier of the connector destination to update.</p>
|
|
1209
|
+
* @public
|
|
1210
|
+
*/
|
|
1211
|
+
Identifier: string | undefined;
|
|
1212
|
+
/**
|
|
1213
|
+
* <p>The new description to assign to the connector destination.</p>
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
Description?: string | undefined;
|
|
1217
|
+
/**
|
|
1218
|
+
* <p>The new display name to assign to the connector destination.</p>
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
Name?: string | undefined;
|
|
1222
|
+
/**
|
|
1223
|
+
* <p>The new authentication type to use for the connector destination.</p>
|
|
1224
|
+
* @public
|
|
1225
|
+
*/
|
|
1226
|
+
AuthType?: AuthType | undefined;
|
|
1227
|
+
/**
|
|
1228
|
+
* <p>The updated authentication configuration details for the connector destination.</p>
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
AuthConfig?: AuthConfigUpdate | undefined;
|
|
1232
|
+
/**
|
|
1233
|
+
* <p>The updated AWS Secrets Manager configuration for the connector destination.</p>
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
SecretsManager?: SecretsManager | undefined;
|
|
1237
|
+
}
|
|
1238
|
+
/**
|
|
1239
|
+
* @public
|
|
1240
|
+
* @enum
|
|
1241
|
+
*/
|
|
1242
|
+
export declare const ConnectorEventOperation: {
|
|
1243
|
+
readonly DEVICE_COMMAND_REQUEST: "DEVICE_COMMAND_REQUEST";
|
|
1244
|
+
readonly DEVICE_COMMAND_RESPONSE: "DEVICE_COMMAND_RESPONSE";
|
|
1245
|
+
readonly DEVICE_DISCOVERY: "DEVICE_DISCOVERY";
|
|
1246
|
+
readonly DEVICE_EVENT: "DEVICE_EVENT";
|
|
1247
|
+
};
|
|
1248
|
+
/**
|
|
279
1249
|
* @public
|
|
280
1250
|
*/
|
|
281
|
-
export
|
|
282
|
-
readonly name: "ConflictException";
|
|
283
|
-
readonly $fault: "client";
|
|
284
|
-
Message?: string | undefined;
|
|
285
|
-
/**
|
|
286
|
-
* @internal
|
|
287
|
-
*/
|
|
288
|
-
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
289
|
-
}
|
|
1251
|
+
export type ConnectorEventOperation = (typeof ConnectorEventOperation)[keyof typeof ConnectorEventOperation];
|
|
290
1252
|
/**
|
|
291
1253
|
* @public
|
|
292
1254
|
*/
|
|
@@ -297,9 +1259,7 @@ export interface CreateCredentialLockerRequest {
|
|
|
297
1259
|
*/
|
|
298
1260
|
Name?: string | undefined;
|
|
299
1261
|
/**
|
|
300
|
-
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
301
|
-
* the same client token and parameters, then the retry attempt will succeed without
|
|
302
|
-
* performing any further actions.</p>
|
|
1262
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
303
1263
|
* @public
|
|
304
1264
|
*/
|
|
305
1265
|
ClientToken?: string | undefined;
|
|
@@ -329,20 +1289,6 @@ export interface CreateCredentialLockerResponse {
|
|
|
329
1289
|
*/
|
|
330
1290
|
CreatedAt?: Date | undefined;
|
|
331
1291
|
}
|
|
332
|
-
/**
|
|
333
|
-
* <p>Internal error from the service that indicates an unexpected error or that the service
|
|
334
|
-
* is unavailable.</p>
|
|
335
|
-
* @public
|
|
336
|
-
*/
|
|
337
|
-
export declare class InternalServerException extends __BaseException {
|
|
338
|
-
readonly name: "InternalServerException";
|
|
339
|
-
readonly $fault: "server";
|
|
340
|
-
Message?: string | undefined;
|
|
341
|
-
/**
|
|
342
|
-
* @internal
|
|
343
|
-
*/
|
|
344
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
345
|
-
}
|
|
346
1292
|
/**
|
|
347
1293
|
* <p>The service quota has been exceeded for this request.</p>
|
|
348
1294
|
* @public
|
|
@@ -356,45 +1302,6 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
356
1302
|
*/
|
|
357
1303
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
358
1304
|
}
|
|
359
|
-
/**
|
|
360
|
-
* <p>The service is temporarily unavailable.</p>
|
|
361
|
-
* @public
|
|
362
|
-
*/
|
|
363
|
-
export declare class ServiceUnavailableException extends __BaseException {
|
|
364
|
-
readonly name: "ServiceUnavailableException";
|
|
365
|
-
readonly $fault: "server";
|
|
366
|
-
Message?: string | undefined;
|
|
367
|
-
/**
|
|
368
|
-
* @internal
|
|
369
|
-
*/
|
|
370
|
-
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
371
|
-
}
|
|
372
|
-
/**
|
|
373
|
-
* <p>The rate exceeds the limit.</p>
|
|
374
|
-
* @public
|
|
375
|
-
*/
|
|
376
|
-
export declare class ThrottlingException extends __BaseException {
|
|
377
|
-
readonly name: "ThrottlingException";
|
|
378
|
-
readonly $fault: "client";
|
|
379
|
-
Message?: string | undefined;
|
|
380
|
-
/**
|
|
381
|
-
* @internal
|
|
382
|
-
*/
|
|
383
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
384
|
-
}
|
|
385
|
-
/**
|
|
386
|
-
* <p>A validation error occurred when performing the API request.</p>
|
|
387
|
-
* @public
|
|
388
|
-
*/
|
|
389
|
-
export declare class ValidationException extends __BaseException {
|
|
390
|
-
readonly name: "ValidationException";
|
|
391
|
-
readonly $fault: "client";
|
|
392
|
-
Message?: string | undefined;
|
|
393
|
-
/**
|
|
394
|
-
* @internal
|
|
395
|
-
*/
|
|
396
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
397
|
-
}
|
|
398
1305
|
/**
|
|
399
1306
|
* @public
|
|
400
1307
|
* @enum
|
|
@@ -431,9 +1338,7 @@ export interface CreateDestinationRequest {
|
|
|
431
1338
|
*/
|
|
432
1339
|
RoleArn: string | undefined;
|
|
433
1340
|
/**
|
|
434
|
-
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
435
|
-
* the same client token and parameters, then the retry attempt will succeed without
|
|
436
|
-
* performing any further actions.</p>
|
|
1341
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
437
1342
|
* @public
|
|
438
1343
|
*/
|
|
439
1344
|
ClientToken?: string | undefined;
|
|
@@ -444,6 +1349,8 @@ export interface CreateDestinationRequest {
|
|
|
444
1349
|
Description?: string | undefined;
|
|
445
1350
|
/**
|
|
446
1351
|
* <p>A set of key/value pairs that are used to manage the destination.</p>
|
|
1352
|
+
*
|
|
1353
|
+
* @deprecated
|
|
447
1354
|
* @public
|
|
448
1355
|
*/
|
|
449
1356
|
Tags?: Record<string, string> | undefined;
|
|
@@ -492,9 +1399,7 @@ export interface CreateEventLogConfigurationRequest {
|
|
|
492
1399
|
*/
|
|
493
1400
|
EventLogLevel: LogLevel | undefined;
|
|
494
1401
|
/**
|
|
495
|
-
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
496
|
-
* the same client token and parameters, then the retry attempt will succeed without
|
|
497
|
-
* performing any further actions.</p>
|
|
1402
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
498
1403
|
* @public
|
|
499
1404
|
*/
|
|
500
1405
|
ClientToken?: string | undefined;
|
|
@@ -526,14 +1431,12 @@ export type Role = (typeof Role)[keyof typeof Role];
|
|
|
526
1431
|
*/
|
|
527
1432
|
export interface CreateManagedThingRequest {
|
|
528
1433
|
/**
|
|
529
|
-
* <p>The type of device used. This will be the hub controller, cloud device, or AWS IoT
|
|
530
|
-
* device.</p>
|
|
1434
|
+
* <p>The type of device used. This will be the hub controller, cloud device, or AWS IoT device.</p>
|
|
531
1435
|
* @public
|
|
532
1436
|
*/
|
|
533
1437
|
Role: Role | undefined;
|
|
534
1438
|
/**
|
|
535
|
-
* <p>Owner of the device, usually an indication of whom the device belongs to. This value
|
|
536
|
-
* should not contain personal identifiable information.</p>
|
|
1439
|
+
* <p>Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.</p>
|
|
537
1440
|
* @public
|
|
538
1441
|
*/
|
|
539
1442
|
Owner?: string | undefined;
|
|
@@ -543,8 +1446,7 @@ export interface CreateManagedThingRequest {
|
|
|
543
1446
|
*/
|
|
544
1447
|
CredentialLockerId?: string | undefined;
|
|
545
1448
|
/**
|
|
546
|
-
* <p>The authentication material defining the device connectivity setup requests. The
|
|
547
|
-
* authentication materials used are the device bar code.</p>
|
|
1449
|
+
* <p>The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.</p>
|
|
548
1450
|
* @public
|
|
549
1451
|
*/
|
|
550
1452
|
AuthenticationMaterial: string | undefined;
|
|
@@ -578,15 +1480,18 @@ export interface CreateManagedThingRequest {
|
|
|
578
1480
|
* @public
|
|
579
1481
|
*/
|
|
580
1482
|
CapabilityReport?: CapabilityReport | undefined;
|
|
1483
|
+
/**
|
|
1484
|
+
* <p>The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.</p>
|
|
1485
|
+
* @public
|
|
1486
|
+
*/
|
|
1487
|
+
CapabilitySchemas?: CapabilitySchemaItem[] | undefined;
|
|
581
1488
|
/**
|
|
582
1489
|
* <p>The capabilities of the device such as light bulb.</p>
|
|
583
1490
|
* @public
|
|
584
1491
|
*/
|
|
585
1492
|
Capabilities?: string | undefined;
|
|
586
1493
|
/**
|
|
587
|
-
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
588
|
-
* the same client token and parameters, then the retry attempt will succeed without
|
|
589
|
-
* performing any further actions.</p>
|
|
1494
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
590
1495
|
* @public
|
|
591
1496
|
*/
|
|
592
1497
|
ClientToken?: string | undefined;
|
|
@@ -601,7 +1506,7 @@ export interface CreateManagedThingRequest {
|
|
|
601
1506
|
*/
|
|
602
1507
|
Tags?: Record<string, string> | undefined;
|
|
603
1508
|
/**
|
|
604
|
-
* <p>The metadata for the managed thing.</p>
|
|
1509
|
+
* <p>The metadata for the managed thing.</p> <note> <p>The <code>managedThing</code> <code>metadata</code> parameter is used for associating attributes with a <code>managedThing</code> that can be used for grouping over-the-air (OTA) tasks. Name value pairs in <code>metadata</code> can be used in the <code>OtaTargetQueryString</code> parameter for the <code>CreateOtaTask</code> API operation.</p> </note>
|
|
605
1510
|
* @public
|
|
606
1511
|
*/
|
|
607
1512
|
MetaData?: Record<string, string> | undefined;
|
|
@@ -626,19 +1531,6 @@ export interface CreateManagedThingResponse {
|
|
|
626
1531
|
*/
|
|
627
1532
|
CreatedAt?: Date | undefined;
|
|
628
1533
|
}
|
|
629
|
-
/**
|
|
630
|
-
* <p>The specified resource does not exist.</p>
|
|
631
|
-
* @public
|
|
632
|
-
*/
|
|
633
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
634
|
-
readonly name: "ResourceNotFoundException";
|
|
635
|
-
readonly $fault: "client";
|
|
636
|
-
Message?: string | undefined;
|
|
637
|
-
/**
|
|
638
|
-
* @internal
|
|
639
|
-
*/
|
|
640
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
641
|
-
}
|
|
642
1534
|
/**
|
|
643
1535
|
* <p>You are not authorized to perform this operation.</p>
|
|
644
1536
|
* @public
|
|
@@ -657,10 +1549,12 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
657
1549
|
* @enum
|
|
658
1550
|
*/
|
|
659
1551
|
export declare const EventType: {
|
|
1552
|
+
readonly ACCOUNT_ASSOCIATION: "ACCOUNT_ASSOCIATION";
|
|
660
1553
|
readonly CONNECTOR_ASSOCIATION: "CONNECTOR_ASSOCIATION";
|
|
661
1554
|
readonly CONNECTOR_ERROR_REPORT: "CONNECTOR_ERROR_REPORT";
|
|
662
1555
|
readonly DEVICE_COMMAND: "DEVICE_COMMAND";
|
|
663
1556
|
readonly DEVICE_COMMAND_REQUEST: "DEVICE_COMMAND_REQUEST";
|
|
1557
|
+
readonly DEVICE_DISCOVERY_STATUS: "DEVICE_DISCOVERY_STATUS";
|
|
664
1558
|
readonly DEVICE_EVENT: "DEVICE_EVENT";
|
|
665
1559
|
readonly DEVICE_LIFE_CYCLE: "DEVICE_LIFE_CYCLE";
|
|
666
1560
|
readonly DEVICE_OTA: "DEVICE_OTA";
|
|
@@ -675,8 +1569,7 @@ export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
|
675
1569
|
*/
|
|
676
1570
|
export interface CreateNotificationConfigurationRequest {
|
|
677
1571
|
/**
|
|
678
|
-
* <p>The type of event triggering a device notification to the customer-managed
|
|
679
|
-
* destination.</p>
|
|
1572
|
+
* <p>The type of event triggering a device notification to the customer-managed destination.</p>
|
|
680
1573
|
* @public
|
|
681
1574
|
*/
|
|
682
1575
|
EventType: EventType | undefined;
|
|
@@ -686,14 +1579,14 @@ export interface CreateNotificationConfigurationRequest {
|
|
|
686
1579
|
*/
|
|
687
1580
|
DestinationName: string | undefined;
|
|
688
1581
|
/**
|
|
689
|
-
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
690
|
-
* the same client token and parameters, then the retry attempt will succeed without
|
|
691
|
-
* performing any further actions.</p>
|
|
1582
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
692
1583
|
* @public
|
|
693
1584
|
*/
|
|
694
1585
|
ClientToken?: string | undefined;
|
|
695
1586
|
/**
|
|
696
1587
|
* <p>A set of key/value pairs that are used to manage the notification configuration.</p>
|
|
1588
|
+
*
|
|
1589
|
+
* @deprecated
|
|
697
1590
|
* @public
|
|
698
1591
|
*/
|
|
699
1592
|
Tags?: Record<string, string> | undefined;
|
|
@@ -703,8 +1596,7 @@ export interface CreateNotificationConfigurationRequest {
|
|
|
703
1596
|
*/
|
|
704
1597
|
export interface CreateNotificationConfigurationResponse {
|
|
705
1598
|
/**
|
|
706
|
-
* <p>The type of event triggering a device notification to the customer-managed
|
|
707
|
-
* destination.</p>
|
|
1599
|
+
* <p>The type of event triggering a device notification to the customer-managed destination.</p>
|
|
708
1600
|
* @public
|
|
709
1601
|
*/
|
|
710
1602
|
EventType?: EventType | undefined;
|
|
@@ -755,9 +1647,7 @@ export interface ScheduleMaintenanceWindow {
|
|
|
755
1647
|
*/
|
|
756
1648
|
export interface OtaTaskSchedulingConfig {
|
|
757
1649
|
/**
|
|
758
|
-
* <p>Specifies the end behavior for all task executions after a task reaches the selected
|
|
759
|
-
* <code>endTime</code>. If <code>endTime</code> is not selected when creating the task,
|
|
760
|
-
* then <code>endBehavior</code> does not apply.</p>
|
|
1650
|
+
* <p>Specifies the end behavior for all task executions after a task reaches the selected <code>endTime</code>. If <code>endTime</code> is not selected when creating the task, then <code>endBehavior</code> does not apply.</p>
|
|
761
1651
|
* @public
|
|
762
1652
|
*/
|
|
763
1653
|
EndBehavior?: SchedulingConfigEndBehavior | undefined;
|
|
@@ -885,9 +1775,7 @@ export interface CreateOtaTaskRequest {
|
|
|
885
1775
|
*/
|
|
886
1776
|
OtaTargetQueryString?: string | undefined;
|
|
887
1777
|
/**
|
|
888
|
-
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
889
|
-
* the same client token and parameters, then the retry attempt will succeed without
|
|
890
|
-
* performing any further actions.</p>
|
|
1778
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
891
1779
|
* @public
|
|
892
1780
|
*/
|
|
893
1781
|
ClientToken?: string | undefined;
|
|
@@ -944,21 +1832,18 @@ export interface OtaTaskAbortConfig {
|
|
|
944
1832
|
*/
|
|
945
1833
|
export interface RolloutRateIncreaseCriteria {
|
|
946
1834
|
/**
|
|
947
|
-
* <p>The threshold for number of notified things that will initiate the increase in rate of
|
|
948
|
-
* rollout.</p>
|
|
1835
|
+
* <p>The threshold for number of notified things that will initiate the increase in rate of rollout.</p>
|
|
949
1836
|
* @public
|
|
950
1837
|
*/
|
|
951
1838
|
numberOfNotifiedThings?: number | undefined;
|
|
952
1839
|
/**
|
|
953
|
-
* <p>The threshold for number of succeeded things that will initiate the increase in rate of
|
|
954
|
-
* rollout.</p>
|
|
1840
|
+
* <p>The threshold for number of succeeded things that will initiate the increase in rate of rollout.</p>
|
|
955
1841
|
* @public
|
|
956
1842
|
*/
|
|
957
1843
|
numberOfSucceededThings?: number | undefined;
|
|
958
1844
|
}
|
|
959
1845
|
/**
|
|
960
|
-
* <p>Structure representing exponential rate of rollout for an over-the-air (OTA)
|
|
961
|
-
* task.</p>
|
|
1846
|
+
* <p>Structure representing exponential rate of rollout for an over-the-air (OTA) task.</p>
|
|
962
1847
|
* @public
|
|
963
1848
|
*/
|
|
964
1849
|
export interface ExponentialRolloutRate {
|
|
@@ -968,8 +1853,7 @@ export interface ExponentialRolloutRate {
|
|
|
968
1853
|
*/
|
|
969
1854
|
BaseRatePerMinute?: number | undefined;
|
|
970
1855
|
/**
|
|
971
|
-
* <p>The incremental factor for increasing the rollout rate of an over-the-air (OTA)
|
|
972
|
-
* task.</p>
|
|
1856
|
+
* <p>The incremental factor for increasing the rollout rate of an over-the-air (OTA) task.</p>
|
|
973
1857
|
* @public
|
|
974
1858
|
*/
|
|
975
1859
|
IncrementFactor?: number | undefined;
|
|
@@ -985,8 +1869,7 @@ export interface ExponentialRolloutRate {
|
|
|
985
1869
|
*/
|
|
986
1870
|
export interface OtaTaskExecutionRolloutConfig {
|
|
987
1871
|
/**
|
|
988
|
-
* <p>Structure representing exponential rate of rollout for an over-the-air (OTA)
|
|
989
|
-
* task.</p>
|
|
1872
|
+
* <p>Structure representing exponential rate of rollout for an over-the-air (OTA) task.</p>
|
|
990
1873
|
* @public
|
|
991
1874
|
*/
|
|
992
1875
|
ExponentialRolloutRate?: ExponentialRolloutRate | undefined;
|
|
@@ -1002,8 +1885,7 @@ export interface OtaTaskExecutionRolloutConfig {
|
|
|
1002
1885
|
*/
|
|
1003
1886
|
export interface OtaTaskTimeoutConfig {
|
|
1004
1887
|
/**
|
|
1005
|
-
* <p>Specifies the amount of time the device has to finish execution of this task. The
|
|
1006
|
-
* timeout interval can be anywhere between 1 minute and 7 days.</p>
|
|
1888
|
+
* <p>Specifies the amount of time the device has to finish execution of this task. The timeout interval can be anywhere between 1 minute and 7 days.</p>
|
|
1007
1889
|
* @public
|
|
1008
1890
|
*/
|
|
1009
1891
|
InProgressTimeoutInMinutes?: number | undefined;
|
|
@@ -1049,9 +1931,7 @@ export interface CreateOtaTaskConfigurationRequest {
|
|
|
1049
1931
|
*/
|
|
1050
1932
|
PushConfig?: PushConfig | undefined;
|
|
1051
1933
|
/**
|
|
1052
|
-
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
1053
|
-
* the same client token and parameters, then the retry attempt will succeed without
|
|
1054
|
-
* performing any further actions.</p>
|
|
1934
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
1055
1935
|
* @public
|
|
1056
1936
|
*/
|
|
1057
1937
|
ClientToken?: string | undefined;
|
|
@@ -1098,9 +1978,7 @@ export interface CreateProvisioningProfileRequest {
|
|
|
1098
1978
|
*/
|
|
1099
1979
|
Name?: string | undefined;
|
|
1100
1980
|
/**
|
|
1101
|
-
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
1102
|
-
* the same client token and parameters, then the retry attempt will succeed without
|
|
1103
|
-
* performing any further actions.</p>
|
|
1981
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
1104
1982
|
* @public
|
|
1105
1983
|
*/
|
|
1106
1984
|
ClientToken?: string | undefined;
|
|
@@ -1115,8 +1993,7 @@ export interface CreateProvisioningProfileRequest {
|
|
|
1115
1993
|
*/
|
|
1116
1994
|
export interface CreateProvisioningProfileResponse {
|
|
1117
1995
|
/**
|
|
1118
|
-
* <p>The Amazon Resource Name (ARN) of the provisioning template used in the provisioning
|
|
1119
|
-
* profile.</p>
|
|
1996
|
+
* <p>The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.</p>
|
|
1120
1997
|
* @public
|
|
1121
1998
|
*/
|
|
1122
1999
|
Arn?: string | undefined;
|
|
@@ -1141,8 +2018,7 @@ export interface CreateProvisioningProfileResponse {
|
|
|
1141
2018
|
*/
|
|
1142
2019
|
ClaimCertificate?: string | undefined;
|
|
1143
2020
|
/**
|
|
1144
|
-
* <p>The private key of the claim certificate. This is stored securely on the device for
|
|
1145
|
-
* validating the connection endpoint with IoT managed integrations using the public key.</p>
|
|
2021
|
+
* <p>The private key of the claim certificate. This is stored securely on the device for validating the connection endpoint with IoT managed integrations using the public key.</p>
|
|
1146
2022
|
* @public
|
|
1147
2023
|
*/
|
|
1148
2024
|
ClaimCertificatePrivateKey?: string | undefined;
|
|
@@ -1283,9 +2159,7 @@ export interface DeleteManagedThingRequest {
|
|
|
1283
2159
|
*/
|
|
1284
2160
|
Identifier: string | undefined;
|
|
1285
2161
|
/**
|
|
1286
|
-
* <p>When set to <code>TRUE</code>, a forceful deteletion of the managed thing will occur.
|
|
1287
|
-
* When set to <code>FALSE</code>, a non-forceful deletion of the managed thing will
|
|
1288
|
-
* occur.</p>
|
|
2162
|
+
* <p>When set to <code>TRUE</code>, a forceful deteletion of the managed thing will occur. When set to <code>FALSE</code>, a non-forceful deletion of the managed thing will occur.</p>
|
|
1289
2163
|
* @public
|
|
1290
2164
|
*/
|
|
1291
2165
|
Force?: boolean | undefined;
|
|
@@ -1295,8 +2169,7 @@ export interface DeleteManagedThingRequest {
|
|
|
1295
2169
|
*/
|
|
1296
2170
|
export interface DeleteNotificationConfigurationRequest {
|
|
1297
2171
|
/**
|
|
1298
|
-
* <p>The type of event triggering a device notification to the customer-managed
|
|
1299
|
-
* destination.</p>
|
|
2172
|
+
* <p>The type of event triggering a device notification to the customer-managed destination.</p>
|
|
1300
2173
|
* @public
|
|
1301
2174
|
*/
|
|
1302
2175
|
EventType: EventType | undefined;
|
|
@@ -1311,6 +2184,19 @@ export interface DeleteOtaTaskRequest {
|
|
|
1311
2184
|
*/
|
|
1312
2185
|
Identifier: string | undefined;
|
|
1313
2186
|
}
|
|
2187
|
+
/**
|
|
2188
|
+
* <p>The request exceeds a service limit or quota. Adjust your request parameters and try again.</p>
|
|
2189
|
+
* @public
|
|
2190
|
+
*/
|
|
2191
|
+
export declare class LimitExceededException extends __BaseException {
|
|
2192
|
+
readonly name: "LimitExceededException";
|
|
2193
|
+
readonly $fault: "client";
|
|
2194
|
+
Message?: string | undefined;
|
|
2195
|
+
/**
|
|
2196
|
+
* @internal
|
|
2197
|
+
*/
|
|
2198
|
+
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
2199
|
+
}
|
|
1314
2200
|
/**
|
|
1315
2201
|
* @public
|
|
1316
2202
|
*/
|
|
@@ -1332,162 +2218,338 @@ export interface DeleteProvisioningProfileRequest {
|
|
|
1332
2218
|
Identifier: string | undefined;
|
|
1333
2219
|
}
|
|
1334
2220
|
/**
|
|
1335
|
-
*
|
|
1336
|
-
*
|
|
2221
|
+
* Request for deregister a managed thing from account association
|
|
2222
|
+
* @public
|
|
2223
|
+
*/
|
|
2224
|
+
export interface DeregisterAccountAssociationRequest {
|
|
2225
|
+
/**
|
|
2226
|
+
* <p>The identifier of the managed thing to be deregistered from the account association.</p>
|
|
2227
|
+
* @public
|
|
2228
|
+
*/
|
|
2229
|
+
ManagedThingId: string | undefined;
|
|
2230
|
+
/**
|
|
2231
|
+
* <p>The unique identifier of the account association to be deregistered.</p>
|
|
2232
|
+
* @public
|
|
2233
|
+
*/
|
|
2234
|
+
AccountAssociationId: string | undefined;
|
|
2235
|
+
}
|
|
2236
|
+
/**
|
|
2237
|
+
* <p>Structure describing a destination for IoT managed integrations to deliver notifications for a device.</p>
|
|
2238
|
+
* @public
|
|
2239
|
+
*/
|
|
2240
|
+
export interface DestinationSummary {
|
|
2241
|
+
/**
|
|
2242
|
+
* <p>The description of the customer-managed destination.</p>
|
|
2243
|
+
* @public
|
|
2244
|
+
*/
|
|
2245
|
+
Description?: string | undefined;
|
|
2246
|
+
/**
|
|
2247
|
+
* <p>The Amazon Resource Name (ARN) of the customer-managed destination.</p>
|
|
2248
|
+
* @public
|
|
2249
|
+
*/
|
|
2250
|
+
DeliveryDestinationArn?: string | undefined;
|
|
2251
|
+
/**
|
|
2252
|
+
* <p>The destination type for the customer-managed destination.</p>
|
|
2253
|
+
* @public
|
|
2254
|
+
*/
|
|
2255
|
+
DeliveryDestinationType?: DeliveryDestinationType | undefined;
|
|
2256
|
+
/**
|
|
2257
|
+
* <p>The name of the customer-managed destination.</p>
|
|
2258
|
+
* @public
|
|
2259
|
+
*/
|
|
2260
|
+
Name?: string | undefined;
|
|
2261
|
+
/**
|
|
2262
|
+
* <p>The Amazon Resource Name (ARN) of the delivery destination.</p>
|
|
2263
|
+
* @public
|
|
2264
|
+
*/
|
|
2265
|
+
RoleArn?: string | undefined;
|
|
2266
|
+
}
|
|
2267
|
+
/**
|
|
2268
|
+
* @public
|
|
2269
|
+
*/
|
|
2270
|
+
export interface GetDestinationRequest {
|
|
2271
|
+
/**
|
|
2272
|
+
* <p>The name of the customer-managed destination.</p>
|
|
2273
|
+
* @public
|
|
2274
|
+
*/
|
|
2275
|
+
Name: string | undefined;
|
|
2276
|
+
}
|
|
2277
|
+
/**
|
|
2278
|
+
* @public
|
|
2279
|
+
*/
|
|
2280
|
+
export interface GetDestinationResponse {
|
|
2281
|
+
/**
|
|
2282
|
+
* <p>The description of the customer-managed destination.</p>
|
|
2283
|
+
* @public
|
|
2284
|
+
*/
|
|
2285
|
+
Description?: string | undefined;
|
|
2286
|
+
/**
|
|
2287
|
+
* <p>The Amazon Resource Name (ARN) of the customer-managed destination.</p>
|
|
2288
|
+
* @public
|
|
2289
|
+
*/
|
|
2290
|
+
DeliveryDestinationArn?: string | undefined;
|
|
2291
|
+
/**
|
|
2292
|
+
* <p>The destination type for the customer-managed destination.</p>
|
|
2293
|
+
* @public
|
|
2294
|
+
*/
|
|
2295
|
+
DeliveryDestinationType?: DeliveryDestinationType | undefined;
|
|
2296
|
+
/**
|
|
2297
|
+
* <p>The name of the customer-managed destination.</p>
|
|
2298
|
+
* @public
|
|
2299
|
+
*/
|
|
2300
|
+
Name?: string | undefined;
|
|
2301
|
+
/**
|
|
2302
|
+
* <p>The Amazon Resource Name (ARN) of the delivery destination role.</p>
|
|
2303
|
+
* @public
|
|
2304
|
+
*/
|
|
2305
|
+
RoleArn?: string | undefined;
|
|
2306
|
+
/**
|
|
2307
|
+
* <p>The timestamp value of when the destination creation requset occurred.</p>
|
|
2308
|
+
* @public
|
|
2309
|
+
*/
|
|
2310
|
+
CreatedAt?: Date | undefined;
|
|
2311
|
+
/**
|
|
2312
|
+
* <p>The timestamp value of when the destination update requset occurred.</p>
|
|
2313
|
+
* @public
|
|
2314
|
+
*/
|
|
2315
|
+
UpdatedAt?: Date | undefined;
|
|
2316
|
+
/**
|
|
2317
|
+
* <p>A set of key/value pairs that are used to manage the customer-managed destination.</p>
|
|
2318
|
+
*
|
|
2319
|
+
* @deprecated
|
|
2320
|
+
* @public
|
|
2321
|
+
*/
|
|
2322
|
+
Tags?: Record<string, string> | undefined;
|
|
2323
|
+
}
|
|
2324
|
+
/**
|
|
2325
|
+
* @public
|
|
2326
|
+
*/
|
|
2327
|
+
export interface ListDestinationsRequest {
|
|
2328
|
+
/**
|
|
2329
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
2330
|
+
* @public
|
|
2331
|
+
*/
|
|
2332
|
+
NextToken?: string | undefined;
|
|
2333
|
+
/**
|
|
2334
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
2335
|
+
* @public
|
|
2336
|
+
*/
|
|
2337
|
+
MaxResults?: number | undefined;
|
|
2338
|
+
}
|
|
2339
|
+
/**
|
|
2340
|
+
* @public
|
|
2341
|
+
*/
|
|
2342
|
+
export interface ListDestinationsResponse {
|
|
2343
|
+
/**
|
|
2344
|
+
* <p>The list of destinations.</p>
|
|
2345
|
+
* @public
|
|
2346
|
+
*/
|
|
2347
|
+
DestinationList?: DestinationSummary[] | undefined;
|
|
2348
|
+
/**
|
|
2349
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
2350
|
+
* @public
|
|
2351
|
+
*/
|
|
2352
|
+
NextToken?: string | undefined;
|
|
2353
|
+
}
|
|
2354
|
+
/**
|
|
2355
|
+
* @public
|
|
2356
|
+
*/
|
|
2357
|
+
export interface UpdateDestinationRequest {
|
|
2358
|
+
/**
|
|
2359
|
+
* <p>The name of the customer-managed destination.</p>
|
|
2360
|
+
* @public
|
|
2361
|
+
*/
|
|
2362
|
+
Name: string | undefined;
|
|
2363
|
+
/**
|
|
2364
|
+
* <p>The Amazon Resource Name (ARN) of the customer-managed destination.</p>
|
|
2365
|
+
* @public
|
|
2366
|
+
*/
|
|
2367
|
+
DeliveryDestinationArn?: string | undefined;
|
|
2368
|
+
/**
|
|
2369
|
+
* <p>The destination type for the customer-managed destination.</p>
|
|
2370
|
+
* @public
|
|
2371
|
+
*/
|
|
2372
|
+
DeliveryDestinationType?: DeliveryDestinationType | undefined;
|
|
2373
|
+
/**
|
|
2374
|
+
* <p>The Amazon Resource Name (ARN) of the delivery destination role.</p>
|
|
2375
|
+
* @public
|
|
2376
|
+
*/
|
|
2377
|
+
RoleArn?: string | undefined;
|
|
2378
|
+
/**
|
|
2379
|
+
* <p>The description of the customer-managed destination.</p>
|
|
2380
|
+
* @public
|
|
2381
|
+
*/
|
|
2382
|
+
Description?: string | undefined;
|
|
2383
|
+
}
|
|
2384
|
+
/**
|
|
2385
|
+
* <p>Matter attribute used in capability report.</p>
|
|
2386
|
+
* @public
|
|
2387
|
+
*/
|
|
2388
|
+
export interface MatterCapabilityReportAttribute {
|
|
2389
|
+
/**
|
|
2390
|
+
* <p>The id of the Matter attribute.</p>
|
|
2391
|
+
* @public
|
|
2392
|
+
*/
|
|
2393
|
+
id?: string | undefined;
|
|
2394
|
+
/**
|
|
2395
|
+
* <p>Name for the Amazon Web Services Matter capability report attribute.</p>
|
|
2396
|
+
* @public
|
|
2397
|
+
*/
|
|
2398
|
+
name?: string | undefined;
|
|
2399
|
+
/**
|
|
2400
|
+
* <p>Value for the Amazon Web Services Matter capability report attribute.</p>
|
|
2401
|
+
* @public
|
|
2402
|
+
*/
|
|
2403
|
+
value?: __DocumentType | undefined;
|
|
2404
|
+
}
|
|
2405
|
+
/**
|
|
2406
|
+
* <p>Capability used in Matter capability report.</p>
|
|
1337
2407
|
* @public
|
|
1338
2408
|
*/
|
|
1339
|
-
export interface
|
|
2409
|
+
export interface MatterCapabilityReportCluster {
|
|
1340
2410
|
/**
|
|
1341
|
-
* <p>The
|
|
2411
|
+
* <p>The id of the Amazon Web Services Matter capability report cluster.</p>
|
|
1342
2412
|
* @public
|
|
1343
2413
|
*/
|
|
1344
|
-
|
|
2414
|
+
id: string | undefined;
|
|
1345
2415
|
/**
|
|
1346
|
-
* <p>The
|
|
2416
|
+
* <p>The id of the revision for the Amazon Web Services Matter capability report.</p>
|
|
1347
2417
|
* @public
|
|
1348
2418
|
*/
|
|
1349
|
-
|
|
2419
|
+
revision: number | undefined;
|
|
1350
2420
|
/**
|
|
1351
|
-
* <p>The
|
|
2421
|
+
* <p>The id of the schema version.</p>
|
|
1352
2422
|
* @public
|
|
1353
2423
|
*/
|
|
1354
|
-
|
|
2424
|
+
publicId?: string | undefined;
|
|
1355
2425
|
/**
|
|
1356
|
-
* <p>The name
|
|
2426
|
+
* <p>The capability name used in the Amazon Web Services Matter capability report.</p>
|
|
1357
2427
|
* @public
|
|
1358
2428
|
*/
|
|
1359
|
-
|
|
2429
|
+
name?: string | undefined;
|
|
1360
2430
|
/**
|
|
1361
|
-
* <p>The
|
|
2431
|
+
* <p>The spec version used in the Amazon Web Services Matter capability report.</p>
|
|
1362
2432
|
* @public
|
|
1363
2433
|
*/
|
|
1364
|
-
|
|
1365
|
-
}
|
|
1366
|
-
/**
|
|
1367
|
-
* @public
|
|
1368
|
-
*/
|
|
1369
|
-
export interface GetDestinationRequest {
|
|
2434
|
+
specVersion?: string | undefined;
|
|
1370
2435
|
/**
|
|
1371
|
-
* <p>The
|
|
2436
|
+
* <p>The attributes of the Amazon Web Services Matter capability report.</p>
|
|
1372
2437
|
* @public
|
|
1373
2438
|
*/
|
|
1374
|
-
|
|
1375
|
-
}
|
|
1376
|
-
/**
|
|
1377
|
-
* @public
|
|
1378
|
-
*/
|
|
1379
|
-
export interface GetDestinationResponse {
|
|
2439
|
+
attributes?: MatterCapabilityReportAttribute[] | undefined;
|
|
1380
2440
|
/**
|
|
1381
|
-
* <p>The
|
|
2441
|
+
* <p>The commands used with the Amazon Web Services Matter capability report.</p>
|
|
1382
2442
|
* @public
|
|
1383
2443
|
*/
|
|
1384
|
-
|
|
2444
|
+
commands?: string[] | undefined;
|
|
1385
2445
|
/**
|
|
1386
|
-
* <p>The
|
|
2446
|
+
* <p>The events used with the Amazon Web Services Matter capability report.</p>
|
|
1387
2447
|
* @public
|
|
1388
2448
|
*/
|
|
1389
|
-
|
|
2449
|
+
events?: string[] | undefined;
|
|
1390
2450
|
/**
|
|
1391
|
-
* <p>
|
|
2451
|
+
* <p>32 bit-map used to indicate which features a cluster supports.</p>
|
|
1392
2452
|
* @public
|
|
1393
2453
|
*/
|
|
1394
|
-
|
|
2454
|
+
featureMap?: number | undefined;
|
|
1395
2455
|
/**
|
|
1396
|
-
* <p>
|
|
2456
|
+
* <p>Matter clusters used in capability report.</p>
|
|
1397
2457
|
* @public
|
|
1398
2458
|
*/
|
|
1399
|
-
|
|
2459
|
+
generatedCommands?: string[] | undefined;
|
|
1400
2460
|
/**
|
|
1401
|
-
* <p>The
|
|
2461
|
+
* <p>The fabric index for the Amazon Web Services Matter capability report.</p>
|
|
1402
2462
|
* @public
|
|
1403
2463
|
*/
|
|
1404
|
-
|
|
2464
|
+
fabricIndex?: number | undefined;
|
|
2465
|
+
}
|
|
2466
|
+
/**
|
|
2467
|
+
* <p>Matter endpoint used in capability report.</p>
|
|
2468
|
+
* @public
|
|
2469
|
+
*/
|
|
2470
|
+
export interface MatterCapabilityReportEndpoint {
|
|
1405
2471
|
/**
|
|
1406
|
-
* <p>The
|
|
2472
|
+
* <p>The id of the Amazon Web Services Matter capability report endpoint.</p>
|
|
1407
2473
|
* @public
|
|
1408
2474
|
*/
|
|
1409
|
-
|
|
2475
|
+
id: string | undefined;
|
|
1410
2476
|
/**
|
|
1411
|
-
* <p>The
|
|
2477
|
+
* <p>The type of device.</p>
|
|
1412
2478
|
* @public
|
|
1413
2479
|
*/
|
|
1414
|
-
|
|
2480
|
+
deviceTypes: string[] | undefined;
|
|
1415
2481
|
/**
|
|
1416
|
-
* <p>
|
|
1417
|
-
* destination.</p>
|
|
2482
|
+
* <p>Matter clusters used in capability report.</p>
|
|
1418
2483
|
* @public
|
|
1419
2484
|
*/
|
|
1420
|
-
|
|
1421
|
-
}
|
|
1422
|
-
/**
|
|
1423
|
-
* @public
|
|
1424
|
-
*/
|
|
1425
|
-
export interface ListDestinationsRequest {
|
|
2485
|
+
clusters: MatterCapabilityReportCluster[] | undefined;
|
|
1426
2486
|
/**
|
|
1427
|
-
* <p>
|
|
2487
|
+
* <p>Heirachy of child endpoints contained in the given endpoint.</p>
|
|
1428
2488
|
* @public
|
|
1429
2489
|
*/
|
|
1430
|
-
|
|
2490
|
+
parts?: string[] | undefined;
|
|
1431
2491
|
/**
|
|
1432
|
-
* <p>
|
|
2492
|
+
* <p>Semantic information related to endpoint.</p>
|
|
1433
2493
|
* @public
|
|
1434
2494
|
*/
|
|
1435
|
-
|
|
2495
|
+
semanticTags?: string[] | undefined;
|
|
2496
|
+
/**
|
|
2497
|
+
* <p>Semantic information related to endpoint.</p>
|
|
2498
|
+
* @public
|
|
2499
|
+
*/
|
|
2500
|
+
clientClusters?: string[] | undefined;
|
|
1436
2501
|
}
|
|
1437
2502
|
/**
|
|
2503
|
+
* <p>Matter based capability report.</p>
|
|
1438
2504
|
* @public
|
|
1439
2505
|
*/
|
|
1440
|
-
export interface
|
|
2506
|
+
export interface MatterCapabilityReport {
|
|
1441
2507
|
/**
|
|
1442
|
-
* <p>The
|
|
2508
|
+
* <p>The version of the capability report.</p>
|
|
1443
2509
|
* @public
|
|
1444
2510
|
*/
|
|
1445
|
-
|
|
2511
|
+
version: string | undefined;
|
|
1446
2512
|
/**
|
|
1447
|
-
* <p>
|
|
2513
|
+
* <p>The numeric identifier of the node.</p>
|
|
1448
2514
|
* @public
|
|
1449
2515
|
*/
|
|
1450
|
-
|
|
2516
|
+
nodeId?: string | undefined;
|
|
2517
|
+
/**
|
|
2518
|
+
* <p>The endpoints used in the capability report.</p>
|
|
2519
|
+
* @public
|
|
2520
|
+
*/
|
|
2521
|
+
endpoints: MatterCapabilityReportEndpoint[] | undefined;
|
|
1451
2522
|
}
|
|
1452
2523
|
/**
|
|
2524
|
+
* <p>Describe the device using the relevant metadata and supported clusters for device discovery.</p>
|
|
1453
2525
|
* @public
|
|
1454
2526
|
*/
|
|
1455
|
-
export interface
|
|
1456
|
-
/**
|
|
1457
|
-
* <p>The name of the customer-managed destination.</p>
|
|
1458
|
-
* @public
|
|
1459
|
-
*/
|
|
1460
|
-
Name: string | undefined;
|
|
2527
|
+
export interface Device {
|
|
1461
2528
|
/**
|
|
1462
|
-
* <p>The
|
|
2529
|
+
* <p>The device id as defined by the connector.</p> <note> <p>This parameter is used for cloud-to-cloud devices only.</p> </note>
|
|
1463
2530
|
* @public
|
|
1464
2531
|
*/
|
|
1465
|
-
|
|
2532
|
+
ConnectorDeviceId: string | undefined;
|
|
1466
2533
|
/**
|
|
1467
|
-
* <p>The
|
|
2534
|
+
* <p>The name of the device as defined by the connector.</p>
|
|
1468
2535
|
* @public
|
|
1469
2536
|
*/
|
|
1470
|
-
|
|
2537
|
+
ConnectorDeviceName?: string | undefined;
|
|
1471
2538
|
/**
|
|
1472
|
-
* <p>The
|
|
2539
|
+
* <p>The capability report for the device.</p>
|
|
1473
2540
|
* @public
|
|
1474
2541
|
*/
|
|
1475
|
-
|
|
2542
|
+
CapabilityReport: MatterCapabilityReport | undefined;
|
|
1476
2543
|
/**
|
|
1477
|
-
* <p>
|
|
2544
|
+
* <p>Report of all capabilities supported by the device.</p>
|
|
1478
2545
|
* @public
|
|
1479
2546
|
*/
|
|
1480
|
-
|
|
1481
|
-
}
|
|
1482
|
-
/**
|
|
1483
|
-
* @public
|
|
1484
|
-
*/
|
|
1485
|
-
export interface GetDeviceDiscoveryRequest {
|
|
2547
|
+
CapabilitySchemas?: CapabilitySchemaItem[] | undefined;
|
|
1486
2548
|
/**
|
|
1487
|
-
* <p>The
|
|
2549
|
+
* <p>The metadata attributes for a device.</p>
|
|
1488
2550
|
* @public
|
|
1489
2551
|
*/
|
|
1490
|
-
|
|
2552
|
+
DeviceMetadata?: __DocumentType | undefined;
|
|
1491
2553
|
}
|
|
1492
2554
|
/**
|
|
1493
2555
|
* @public
|
|
@@ -1495,6 +2557,7 @@ export interface GetDeviceDiscoveryRequest {
|
|
|
1495
2557
|
*/
|
|
1496
2558
|
export declare const DiscoveryType: {
|
|
1497
2559
|
readonly CLOUD: "CLOUD";
|
|
2560
|
+
readonly CUSTOM: "CUSTOM";
|
|
1498
2561
|
readonly ZIGBEE: "ZIGBEE";
|
|
1499
2562
|
readonly ZWAVE: "ZWAVE";
|
|
1500
2563
|
};
|
|
@@ -1516,6 +2579,37 @@ export declare const DeviceDiscoveryStatus: {
|
|
|
1516
2579
|
* @public
|
|
1517
2580
|
*/
|
|
1518
2581
|
export type DeviceDiscoveryStatus = (typeof DeviceDiscoveryStatus)[keyof typeof DeviceDiscoveryStatus];
|
|
2582
|
+
/**
|
|
2583
|
+
* <p>Structure containing summary information about a device discovery job, including its identifier, type, and status.</p>
|
|
2584
|
+
* @public
|
|
2585
|
+
*/
|
|
2586
|
+
export interface DeviceDiscoverySummary {
|
|
2587
|
+
/**
|
|
2588
|
+
* <p>The unique identifier of the device discovery job.</p>
|
|
2589
|
+
* @public
|
|
2590
|
+
*/
|
|
2591
|
+
Id?: string | undefined;
|
|
2592
|
+
/**
|
|
2593
|
+
* <p>The type of discovery process used to find devices.</p>
|
|
2594
|
+
* @public
|
|
2595
|
+
*/
|
|
2596
|
+
DiscoveryType?: DiscoveryType | undefined;
|
|
2597
|
+
/**
|
|
2598
|
+
* <p>The current status of the device discovery job.</p>
|
|
2599
|
+
* @public
|
|
2600
|
+
*/
|
|
2601
|
+
Status?: DeviceDiscoveryStatus | undefined;
|
|
2602
|
+
}
|
|
2603
|
+
/**
|
|
2604
|
+
* @public
|
|
2605
|
+
*/
|
|
2606
|
+
export interface GetDeviceDiscoveryRequest {
|
|
2607
|
+
/**
|
|
2608
|
+
* <p>The id of the device discovery job request.</p>
|
|
2609
|
+
* @public
|
|
2610
|
+
*/
|
|
2611
|
+
Identifier: string | undefined;
|
|
2612
|
+
}
|
|
1519
2613
|
/**
|
|
1520
2614
|
* @public
|
|
1521
2615
|
*/
|
|
@@ -1531,8 +2625,7 @@ export interface GetDeviceDiscoveryResponse {
|
|
|
1531
2625
|
*/
|
|
1532
2626
|
Arn: string | undefined;
|
|
1533
2627
|
/**
|
|
1534
|
-
* <p>The discovery type supporting the type of device to be discovered in the device
|
|
1535
|
-
* discovery job request.</p>
|
|
2628
|
+
* <p>The discovery type supporting the type of device to be discovered in the device discovery job request.</p>
|
|
1536
2629
|
* @public
|
|
1537
2630
|
*/
|
|
1538
2631
|
DiscoveryType: DiscoveryType | undefined;
|
|
@@ -1553,9 +2646,16 @@ export interface GetDeviceDiscoveryResponse {
|
|
|
1553
2646
|
ControllerId?: string | undefined;
|
|
1554
2647
|
/**
|
|
1555
2648
|
* <p>The ID tracking the current discovery process for one connector association.</p>
|
|
2649
|
+
*
|
|
2650
|
+
* @deprecated
|
|
1556
2651
|
* @public
|
|
1557
2652
|
*/
|
|
1558
2653
|
ConnectorAssociationId?: string | undefined;
|
|
2654
|
+
/**
|
|
2655
|
+
* <p>The identifier of the account association used for the device discovery.</p>
|
|
2656
|
+
* @public
|
|
2657
|
+
*/
|
|
2658
|
+
AccountAssociationId?: string | undefined;
|
|
1559
2659
|
/**
|
|
1560
2660
|
* <p>The timestamp value for the completion time of the device discovery.</p>
|
|
1561
2661
|
* @public
|
|
@@ -1563,10 +2663,151 @@ export interface GetDeviceDiscoveryResponse {
|
|
|
1563
2663
|
FinishedAt?: Date | undefined;
|
|
1564
2664
|
/**
|
|
1565
2665
|
* <p>A set of key/value pairs that are used to manage the device discovery request.</p>
|
|
2666
|
+
*
|
|
2667
|
+
* @deprecated
|
|
1566
2668
|
* @public
|
|
1567
2669
|
*/
|
|
1568
2670
|
Tags?: Record<string, string> | undefined;
|
|
1569
2671
|
}
|
|
2672
|
+
/**
|
|
2673
|
+
* @public
|
|
2674
|
+
*/
|
|
2675
|
+
export interface ListDeviceDiscoveriesRequest {
|
|
2676
|
+
/**
|
|
2677
|
+
* <p>A token used for pagination of results.</p>
|
|
2678
|
+
* @public
|
|
2679
|
+
*/
|
|
2680
|
+
NextToken?: string | undefined;
|
|
2681
|
+
/**
|
|
2682
|
+
* <p>The maximum number of device discovery jobs to return in a single response.</p>
|
|
2683
|
+
* @public
|
|
2684
|
+
*/
|
|
2685
|
+
MaxResults?: number | undefined;
|
|
2686
|
+
/**
|
|
2687
|
+
* <p>The discovery type to filter device discovery jobs by.</p>
|
|
2688
|
+
* @public
|
|
2689
|
+
*/
|
|
2690
|
+
TypeFilter?: DiscoveryType | undefined;
|
|
2691
|
+
/**
|
|
2692
|
+
* <p>The status to filter device discovery jobs by.</p>
|
|
2693
|
+
* @public
|
|
2694
|
+
*/
|
|
2695
|
+
StatusFilter?: DeviceDiscoveryStatus | undefined;
|
|
2696
|
+
}
|
|
2697
|
+
/**
|
|
2698
|
+
* @public
|
|
2699
|
+
*/
|
|
2700
|
+
export interface ListDeviceDiscoveriesResponse {
|
|
2701
|
+
/**
|
|
2702
|
+
* <p>The list of device discovery jobs that match the specified criteria.</p>
|
|
2703
|
+
* @public
|
|
2704
|
+
*/
|
|
2705
|
+
Items?: DeviceDiscoverySummary[] | undefined;
|
|
2706
|
+
/**
|
|
2707
|
+
* <p>A token used for pagination of results when there are more device discovery jobs than can be returned in a single response.</p>
|
|
2708
|
+
* @public
|
|
2709
|
+
*/
|
|
2710
|
+
NextToken?: string | undefined;
|
|
2711
|
+
}
|
|
2712
|
+
/**
|
|
2713
|
+
* @public
|
|
2714
|
+
*/
|
|
2715
|
+
export interface ListDiscoveredDevicesRequest {
|
|
2716
|
+
/**
|
|
2717
|
+
* <p>The identifier of the device discovery job to list discovered devices for.</p>
|
|
2718
|
+
* @public
|
|
2719
|
+
*/
|
|
2720
|
+
Identifier: string | undefined;
|
|
2721
|
+
/**
|
|
2722
|
+
* <p>A token used for pagination of results.</p>
|
|
2723
|
+
* @public
|
|
2724
|
+
*/
|
|
2725
|
+
NextToken?: string | undefined;
|
|
2726
|
+
/**
|
|
2727
|
+
* <p>The maximum number of discovered devices to return in a single response.</p>
|
|
2728
|
+
* @public
|
|
2729
|
+
*/
|
|
2730
|
+
MaxResults?: number | undefined;
|
|
2731
|
+
}
|
|
2732
|
+
/**
|
|
2733
|
+
* @public
|
|
2734
|
+
* @enum
|
|
2735
|
+
*/
|
|
2736
|
+
export declare const DiscoveryModification: {
|
|
2737
|
+
readonly DISCOVERED: "DISCOVERED";
|
|
2738
|
+
readonly NO_CHANGE: "NO_CHANGE";
|
|
2739
|
+
readonly UPDATED: "UPDATED";
|
|
2740
|
+
};
|
|
2741
|
+
/**
|
|
2742
|
+
* @public
|
|
2743
|
+
*/
|
|
2744
|
+
export type DiscoveryModification = (typeof DiscoveryModification)[keyof typeof DiscoveryModification];
|
|
2745
|
+
/**
|
|
2746
|
+
* <p>Structure containing summary information about a device discovered during a device discovery job.</p>
|
|
2747
|
+
* @public
|
|
2748
|
+
*/
|
|
2749
|
+
export interface DiscoveredDeviceSummary {
|
|
2750
|
+
/**
|
|
2751
|
+
* <p>The third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII).</p>
|
|
2752
|
+
* @public
|
|
2753
|
+
*/
|
|
2754
|
+
ConnectorDeviceId?: string | undefined;
|
|
2755
|
+
/**
|
|
2756
|
+
* <p>The name of the device as defined by the connector or third-party system.</p>
|
|
2757
|
+
* @public
|
|
2758
|
+
*/
|
|
2759
|
+
ConnectorDeviceName?: string | undefined;
|
|
2760
|
+
/**
|
|
2761
|
+
* <p>The list of device types or categories that the discovered device belongs to.</p>
|
|
2762
|
+
* @public
|
|
2763
|
+
*/
|
|
2764
|
+
DeviceTypes?: string[] | undefined;
|
|
2765
|
+
/**
|
|
2766
|
+
* <p>The identifier of the managed thing created for this discovered device, if one exists.</p>
|
|
2767
|
+
* @public
|
|
2768
|
+
*/
|
|
2769
|
+
ManagedThingId?: string | undefined;
|
|
2770
|
+
/**
|
|
2771
|
+
* <p>The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery.</p>
|
|
2772
|
+
* @public
|
|
2773
|
+
*/
|
|
2774
|
+
Modification?: DiscoveryModification | undefined;
|
|
2775
|
+
/**
|
|
2776
|
+
* <p>The timestamp indicating when the device was discovered.</p>
|
|
2777
|
+
* @public
|
|
2778
|
+
*/
|
|
2779
|
+
DiscoveredAt?: Date | undefined;
|
|
2780
|
+
/**
|
|
2781
|
+
* <p>The brand of the discovered device.</p>
|
|
2782
|
+
* @public
|
|
2783
|
+
*/
|
|
2784
|
+
Brand?: string | undefined;
|
|
2785
|
+
/**
|
|
2786
|
+
* <p>The model of the discovered device.</p>
|
|
2787
|
+
* @public
|
|
2788
|
+
*/
|
|
2789
|
+
Model?: string | undefined;
|
|
2790
|
+
/**
|
|
2791
|
+
* <p>The authentication material required for connecting to the discovered device, such as credentials or tokens.</p>
|
|
2792
|
+
* @public
|
|
2793
|
+
*/
|
|
2794
|
+
AuthenticationMaterial?: string | undefined;
|
|
2795
|
+
}
|
|
2796
|
+
/**
|
|
2797
|
+
* @public
|
|
2798
|
+
*/
|
|
2799
|
+
export interface ListDiscoveredDevicesResponse {
|
|
2800
|
+
/**
|
|
2801
|
+
* <p>The list of discovered devices that match the specified criteria.</p>
|
|
2802
|
+
* @public
|
|
2803
|
+
*/
|
|
2804
|
+
Items?: DiscoveredDeviceSummary[] | undefined;
|
|
2805
|
+
/**
|
|
2806
|
+
* <p>A token used for pagination of results when there are more discovered devices than can be returned in a single response.</p>
|
|
2807
|
+
* @public
|
|
2808
|
+
*/
|
|
2809
|
+
NextToken?: string | undefined;
|
|
2810
|
+
}
|
|
1570
2811
|
/**
|
|
1571
2812
|
* @public
|
|
1572
2813
|
* @enum
|
|
@@ -1583,11 +2824,15 @@ export type DiscoveryAuthMaterialType = (typeof DiscoveryAuthMaterialType)[keyof
|
|
|
1583
2824
|
*/
|
|
1584
2825
|
export interface StartDeviceDiscoveryRequest {
|
|
1585
2826
|
/**
|
|
1586
|
-
* <p>The discovery type supporting the type of device to be discovered in the device
|
|
1587
|
-
* discovery job request.</p>
|
|
2827
|
+
* <p>The discovery type supporting the type of device to be discovered in the device discovery task request.</p>
|
|
1588
2828
|
* @public
|
|
1589
2829
|
*/
|
|
1590
2830
|
DiscoveryType: DiscoveryType | undefined;
|
|
2831
|
+
/**
|
|
2832
|
+
* <p>Additional protocol-specific details required for device discovery, which vary based on the discovery type.</p> <note> <p>For a <code>DiscoveryType</code> of <code>CUSTOM</code>, the string-to-string map must have a key value of <code>Name</code> set to a non-empty-string.</p> </note>
|
|
2833
|
+
* @public
|
|
2834
|
+
*/
|
|
2835
|
+
CustomProtocolDetail?: Record<string, string> | undefined;
|
|
1591
2836
|
/**
|
|
1592
2837
|
* <p>The id of the end-user's IoT hub.</p>
|
|
1593
2838
|
* @public
|
|
@@ -1595,12 +2840,18 @@ export interface StartDeviceDiscoveryRequest {
|
|
|
1595
2840
|
ControllerIdentifier?: string | undefined;
|
|
1596
2841
|
/**
|
|
1597
2842
|
* <p>The id of the connector association.</p>
|
|
2843
|
+
*
|
|
2844
|
+
* @deprecated
|
|
1598
2845
|
* @public
|
|
1599
2846
|
*/
|
|
1600
2847
|
ConnectorAssociationIdentifier?: string | undefined;
|
|
1601
2848
|
/**
|
|
1602
|
-
* <p>The
|
|
1603
|
-
*
|
|
2849
|
+
* <p>The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.</p>
|
|
2850
|
+
* @public
|
|
2851
|
+
*/
|
|
2852
|
+
AccountAssociationId?: string | undefined;
|
|
2853
|
+
/**
|
|
2854
|
+
* <p>The authentication material required to start the local device discovery job request.</p>
|
|
1604
2855
|
* @public
|
|
1605
2856
|
*/
|
|
1606
2857
|
AuthenticationMaterial?: string | undefined;
|
|
@@ -1610,14 +2861,14 @@ export interface StartDeviceDiscoveryRequest {
|
|
|
1610
2861
|
*/
|
|
1611
2862
|
AuthenticationMaterialType?: DiscoveryAuthMaterialType | undefined;
|
|
1612
2863
|
/**
|
|
1613
|
-
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
1614
|
-
* the same client token and parameters, then the retry attempt will succeed without
|
|
1615
|
-
* performing any further actions.</p>
|
|
2864
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
|
|
1616
2865
|
* @public
|
|
1617
2866
|
*/
|
|
1618
2867
|
ClientToken?: string | undefined;
|
|
1619
2868
|
/**
|
|
1620
2869
|
* <p>A set of key/value pairs that are used to manage the device discovery request.</p>
|
|
2870
|
+
*
|
|
2871
|
+
* @deprecated
|
|
1621
2872
|
* @public
|
|
1622
2873
|
*/
|
|
1623
2874
|
Tags?: Record<string, string> | undefined;
|
|
@@ -1814,8 +3065,7 @@ export interface GetDefaultEncryptionConfigurationResponse {
|
|
|
1814
3065
|
*/
|
|
1815
3066
|
encryptionType: EncryptionType | undefined;
|
|
1816
3067
|
/**
|
|
1817
|
-
* <p>The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use
|
|
1818
|
-
* <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
3068
|
+
* <p>The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
1819
3069
|
* @public
|
|
1820
3070
|
*/
|
|
1821
3071
|
kmsKeyArn?: string | undefined;
|
|
@@ -1843,8 +3093,7 @@ export interface GetHubConfigurationRequest {
|
|
|
1843
3093
|
*/
|
|
1844
3094
|
export interface GetHubConfigurationResponse {
|
|
1845
3095
|
/**
|
|
1846
|
-
* <p>A user-defined integer value that represents the hub token timer expiry setting in
|
|
1847
|
-
* seconds.</p>
|
|
3096
|
+
* <p>A user-defined integer value that represents the hub token timer expiry setting in seconds.</p>
|
|
1848
3097
|
* @public
|
|
1849
3098
|
*/
|
|
1850
3099
|
HubTokenTimerExpirySettingInSeconds?: number | undefined;
|
|
@@ -1909,8 +3158,7 @@ export interface GetManagedThingResponse {
|
|
|
1909
3158
|
*/
|
|
1910
3159
|
Arn?: string | undefined;
|
|
1911
3160
|
/**
|
|
1912
|
-
* <p>Owner of the device, usually an indication of whom the device belongs to. This value
|
|
1913
|
-
* should not contain personal identifiable information.</p>
|
|
3161
|
+
* <p>Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.</p>
|
|
1914
3162
|
* @public
|
|
1915
3163
|
*/
|
|
1916
3164
|
Owner?: string | undefined;
|
|
@@ -1925,14 +3173,12 @@ export interface GetManagedThingResponse {
|
|
|
1925
3173
|
*/
|
|
1926
3174
|
AdvertisedProductId?: string | undefined;
|
|
1927
3175
|
/**
|
|
1928
|
-
* <p>The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT
|
|
1929
|
-
* device.</p>
|
|
3176
|
+
* <p>The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.</p>
|
|
1930
3177
|
* @public
|
|
1931
3178
|
*/
|
|
1932
3179
|
Role?: Role | undefined;
|
|
1933
3180
|
/**
|
|
1934
|
-
* <p>The provisioning status of the device in the provisioning workflow for onboarding to
|
|
1935
|
-
* IoT managed integrations.</p>
|
|
3181
|
+
* <p>The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.</p>
|
|
1936
3182
|
* @public
|
|
1937
3183
|
*/
|
|
1938
3184
|
ProvisioningStatus?: ProvisioningStatus | undefined;
|
|
@@ -1957,8 +3203,7 @@ export interface GetManagedThingResponse {
|
|
|
1957
3203
|
*/
|
|
1958
3204
|
SerialNumber?: string | undefined;
|
|
1959
3205
|
/**
|
|
1960
|
-
* <p>The universal product code (UPC) of the device model. The UPC is typically used in the
|
|
1961
|
-
* United States of America and Canada.</p>
|
|
3206
|
+
* <p>The universal product code (UPC) of the device model. The UPC is typically used in the United States of America and Canada.</p>
|
|
1962
3207
|
* @public
|
|
1963
3208
|
*/
|
|
1964
3209
|
UniversalProductCode?: string | undefined;
|
|
@@ -1968,36 +3213,29 @@ export interface GetManagedThingResponse {
|
|
|
1968
3213
|
*/
|
|
1969
3214
|
InternationalArticleNumber?: string | undefined;
|
|
1970
3215
|
/**
|
|
1971
|
-
* <p>The id of the connector policy.</p>
|
|
1972
|
-
*
|
|
1973
|
-
*
|
|
1974
|
-
* </note>
|
|
3216
|
+
* <p>The id of the connector policy.</p> <note> <p>This parameter is used for cloud-to-cloud devices only.</p> </note>
|
|
3217
|
+
*
|
|
3218
|
+
* @deprecated
|
|
1975
3219
|
* @public
|
|
1976
3220
|
*/
|
|
1977
3221
|
ConnectorPolicyId?: string | undefined;
|
|
1978
3222
|
/**
|
|
1979
|
-
* <p>The
|
|
1980
|
-
*
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
|
|
3223
|
+
* <p>The identifier of the connector destination associated with this managed thing.</p>
|
|
3224
|
+
* @public
|
|
3225
|
+
*/
|
|
3226
|
+
ConnectorDestinationId?: string | undefined;
|
|
3227
|
+
/**
|
|
3228
|
+
* <p>The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).</p> <note> <p>This parameter is used for cloud-to-cloud devices only.</p> </note>
|
|
1984
3229
|
* @public
|
|
1985
3230
|
*/
|
|
1986
3231
|
ConnectorDeviceId?: string | undefined;
|
|
1987
3232
|
/**
|
|
1988
|
-
* <p>A Zwave device-specific key used during device activation.</p>
|
|
1989
|
-
* <note>
|
|
1990
|
-
* <p>This parameter is used for Zwave devices only.</p>
|
|
1991
|
-
* </note>
|
|
3233
|
+
* <p>A Zwave device-specific key used during device activation.</p> <note> <p>This parameter is used for Zwave devices only.</p> </note>
|
|
1992
3234
|
* @public
|
|
1993
3235
|
*/
|
|
1994
3236
|
DeviceSpecificKey?: string | undefined;
|
|
1995
3237
|
/**
|
|
1996
|
-
* <p>The media access control (MAC) address for the device represented by the managed
|
|
1997
|
-
* thing.</p>
|
|
1998
|
-
* <note>
|
|
1999
|
-
* <p>This parameter is used for Zigbee devices only.</p>
|
|
2000
|
-
* </note>
|
|
3238
|
+
* <p>The media access control (MAC) address for the device represented by the managed thing.</p> <note> <p>This parameter is used for Zigbee devices only.</p> </note>
|
|
2001
3239
|
* @public
|
|
2002
3240
|
*/
|
|
2003
3241
|
MacAddress?: string | undefined;
|
|
@@ -2097,8 +3335,7 @@ export interface GetManagedThingConnectivityDataResponse {
|
|
|
2097
3335
|
*/
|
|
2098
3336
|
Connected?: boolean | undefined;
|
|
2099
3337
|
/**
|
|
2100
|
-
* <p>The timestamp value of when the connectivity status for a managed thing was last
|
|
2101
|
-
* taken.</p>
|
|
3338
|
+
* <p>The timestamp value of when the connectivity status for a managed thing was last taken.</p>
|
|
2102
3339
|
* @public
|
|
2103
3340
|
*/
|
|
2104
3341
|
Timestamp?: Date | undefined;
|
|
@@ -2170,8 +3407,7 @@ export interface StateCapability {
|
|
|
2170
3407
|
properties?: __DocumentType | undefined;
|
|
2171
3408
|
}
|
|
2172
3409
|
/**
|
|
2173
|
-
* <p>Describe the endpoint with an Id, a name, and the relevant capabilities for reporting
|
|
2174
|
-
* state</p>
|
|
3410
|
+
* <p>Describe the endpoint with an Id, a name, and the relevant capabilities for reporting state</p>
|
|
2175
3411
|
* @public
|
|
2176
3412
|
*/
|
|
2177
3413
|
export interface StateEndpoint {
|
|
@@ -2181,8 +3417,7 @@ export interface StateEndpoint {
|
|
|
2181
3417
|
*/
|
|
2182
3418
|
endpointId: string | undefined;
|
|
2183
3419
|
/**
|
|
2184
|
-
* <p>Describe the endpoint with an id, a name, and the relevant capabilities for the
|
|
2185
|
-
* reporting state.</p>
|
|
3420
|
+
* <p>Describe the endpoint with an id, a name, and the relevant capabilities for the reporting state.</p>
|
|
2186
3421
|
* @public
|
|
2187
3422
|
*/
|
|
2188
3423
|
capabilities: StateCapability[] | undefined;
|
|
@@ -2202,8 +3437,7 @@ export interface GetManagedThingStateResponse {
|
|
|
2202
3437
|
*/
|
|
2203
3438
|
export interface GetNotificationConfigurationRequest {
|
|
2204
3439
|
/**
|
|
2205
|
-
* <p>The type of event triggering a device notification to the customer-managed
|
|
2206
|
-
* destination.</p>
|
|
3440
|
+
* <p>The type of event triggering a device notification to the customer-managed destination.</p>
|
|
2207
3441
|
* @public
|
|
2208
3442
|
*/
|
|
2209
3443
|
EventType: EventType | undefined;
|
|
@@ -2213,8 +3447,7 @@ export interface GetNotificationConfigurationRequest {
|
|
|
2213
3447
|
*/
|
|
2214
3448
|
export interface GetNotificationConfigurationResponse {
|
|
2215
3449
|
/**
|
|
2216
|
-
* <p>The type of event triggering a device notification to the customer-managed
|
|
2217
|
-
* destination.</p>
|
|
3450
|
+
* <p>The type of event triggering a device notification to the customer-managed destination.</p>
|
|
2218
3451
|
* @public
|
|
2219
3452
|
*/
|
|
2220
3453
|
EventType?: EventType | undefined;
|
|
@@ -2235,6 +3468,8 @@ export interface GetNotificationConfigurationResponse {
|
|
|
2235
3468
|
UpdatedAt?: Date | undefined;
|
|
2236
3469
|
/**
|
|
2237
3470
|
* <p>A set of key/value pairs that are used to manage the notification configuration.</p>
|
|
3471
|
+
*
|
|
3472
|
+
* @deprecated
|
|
2238
3473
|
* @public
|
|
2239
3474
|
*/
|
|
2240
3475
|
Tags?: Record<string, string> | undefined;
|
|
@@ -2399,6 +3634,11 @@ export interface GetOtaTaskResponse {
|
|
|
2399
3634
|
* @public
|
|
2400
3635
|
*/
|
|
2401
3636
|
Status?: OtaStatus | undefined;
|
|
3637
|
+
/**
|
|
3638
|
+
* <p>A set of key/value pairs that are used to manage the over-the-air (OTA) task.</p>
|
|
3639
|
+
* @public
|
|
3640
|
+
*/
|
|
3641
|
+
Tags?: Record<string, string> | undefined;
|
|
2402
3642
|
}
|
|
2403
3643
|
/**
|
|
2404
3644
|
* @public
|
|
@@ -2435,8 +3675,7 @@ export interface GetOtaTaskConfigurationResponse {
|
|
|
2435
3675
|
*/
|
|
2436
3676
|
Description?: string | undefined;
|
|
2437
3677
|
/**
|
|
2438
|
-
* <p>The timestamp value of when the over-the-air (OTA) task configuration was created
|
|
2439
|
-
* at.</p>
|
|
3678
|
+
* <p>The timestamp value of when the over-the-air (OTA) task configuration was created at.</p>
|
|
2440
3679
|
* @public
|
|
2441
3680
|
*/
|
|
2442
3681
|
CreatedAt?: Date | undefined;
|
|
@@ -2456,8 +3695,7 @@ export interface GetProvisioningProfileRequest {
|
|
|
2456
3695
|
*/
|
|
2457
3696
|
export interface GetProvisioningProfileResponse {
|
|
2458
3697
|
/**
|
|
2459
|
-
* <p>The Amazon Resource Name (ARN) of the provisioning template used in the provisioning
|
|
2460
|
-
* profile.</p>
|
|
3698
|
+
* <p>The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.</p>
|
|
2461
3699
|
* @public
|
|
2462
3700
|
*/
|
|
2463
3701
|
Arn?: string | undefined;
|
|
@@ -2518,14 +3756,12 @@ export interface RuntimeLogConfigurations {
|
|
|
2518
3756
|
*/
|
|
2519
3757
|
LocalStoreLocation?: string | undefined;
|
|
2520
3758
|
/**
|
|
2521
|
-
* <p>Configuration to set the maximum number of runtime log files that can be stored on the
|
|
2522
|
-
* device before the oldest files are deleted or overwritten.</p>
|
|
3759
|
+
* <p>Configuration to set the maximum number of runtime log files that can be stored on the device before the oldest files are deleted or overwritten.</p>
|
|
2523
3760
|
* @public
|
|
2524
3761
|
*/
|
|
2525
3762
|
LocalStoreFileRotationMaxFiles?: number | undefined;
|
|
2526
3763
|
/**
|
|
2527
|
-
* <p>Configuration to set the maximum bytes of runtime logs that can be stored on the device
|
|
2528
|
-
* before the oldest logs are deleted or overwritten.</p>
|
|
3764
|
+
* <p>Configuration to set the maximum bytes of runtime logs that can be stored on the device before the oldest logs are deleted or overwritten.</p>
|
|
2529
3765
|
* @public
|
|
2530
3766
|
*/
|
|
2531
3767
|
LocalStoreFileRotationMaxBytes?: number | undefined;
|
|
@@ -2535,14 +3771,12 @@ export interface RuntimeLogConfigurations {
|
|
|
2535
3771
|
*/
|
|
2536
3772
|
UploadLog?: boolean | undefined;
|
|
2537
3773
|
/**
|
|
2538
|
-
* <p>Configuration to set the time interval in minutes between each batch of runtime logs
|
|
2539
|
-
* that the device uploads to the cloud.</p>
|
|
3774
|
+
* <p>Configuration to set the time interval in minutes between each batch of runtime logs that the device uploads to the cloud.</p>
|
|
2540
3775
|
* @public
|
|
2541
3776
|
*/
|
|
2542
3777
|
UploadPeriodMinutes?: number | undefined;
|
|
2543
3778
|
/**
|
|
2544
|
-
* <p>Configuration to enable or disable deleting of runtime logs in the device once uploaded
|
|
2545
|
-
* to the cloud.</p>
|
|
3779
|
+
* <p>Configuration to enable or disable deleting of runtime logs in the device once uploaded to the cloud.</p>
|
|
2546
3780
|
* @public
|
|
2547
3781
|
*/
|
|
2548
3782
|
DeleteLocalStoreAfterUpload?: boolean | undefined;
|
|
@@ -2554,27 +3788,14 @@ export interface GetRuntimeLogConfigurationResponse {
|
|
|
2554
3788
|
/**
|
|
2555
3789
|
* <p>The id for a managed thing.</p>
|
|
2556
3790
|
* @public
|
|
2557
|
-
*/
|
|
2558
|
-
ManagedThingId?: string | undefined;
|
|
2559
|
-
/**
|
|
2560
|
-
* <p>The runtime log configuration for a managed thing.</p>
|
|
2561
|
-
* @public
|
|
2562
|
-
*/
|
|
2563
|
-
RuntimeLogConfigurations?: RuntimeLogConfigurations | undefined;
|
|
2564
|
-
}
|
|
2565
|
-
/**
|
|
2566
|
-
* @public
|
|
2567
|
-
* @enum
|
|
2568
|
-
*/
|
|
2569
|
-
export declare const SchemaVersionFormat: {
|
|
2570
|
-
readonly AWS: "AWS";
|
|
2571
|
-
readonly CONNECTOR: "CONNECTOR";
|
|
2572
|
-
readonly ZCL: "ZCL";
|
|
2573
|
-
};
|
|
2574
|
-
/**
|
|
2575
|
-
* @public
|
|
2576
|
-
*/
|
|
2577
|
-
export type SchemaVersionFormat = (typeof SchemaVersionFormat)[keyof typeof SchemaVersionFormat];
|
|
3791
|
+
*/
|
|
3792
|
+
ManagedThingId?: string | undefined;
|
|
3793
|
+
/**
|
|
3794
|
+
* <p>The runtime log configuration for a managed thing.</p>
|
|
3795
|
+
* @public
|
|
3796
|
+
*/
|
|
3797
|
+
RuntimeLogConfigurations?: RuntimeLogConfigurations | undefined;
|
|
3798
|
+
}
|
|
2578
3799
|
/**
|
|
2579
3800
|
* @public
|
|
2580
3801
|
* @enum
|
|
@@ -2597,8 +3818,7 @@ export interface GetSchemaVersionRequest {
|
|
|
2597
3818
|
*/
|
|
2598
3819
|
Type: SchemaVersionType | undefined;
|
|
2599
3820
|
/**
|
|
2600
|
-
* <p>Schema id with a version specified. If the version is missing, it defaults to latest
|
|
2601
|
-
* version.</p>
|
|
3821
|
+
* <p>Schema id with a version specified. If the version is missing, it defaults to latest version.</p>
|
|
2602
3822
|
* @public
|
|
2603
3823
|
*/
|
|
2604
3824
|
SchemaVersionedId: string | undefined;
|
|
@@ -2665,8 +3885,7 @@ export interface GetSchemaVersionResponse {
|
|
|
2665
3885
|
*/
|
|
2666
3886
|
export interface PutHubConfigurationRequest {
|
|
2667
3887
|
/**
|
|
2668
|
-
* <p>A user-defined integer value that represents the hub token timer expiry setting in
|
|
2669
|
-
* seconds.</p>
|
|
3888
|
+
* <p>A user-defined integer value that represents the hub token timer expiry setting in seconds.</p>
|
|
2670
3889
|
* @public
|
|
2671
3890
|
*/
|
|
2672
3891
|
HubTokenTimerExpirySettingInSeconds: number | undefined;
|
|
@@ -2676,12 +3895,24 @@ export interface PutHubConfigurationRequest {
|
|
|
2676
3895
|
*/
|
|
2677
3896
|
export interface PutHubConfigurationResponse {
|
|
2678
3897
|
/**
|
|
2679
|
-
* <p>A user-defined integer value that represents the hub token timer expiry setting in
|
|
2680
|
-
* seconds.</p>
|
|
3898
|
+
* <p>A user-defined integer value that represents the hub token timer expiry setting in seconds.</p>
|
|
2681
3899
|
* @public
|
|
2682
3900
|
*/
|
|
2683
3901
|
HubTokenTimerExpirySettingInSeconds?: number | undefined;
|
|
2684
3902
|
}
|
|
3903
|
+
/**
|
|
3904
|
+
* <p>The request is not valid.</p>
|
|
3905
|
+
* @public
|
|
3906
|
+
*/
|
|
3907
|
+
export declare class InvalidRequestException extends __BaseException {
|
|
3908
|
+
readonly name: "InvalidRequestException";
|
|
3909
|
+
readonly $fault: "client";
|
|
3910
|
+
Message?: string | undefined;
|
|
3911
|
+
/**
|
|
3912
|
+
* @internal
|
|
3913
|
+
*/
|
|
3914
|
+
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
3915
|
+
}
|
|
2685
3916
|
/**
|
|
2686
3917
|
* @public
|
|
2687
3918
|
*/
|
|
@@ -2692,8 +3923,7 @@ export interface PutDefaultEncryptionConfigurationRequest {
|
|
|
2692
3923
|
*/
|
|
2693
3924
|
encryptionType: EncryptionType | undefined;
|
|
2694
3925
|
/**
|
|
2695
|
-
* <p>The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use
|
|
2696
|
-
* <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
3926
|
+
* <p>The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
2697
3927
|
* @public
|
|
2698
3928
|
*/
|
|
2699
3929
|
kmsKeyArn?: string | undefined;
|
|
@@ -2713,12 +3943,127 @@ export interface PutDefaultEncryptionConfigurationResponse {
|
|
|
2713
3943
|
*/
|
|
2714
3944
|
encryptionType: EncryptionType | undefined;
|
|
2715
3945
|
/**
|
|
2716
|
-
* <p>The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use
|
|
2717
|
-
* <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
3946
|
+
* <p>The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
2718
3947
|
* @public
|
|
2719
3948
|
*/
|
|
2720
3949
|
kmsKeyArn?: string | undefined;
|
|
2721
3950
|
}
|
|
3951
|
+
/**
|
|
3952
|
+
* @public
|
|
3953
|
+
*/
|
|
3954
|
+
export interface ListTagsForResourceRequest {
|
|
3955
|
+
/**
|
|
3956
|
+
* The ARN of the resource for which to list tags.
|
|
3957
|
+
* @public
|
|
3958
|
+
*/
|
|
3959
|
+
ResourceArn: string | undefined;
|
|
3960
|
+
}
|
|
3961
|
+
/**
|
|
3962
|
+
* @public
|
|
3963
|
+
*/
|
|
3964
|
+
export interface ListTagsForResourceResponse {
|
|
3965
|
+
/**
|
|
3966
|
+
* A set of key/value pairs that are used to manage the resource.
|
|
3967
|
+
* @public
|
|
3968
|
+
*/
|
|
3969
|
+
tags?: Record<string, string> | undefined;
|
|
3970
|
+
}
|
|
3971
|
+
/**
|
|
3972
|
+
* @public
|
|
3973
|
+
*/
|
|
3974
|
+
export interface ListManagedThingAccountAssociationsRequest {
|
|
3975
|
+
/**
|
|
3976
|
+
* <p>The identifier of the managed thing to list account associations for.</p>
|
|
3977
|
+
* @public
|
|
3978
|
+
*/
|
|
3979
|
+
ManagedThingId?: string | undefined;
|
|
3980
|
+
/**
|
|
3981
|
+
* <p>The identifier of the account association to filter results by. When specified, only associations with this account association ID will be returned.</p>
|
|
3982
|
+
* @public
|
|
3983
|
+
*/
|
|
3984
|
+
AccountAssociationId?: string | undefined;
|
|
3985
|
+
/**
|
|
3986
|
+
* <p>The maximum number of account associations to return in a single response.</p>
|
|
3987
|
+
* @public
|
|
3988
|
+
*/
|
|
3989
|
+
MaxResults?: number | undefined;
|
|
3990
|
+
/**
|
|
3991
|
+
* <p>A token used for pagination of results.</p>
|
|
3992
|
+
* @public
|
|
3993
|
+
*/
|
|
3994
|
+
NextToken?: string | undefined;
|
|
3995
|
+
}
|
|
3996
|
+
/**
|
|
3997
|
+
* <p>Structure representing an association between a managed thing and an account association, which connects a device to a third-party account.</p>
|
|
3998
|
+
* @public
|
|
3999
|
+
*/
|
|
4000
|
+
export interface ManagedThingAssociation {
|
|
4001
|
+
/**
|
|
4002
|
+
* <p>The identifier of the managed thing in the association.</p>
|
|
4003
|
+
* @public
|
|
4004
|
+
*/
|
|
4005
|
+
ManagedThingId?: string | undefined;
|
|
4006
|
+
/**
|
|
4007
|
+
* <p>The identifier of the account association in the association.</p>
|
|
4008
|
+
* @public
|
|
4009
|
+
*/
|
|
4010
|
+
AccountAssociationId?: string | undefined;
|
|
4011
|
+
}
|
|
4012
|
+
/**
|
|
4013
|
+
* @public
|
|
4014
|
+
*/
|
|
4015
|
+
export interface ListManagedThingAccountAssociationsResponse {
|
|
4016
|
+
/**
|
|
4017
|
+
* <p>The list of managed thing associations that match the specified criteria, including the managed thing ID and account association ID for each association.</p>
|
|
4018
|
+
* @public
|
|
4019
|
+
*/
|
|
4020
|
+
Items?: ManagedThingAssociation[] | undefined;
|
|
4021
|
+
/**
|
|
4022
|
+
* <p>A token used for pagination of results when there are more account associations than can be returned in a single response.</p>
|
|
4023
|
+
* @public
|
|
4024
|
+
*/
|
|
4025
|
+
NextToken?: string | undefined;
|
|
4026
|
+
}
|
|
4027
|
+
/**
|
|
4028
|
+
* @public
|
|
4029
|
+
*/
|
|
4030
|
+
export interface RegisterAccountAssociationRequest {
|
|
4031
|
+
/**
|
|
4032
|
+
* <p>The identifier of the managed thing to register with the account association.</p>
|
|
4033
|
+
* @public
|
|
4034
|
+
*/
|
|
4035
|
+
ManagedThingId: string | undefined;
|
|
4036
|
+
/**
|
|
4037
|
+
* <p>The identifier of the account association to register with the managed thing.</p>
|
|
4038
|
+
* @public
|
|
4039
|
+
*/
|
|
4040
|
+
AccountAssociationId: string | undefined;
|
|
4041
|
+
/**
|
|
4042
|
+
* <p>The identifier of the device discovery job associated with this registration.</p>
|
|
4043
|
+
* @public
|
|
4044
|
+
*/
|
|
4045
|
+
DeviceDiscoveryId: string | undefined;
|
|
4046
|
+
}
|
|
4047
|
+
/**
|
|
4048
|
+
* @public
|
|
4049
|
+
*/
|
|
4050
|
+
export interface RegisterAccountAssociationResponse {
|
|
4051
|
+
/**
|
|
4052
|
+
* <p>The identifier of the account association that was registered.</p>
|
|
4053
|
+
* @public
|
|
4054
|
+
*/
|
|
4055
|
+
AccountAssociationId?: string | undefined;
|
|
4056
|
+
/**
|
|
4057
|
+
* <p>The identifier of the device discovery job associated with this registration.</p>
|
|
4058
|
+
* @public
|
|
4059
|
+
*/
|
|
4060
|
+
DeviceDiscoveryId?: string | undefined;
|
|
4061
|
+
/**
|
|
4062
|
+
* <p>The identifier of the managed thing that was registered with the account association.</p>
|
|
4063
|
+
* @public
|
|
4064
|
+
*/
|
|
4065
|
+
ManagedThingId?: string | undefined;
|
|
4066
|
+
}
|
|
2722
4067
|
/**
|
|
2723
4068
|
* @public
|
|
2724
4069
|
*/
|
|
@@ -2735,17 +4080,23 @@ export interface SendManagedThingCommandRequest {
|
|
|
2735
4080
|
Endpoints: CommandEndpoint[] | undefined;
|
|
2736
4081
|
/**
|
|
2737
4082
|
* <p>The ID tracking the current discovery process for one connector association.</p>
|
|
4083
|
+
*
|
|
4084
|
+
* @deprecated
|
|
2738
4085
|
* @public
|
|
2739
4086
|
*/
|
|
2740
4087
|
ConnectorAssociationId?: string | undefined;
|
|
4088
|
+
/**
|
|
4089
|
+
* <p>The identifier of the account association to use when sending a command to a managed thing.</p>
|
|
4090
|
+
* @public
|
|
4091
|
+
*/
|
|
4092
|
+
AccountAssociationId?: string | undefined;
|
|
2741
4093
|
}
|
|
2742
4094
|
/**
|
|
2743
4095
|
* @public
|
|
2744
4096
|
*/
|
|
2745
4097
|
export interface SendManagedThingCommandResponse {
|
|
2746
4098
|
/**
|
|
2747
|
-
* <p>The trace request identifier. This is specified by the device owner, but will be
|
|
2748
|
-
* generated by IoT managed integrations if not provided by the device owner.</p>
|
|
4099
|
+
* <p>The trace request identifier. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.</p>
|
|
2749
4100
|
* @public
|
|
2750
4101
|
*/
|
|
2751
4102
|
TraceId?: string | undefined;
|
|
@@ -2765,8 +4116,7 @@ export interface ListManagedThingsRequest {
|
|
|
2765
4116
|
*/
|
|
2766
4117
|
CredentialLockerFilter?: string | undefined;
|
|
2767
4118
|
/**
|
|
2768
|
-
* <p>Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device,
|
|
2769
|
-
* or IoT device.</p>
|
|
4119
|
+
* <p>Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.</p>
|
|
2770
4120
|
* @public
|
|
2771
4121
|
*/
|
|
2772
4122
|
RoleFilter?: Role | undefined;
|
|
@@ -2777,9 +4127,21 @@ export interface ListManagedThingsRequest {
|
|
|
2777
4127
|
ParentControllerIdentifierFilter?: string | undefined;
|
|
2778
4128
|
/**
|
|
2779
4129
|
* <p>Filter on a connector policy id for a managed thing.</p>
|
|
4130
|
+
*
|
|
4131
|
+
* @deprecated
|
|
2780
4132
|
* @public
|
|
2781
4133
|
*/
|
|
2782
4134
|
ConnectorPolicyIdFilter?: string | undefined;
|
|
4135
|
+
/**
|
|
4136
|
+
* <p>Filter managed things by the connector destination ID they are associated with.</p>
|
|
4137
|
+
* @public
|
|
4138
|
+
*/
|
|
4139
|
+
ConnectorDestinationIdFilter?: string | undefined;
|
|
4140
|
+
/**
|
|
4141
|
+
* <p>Filter managed things by the connector device ID they are associated with. When specified, only managed things with this connector device ID will be returned.</p>
|
|
4142
|
+
* @public
|
|
4143
|
+
*/
|
|
4144
|
+
ConnectorDeviceIdFilter?: string | undefined;
|
|
2783
4145
|
/**
|
|
2784
4146
|
* <p>Filter on the serial number of the device.</p>
|
|
2785
4147
|
* @public
|
|
@@ -2832,22 +4194,22 @@ export interface ManagedThingSummary {
|
|
|
2832
4194
|
*/
|
|
2833
4195
|
Classification?: string | undefined;
|
|
2834
4196
|
/**
|
|
2835
|
-
* <p>The third-party device id as defined by the connector. This device id must not contain
|
|
2836
|
-
* personal identifiable information (PII).</p>
|
|
2837
|
-
* <note>
|
|
2838
|
-
* <p>This parameter is used for cloud-to-cloud devices only.</p>
|
|
2839
|
-
* </note>
|
|
4197
|
+
* <p>The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).</p> <note> <p>This parameter is used for cloud-to-cloud devices only.</p> </note>
|
|
2840
4198
|
* @public
|
|
2841
4199
|
*/
|
|
2842
4200
|
ConnectorDeviceId?: string | undefined;
|
|
2843
4201
|
/**
|
|
2844
|
-
* <p>The id of the connector policy.</p>
|
|
2845
|
-
*
|
|
2846
|
-
*
|
|
2847
|
-
* </note>
|
|
4202
|
+
* <p>The id of the connector policy.</p> <note> <p>This parameter is used for cloud-to-cloud devices only.</p> </note>
|
|
4203
|
+
*
|
|
4204
|
+
* @deprecated
|
|
2848
4205
|
* @public
|
|
2849
4206
|
*/
|
|
2850
4207
|
ConnectorPolicyId?: string | undefined;
|
|
4208
|
+
/**
|
|
4209
|
+
* <p>The identifier of the connector destination associated with this managed thing, if applicable.</p>
|
|
4210
|
+
* @public
|
|
4211
|
+
*/
|
|
4212
|
+
ConnectorDestinationId?: string | undefined;
|
|
2851
4213
|
/**
|
|
2852
4214
|
* <p>The model of the device.</p>
|
|
2853
4215
|
* @public
|
|
@@ -2859,8 +4221,7 @@ export interface ManagedThingSummary {
|
|
|
2859
4221
|
*/
|
|
2860
4222
|
Name?: string | undefined;
|
|
2861
4223
|
/**
|
|
2862
|
-
* <p>Owner of the device, usually an indication of whom the device belongs to. This value
|
|
2863
|
-
* should not contain personal identifiable information.</p>
|
|
4224
|
+
* <p>Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.</p>
|
|
2864
4225
|
* @public
|
|
2865
4226
|
*/
|
|
2866
4227
|
Owner?: string | undefined;
|
|
@@ -2875,14 +4236,12 @@ export interface ManagedThingSummary {
|
|
|
2875
4236
|
*/
|
|
2876
4237
|
ParentControllerId?: string | undefined;
|
|
2877
4238
|
/**
|
|
2878
|
-
* <p>The provisioning status of the device in the provisioning workflow for onboarding to
|
|
2879
|
-
* IoT managed integrations.</p>
|
|
4239
|
+
* <p>The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.</p>
|
|
2880
4240
|
* @public
|
|
2881
4241
|
*/
|
|
2882
4242
|
ProvisioningStatus?: ProvisioningStatus | undefined;
|
|
2883
4243
|
/**
|
|
2884
|
-
* <p>The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT
|
|
2885
|
-
* device.</p>
|
|
4244
|
+
* <p>The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.</p>
|
|
2886
4245
|
* @public
|
|
2887
4246
|
*/
|
|
2888
4247
|
Role?: Role | undefined;
|
|
@@ -2998,8 +4357,7 @@ export interface UpdateManagedThingRequest {
|
|
|
2998
4357
|
*/
|
|
2999
4358
|
Identifier: string | undefined;
|
|
3000
4359
|
/**
|
|
3001
|
-
* <p>Owner of the device, usually an indication of whom the device belongs to. This value
|
|
3002
|
-
* should not contain personal identifiable information.</p>
|
|
4360
|
+
* <p>Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.</p>
|
|
3003
4361
|
* @public
|
|
3004
4362
|
*/
|
|
3005
4363
|
Owner?: string | undefined;
|
|
@@ -3033,6 +4391,11 @@ export interface UpdateManagedThingRequest {
|
|
|
3033
4391
|
* @public
|
|
3034
4392
|
*/
|
|
3035
4393
|
CapabilityReport?: CapabilityReport | undefined;
|
|
4394
|
+
/**
|
|
4395
|
+
* <p>The updated capability schemas that define the functionality and features supported by the managed thing.</p>
|
|
4396
|
+
* @public
|
|
4397
|
+
*/
|
|
4398
|
+
CapabilitySchemas?: CapabilitySchemaItem[] | undefined;
|
|
3036
4399
|
/**
|
|
3037
4400
|
* <p>The capabilities of the device such as light bulb.</p>
|
|
3038
4401
|
* @public
|
|
@@ -3075,8 +4438,7 @@ export interface ListNotificationConfigurationsRequest {
|
|
|
3075
4438
|
*/
|
|
3076
4439
|
export interface NotificationConfigurationSummary {
|
|
3077
4440
|
/**
|
|
3078
|
-
* <p>The type of event triggering a device notification to the customer-managed
|
|
3079
|
-
* destination.</p>
|
|
4441
|
+
* <p>The type of event triggering a device notification to the customer-managed destination.</p>
|
|
3080
4442
|
* @public
|
|
3081
4443
|
*/
|
|
3082
4444
|
EventType?: EventType | undefined;
|
|
@@ -3106,8 +4468,7 @@ export interface ListNotificationConfigurationsResponse {
|
|
|
3106
4468
|
*/
|
|
3107
4469
|
export interface UpdateNotificationConfigurationRequest {
|
|
3108
4470
|
/**
|
|
3109
|
-
* <p>The type of event triggering a device notification to the customer-managed
|
|
3110
|
-
* destination.</p>
|
|
4471
|
+
* <p>The type of event triggering a device notification to the customer-managed destination.</p>
|
|
3111
4472
|
* @public
|
|
3112
4473
|
*/
|
|
3113
4474
|
EventType: EventType | undefined;
|
|
@@ -3148,8 +4509,7 @@ export interface OtaTaskConfigurationSummary {
|
|
|
3148
4509
|
*/
|
|
3149
4510
|
Name?: string | undefined;
|
|
3150
4511
|
/**
|
|
3151
|
-
* <p>The timestamp value of when the over-the-air (OTA) task configuration was created
|
|
3152
|
-
* at.</p>
|
|
4512
|
+
* <p>The timestamp value of when the over-the-air (OTA) task configuration was created at.</p>
|
|
3153
4513
|
* @public
|
|
3154
4514
|
*/
|
|
3155
4515
|
CreatedAt?: Date | undefined;
|
|
@@ -3218,26 +4578,22 @@ export interface OtaTaskExecutionSummary {
|
|
|
3218
4578
|
*/
|
|
3219
4579
|
ExecutionNumber?: number | undefined;
|
|
3220
4580
|
/**
|
|
3221
|
-
* <p>The timestamp value of when the over-the-air (OTA) task execution summary was last
|
|
3222
|
-
* updated.</p>
|
|
4581
|
+
* <p>The timestamp value of when the over-the-air (OTA) task execution summary was last updated.</p>
|
|
3223
4582
|
* @public
|
|
3224
4583
|
*/
|
|
3225
4584
|
LastUpdatedAt?: Date | undefined;
|
|
3226
4585
|
/**
|
|
3227
|
-
* <p>The timestamp value of when the over-the-air (OTA) task execution summary is targeted to
|
|
3228
|
-
* start.</p>
|
|
4586
|
+
* <p>The timestamp value of when the over-the-air (OTA) task execution summary is targeted to start.</p>
|
|
3229
4587
|
* @public
|
|
3230
4588
|
*/
|
|
3231
4589
|
QueuedAt?: Date | undefined;
|
|
3232
4590
|
/**
|
|
3233
|
-
* <p>The number of retry attempts for starting the over-the-air (OTA) task execution summary
|
|
3234
|
-
* after a failed attempt.</p>
|
|
4591
|
+
* <p>The number of retry attempts for starting the over-the-air (OTA) task execution summary after a failed attempt.</p>
|
|
3235
4592
|
* @public
|
|
3236
4593
|
*/
|
|
3237
4594
|
RetryAttempt?: number | undefined;
|
|
3238
4595
|
/**
|
|
3239
|
-
* <p>The timestamp value of when the over-the-air (OTA) task execution summary
|
|
3240
|
-
* started.</p>
|
|
4596
|
+
* <p>The timestamp value of when the over-the-air (OTA) task execution summary started.</p>
|
|
3241
4597
|
* @public
|
|
3242
4598
|
*/
|
|
3243
4599
|
StartedAt?: Date | undefined;
|
|
@@ -3395,8 +4751,7 @@ export interface ProvisioningProfileSummary {
|
|
|
3395
4751
|
*/
|
|
3396
4752
|
Id?: string | undefined;
|
|
3397
4753
|
/**
|
|
3398
|
-
* <p>The Amazon Resource Name (ARN) of the provisioning template used in the provisioning
|
|
3399
|
-
* profile.</p>
|
|
4754
|
+
* <p>The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.</p>
|
|
3400
4755
|
* @public
|
|
3401
4756
|
*/
|
|
3402
4757
|
Arn?: string | undefined;
|
|
@@ -3552,6 +4907,174 @@ export interface ListSchemaVersionsResponse {
|
|
|
3552
4907
|
*/
|
|
3553
4908
|
NextToken?: string | undefined;
|
|
3554
4909
|
}
|
|
4910
|
+
/**
|
|
4911
|
+
* <p>Describe a Matter cluster with an id, and the relevant attributes, commands, and events.</p>
|
|
4912
|
+
* @public
|
|
4913
|
+
*/
|
|
4914
|
+
export interface MatterCluster {
|
|
4915
|
+
/**
|
|
4916
|
+
* <p>The cluster id.</p>
|
|
4917
|
+
* @public
|
|
4918
|
+
*/
|
|
4919
|
+
id?: string | undefined;
|
|
4920
|
+
/**
|
|
4921
|
+
* <p>The Matter attributes.</p>
|
|
4922
|
+
* @public
|
|
4923
|
+
*/
|
|
4924
|
+
attributes?: __DocumentType | undefined;
|
|
4925
|
+
/**
|
|
4926
|
+
* <p>Describe the Matter commands with the Matter command identifier mapped to the command fields.</p>
|
|
4927
|
+
* @public
|
|
4928
|
+
*/
|
|
4929
|
+
commands?: Record<string, __DocumentType> | undefined;
|
|
4930
|
+
/**
|
|
4931
|
+
* <p>Describe the Matter events with the Matter event identifier mapped to the event fields.</p>
|
|
4932
|
+
* @public
|
|
4933
|
+
*/
|
|
4934
|
+
events?: Record<string, __DocumentType> | undefined;
|
|
4935
|
+
}
|
|
4936
|
+
/**
|
|
4937
|
+
* <p>Structure describing a managed thing.</p>
|
|
4938
|
+
* @public
|
|
4939
|
+
*/
|
|
4940
|
+
export interface MatterEndpoint {
|
|
4941
|
+
/**
|
|
4942
|
+
* <p>The Matter endpoint id.</p>
|
|
4943
|
+
* @public
|
|
4944
|
+
*/
|
|
4945
|
+
id?: string | undefined;
|
|
4946
|
+
/**
|
|
4947
|
+
* <p>A list of Matter clusters for a managed thing.</p>
|
|
4948
|
+
* @public
|
|
4949
|
+
*/
|
|
4950
|
+
clusters?: MatterCluster[] | undefined;
|
|
4951
|
+
}
|
|
4952
|
+
/**
|
|
4953
|
+
* @public
|
|
4954
|
+
*/
|
|
4955
|
+
export interface SendConnectorEventRequest {
|
|
4956
|
+
/**
|
|
4957
|
+
* <p>The id of the connector between the third-party cloud provider and IoT managed integrations.</p>
|
|
4958
|
+
* @public
|
|
4959
|
+
*/
|
|
4960
|
+
ConnectorId: string | undefined;
|
|
4961
|
+
/**
|
|
4962
|
+
* <p>The id of the third-party cloud provider.</p>
|
|
4963
|
+
* @public
|
|
4964
|
+
*/
|
|
4965
|
+
UserId?: string | undefined;
|
|
4966
|
+
/**
|
|
4967
|
+
* <p>The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.</p> <note> <p>The field op can have a value of "I" or "U". The field "cn" will contain the capability types.</p> </note>
|
|
4968
|
+
* @public
|
|
4969
|
+
*/
|
|
4970
|
+
Operation: ConnectorEventOperation | undefined;
|
|
4971
|
+
/**
|
|
4972
|
+
* <p>The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see <a href="https://openconnectivity.org/specs/OCF_Security_Specification_v1.0.0.pdf">OCF Security Specification</a>.</p>
|
|
4973
|
+
* @public
|
|
4974
|
+
*/
|
|
4975
|
+
OperationVersion?: string | undefined;
|
|
4976
|
+
/**
|
|
4977
|
+
* <p>The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.</p>
|
|
4978
|
+
* @public
|
|
4979
|
+
*/
|
|
4980
|
+
StatusCode?: number | undefined;
|
|
4981
|
+
/**
|
|
4982
|
+
* <p>The device state change event payload.</p> <p>This parameter will include the following three fields:</p> <ul> <li> <p> <code>uri</code>: <code>schema auc://<PARTNER-DEVICE-ID>/ResourcePath</code> (The <code>Resourcepath</code> corresponds to an OCF resource.)</p> </li> <li> <p> <code>op</code>: For device state changes, this field must populate as <code>n+d</code>.</p> </li> <li> <p> <code>cn</code>: The content depends on the OCF resource referenced in <code>ResourcePath</code>.</p> </li> </ul>
|
|
4983
|
+
* @public
|
|
4984
|
+
*/
|
|
4985
|
+
Message?: string | undefined;
|
|
4986
|
+
/**
|
|
4987
|
+
* <p>The id for the device discovery job.</p>
|
|
4988
|
+
* @public
|
|
4989
|
+
*/
|
|
4990
|
+
DeviceDiscoveryId?: string | undefined;
|
|
4991
|
+
/**
|
|
4992
|
+
* <p>The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).</p> <note> <p>This parameter is used for cloud-to-cloud devices only.</p> </note>
|
|
4993
|
+
* @public
|
|
4994
|
+
*/
|
|
4995
|
+
ConnectorDeviceId?: string | undefined;
|
|
4996
|
+
/**
|
|
4997
|
+
* <p>The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.</p>
|
|
4998
|
+
* @public
|
|
4999
|
+
*/
|
|
5000
|
+
TraceId?: string | undefined;
|
|
5001
|
+
/**
|
|
5002
|
+
* <p>The list of devices.</p>
|
|
5003
|
+
* @public
|
|
5004
|
+
*/
|
|
5005
|
+
Devices?: Device[] | undefined;
|
|
5006
|
+
/**
|
|
5007
|
+
* <p>The device endpoint.</p>
|
|
5008
|
+
* @public
|
|
5009
|
+
*/
|
|
5010
|
+
MatterEndpoint?: MatterEndpoint | undefined;
|
|
5011
|
+
}
|
|
5012
|
+
/**
|
|
5013
|
+
* @public
|
|
5014
|
+
*/
|
|
5015
|
+
export interface SendConnectorEventResponse {
|
|
5016
|
+
/**
|
|
5017
|
+
* <p>The id of the connector between the third-party cloud provider and IoT managed integrations.</p>
|
|
5018
|
+
* @public
|
|
5019
|
+
*/
|
|
5020
|
+
ConnectorId: string | undefined;
|
|
5021
|
+
}
|
|
5022
|
+
/**
|
|
5023
|
+
* @public
|
|
5024
|
+
*/
|
|
5025
|
+
export interface TagResourceRequest {
|
|
5026
|
+
/**
|
|
5027
|
+
* The ARN of the resource to which to add tags.
|
|
5028
|
+
* @public
|
|
5029
|
+
*/
|
|
5030
|
+
ResourceArn: string | undefined;
|
|
5031
|
+
/**
|
|
5032
|
+
* A set of key/value pairs that are used to manage the resource
|
|
5033
|
+
* @public
|
|
5034
|
+
*/
|
|
5035
|
+
Tags: Record<string, string> | undefined;
|
|
5036
|
+
}
|
|
5037
|
+
/**
|
|
5038
|
+
* @public
|
|
5039
|
+
*/
|
|
5040
|
+
export interface TagResourceResponse {
|
|
5041
|
+
}
|
|
5042
|
+
/**
|
|
5043
|
+
* @public
|
|
5044
|
+
*/
|
|
5045
|
+
export interface UntagResourceRequest {
|
|
5046
|
+
/**
|
|
5047
|
+
* The ARN of the resource to which to add tags.
|
|
5048
|
+
* @public
|
|
5049
|
+
*/
|
|
5050
|
+
ResourceArn: string | undefined;
|
|
5051
|
+
/**
|
|
5052
|
+
* A list of tag keys to remove from the resource.
|
|
5053
|
+
* @public
|
|
5054
|
+
*/
|
|
5055
|
+
TagKeys: string[] | undefined;
|
|
5056
|
+
}
|
|
5057
|
+
/**
|
|
5058
|
+
* @public
|
|
5059
|
+
*/
|
|
5060
|
+
export interface UntagResourceResponse {
|
|
5061
|
+
}
|
|
5062
|
+
/**
|
|
5063
|
+
* @internal
|
|
5064
|
+
*/
|
|
5065
|
+
export declare const CreateAccountAssociationRequestFilterSensitiveLog: (obj: CreateAccountAssociationRequest) => any;
|
|
5066
|
+
/**
|
|
5067
|
+
* @internal
|
|
5068
|
+
*/
|
|
5069
|
+
export declare const CreateAccountAssociationResponseFilterSensitiveLog: (obj: CreateAccountAssociationResponse) => any;
|
|
5070
|
+
/**
|
|
5071
|
+
* @internal
|
|
5072
|
+
*/
|
|
5073
|
+
export declare const GetAccountAssociationResponseFilterSensitiveLog: (obj: GetAccountAssociationResponse) => any;
|
|
5074
|
+
/**
|
|
5075
|
+
* @internal
|
|
5076
|
+
*/
|
|
5077
|
+
export declare const StartAccountAssociationRefreshResponseFilterSensitiveLog: (obj: StartAccountAssociationRefreshResponse) => any;
|
|
3555
5078
|
/**
|
|
3556
5079
|
* @internal
|
|
3557
5080
|
*/
|
|
@@ -3612,10 +5135,22 @@ export declare const ListCredentialLockersResponseFilterSensitiveLog: (obj: List
|
|
|
3612
5135
|
* @internal
|
|
3613
5136
|
*/
|
|
3614
5137
|
export declare const GetDestinationResponseFilterSensitiveLog: (obj: GetDestinationResponse) => any;
|
|
5138
|
+
/**
|
|
5139
|
+
* @internal
|
|
5140
|
+
*/
|
|
5141
|
+
export declare const DeviceFilterSensitiveLog: (obj: Device) => any;
|
|
3615
5142
|
/**
|
|
3616
5143
|
* @internal
|
|
3617
5144
|
*/
|
|
3618
5145
|
export declare const GetDeviceDiscoveryResponseFilterSensitiveLog: (obj: GetDeviceDiscoveryResponse) => any;
|
|
5146
|
+
/**
|
|
5147
|
+
* @internal
|
|
5148
|
+
*/
|
|
5149
|
+
export declare const DiscoveredDeviceSummaryFilterSensitiveLog: (obj: DiscoveredDeviceSummary) => any;
|
|
5150
|
+
/**
|
|
5151
|
+
* @internal
|
|
5152
|
+
*/
|
|
5153
|
+
export declare const ListDiscoveredDevicesResponseFilterSensitiveLog: (obj: ListDiscoveredDevicesResponse) => any;
|
|
3619
5154
|
/**
|
|
3620
5155
|
* @internal
|
|
3621
5156
|
*/
|
|
@@ -3640,6 +5175,10 @@ export declare const GetManagedThingStateResponseFilterSensitiveLog: (obj: GetMa
|
|
|
3640
5175
|
* @internal
|
|
3641
5176
|
*/
|
|
3642
5177
|
export declare const GetNotificationConfigurationResponseFilterSensitiveLog: (obj: GetNotificationConfigurationResponse) => any;
|
|
5178
|
+
/**
|
|
5179
|
+
* @internal
|
|
5180
|
+
*/
|
|
5181
|
+
export declare const GetOtaTaskResponseFilterSensitiveLog: (obj: GetOtaTaskResponse) => any;
|
|
3643
5182
|
/**
|
|
3644
5183
|
* @internal
|
|
3645
5184
|
*/
|
|
@@ -3648,6 +5187,10 @@ export declare const GetOtaTaskConfigurationResponseFilterSensitiveLog: (obj: Ge
|
|
|
3648
5187
|
* @internal
|
|
3649
5188
|
*/
|
|
3650
5189
|
export declare const GetProvisioningProfileResponseFilterSensitiveLog: (obj: GetProvisioningProfileResponse) => any;
|
|
5190
|
+
/**
|
|
5191
|
+
* @internal
|
|
5192
|
+
*/
|
|
5193
|
+
export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
3651
5194
|
/**
|
|
3652
5195
|
* @internal
|
|
3653
5196
|
*/
|
|
@@ -3676,3 +5219,19 @@ export declare const OtaTaskConfigurationSummaryFilterSensitiveLog: (obj: OtaTas
|
|
|
3676
5219
|
* @internal
|
|
3677
5220
|
*/
|
|
3678
5221
|
export declare const ListOtaTaskConfigurationsResponseFilterSensitiveLog: (obj: ListOtaTaskConfigurationsResponse) => any;
|
|
5222
|
+
/**
|
|
5223
|
+
* @internal
|
|
5224
|
+
*/
|
|
5225
|
+
export declare const MatterClusterFilterSensitiveLog: (obj: MatterCluster) => any;
|
|
5226
|
+
/**
|
|
5227
|
+
* @internal
|
|
5228
|
+
*/
|
|
5229
|
+
export declare const MatterEndpointFilterSensitiveLog: (obj: MatterEndpoint) => any;
|
|
5230
|
+
/**
|
|
5231
|
+
* @internal
|
|
5232
|
+
*/
|
|
5233
|
+
export declare const SendConnectorEventRequestFilterSensitiveLog: (obj: SendConnectorEventRequest) => any;
|
|
5234
|
+
/**
|
|
5235
|
+
* @internal
|
|
5236
|
+
*/
|
|
5237
|
+
export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
|