CreateApplication
Creates a Fleet Hub for AWS IoT Device Management web application.
When creating a Fleet Hub application, you must create an organization instance of IAM Identity Center if you don't already have one. The Fleet Hub application you create must also be in the same AWS Region of the organization instance of IAM Identity Center. For more information see Enabling IAM Identity Center and Organization instances of IAM Identity Center.
Request Syntax
POST /applications HTTP/1.1
Content-type: application/json
{
"applicationDescription": "string
",
"applicationName": "string
",
"clientToken": "string
",
"roleArn": "string
",
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- applicationDescription
-
An optional description of the web application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[ -~]*$
Required: No
- applicationName
-
The name of the web application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[ -~]*$
Required: Yes
- clientToken
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$
Required: No
- roleArn
-
The ARN of the role that the web application assumes when it interacts with AWS IoT Core.
Note
The name of the role must be in the form
AWSIotFleetHub_random_string
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:[!-~]+$
Required: Yes
-
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.
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"applicationArn": "string",
"applicationId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 201 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:[!-~]+$
- 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}$
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- LimitExceededException
-
A limit has been exceeded.
HTTP Status Code: 410
- 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: