DescribeApplication
Gets information about a Fleet Hub for AWS IoT Device Management web application.
Request Syntax
GET /applications/applicationId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The unique Id of the web application.
Length Constraints: Fixed length of 36.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"applicationArn": "string",
"applicationCreationDate": number,
"applicationDescription": "string",
"applicationId": "string",
"applicationLastUpdateDate": number,
"applicationName": "string",
"applicationState": "string",
"applicationUrl": "string",
"errorMessage": "string",
"roleArn": "string",
"ssoClientId": "string",
"tags": {
"string" : "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- applicationArn
-
The ARN of the web application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:[!-~]+$
- applicationCreationDate
-
The date (in Unix epoch time) when the application was created.
Type: Long
- applicationDescription
-
An optional description of the web application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[ -~]*$
- applicationId
-
The unique Id of the web application.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- applicationLastUpdateDate
-
The date (in Unix epoch time) when the application was last updated.
Type: Long
- applicationName
-
The name of the web application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[ -~]*$
- applicationState
-
The current state of the web application.
Type: String
Valid Values:
CREATING | DELETING | ACTIVE | CREATE_FAILED | DELETE_FAILED
- applicationUrl
-
The URL of the web application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^https\://\S+$
- errorMessage
-
A message that explains any failures included in the
applicationState
response field. This message explains failures in theCreateApplication
andDeleteApplication
actions.Type: String
- roleArn
-
The ARN of the role that the web application assumes when it interacts with AWS IoT Core.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:[!-~]+$
- ssoClientId
-
The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
Type: String
- tags
-
A set of key/value pairs that you can use to manage the web application resource.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: