iotroborunner/aws.sdk.kotlin.services.iotroborunner/IotRoboRunnerClient

IotRoboRunnerClient

interface IotRoboRunnerClient : SdkClient

An example service, deployed with the Octane Service creator, which will echo the string

Types

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

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

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

Properties

abstract override val config: IotRoboRunnerClient.Config

IotRoboRunnerClient's configuration

Functions

createDestination

abstract suspend fun createDestination(input: CreateDestinationRequest): CreateDestinationResponse

Grants permission to create a destination

abstract suspend fun createSite(input: CreateSiteRequest): CreateSiteResponse

Grants permission to create a site

abstract suspend fun createWorker(input: CreateWorkerRequest): CreateWorkerResponse

Grants permission to create a worker

createWorkerFleet

abstract suspend fun createWorkerFleet(input: CreateWorkerFleetRequest): CreateWorkerFleetResponse

Grants permission to create a worker fleet

deleteDestination

abstract suspend fun deleteDestination(input: DeleteDestinationRequest): DeleteDestinationResponse

Grants permission to delete a destination

abstract suspend fun deleteSite(input: DeleteSiteRequest): DeleteSiteResponse

Grants permission to delete a site

abstract suspend fun deleteWorker(input: DeleteWorkerRequest): DeleteWorkerResponse

Grants permission to delete a worker

deleteWorkerFleet

abstract suspend fun deleteWorkerFleet(input: DeleteWorkerFleetRequest): DeleteWorkerFleetResponse

Grants permission to delete a worker fleet

abstract suspend fun getDestination(input: GetDestinationRequest): GetDestinationResponse

Grants permission to get a destination

abstract suspend fun getSite(input: GetSiteRequest): GetSiteResponse

Grants permission to get a site

abstract suspend fun getWorker(input: GetWorkerRequest): GetWorkerResponse

Grants permission to get a worker

abstract suspend fun getWorkerFleet(input: GetWorkerFleetRequest): GetWorkerFleetResponse

Grants permission to get a worker fleet

listDestinations

abstract suspend fun listDestinations(input: ListDestinationsRequest): ListDestinationsResponse

Grants permission to list destinations

abstract suspend fun listSites(input: ListSitesRequest = ListSitesRequest { }): ListSitesResponse

Grants permission to list sites

listWorkerFleets

abstract suspend fun listWorkerFleets(input: ListWorkerFleetsRequest): ListWorkerFleetsResponse

Grants permission to list worker fleets

abstract suspend fun listWorkers(input: ListWorkersRequest): ListWorkersResponse

Grants permission to list workers

updateDestination

abstract suspend fun updateDestination(input: UpdateDestinationRequest): UpdateDestinationResponse

Grants permission to update a destination

abstract suspend fun updateSite(input: UpdateSiteRequest): UpdateSiteResponse

Grants permission to update a site

abstract suspend fun updateWorker(input: UpdateWorkerRequest): UpdateWorkerResponse

Grants permission to update a worker

updateWorkerFleet

abstract suspend fun updateWorkerFleet(input: UpdateWorkerFleetRequest): UpdateWorkerFleetResponse

Grants permission to update a worker fleet

Inherited functions

expect abstract fun close()

createDestination

inline suspend fun IotRoboRunnerClient.createDestination(crossinline block: CreateDestinationRequest.Builder.() -> Unit): CreateDestinationResponse

Grants permission to create a destination

inline suspend fun IotRoboRunnerClient.createSite(crossinline block: CreateSiteRequest.Builder.() -> Unit): CreateSiteResponse

Grants permission to create a site

inline suspend fun IotRoboRunnerClient.createWorker(crossinline block: CreateWorkerRequest.Builder.() -> Unit): CreateWorkerResponse

Grants permission to create a worker

createWorkerFleet

inline suspend fun IotRoboRunnerClient.createWorkerFleet(crossinline block: CreateWorkerFleetRequest.Builder.() -> Unit): CreateWorkerFleetResponse

Grants permission to create a worker fleet

deleteDestination

inline suspend fun IotRoboRunnerClient.deleteDestination(crossinline block: DeleteDestinationRequest.Builder.() -> Unit): DeleteDestinationResponse

Grants permission to delete a destination

inline suspend fun IotRoboRunnerClient.deleteSite(crossinline block: DeleteSiteRequest.Builder.() -> Unit): DeleteSiteResponse

Grants permission to delete a site

inline suspend fun IotRoboRunnerClient.deleteWorker(crossinline block: DeleteWorkerRequest.Builder.() -> Unit): DeleteWorkerResponse

Grants permission to delete a worker

deleteWorkerFleet

inline suspend fun IotRoboRunnerClient.deleteWorkerFleet(crossinline block: DeleteWorkerFleetRequest.Builder.() -> Unit): DeleteWorkerFleetResponse

Grants permission to delete a worker fleet

inline suspend fun IotRoboRunnerClient.getDestination(crossinline block: GetDestinationRequest.Builder.() -> Unit): GetDestinationResponse

Grants permission to get a destination

inline suspend fun IotRoboRunnerClient.getSite(crossinline block: GetSiteRequest.Builder.() -> Unit): GetSiteResponse

Grants permission to get a site

inline suspend fun IotRoboRunnerClient.getWorker(crossinline block: GetWorkerRequest.Builder.() -> Unit): GetWorkerResponse

Grants permission to get a worker

inline suspend fun IotRoboRunnerClient.getWorkerFleet(crossinline block: GetWorkerFleetRequest.Builder.() -> Unit): GetWorkerFleetResponse

Grants permission to get a worker fleet

listDestinations

inline suspend fun IotRoboRunnerClient.listDestinations(crossinline block: ListDestinationsRequest.Builder.() -> Unit): ListDestinationsResponse

Grants permission to list destinations

inline suspend fun IotRoboRunnerClient.listSites(crossinline block: ListSitesRequest.Builder.() -> Unit): ListSitesResponse

Grants permission to list sites

listWorkerFleets

inline suspend fun IotRoboRunnerClient.listWorkerFleets(crossinline block: ListWorkerFleetsRequest.Builder.() -> Unit): ListWorkerFleetsResponse

Grants permission to list worker fleets

inline suspend fun IotRoboRunnerClient.listWorkers(crossinline block: ListWorkersRequest.Builder.() -> Unit): ListWorkersResponse

Grants permission to list workers

listWorkersPaginated

fun IotRoboRunnerClient.listWorkersPaginated(initialRequest: ListWorkersRequest): Flow<ListWorkersResponse>

fun IotRoboRunnerClient.listWorkersPaginated(block: ListWorkersRequest.Builder.() -> Unit): Flow<ListWorkersResponse>

Paginate over ListWorkersResponse results.

updateDestination

inline suspend fun IotRoboRunnerClient.updateDestination(crossinline block: UpdateDestinationRequest.Builder.() -> Unit): UpdateDestinationResponse

Grants permission to update a destination

inline suspend fun IotRoboRunnerClient.updateSite(crossinline block: UpdateSiteRequest.Builder.() -> Unit): UpdateSiteResponse

Grants permission to update a site

inline suspend fun IotRoboRunnerClient.updateWorker(crossinline block: UpdateWorkerRequest.Builder.() -> Unit): UpdateWorkerResponse

Grants permission to update a worker

updateWorkerFleet

inline suspend fun IotRoboRunnerClient.updateWorkerFleet(crossinline block: UpdateWorkerFleetRequest.Builder.() -> Unit): UpdateWorkerFleetResponse

Grants permission to update a worker fleet

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

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.