2020/12/15 - AWS IoT Fleet Hub - 8 new api methods
Changes AWS IoT Fleet Hub, a new feature of AWS IoT Device Management that provides a web application for monitoring and managing device fleets connected to AWS IoT at scale.
Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.
Note
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
See also: AWS API Documentation
Request Syntax
client.tag_resource( resourceArn='string', tags={ 'string': 'string' } )
string
[REQUIRED]
The ARN of the resource.
dict
[REQUIRED]
The new or modified tags for the resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Gets information about a Fleet Hub for AWS IoT Device Management web application.
Note
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
See also: AWS API Documentation
Request Syntax
client.describe_application( applicationId='string' )
string
[REQUIRED]
The unique Id of the web application.
dict
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 AWS 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 indicating why the DescribeApplication API failed.
tags (dict) --
A set of key/value pairs that you can use to manage the web application resource.
(string) --
(string) --
Deletes a Fleet Hub for AWS IoT Device Management web application.
Note
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
See also: AWS API Documentation
Request Syntax
client.delete_application( applicationId='string', clientToken='string' )
string
[REQUIRED]
The unique Id of the web application.
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.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
Note
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
See also: AWS API Documentation
Request Syntax
client.list_applications( nextToken='string' )
string
A token used to get the next set of results.
dict
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 AWS IoT Device Management web application.
Note
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
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.
Updates information about a Fleet Hub for a AWS IoT Device Management web application.
Note
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
See also: AWS API Documentation
Request Syntax
client.update_application( applicationId='string', applicationName='string', applicationDescription='string', clientToken='string' )
string
[REQUIRED]
The unique Id of the web application.
string
The name of the web application.
string
An optional description of the web application.
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.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a Fleet Hub for AWS IoT Device Management web application.
Note
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
See also: AWS API Documentation
Request Syntax
client.create_application( applicationName='string', applicationDescription='string', clientToken='string', roleArn='string', tags={ 'string': 'string' } )
string
[REQUIRED]
The name of the web application.
string
An optional description of the web application.
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.
string
[REQUIRED]
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 .
dict
A set of key/value pairs that you can use to manage the web application resource.
(string) --
(string) --
dict
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.
Lists the tags for the specified resource.
Note
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource( resourceArn='string' )
string
[REQUIRED]
The ARN of the resource.
dict
Response Syntax
{ 'tags': { 'string': 'string' } }
Response Structure
(dict) --
tags (dict) --
The list of tags assigned to the resource.
(string) --
(string) --
Removes the specified tags (metadata) from the resource.
Note
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
See also: AWS API Documentation
Request Syntax
client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] )
string
[REQUIRED]
The ARN of the resource.
list
[REQUIRED]
A list of the keys of the tags to be removed from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --