iotfleethub.d.ts
  1  import {Request} from '../lib/request';
  2  import {Response} from '../lib/response';
  3  import {AWSError} from '../lib/error';
  4  import {Service} from '../lib/service';
  5  import {ServiceConfigurationOptions} from '../lib/service';
  6  import {ConfigBase as Config} from '../lib/config-base';
  7  interface Blob {}
  8  declare class IoTFleetHub extends Service {
  9    /**
 10     * Constructs a service object. This object has one method for each API operation.
 11     */
 12    constructor(options?: IoTFleetHub.Types.ClientConfiguration)
 13    config: Config & IoTFleetHub.Types.ClientConfiguration;
 14    /**
 15     * Creates a Fleet Hub for AWS IoT Device Management web application.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 16     */
 17    createApplication(params: IoTFleetHub.Types.CreateApplicationRequest, callback?: (err: AWSError, data: IoTFleetHub.Types.CreateApplicationResponse) => void): Request<IoTFleetHub.Types.CreateApplicationResponse, AWSError>;
 18    /**
 19     * Creates a Fleet Hub for AWS IoT Device Management web application.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 20     */
 21    createApplication(callback?: (err: AWSError, data: IoTFleetHub.Types.CreateApplicationResponse) => void): Request<IoTFleetHub.Types.CreateApplicationResponse, AWSError>;
 22    /**
 23     * Deletes a Fleet Hub for AWS IoT Device Management web application.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 24     */
 25    deleteApplication(params: IoTFleetHub.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: IoTFleetHub.Types.DeleteApplicationResponse) => void): Request<IoTFleetHub.Types.DeleteApplicationResponse, AWSError>;
 26    /**
 27     * Deletes a Fleet Hub for AWS IoT Device Management web application.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 28     */
 29    deleteApplication(callback?: (err: AWSError, data: IoTFleetHub.Types.DeleteApplicationResponse) => void): Request<IoTFleetHub.Types.DeleteApplicationResponse, AWSError>;
 30    /**
 31     * Gets information about a Fleet Hub for AWS IoT Device Management web application.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 32     */
 33    describeApplication(params: IoTFleetHub.Types.DescribeApplicationRequest, callback?: (err: AWSError, data: IoTFleetHub.Types.DescribeApplicationResponse) => void): Request<IoTFleetHub.Types.DescribeApplicationResponse, AWSError>;
 34    /**
 35     * Gets information about a Fleet Hub for AWS IoT Device Management web application.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 36     */
 37    describeApplication(callback?: (err: AWSError, data: IoTFleetHub.Types.DescribeApplicationResponse) => void): Request<IoTFleetHub.Types.DescribeApplicationResponse, AWSError>;
 38    /**
 39     * Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 40     */
 41    listApplications(params: IoTFleetHub.Types.ListApplicationsRequest, callback?: (err: AWSError, data: IoTFleetHub.Types.ListApplicationsResponse) => void): Request<IoTFleetHub.Types.ListApplicationsResponse, AWSError>;
 42    /**
 43     * Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 44     */
 45    listApplications(callback?: (err: AWSError, data: IoTFleetHub.Types.ListApplicationsResponse) => void): Request<IoTFleetHub.Types.ListApplicationsResponse, AWSError>;
 46    /**
 47     * Lists the tags for the specified resource.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 48     */
 49    listTagsForResource(params: IoTFleetHub.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoTFleetHub.Types.ListTagsForResourceResponse) => void): Request<IoTFleetHub.Types.ListTagsForResourceResponse, AWSError>;
 50    /**
 51     * Lists the tags for the specified resource.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 52     */
 53    listTagsForResource(callback?: (err: AWSError, data: IoTFleetHub.Types.ListTagsForResourceResponse) => void): Request<IoTFleetHub.Types.ListTagsForResourceResponse, AWSError>;
 54    /**
 55     * Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 56     */
 57    tagResource(params: IoTFleetHub.Types.TagResourceRequest, callback?: (err: AWSError, data: IoTFleetHub.Types.TagResourceResponse) => void): Request<IoTFleetHub.Types.TagResourceResponse, AWSError>;
 58    /**
 59     * Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 60     */
 61    tagResource(callback?: (err: AWSError, data: IoTFleetHub.Types.TagResourceResponse) => void): Request<IoTFleetHub.Types.TagResourceResponse, AWSError>;
 62    /**
 63     * Removes the specified tags (metadata) from the resource.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 64     */
 65    untagResource(params: IoTFleetHub.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoTFleetHub.Types.UntagResourceResponse) => void): Request<IoTFleetHub.Types.UntagResourceResponse, AWSError>;
 66    /**
 67     * Removes the specified tags (metadata) from the resource.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 68     */
 69    untagResource(callback?: (err: AWSError, data: IoTFleetHub.Types.UntagResourceResponse) => void): Request<IoTFleetHub.Types.UntagResourceResponse, AWSError>;
 70    /**
 71     * Updates information about a Fleet Hub for a AWS IoT Device Management web application.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 72     */
 73    updateApplication(params: IoTFleetHub.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: IoTFleetHub.Types.UpdateApplicationResponse) => void): Request<IoTFleetHub.Types.UpdateApplicationResponse, AWSError>;
 74    /**
 75     * Updates information about a Fleet Hub for a AWS IoT Device Management web application.  Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. 
 76     */
 77    updateApplication(callback?: (err: AWSError, data: IoTFleetHub.Types.UpdateApplicationResponse) => void): Request<IoTFleetHub.Types.UpdateApplicationResponse, AWSError>;
 78  }
 79  declare namespace IoTFleetHub {
 80    export type ApplicationState = "CREATING"|"DELETING"|"ACTIVE"|"CREATE_FAILED"|"DELETE_FAILED"|string;
 81    export type ApplicationSummaries = ApplicationSummary[];
 82    export interface ApplicationSummary {
 83      /**
 84       * The unique Id of the web application.
 85       */
 86      applicationId: Id;
 87      /**
 88       * The name of the web application.
 89       */
 90      applicationName: Name;
 91      /**
 92       * An optional description of the web application.
 93       */
 94      applicationDescription?: Description;
 95      /**
 96       * The URL of the web application.
 97       */
 98      applicationUrl: Url;
 99      /**
100       * The date (in Unix epoch time) when the web application was created.
101       */
102      applicationCreationDate?: Timestamp;
103      /**
104       * The date (in Unix epoch time) when the web application was last updated.
105       */
106      applicationLastUpdateDate?: Timestamp;
107      /**
108       * The current state of the web application.
109       */
110      applicationState?: ApplicationState;
111    }
112    export type Arn = string;
113    export type ClientRequestToken = string;
114    export interface CreateApplicationRequest {
115      /**
116       * The name of the web application.
117       */
118      applicationName: Name;
119      /**
120       * An optional description of the web application.
121       */
122      applicationDescription?: Description;
123      /**
124       * A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
125       */
126      clientToken?: ClientRequestToken;
127      /**
128       * The ARN of the role that the web application assumes when it interacts with AWS IoT Core.  The name of the role must be in the form AWSIotFleetHub_random_string . 
129       */
130      roleArn: Arn;
131      /**
132       * A set of key/value pairs that you can use to manage the web application resource.
133       */
134      tags?: TagMap;
135    }
136    export interface CreateApplicationResponse {
137      /**
138       * The unique Id of the web application.
139       */
140      applicationId: Id;
141      /**
142       * The ARN of the web application.
143       */
144      applicationArn: Arn;
145    }
146    export interface DeleteApplicationRequest {
147      /**
148       * The unique Id of the web application.
149       */
150      applicationId: Id;
151      /**
152       * A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
153       */
154      clientToken?: ClientRequestToken;
155    }
156    export interface DeleteApplicationResponse {
157    }
158    export interface DescribeApplicationRequest {
159      /**
160       * The unique Id of the web application.
161       */
162      applicationId: Id;
163    }
164    export interface DescribeApplicationResponse {
165      /**
166       * The unique Id of the web application.
167       */
168      applicationId: Id;
169      /**
170       * The ARN of the web application.
171       */
172      applicationArn: Arn;
173      /**
174       * The name of the web application.
175       */
176      applicationName: Name;
177      /**
178       * An optional description of the web application.
179       */
180      applicationDescription?: Description;
181      /**
182       * The URL of the web application.
183       */
184      applicationUrl: Url;
185      /**
186       * The current state of the web application.
187       */
188      applicationState: ApplicationState;
189      /**
190       * The date (in Unix epoch time) when the application was created.
191       */
192      applicationCreationDate: Timestamp;
193      /**
194       * The date (in Unix epoch time) when the application was last updated.
195       */
196      applicationLastUpdateDate: Timestamp;
197      /**
198       * The ARN of the role that the web application assumes when it interacts with AWS IoT Core.
199       */
200      roleArn: Arn;
201      /**
202       * The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
203       */
204      ssoClientId?: SsoClientId;
205      /**
206       * A message indicating why the DescribeApplication API failed.
207       */
208      errorMessage?: ErrorMessage;
209      /**
210       * A set of key/value pairs that you can use to manage the web application resource.
211       */
212      tags?: TagMap;
213    }
214    export type Description = string;
215    export type ErrorMessage = string;
216    export type Id = string;
217    export interface ListApplicationsRequest {
218      /**
219       * A token used to get the next set of results.
220       */
221      nextToken?: NextToken;
222    }
223    export interface ListApplicationsResponse {
224      /**
225       * An array of objects that provide summaries of information about the web applications in the list.
226       */
227      applicationSummaries?: ApplicationSummaries;
228      /**
229       * A token used to get the next set of results.
230       */
231      nextToken?: NextToken;
232    }
233    export interface ListTagsForResourceRequest {
234      /**
235       * The ARN of the resource.
236       */
237      resourceArn: ResourceArn;
238    }
239    export interface ListTagsForResourceResponse {
240      /**
241       * The list of tags assigned to the resource.
242       */
243      tags?: TagMap;
244    }
245    export type Name = string;
246    export type NextToken = string;
247    export type ResourceArn = string;
248    export type SsoClientId = string;
249    export type TagKey = string;
250    export type TagKeyList = TagKey[];
251    export type TagMap = {[key: string]: TagValue};
252    export interface TagResourceRequest {
253      /**
254       * The ARN of the resource.
255       */
256      resourceArn: ResourceArn;
257      /**
258       * The new or modified tags for the resource.
259       */
260      tags: TagMap;
261    }
262    export interface TagResourceResponse {
263    }
264    export type TagValue = string;
265    export type Timestamp = number;
266    export interface UntagResourceRequest {
267      /**
268       * The ARN of the resource.
269       */
270      resourceArn: ResourceArn;
271      /**
272       * A list of the keys of the tags to be removed from the resource.
273       */
274      tagKeys: TagKeyList;
275    }
276    export interface UntagResourceResponse {
277    }
278    export interface UpdateApplicationRequest {
279      /**
280       * The unique Id of the web application.
281       */
282      applicationId: Id;
283      /**
284       * The name of the web application.
285       */
286      applicationName?: Name;
287      /**
288       * An optional description of the web application.
289       */
290      applicationDescription?: Description;
291      /**
292       * A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
293       */
294      clientToken?: ClientRequestToken;
295    }
296    export interface UpdateApplicationResponse {
297    }
298    export type Url = string;
299    /**
300     * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
301     */
302    export type apiVersion = "2020-11-03"|"latest"|string;
303    export interface ClientApiVersions {
304      /**
305       * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
306       */
307      apiVersion?: apiVersion;
308    }
309    export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
310    /**
311     * Contains interfaces for use with the IoTFleetHub client.
312     */
313    export import Types = IoTFleetHub;
314  }
315  export = IoTFleetHub;