IoTFleetHub *********** Client ====== class IoTFleetHub.Client A low-level client representing AWS IoT Fleet Hub With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets. import boto3 client = boto3.client('iotfleethub') These are the available methods: * can_paginate * close * create_application * delete_application * describe_application * get_paginator * get_waiter * list_applications * list_tags_for_resource * tag_resource * untag_resource * update_application Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListApplications IoTFleetHub / Paginator / ListApplications ListApplications **************** class IoTFleetHub.Paginator.ListApplications paginator = client.get_paginator('list_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetHub.Client.list_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'applicationSummaries': [ { 'applicationId': 'string', 'applicationName': 'string', 'applicationDescription': 'string', 'applicationUrl': 'string', 'applicationCreationDate': 123, 'applicationLastUpdateDate': 123, 'applicationState': 'CREATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **applicationSummaries** *(list) --* An array of objects that provide summaries of information about the web applications in the list. * *(dict) --* A summary of information about a Fleet Hub for IoT Device Management web application. * **applicationId** *(string) --* The unique Id of the web application. * **applicationName** *(string) --* The name of the web application. * **applicationDescription** *(string) --* An optional description of the web application. * **applicationUrl** *(string) --* The URL of the web application. * **applicationCreationDate** *(integer) --* The date (in Unix epoch time) when the web application was created. * **applicationLastUpdateDate** *(integer) --* The date (in Unix epoch time) when the web application was last updated. * **applicationState** *(string) --* The current state of the web application. * **NextToken** *(string) --* A token to resume pagination. IoTFleetHub / Client / list_applications list_applications ***************** IoTFleetHub.Client.list_applications(**kwargs) Gets a list of Fleet Hub for IoT Device Management web applications for the current account. See also: AWS API Documentation **Request Syntax** response = client.list_applications( nextToken='string' ) Parameters: **nextToken** (*string*) -- A token used to get the next set of results. Return type: dict Returns: **Response Syntax** { 'applicationSummaries': [ { 'applicationId': 'string', 'applicationName': 'string', 'applicationDescription': 'string', 'applicationUrl': 'string', 'applicationCreationDate': 123, 'applicationLastUpdateDate': 123, 'applicationState': 'CREATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **applicationSummaries** *(list) --* An array of objects that provide summaries of information about the web applications in the list. * *(dict) --* A summary of information about a Fleet Hub for IoT Device Management web application. * **applicationId** *(string) --* The unique Id of the web application. * **applicationName** *(string) --* The name of the web application. * **applicationDescription** *(string) --* An optional description of the web application. * **applicationUrl** *(string) --* The URL of the web application. * **applicationCreationDate** *(integer) --* The date (in Unix epoch time) when the web application was created. * **applicationLastUpdateDate** *(integer) --* The date (in Unix epoch time) when the web application was last updated. * **applicationState** *(string) --* The current state of the web application. * **nextToken** *(string) --* A token used to get the next set of results. **Exceptions** * "IoTFleetHub.Client.exceptions.InvalidRequestException" * "IoTFleetHub.Client.exceptions.InternalFailureException" * "IoTFleetHub.Client.exceptions.ThrottlingException" IoTFleetHub / Client / get_paginator get_paginator ************* IoTFleetHub.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. IoTFleetHub / Client / can_paginate can_paginate ************ IoTFleetHub.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. IoTFleetHub / Client / list_tags_for_resource list_tags_for_resource ********************** IoTFleetHub.Client.list_tags_for_resource(**kwargs) Lists the tags for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The list of tags assigned to the resource. * *(string) --* * *(string) --* **Exceptions** * "IoTFleetHub.Client.exceptions.InternalFailureException" * "IoTFleetHub.Client.exceptions.InvalidRequestException" * "IoTFleetHub.Client.exceptions.ResourceNotFoundException" IoTFleetHub / Client / untag_resource untag_resource ************** IoTFleetHub.Client.untag_resource(**kwargs) Removes the specified tags (metadata) from the resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. * **tagKeys** (*list*) -- **[REQUIRED]** A list of the keys of the tags to be removed from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTFleetHub.Client.exceptions.InternalFailureException" * "IoTFleetHub.Client.exceptions.InvalidRequestException" * "IoTFleetHub.Client.exceptions.ResourceNotFoundException" IoTFleetHub / Client / get_waiter get_waiter ********** IoTFleetHub.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" IoTFleetHub / Client / update_application update_application ****************** IoTFleetHub.Client.update_application(**kwargs) Updates information about a Fleet Hub for IoT Device Management web application. See also: AWS API Documentation **Request Syntax** response = client.update_application( applicationId='string', applicationName='string', applicationDescription='string', clientToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique Id of the web application. * **applicationName** (*string*) -- The name of the web application. * **applicationDescription** (*string*) -- An optional description of the web application. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTFleetHub.Client.exceptions.InvalidRequestException" * "IoTFleetHub.Client.exceptions.ResourceNotFoundException" * "IoTFleetHub.Client.exceptions.InternalFailureException" * "IoTFleetHub.Client.exceptions.ConflictException" * "IoTFleetHub.Client.exceptions.ThrottlingException" IoTFleetHub / Client / close close ***** IoTFleetHub.Client.close() Closes underlying endpoint connections. IoTFleetHub / Client / describe_application describe_application ******************** IoTFleetHub.Client.describe_application(**kwargs) Gets information about a Fleet Hub for IoT Device Management web application. See also: AWS API Documentation **Request Syntax** response = client.describe_application( applicationId='string' ) Parameters: **applicationId** (*string*) -- **[REQUIRED]** The unique Id of the web application. Return type: dict Returns: **Response Syntax** { 'applicationId': 'string', 'applicationArn': 'string', 'applicationName': 'string', 'applicationDescription': 'string', 'applicationUrl': 'string', 'applicationState': 'CREATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'DELETE_FAILED', 'applicationCreationDate': 123, 'applicationLastUpdateDate': 123, 'roleArn': 'string', 'ssoClientId': 'string', 'errorMessage': 'string', 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **applicationId** *(string) --* The unique Id of the web application. * **applicationArn** *(string) --* The ARN of the web application. * **applicationName** *(string) --* The name of the web application. * **applicationDescription** *(string) --* An optional description of the web application. * **applicationUrl** *(string) --* The URL of the web application. * **applicationState** *(string) --* The current state of the web application. * **applicationCreationDate** *(integer) --* The date (in Unix epoch time) when the application was created. * **applicationLastUpdateDate** *(integer) --* The date (in Unix epoch time) when the application was last updated. * **roleArn** *(string) --* The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core. * **ssoClientId** *(string) --* The Id of the single sign-on client that you use to authenticate and authorize users on the web application. * **errorMessage** *(string) --* A message that explains any failures included in the "applicationState" response field. This message explains failures in the "CreateApplication" and "DeleteApplication" actions. * **tags** *(dict) --* A set of key/value pairs that you can use to manage the web application resource. * *(string) --* * *(string) --* **Exceptions** * "IoTFleetHub.Client.exceptions.InvalidRequestException" * "IoTFleetHub.Client.exceptions.ResourceNotFoundException" * "IoTFleetHub.Client.exceptions.InternalFailureException" * "IoTFleetHub.Client.exceptions.ThrottlingException" IoTFleetHub / Client / delete_application delete_application ****************** IoTFleetHub.Client.delete_application(**kwargs) Deletes a Fleet Hub for IoT Device Management web application. See also: AWS API Documentation **Request Syntax** response = client.delete_application( applicationId='string', clientToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique Id of the web application. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTFleetHub.Client.exceptions.InvalidRequestException" * "IoTFleetHub.Client.exceptions.ResourceNotFoundException" * "IoTFleetHub.Client.exceptions.InternalFailureException" * "IoTFleetHub.Client.exceptions.ThrottlingException" IoTFleetHub / Client / create_application create_application ****************** IoTFleetHub.Client.create_application(**kwargs) Creates a Fleet Hub for 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 Amazon Web Services Region of the organization instance of IAM Identity Center. For more information see Enabling IAM Identity Center and Organization instances of IAM Identity Center. See also: AWS API Documentation **Request Syntax** response = client.create_application( applicationName='string', applicationDescription='string', clientToken='string', roleArn='string', tags={ 'string': 'string' } ) Parameters: * **applicationName** (*string*) -- **[REQUIRED]** The name of the web application. * **applicationDescription** (*string*) -- An optional description of the web application. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **roleArn** (*string*) -- **[REQUIRED]** The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core. Note: The name of the role must be in the form >>``<>``<<. * **tags** (*dict*) -- A set of key/value pairs that you can use to manage the web application resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'applicationId': 'string', 'applicationArn': 'string' } **Response Structure** * *(dict) --* * **applicationId** *(string) --* The unique Id of the web application. * **applicationArn** *(string) --* The ARN of the web application. **Exceptions** * "IoTFleetHub.Client.exceptions.InvalidRequestException" * "IoTFleetHub.Client.exceptions.InternalFailureException" * "IoTFleetHub.Client.exceptions.ThrottlingException" * "IoTFleetHub.Client.exceptions.LimitExceededException" IoTFleetHub / Client / tag_resource tag_resource ************ IoTFleetHub.Client.tag_resource(**kwargs) Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. * **tags** (*dict*) -- **[REQUIRED]** The new or modified tags for the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTFleetHub.Client.exceptions.InternalFailureException" * "IoTFleetHub.Client.exceptions.InvalidRequestException" * "IoTFleetHub.Client.exceptions.ResourceNotFoundException"