github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/iotfleethub/2020-11-03/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<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>",
     4    "operations": {
     5      "CreateApplication": "<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>",
     6      "DeleteApplication": "<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>",
     7      "DescribeApplication": "<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>",
     8      "ListApplications": "<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>",
     9      "ListTagsForResource": "<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>",
    10      "TagResource": "<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>",
    11      "UntagResource": "<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>",
    12      "UpdateApplication": "<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>"
    13    },
    14    "shapes": {
    15      "ApplicationState": {
    16        "base": null,
    17        "refs": {
    18          "ApplicationSummary$applicationState": "<p>The current state of the web application.</p>",
    19          "DescribeApplicationResponse$applicationState": "<p>The current state of the web application.</p>"
    20        }
    21      },
    22      "ApplicationSummaries": {
    23        "base": null,
    24        "refs": {
    25          "ListApplicationsResponse$applicationSummaries": "<p>An array of objects that provide summaries of information about the web applications in the list.</p>"
    26        }
    27      },
    28      "ApplicationSummary": {
    29        "base": "<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>",
    30        "refs": {
    31          "ApplicationSummaries$member": null
    32        }
    33      },
    34      "Arn": {
    35        "base": null,
    36        "refs": {
    37          "CreateApplicationRequest$roleArn": "<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>",
    38          "CreateApplicationResponse$applicationArn": "<p>The ARN of the web application.</p>",
    39          "DescribeApplicationResponse$applicationArn": "<p>The ARN of the web application.</p>",
    40          "DescribeApplicationResponse$roleArn": "<p>The ARN of the role that the web application assumes when it interacts with AWS IoT Core.</p>"
    41        }
    42      },
    43      "ClientRequestToken": {
    44        "base": null,
    45        "refs": {
    46          "CreateApplicationRequest$clientToken": "<p>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.</p>",
    47          "DeleteApplicationRequest$clientToken": "<p>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.</p>",
    48          "UpdateApplicationRequest$clientToken": "<p>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.</p>"
    49        }
    50      },
    51      "ConflictException": {
    52        "base": "<p>The request conflicts with the current state of the resource.</p>",
    53        "refs": {
    54        }
    55      },
    56      "CreateApplicationRequest": {
    57        "base": null,
    58        "refs": {
    59        }
    60      },
    61      "CreateApplicationResponse": {
    62        "base": null,
    63        "refs": {
    64        }
    65      },
    66      "DeleteApplicationRequest": {
    67        "base": null,
    68        "refs": {
    69        }
    70      },
    71      "DeleteApplicationResponse": {
    72        "base": null,
    73        "refs": {
    74        }
    75      },
    76      "DescribeApplicationRequest": {
    77        "base": null,
    78        "refs": {
    79        }
    80      },
    81      "DescribeApplicationResponse": {
    82        "base": null,
    83        "refs": {
    84        }
    85      },
    86      "Description": {
    87        "base": null,
    88        "refs": {
    89          "ApplicationSummary$applicationDescription": "<p>An optional description of the web application.</p>",
    90          "CreateApplicationRequest$applicationDescription": "<p>An optional description of the web application.</p>",
    91          "DescribeApplicationResponse$applicationDescription": "<p>An optional description of the web application.</p>",
    92          "UpdateApplicationRequest$applicationDescription": "<p>An optional description of the web application.</p>"
    93        }
    94      },
    95      "ErrorMessage": {
    96        "base": null,
    97        "refs": {
    98          "DescribeApplicationResponse$errorMessage": "<p>A message indicating why the <code>DescribeApplication</code> API failed.</p>"
    99        }
   100      },
   101      "Id": {
   102        "base": null,
   103        "refs": {
   104          "ApplicationSummary$applicationId": "<p>The unique Id of the web application.</p>",
   105          "CreateApplicationResponse$applicationId": "<p>The unique Id of the web application.</p>",
   106          "DeleteApplicationRequest$applicationId": "<p>The unique Id of the web application.</p>",
   107          "DescribeApplicationRequest$applicationId": "<p>The unique Id of the web application.</p>",
   108          "DescribeApplicationResponse$applicationId": "<p>The unique Id of the web application.</p>",
   109          "UpdateApplicationRequest$applicationId": "<p>The unique Id of the web application.</p>"
   110        }
   111      },
   112      "InternalFailureException": {
   113        "base": "<p>An unexpected error has occurred.</p>",
   114        "refs": {
   115        }
   116      },
   117      "InvalidRequestException": {
   118        "base": "<p>The request is not valid.</p>",
   119        "refs": {
   120        }
   121      },
   122      "LimitExceededException": {
   123        "base": "<p>A limit has been exceeded.</p>",
   124        "refs": {
   125        }
   126      },
   127      "ListApplicationsRequest": {
   128        "base": null,
   129        "refs": {
   130        }
   131      },
   132      "ListApplicationsResponse": {
   133        "base": null,
   134        "refs": {
   135        }
   136      },
   137      "ListTagsForResourceRequest": {
   138        "base": null,
   139        "refs": {
   140        }
   141      },
   142      "ListTagsForResourceResponse": {
   143        "base": null,
   144        "refs": {
   145        }
   146      },
   147      "Name": {
   148        "base": null,
   149        "refs": {
   150          "ApplicationSummary$applicationName": "<p>The name of the web application.</p>",
   151          "CreateApplicationRequest$applicationName": "<p>The name of the web application.</p>",
   152          "DescribeApplicationResponse$applicationName": "<p>The name of the web application.</p>",
   153          "UpdateApplicationRequest$applicationName": "<p>The name of the web application.</p>"
   154        }
   155      },
   156      "NextToken": {
   157        "base": null,
   158        "refs": {
   159          "ListApplicationsRequest$nextToken": "<p>A token used to get the next set of results.</p>",
   160          "ListApplicationsResponse$nextToken": "<p>A token used to get the next set of results.</p>"
   161        }
   162      },
   163      "ResourceArn": {
   164        "base": null,
   165        "refs": {
   166          "ListTagsForResourceRequest$resourceArn": "<p>The ARN of the resource.</p>",
   167          "TagResourceRequest$resourceArn": "<p>The ARN of the resource.</p>",
   168          "UntagResourceRequest$resourceArn": "<p>The ARN of the resource.</p>"
   169        }
   170      },
   171      "ResourceNotFoundException": {
   172        "base": "<p>The specified resource does not exist.</p>",
   173        "refs": {
   174        }
   175      },
   176      "SsoClientId": {
   177        "base": null,
   178        "refs": {
   179          "DescribeApplicationResponse$ssoClientId": "<p>The Id of the single sign-on client that you use to authenticate and authorize users on the web application.</p>"
   180        }
   181      },
   182      "TagKey": {
   183        "base": null,
   184        "refs": {
   185          "TagKeyList$member": null,
   186          "TagMap$key": null
   187        }
   188      },
   189      "TagKeyList": {
   190        "base": null,
   191        "refs": {
   192          "UntagResourceRequest$tagKeys": "<p>A list of the keys of the tags to be removed from the resource.</p>"
   193        }
   194      },
   195      "TagMap": {
   196        "base": null,
   197        "refs": {
   198          "CreateApplicationRequest$tags": "<p>A set of key/value pairs that you can use to manage the web application resource.</p>",
   199          "DescribeApplicationResponse$tags": "<p>A set of key/value pairs that you can use to manage the web application resource.</p>",
   200          "ListTagsForResourceResponse$tags": "<p>The list of tags assigned to the resource.</p>",
   201          "TagResourceRequest$tags": "<p>The new or modified tags for the resource.</p>"
   202        }
   203      },
   204      "TagResourceRequest": {
   205        "base": null,
   206        "refs": {
   207        }
   208      },
   209      "TagResourceResponse": {
   210        "base": null,
   211        "refs": {
   212        }
   213      },
   214      "TagValue": {
   215        "base": null,
   216        "refs": {
   217          "TagMap$value": null
   218        }
   219      },
   220      "ThrottlingException": {
   221        "base": "<p>The rate exceeds the limit.</p>",
   222        "refs": {
   223        }
   224      },
   225      "Timestamp": {
   226        "base": null,
   227        "refs": {
   228          "ApplicationSummary$applicationCreationDate": "<p>The date (in Unix epoch time) when the web application was created.</p>",
   229          "ApplicationSummary$applicationLastUpdateDate": "<p>The date (in Unix epoch time) when the web application was last updated.</p>",
   230          "DescribeApplicationResponse$applicationCreationDate": "<p>The date (in Unix epoch time) when the application was created.</p>",
   231          "DescribeApplicationResponse$applicationLastUpdateDate": "<p>The date (in Unix epoch time) when the application was last updated.</p>"
   232        }
   233      },
   234      "UntagResourceRequest": {
   235        "base": null,
   236        "refs": {
   237        }
   238      },
   239      "UntagResourceResponse": {
   240        "base": null,
   241        "refs": {
   242        }
   243      },
   244      "UpdateApplicationRequest": {
   245        "base": null,
   246        "refs": {
   247        }
   248      },
   249      "UpdateApplicationResponse": {
   250        "base": null,
   251        "refs": {
   252        }
   253      },
   254      "Url": {
   255        "base": null,
   256        "refs": {
   257          "ApplicationSummary$applicationUrl": "<p>The URL of the web application.</p>",
   258          "DescribeApplicationResponse$applicationUrl": "<p>The URL of the web application.</p>"
   259        }
   260      },
   261      "errorMessage": {
   262        "base": null,
   263        "refs": {
   264          "ConflictException$message": null,
   265          "InternalFailureException$message": null,
   266          "InvalidRequestException$message": null,
   267          "LimitExceededException$message": null,
   268          "ResourceNotFoundException$message": null,
   269          "ThrottlingException$message": null
   270        }
   271      }
   272    }
   273  }