AWS IoT Fleet Hub
<p>With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"info": {
"version": "2020-11-03",
"x-release": "v4",
"title": "AWS IoT Fleet Hub",
"description": "<p>With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png",
"backgroundColor": "#FFFFFF"
},
"termsOfService": "https://aws.amazon.com/service-terms/",
"contact": {
"name": "Mike Ralphson",
"email": "mike.ralphson@gmail.com",
"url": "https://github.com/mermade/aws2openapi",
"x-twitter": "PermittedSoc"
},
"license": {
"name": "Apache 2.0 License",
"url": "http://www.apache.org/licenses/"
},
"x-providerName": "amazonaws.com",
"x-serviceName": "iotfleethub",
"x-aws-signingName": "iotfleethub",
"x-origin": [
{
"contentType": "application/json",
"url": "https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotfleethub-2020-11-03.normal.json",
"converter": {
"url": "https://github.com/mermade/aws2openapi",
"version": "1.0.0"
},
"x-apisguru-driver": "external"
}
],
"x-apiClientRegistration": {
"url": "https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"
},
"x-apisguru-categories": [
"cloud"
],
"x-preferred": true
},
"externalDocs": {
"description": "Amazon Web Services documentation",
"url": "https://docs.aws.amazon.com/iot/"
},
"servers": [
{
"url": "http://api.fleethub.iot.{region}.amazonaws.com",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"us-gov-west-1",
"us-gov-east-1",
"ca-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"eu-south-1",
"af-south-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-southeast-1",
"ap-southeast-2",
"ap-east-1",
"ap-south-1",
"sa-east-1",
"me-south-1"
],
"default": "us-east-1"
}
},
"description": "The AWS IoT Fleet Hub multi-region endpoint"
},
{
"url": "https://api.fleethub.iot.{region}.amazonaws.com",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"us-gov-west-1",
"us-gov-east-1",
"ca-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"eu-south-1",
"af-south-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-southeast-1",
"ap-southeast-2",
"ap-east-1",
"ap-south-1",
"sa-east-1",
"me-south-1"
],
"default": "us-east-1"
}
},
"description": "The AWS IoT Fleet Hub multi-region endpoint"
},
{
"url": "http://api.fleethub.iot.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The AWS IoT Fleet Hub endpoint for China (Beijing) and China (Ningxia)"
},
{
"url": "https://api.fleethub.iot.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The AWS IoT Fleet Hub endpoint for China (Beijing) and China (Ningxia)"
}
],
"x-hasEquivalentPaths": true,
"paths": {
"/applications": {
"post": {
"operationId": "CreateApplication",
"description": "<p>Creates a Fleet Hub for AWS IoT Device Management web application.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>",
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApplicationResponse"
}
}
}
},
"480": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"481": {
"description": "InternalFailureException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalFailureException"
}
}
}
},
"482": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
},
"483": {
"description": "LimitExceededException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitExceededException"
}
}
}
}
},
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"applicationName",
"roleArn"
],
"properties": {
"applicationName": {
"description": "The name of the web application.",
"type": "string",
"pattern": "^[ -~]*$",
"minLength": 1,
"maxLength": 100
},
"applicationDescription": {
"description": "An optional description of the web application.",
"type": "string",
"pattern": "^[ -~]*$",
"minLength": 1,
"maxLength": 2048
},
"clientToken": {
"description": "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",
"pattern": "^[a-zA-Z0-9-_]+$",
"minLength": 1,
"maxLength": 64
},
"roleArn": {
"description": "<p>The ARN of the role that the web application assumes when it interacts with AWS IoT Core.</p> <note> <p>The name of the role must be in the form <code>AWSIotFleetHub_<i>random_string</i> </code>.</p> </note>",
"type": "string",
"pattern": "^arn:[!-~]+$",
"minLength": 1,
"maxLength": 1600
},
"tags": {
"description": "A set of key/value pairs that you can use to manage the web application resource.",
"type": "object",
"minProperties": 1,
"maxProperties": 50,
"additionalProperties": {
"$ref": "#/components/schemas/TagValue"
}
}
}
}
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
],
"get": {
"operationId": "ListApplications",
"description": "<p>Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListApplicationsResponse"
}
}
}
},
"480": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"481": {
"description": "InternalFailureException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalFailureException"
}
}
}
},
"482": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
}
},
"parameters": [
{
"name": "nextToken",
"in": "query",
"required": false,
"description": "A token used to get the next set of results.",
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9+/=]+$",
"minLength": 1,
"maxLength": 2048
}
}
]
}
},
"/applications/{applicationId}": {
"delete": {
"operationId": "DeleteApplication",
"description": "<p>Deletes a Fleet Hub for AWS IoT Device Management web application.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>",
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteApplicationResponse"
}
}
}
},
"480": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"481": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"482": {
"description": "InternalFailureException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalFailureException"
}
}
}
},
"483": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
}
},
"parameters": [
{
"name": "applicationId",
"in": "path",
"required": true,
"description": "The unique Id of the web application.",
"schema": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
}
},
{
"name": "clientToken",
"in": "query",
"required": false,
"description": "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.",
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9-_]+$",
"minLength": 1,
"maxLength": 64
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
],
"get": {
"operationId": "DescribeApplication",
"description": "<p>Gets information about a Fleet Hub for AWS IoT Device Management web application.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DescribeApplicationResponse"
}
}
}
},
"480": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"481": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"482": {
"description": "InternalFailureException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalFailureException"
}
}
}
},
"483": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
}
},
"parameters": [
{
"name": "applicationId",
"in": "path",
"required": true,
"description": "The unique Id of the web application.",
"schema": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
}
}
]
},
"patch": {
"operationId": "UpdateApplication",
"description": "<p>Updates information about a Fleet Hub for a AWS IoT Device Management web application.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>",
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApplicationResponse"
}
}
}
},
"480": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"481": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"482": {
"description": "InternalFailureException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalFailureException"
}
}
}
},
"483": {
"description": "ConflictException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictException"
}
}
}
},
"484": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
}
},
"parameters": [
{
"name": "applicationId",
"in": "path",
"required": true,
"description": "The unique Id of the web application.",
"schema": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationName": {
"description": "The name of the web application.",
"type": "string",
"pattern": "^[ -~]*$",
"minLength": 1,
"maxLength": 100
},
"applicationDescription": {
"description": "An optional description of the web application.",
"type": "string",
"pattern": "^[ -~]*$",
"minLength": 1,
"maxLength": 2048
},
"clientToken": {
"description": "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",
"pattern": "^[a-zA-Z0-9-_]+$",
"minLength": 1,
"maxLength": 64
}
}
}
}
}
}
}
},
"/tags/{resourceArn}": {
"get": {
"operationId": "ListTagsForResource",
"description": "<p>Lists the tags for the specified resource.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTagsForResourceResponse"
}
}
}
},
"480": {
"description": "InternalFailureException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalFailureException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"parameters": [
{
"name": "resourceArn",
"in": "path",
"required": true,
"description": "The ARN of the resource.",
"schema": {
"type": "string"
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
],
"post": {
"operationId": "TagResource",
"description": "<p>Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResourceResponse"
}
}
}
},
"480": {
"description": "InternalFailureException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalFailureException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"parameters": [
{
"name": "resourceArn",
"in": "path",
"required": true,
"description": "The ARN of the resource.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"tags"
],
"properties": {
"tags": {
"description": "The new or modified tags for the resource.",
"type": "object",
"minProperties": 1,
"maxProperties": 50,
"additionalProperties": {
"$ref": "#/components/schemas/TagValue"
}
}
}
}
}
}
}
}
},
"/tags/{resourceArn}#tagKeys": {
"delete": {
"operationId": "UntagResource",
"description": "<p>Removes the specified tags (metadata) from the resource.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UntagResourceResponse"
}
}
}
},
"480": {
"description": "InternalFailureException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalFailureException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"parameters": [
{
"name": "resourceArn",
"in": "path",
"required": true,
"description": "The ARN of the resource.",
"schema": {
"type": "string"
}
},
{
"name": "tagKeys",
"in": "query",
"required": true,
"description": "A list of the keys of the tags to be removed from the resource.",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagKey"
}
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
}
},
"components": {
"parameters": {
"X-Amz-Content-Sha256": {
"name": "X-Amz-Content-Sha256",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Date": {
"name": "X-Amz-Date",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Algorithm": {
"name": "X-Amz-Algorithm",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Credential": {
"name": "X-Amz-Credential",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Security-Token": {
"name": "X-Amz-Security-Token",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Signature": {
"name": "X-Amz-Signature",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-SignedHeaders": {
"name": "X-Amz-SignedHeaders",
"in": "header",
"schema": {
"type": "string"
},
"required": false
}
},
"securitySchemes": {
"hmac": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"description": "Amazon Signature authorization v4",
"x-amazon-apigateway-authtype": "awsSigv4"
}
},
"schemas": {
"CreateApplicationResponse": {
"type": "object",
"required": [
"applicationId",
"applicationArn"
],
"properties": {
"applicationId": {
"allOf": [
{
"$ref": "#/components/schemas/Id"
},
{
"description": "The unique Id of the web application."
}
]
},
"applicationArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "The ARN of the web application."
}
]
}
}
},
"TagValue": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"InvalidRequestException": {},
"InternalFailureException": {},
"ThrottlingException": {},
"LimitExceededException": {},
"DeleteApplicationResponse": {
"type": "object",
"properties": {}
},
"ResourceNotFoundException": {},
"DescribeApplicationResponse": {
"type": "object",
"required": [
"applicationId",
"applicationArn",
"applicationName",
"applicationUrl",
"applicationState",
"applicationCreationDate",
"applicationLastUpdateDate",
"roleArn"
],
"properties": {
"applicationId": {
"allOf": [
{
"$ref": "#/components/schemas/Id"
},
{
"description": "The unique Id of the web application."
}
]
},
"applicationArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "The ARN of the web application."
}
]
},
"applicationName": {
"allOf": [
{
"$ref": "#/components/schemas/Name"
},
{
"description": "The name of the web application."
}
]
},
"applicationDescription": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "An optional description of the web application."
}
]
},
"applicationUrl": {
"allOf": [
{
"$ref": "#/components/schemas/Url"
},
{
"description": "The URL of the web application."
}
]
},
"applicationState": {
"allOf": [
{
"$ref": "#/components/schemas/ApplicationState"
},
{
"description": "The current state of the web application."
}
]
},
"applicationCreationDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date (in Unix epoch time) when the application was created."
}
]
},
"applicationLastUpdateDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date (in Unix epoch time) when the application was last updated."
}
]
},
"roleArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "The ARN of the role that the web application assumes when it interacts with AWS IoT Core."
}
]
},
"ssoClientId": {
"allOf": [
{
"$ref": "#/components/schemas/SsoClientId"
},
{
"description": "The Id of the single sign-on client that you use to authenticate and authorize users on the web application."
}
]
},
"errorMessage": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorMessage"
},
{
"description": "A message indicating why the <code>DescribeApplication</code> API failed."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagMap"
},
{
"description": "A set of key/value pairs that you can use to manage the web application resource."
}
]
}
}
},
"ListApplicationsResponse": {
"type": "object",
"properties": {
"applicationSummaries": {
"allOf": [
{
"$ref": "#/components/schemas/ApplicationSummaries"
},
{
"description": "An array of objects that provide summaries of information about the web applications in the list."
}
]
},
"nextToken": {
"allOf": [
{
"$ref": "#/components/schemas/NextToken"
},
{
"description": "A token used to get the next set of results."
}
]
}
}
},
"ListTagsForResourceResponse": {
"type": "object",
"properties": {
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagMap"
},
{
"description": "The list of tags assigned to the resource."
}
]
}
}
},
"TagResourceResponse": {
"type": "object",
"properties": {}
},
"UntagResourceResponse": {
"type": "object",
"properties": {}
},
"TagKey": {
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"minLength": 1,
"maxLength": 128
},
"UpdateApplicationResponse": {
"type": "object",
"properties": {}
},
"ConflictException": {},
"ApplicationState": {
"type": "string",
"enum": [
"CREATING",
"DELETING",
"ACTIVE",
"CREATE_FAILED",
"DELETE_FAILED"
]
},
"ApplicationSummary": {
"type": "object",
"required": [
"applicationId",
"applicationName",
"applicationUrl"
],
"properties": {
"applicationId": {
"allOf": [
{
"$ref": "#/components/schemas/Id"
},
{
"description": "The unique Id of the web application."
}
]
},
"applicationName": {
"allOf": [
{
"$ref": "#/components/schemas/Name"
},
{
"description": "The name of the web application."
}
]
},
"applicationDescription": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "An optional description of the web application."
}
]
},
"applicationUrl": {
"allOf": [
{
"$ref": "#/components/schemas/Url"
},
{
"description": "The URL of the web application."
}
]
},
"applicationCreationDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date (in Unix epoch time) when the web application was created."
}
]
},
"applicationLastUpdateDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date (in Unix epoch time) when the web application was last updated."
}
]
},
"applicationState": {
"allOf": [
{
"$ref": "#/components/schemas/ApplicationState"
},
{
"description": "The current state of the web application."
}
]
}
},
"description": "<p>A summary of information about a AWS IoT Device Management web application.</p> <note> <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p> </note>"
},
"ApplicationSummaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationSummary"
}
},
"Id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
},
"Name": {
"type": "string",
"pattern": "^[ -~]*$",
"minLength": 1,
"maxLength": 100
},
"Description": {
"type": "string",
"pattern": "^[ -~]*$",
"minLength": 1,
"maxLength": 2048
},
"Url": {
"type": "string",
"pattern": "^https\\://\\S+$",
"minLength": 1,
"maxLength": 256
},
"Timestamp": {
"type": "integer"
},
"Arn": {
"type": "string",
"pattern": "^arn:[!-~]+$",
"minLength": 1,
"maxLength": 1600
},
"ClientRequestToken": {
"type": "string",
"pattern": "^[a-zA-Z0-9-_]+$",
"minLength": 1,
"maxLength": 64
},
"TagMap": {
"type": "object",
"minProperties": 1,
"maxProperties": 50,
"additionalProperties": {
"$ref": "#/components/schemas/TagValue"
}
},
"CreateApplicationRequest": {
"type": "object",
"required": [
"applicationName",
"roleArn"
],
"title": "CreateApplicationRequest",
"properties": {
"applicationName": {
"allOf": [
{
"$ref": "#/components/schemas/Name"
},
{
"description": "The name of the web application."
}
]
},
"applicationDescription": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "An optional description of the web application."
}
]
},
"clientToken": {
"allOf": [
{
"$ref": "#/components/schemas/ClientRequestToken"
},
{
"description": "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."
}
]
},
"roleArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "<p>The ARN of the role that the web application assumes when it interacts with AWS IoT Core.</p> <note> <p>The name of the role must be in the form <code>AWSIotFleetHub_<i>random_string</i> </code>.</p> </note>"
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagMap"
},
{
"description": "A set of key/value pairs that you can use to manage the web application resource."
}
]
}
}
},
"DeleteApplicationRequest": {
"type": "object",
"title": "DeleteApplicationRequest",
"properties": {}
},
"DescribeApplicationRequest": {
"type": "object",
"title": "DescribeApplicationRequest",
"properties": {}
},
"SsoClientId": {
"type": "string"
},
"ErrorMessage": {
"type": "string"
},
"NextToken": {
"type": "string",
"pattern": "^[A-Za-z0-9+/=]+$",
"minLength": 1,
"maxLength": 2048
},
"ListApplicationsRequest": {
"type": "object",
"title": "ListApplicationsRequest",
"properties": {}
},
"ResourceArn": {
"type": "string"
},
"ListTagsForResourceRequest": {
"type": "object",
"title": "ListTagsForResourceRequest",
"properties": {}
},
"TagKeyList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagKey"
}
},
"TagResourceRequest": {
"type": "object",
"required": [
"tags"
],
"title": "TagResourceRequest",
"properties": {
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagMap"
},
{
"description": "The new or modified tags for the resource."
}
]
}
}
},
"UntagResourceRequest": {
"type": "object",
"title": "UntagResourceRequest",
"properties": {}
},
"UpdateApplicationRequest": {
"type": "object",
"title": "UpdateApplicationRequest",
"properties": {
"applicationName": {
"allOf": [
{
"$ref": "#/components/schemas/Name"
},
{
"description": "The name of the web application."
}
]
},
"applicationDescription": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "An optional description of the web application."
}
]
},
"clientToken": {
"allOf": [
{
"$ref": "#/components/schemas/ClientRequestToken"
},
{
"description": "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."
}
]
}
}
}
}
},
"security": [
{
"hmac": []
}
]
}