iotfleethub/aws.sdk.kotlin.services.iotfleethub/IotFleetHubClient

IotFleetHubClient

interface IotFleetHubClient : SdkClient

With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.

Types

class Builder : AbstractSdkClientBuilder<IotFleetHubClient.Config, IotFleetHubClient.Config.Builder, IotFleetHubClient>

object Companion : AbstractAwsSdkClientFactory<IotFleetHubClient.Config, IotFleetHubClient.Config.Builder, IotFleetHubClient, IotFleetHubClient.Builder>

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

abstract override val config: IotFleetHubClient.Config

IotFleetHubClient's configuration

Functions

createApplication

abstract suspend fun createApplication(input: CreateApplicationRequest): CreateApplicationResponse

Creates a Fleet Hub for IoT Device Management web application.

deleteApplication

abstract suspend fun deleteApplication(input: DeleteApplicationRequest): DeleteApplicationResponse

Deletes a Fleet Hub for IoT Device Management web application.

describeApplication

abstract suspend fun describeApplication(input: DescribeApplicationRequest): DescribeApplicationResponse

Gets information about a Fleet Hub for IoT Device Management web application.

listApplications

abstract suspend fun listApplications(input: ListApplicationsRequest = ListApplicationsRequest { }): ListApplicationsResponse

Gets a list of Fleet Hub for IoT Device Management web applications for the current account.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags for the specified resource.

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the specified tags (metadata) from the resource.

updateApplication

abstract suspend fun updateApplication(input: UpdateApplicationRequest): UpdateApplicationResponse

Updates information about a Fleet Hub for IoT Device Management web application.

Inherited functions

expect abstract fun close()

createApplication

inline suspend fun IotFleetHubClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

Creates a Fleet Hub for IoT Device Management web application.

deleteApplication

inline suspend fun IotFleetHubClient.deleteApplication(crossinline block: DeleteApplicationRequest.Builder.() -> Unit): DeleteApplicationResponse

Deletes a Fleet Hub for IoT Device Management web application.

describeApplication

inline suspend fun IotFleetHubClient.describeApplication(crossinline block: DescribeApplicationRequest.Builder.() -> Unit): DescribeApplicationResponse

Gets information about a Fleet Hub for IoT Device Management web application.

listApplications

inline suspend fun IotFleetHubClient.listApplications(crossinline block: ListApplicationsRequest.Builder.() -> Unit): ListApplicationsResponse

Gets a list of Fleet Hub for IoT Device Management web applications for the current account.

listApplicationsPaginated

fun IotFleetHubClient.listApplicationsPaginated(initialRequest: ListApplicationsRequest = ListApplicationsRequest { }): Flow<ListApplicationsResponse>

fun IotFleetHubClient.listApplicationsPaginated(block: ListApplicationsRequest.Builder.() -> Unit): Flow<ListApplicationsResponse>

Paginate over ListApplicationsResponse results.

listTagsForResource

inline suspend fun IotFleetHubClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags for the specified resource.

inline suspend fun IotFleetHubClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

inline suspend fun IotFleetHubClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags (metadata) from the resource.

updateApplication

inline suspend fun IotFleetHubClient.updateApplication(crossinline block: UpdateApplicationRequest.Builder.() -> Unit): UpdateApplicationResponse

Updates information about a Fleet Hub for IoT Device Management web application.

fun IotFleetHubClient.withConfig(block: IotFleetHubClient.Config.Builder.() -> Unit): IotFleetHubClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.