docs(client-iotfleethub): Documentation updates for AWS IoT Fleet Hub…

… to clarify that Fleet Hub supports organization instance of IAM Identity Center.
aws · Apr 12, 2024 · fa43c0a · fa43c0a
1 parent 72ff8d0
commit fa43c0a
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 65 deletions.
diff --git a/clients/client-iotfleethub/README.md b/clients/client-iotfleethub/README.md
@@ -6,10 +6,7 @@
 
 AWS SDK for JavaScript IoTFleetHub Client for Node.js, Browser and React Native.
 
-<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>
+<p>With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.</p>
 
 ## Installing
 

diff --git a/clients/client-iotfleethub/src/IoTFleetHub.ts b/clients/client-iotfleethub/src/IoTFleetHub.ts
@@ -179,10 +179,7 @@ export interface IoTFleetHub {
 }
 
 /**
- * <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>
+ * <p>With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.</p>
  * @public
  */
 export class IoTFleetHub extends IoTFleetHubClient implements IoTFleetHub {}

diff --git a/clients/client-iotfleethub/src/IoTFleetHubClient.ts b/clients/client-iotfleethub/src/IoTFleetHubClient.ts
@@ -276,10 +276,7 @@ export type IoTFleetHubClientResolvedConfigType = __SmithyResolvedConfiguration<
 export interface IoTFleetHubClientResolvedConfig extends IoTFleetHubClientResolvedConfigType {}
 
 /**
- * <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>
+ * <p>With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.</p>
  * @public
  */
 export class IoTFleetHubClient extends __Client<

diff --git a/clients/client-iotfleethub/src/commands/CreateApplicationCommand.ts b/clients/client-iotfleethub/src/commands/CreateApplicationCommand.ts
@@ -27,10 +27,11 @@ export interface CreateApplicationCommandInput extends CreateApplicationRequest
 export interface CreateApplicationCommandOutput extends CreateApplicationResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <p>Creates a Fleet Hub for IoT Device Management web application.</p>
+ *          <p>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 Amazon Web Services Region of the organization instance of IAM Identity Center. For more information see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/get-set-up-for-idc.html">Enabling
+ *         IAM Identity Center</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/organization-instances-identity-center.html">Organization instances of IAM Identity Center</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iotfleethub/src/commands/DeleteApplicationCommand.ts b/clients/client-iotfleethub/src/commands/DeleteApplicationCommand.ts
@@ -27,10 +27,7 @@ export interface DeleteApplicationCommandInput extends DeleteApplicationRequest
 export interface DeleteApplicationCommandOutput extends DeleteApplicationResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <p>Deletes a Fleet Hub for IoT Device Management web application.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iotfleethub/src/commands/DescribeApplicationCommand.ts b/clients/client-iotfleethub/src/commands/DescribeApplicationCommand.ts
@@ -27,10 +27,7 @@ export interface DescribeApplicationCommandInput extends DescribeApplicationRequ
 export interface DescribeApplicationCommandOutput extends DescribeApplicationResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <p>Gets information about a Fleet Hub for IoT Device Management web application.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iotfleethub/src/commands/ListApplicationsCommand.ts b/clients/client-iotfleethub/src/commands/ListApplicationsCommand.ts
@@ -27,10 +27,7 @@ export interface ListApplicationsCommandInput extends ListApplicationsRequest {}
 export interface ListApplicationsCommandOutput extends ListApplicationsResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <p>Gets a list of Fleet Hub for IoT Device Management web applications for the current account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iotfleethub/src/commands/ListTagsForResourceCommand.ts b/clients/client-iotfleethub/src/commands/ListTagsForResourceCommand.ts
@@ -28,9 +28,6 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 
 /**
  * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iotfleethub/src/commands/TagResourceCommand.ts b/clients/client-iotfleethub/src/commands/TagResourceCommand.ts
@@ -28,9 +28,6 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 
 /**
  * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iotfleethub/src/commands/UntagResourceCommand.ts b/clients/client-iotfleethub/src/commands/UntagResourceCommand.ts
@@ -28,9 +28,6 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 
 /**
  * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iotfleethub/src/commands/UpdateApplicationCommand.ts b/clients/client-iotfleethub/src/commands/UpdateApplicationCommand.ts
@@ -27,10 +27,7 @@ export interface UpdateApplicationCommandInput extends UpdateApplicationRequest
 export interface UpdateApplicationCommandOutput extends UpdateApplicationResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <p>Updates information about a Fleet Hub for IoT Device Management web application.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iotfleethub/src/index.ts b/clients/client-iotfleethub/src/index.ts
@@ -1,10 +1,7 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <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>
+ * <p>With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.</p>
  *
  * @packageDocumentation
  */

diff --git a/clients/client-iotfleethub/src/models/models_0.ts b/clients/client-iotfleethub/src/models/models_0.ts
@@ -21,10 +21,7 @@ export const ApplicationState = {
 export type ApplicationState = (typeof ApplicationState)[keyof typeof ApplicationState];
 
 /**
- * <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>
+ * <p>A summary of information about a Fleet Hub for IoT Device Management web application.</p>
  * @public
  */
 export interface ApplicationSummary {
@@ -95,7 +92,7 @@ export interface CreateApplicationRequest {
   clientToken?: string;
 
   /**
-   * <p>The ARN of the role that the web application assumes when it interacts with AWS IoT Core.</p>
+   * <p>The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.</p>
    *          <note>
    *             <p>The name of the role must be in the form <code>AWSIotFleetHub_<i>random_string</i>
    *                </code>.</p>
@@ -315,7 +312,7 @@ export interface DescribeApplicationResponse {
   applicationLastUpdateDate: number | undefined;
 
   /**
-   * <p>The ARN of the role that the web application assumes when it interacts with AWS IoT Core.</p>
+   * <p>The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.</p>
    * @public
    */
   roleArn: string | undefined;
@@ -327,7 +324,8 @@ export interface DescribeApplicationResponse {
   ssoClientId?: string;
 
   /**
-   * <p>A message indicating why the <code>DescribeApplication</code> API failed.</p>
+   * <p>A message that explains any failures included in the <code>applicationState</code> response field. This message
+   *     explains failures in the <code>CreateApplication</code> and <code>DeleteApplication</code> actions.</p>
    * @public
    */
   errorMessage?: string;

diff --git a/codegen/sdk-codegen/aws-models/iotfleethub.json b/codegen/sdk-codegen/aws-models/iotfleethub.json
@@ -70,7 +70,7 @@
           "name": "iotfleethub"
         },
         "aws.protocols#restJson1": {},
-        "smithy.api#documentation": "<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>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>",
+        "smithy.api#documentation": "<p>With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.</p>",
         "smithy.api#title": "AWS IoT Fleet Hub",
         "smithy.rules#endpointRuleSet": {
           "version": "1.0",
@@ -990,7 +990,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>A summary of information about a AWS IoT Device Management web application.</p>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>"
+        "smithy.api#documentation": "<p>A summary of information about a Fleet Hub for IoT Device Management web application.</p>"
       }
     },
     "com.amazonaws.iotfleethub#Arn": {
@@ -1049,7 +1049,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Creates a Fleet Hub for AWS IoT Device Management web application.</p>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Creates a Fleet Hub for IoT Device Management web application.</p>\n         <p>When creating a Fleet Hub application, you must create an organization instance of\n      IAM Identity Center if you don't already have one. The Fleet Hub application you create must also be in\n      the same Amazon Web Services Region of the organization instance of IAM Identity Center. For more information see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/get-set-up-for-idc.html\">Enabling\n        IAM Identity Center</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/organization-instances-identity-center.html\">Organization instances of IAM Identity Center</a>.</p>",
         "smithy.api#http": {
           "method": "POST",
           "uri": "/applications",
@@ -1083,7 +1083,7 @@
         "roleArn": {
           "target": "com.amazonaws.iotfleethub#Arn",
           "traits": {
-            "smithy.api#documentation": "<p>The ARN of the role that the web application assumes when it interacts with AWS IoT Core.</p>\n         <note>\n            <p>The name of the role must be in the form <code>AWSIotFleetHub_<i>random_string</i>\n               </code>.</p>\n         </note>",
+            "smithy.api#documentation": "<p>The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.</p>\n         <note>\n            <p>The name of the role must be in the form <code>AWSIotFleetHub_<i>random_string</i>\n               </code>.</p>\n         </note>",
             "smithy.api#required": {}
           }
         },
@@ -1143,7 +1143,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Deletes a Fleet Hub for AWS IoT Device Management web application.</p>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Deletes a Fleet Hub for IoT Device Management web application.</p>",
         "smithy.api#http": {
           "method": "DELETE",
           "uri": "/applications/{applicationId}",
@@ -1205,7 +1205,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Gets information about a Fleet Hub for AWS IoT Device Management web application.</p>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Gets information about a Fleet Hub for IoT Device Management web application.</p>",
         "smithy.api#http": {
           "method": "GET",
           "uri": "/applications/{applicationId}",
@@ -1292,7 +1292,7 @@
         "roleArn": {
           "target": "com.amazonaws.iotfleethub#Arn",
           "traits": {
-            "smithy.api#documentation": "<p>The ARN of the role that the web application assumes when it interacts with AWS IoT Core.</p>",
+            "smithy.api#documentation": "<p>The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.</p>",
             "smithy.api#required": {}
           }
         },
@@ -1305,7 +1305,7 @@
         "errorMessage": {
           "target": "com.amazonaws.iotfleethub#ErrorMessage",
           "traits": {
-            "smithy.api#documentation": "<p>A message indicating why the <code>DescribeApplication</code> API failed.</p>"
+            "smithy.api#documentation": "<p>A message that explains any failures included in the <code>applicationState</code> response field. This message \n    explains failures in the <code>CreateApplication</code> and <code>DeleteApplication</code> actions.</p>"
           }
         },
         "tags": {
@@ -1401,7 +1401,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.</p>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Gets a list of Fleet Hub for IoT Device Management web applications for the current account.</p>",
         "smithy.api#http": {
           "method": "GET",
           "uri": "/applications",
@@ -1469,7 +1469,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Lists the tags for the specified resource.</p>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Lists the tags for the specified resource.</p>",
         "smithy.api#http": {
           "method": "GET",
           "uri": "/tags/{resourceArn}",
@@ -1597,7 +1597,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.</p>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.</p>",
         "smithy.api#http": {
           "method": "POST",
           "uri": "/tags/{resourceArn}",
@@ -1683,7 +1683,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Removes the specified tags (metadata) from the resource.</p>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Removes the specified tags (metadata) from the resource.</p>",
         "smithy.api#http": {
           "method": "DELETE",
           "uri": "/tags/{resourceArn}",
@@ -1748,7 +1748,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Updates information about a Fleet Hub for a AWS IoT Device Management web application.</p>\n         <note>\n            <p>Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Updates information about a Fleet Hub for IoT Device Management web application.</p>",
         "smithy.api#http": {
           "method": "PATCH",
           "uri": "/applications/{applicationId}",