Iotfleethub

This page documents function available when using the Iotfleethub module, created with @service Iotfleethub.

Index

Documentation

Main.Iotfleethub.create_applicationMethod
create_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.
source
Main.Iotfleethub.delete_applicationMethod
delete_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.
source
Main.Iotfleethub.describe_applicationMethod
describe_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.
source
Main.Iotfleethub.list_applicationsMethod
list_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.
source
Main.Iotfleethub.list_tags_for_resourceMethod
list_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.
source
Main.Iotfleethub.tag_resourceMethod
tag_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.
source
Main.Iotfleethub.untag_resourceMethod
untag_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.
source
Main.Iotfleethub.update_applicationMethod
update_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.
source