Iotfleethub
This page documents function available when using the Iotfleethub module, created with @service Iotfleethub.
Index
Main.Iotfleethub.create_applicationMain.Iotfleethub.delete_applicationMain.Iotfleethub.describe_applicationMain.Iotfleethub.list_applicationsMain.Iotfleethub.list_tags_for_resourceMain.Iotfleethub.tag_resourceMain.Iotfleethub.untag_resourceMain.Iotfleethub.update_application
Documentation
Main.Iotfleethub.create_application — Methodcreate_application(application_name, role_arn)
create_application(application_name, role_arn, params::Dict{String,<:Any})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.
Arguments
application_name: The name of the web application.role_arn: The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core. The name of the role must be in the form AWSIotFleetHubrandomstring .
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"applicationDescription": An optional description of the web application."clientToken": 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."tags": A set of key/value pairs that you can use to manage the web application resource.
Main.Iotfleethub.delete_application — Methoddelete_application(application_id)
delete_application(application_id, params::Dict{String,<:Any})Deletes a Fleet Hub for IoT Device Management web application.
Arguments
application_id: The unique Id of the web application.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"clientToken": 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.
Main.Iotfleethub.describe_application — Methoddescribe_application(application_id)
describe_application(application_id, params::Dict{String,<:Any})Gets information about a Fleet Hub for IoT Device Management web application.
Arguments
application_id: The unique Id of the web application.
Main.Iotfleethub.list_applications — Methodlist_applications()
list_applications(params::Dict{String,<:Any})Gets a list of Fleet Hub for IoT Device Management web applications for the current account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"nextToken": A token used to get the next set of results.
Main.Iotfleethub.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags for the specified resource.
Arguments
resource_arn: The ARN of the resource.
Main.Iotfleethub.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.
Arguments
resource_arn: The ARN of the resource.tags: The new or modified tags for the resource.
Main.Iotfleethub.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes the specified tags (metadata) from the resource.
Arguments
resource_arn: The ARN of the resource.tag_keys: A list of the keys of the tags to be removed from the resource.
Main.Iotfleethub.update_application — Methodupdate_application(application_id)
update_application(application_id, params::Dict{String,<:Any})Updates information about a Fleet Hub for IoT Device Management web application.
Arguments
application_id: The unique Id of the web application.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"applicationDescription": An optional description of the web application."applicationName": The name of the web application."clientToken": 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.