- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeApplicationCommand
Gets information about a Fleet Hub for IoT Device Management web application.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTFleetHubClient, DescribeApplicationCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import
// const { IoTFleetHubClient, DescribeApplicationCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import
const client = new IoTFleetHubClient(config);
const input = { // DescribeApplicationRequest
applicationId: "STRING_VALUE", // required
};
const command = new DescribeApplicationCommand(input);
const response = await client.send(command);
// { // DescribeApplicationResponse
// applicationId: "STRING_VALUE", // required
// applicationArn: "STRING_VALUE", // required
// applicationName: "STRING_VALUE", // required
// applicationDescription: "STRING_VALUE",
// applicationUrl: "STRING_VALUE", // required
// applicationState: "CREATING" || "DELETING" || "ACTIVE" || "CREATE_FAILED" || "DELETE_FAILED", // required
// applicationCreationDate: Number("long"), // required
// applicationLastUpdateDate: Number("long"), // required
// roleArn: "STRING_VALUE", // required
// ssoClientId: "STRING_VALUE",
// errorMessage: "STRING_VALUE",
// tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// };
DescribeApplicationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
applicationId Required | string | undefined | The unique Id of the web application. |
DescribeApplicationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
applicationArn Required | string | undefined | The ARN of the web application. |
applicationCreationDate Required | number | undefined | The date (in Unix epoch time) when the application was created. |
applicationId Required | string | undefined | The unique Id of the web application. |
applicationLastUpdateDate Required | number | undefined | The date (in Unix epoch time) when the application was last updated. |
applicationName Required | string | undefined | The name of the web application. |
applicationState Required | ApplicationState | undefined | The current state of the web application. |
applicationUrl Required | string | undefined | The URL of the web application. |
roleArn Required | string | undefined | The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core. |
applicationDescription | string | undefined | An optional description of the web application. |
errorMessage | string | undefined | A message that explains any failures included in the |
ssoClientId | string | undefined | The Id of the single sign-on client that you use to authenticate and authorize users on the web application. |
tags | Record<string, string> | undefined | A set of key/value pairs that you can use to manage the web application resource. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalFailureException | server | An unexpected error has occurred. |
InvalidRequestException | client | The request is not valid. |
ResourceNotFoundException | client | The specified resource does not exist. |
ThrottlingException | client | The rate exceeds the limit. |
IoTFleetHubServiceException | Base exception class for all service exceptions from IoTFleetHub service. |