commonMain.aws.sdk.kotlin.services.snowdevicemanagement.SnowDeviceManagementClient.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of snowdevicemanagement-jvm Show documentation
Show all versions of snowdevicemanagement-jvm Show documentation
The AWS SDK for Kotlin client for Snow Device Management
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.snowdevicemanagement
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.config.endpoints.resolveEndpointUrl
import aws.sdk.kotlin.runtime.config.profile.AwsProfile
import aws.sdk.kotlin.runtime.config.profile.AwsSharedConfig
import aws.sdk.kotlin.runtime.http.retries.AwsRetryPolicy
import aws.sdk.kotlin.services.snowdevicemanagement.auth.DefaultSnowDeviceManagementAuthSchemeProvider
import aws.sdk.kotlin.services.snowdevicemanagement.auth.SnowDeviceManagementAuthSchemeProvider
import aws.sdk.kotlin.services.snowdevicemanagement.endpoints.DefaultSnowDeviceManagementEndpointProvider
import aws.sdk.kotlin.services.snowdevicemanagement.endpoints.SnowDeviceManagementEndpointParameters
import aws.sdk.kotlin.services.snowdevicemanagement.endpoints.SnowDeviceManagementEndpointProvider
import aws.sdk.kotlin.services.snowdevicemanagement.model.CancelTaskRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.CancelTaskResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.CreateTaskRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.CreateTaskResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.DescribeDeviceEc2InstancesRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.DescribeDeviceEc2InstancesResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.DescribeDeviceRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.DescribeDeviceResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.DescribeExecutionRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.DescribeExecutionResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.DescribeTaskRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.DescribeTaskResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListDeviceResourcesRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListDeviceResourcesResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListDevicesRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListDevicesResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListExecutionsRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListExecutionsResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListTagsForResourceRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListTagsForResourceResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListTasksRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.ListTasksResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.TagResourceRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.TagResourceResponse
import aws.sdk.kotlin.services.snowdevicemanagement.model.UntagResourceRequest
import aws.sdk.kotlin.services.snowdevicemanagement.model.UntagResourceResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.awsprotocol.ClockSkewInterceptor
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.IdempotencyTokenConfig
import aws.smithy.kotlin.runtime.client.IdempotencyTokenProvider
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.RetryClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfigImpl
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.client.SdkClientFactory
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.url.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.telemetry.Global
import aws.smithy.kotlin.runtime.telemetry.TelemetryConfig
import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import kotlin.collections.List
import kotlin.jvm.JvmStatic
public const val ServiceId: String = "Snow Device Management"
public const val SdkVersion: String = "1.1.4"
public const val ServiceApiVersion: String = "2021-08-04"
/**
* Amazon Web Services Snow Device Management documentation.
*/
public interface SnowDeviceManagementClient : SdkClient {
/**
* SnowDeviceManagementClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory() {
@JvmStatic
override fun builder(): Builder = Builder()
override suspend fun finalizeConfig(builder: Builder, sharedConfig: LazyAsyncValue, activeProfile: LazyAsyncValue) {
builder.config.endpointUrl = builder.config.endpointUrl ?: resolveEndpointUrl(
sharedConfig,
"SnowDeviceManagement",
"SNOW_DEVICE_MANAGEMENT",
"snow_device_management",
)
builder.config.interceptors.add(0, ClockSkewInterceptor())
}
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): SnowDeviceManagementClient = DefaultSnowDeviceManagementClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig by builder.buildRetryStrategyClientConfig(), SdkClientConfig, TelemetryConfig {
override val clientName: String = builder.clientName
override val region: String? = builder.region
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: SnowDeviceManagementEndpointProvider = builder.endpointProvider ?: DefaultSnowDeviceManagementEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val idempotencyTokenProvider: IdempotencyTokenProvider = builder.idempotencyTokenProvider ?: IdempotencyTokenProvider.Default
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsRetryPolicy.Default
override val telemetryProvider: TelemetryProvider = builder.telemetryProvider ?: TelemetryProvider.Global
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
override val applicationId: String? = builder.applicationId
public val authSchemeProvider: SnowDeviceManagementAuthSchemeProvider = builder.authSchemeProvider ?: DefaultSnowDeviceManagementAuthSchemeProvider()
public companion object {
public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
public fun toBuilder(): Builder = Builder().apply {
clientName = [email protected]
region = [email protected]
authSchemes = [email protected]
credentialsProvider = [email protected]
endpointProvider = [email protected]
endpointUrl = [email protected]
httpClient = [email protected]
idempotencyTokenProvider = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
telemetryProvider = [email protected]
useDualStack = [email protected]
useFips = [email protected]
applicationId = [email protected]
authSchemeProvider = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), IdempotencyTokenConfig.Builder, RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "Snow Device Management"
/**
* The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
* [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
* information
*/
override var region: String? = null
/**
* Register new or override default [AuthScheme]s configured for this client. By default, the set
* of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
* precedence over the defaults and can be used to customize identity resolution and signing for specific
* authentication schemes.
*/
override var authSchemes: kotlin.collections.List = emptyList()
/**
* The AWS credentials provider to use for authenticating requests. If not provided a
* [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
* NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
* client will not close it when the client is closed.
*/
override var credentialsProvider: CredentialsProvider? = null
/**
* The endpoint provider used to determine where to make service requests. **This is an advanced config
* option.**
*
* Endpoint resolution occurs as part of the workflow for every request made via the service client.
*
* The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
*/
public var endpointProvider: SnowDeviceManagementEndpointProvider? = null
/**
* A custom endpoint to route requests to. The endpoint set here is passed to the configured
* [endpointProvider], which may inspect and modify it as needed.
*
* Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
* the recommended way to route requests to development or preview instances of a service.
*
* **This is an advanced config option.**
*/
public var endpointUrl: Url? = null
/**
* Override the default idempotency token generator. SDK clients will generate tokens for members
* that represent idempotent tokens when not explicitly set by the caller using this generator.
*/
override var idempotencyTokenProvider: IdempotencyTokenProvider? = null
/**
* Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
* the request and response objects as they are processed by the SDK.
* Interceptors added using this method are executed in the order they are configured and are always
* later than any added automatically by the SDK.
*/
override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()
/**
* Configure events that will be logged. By default clients will not output
* raw requests or responses. Use this setting to opt-in to additional debug logging.
*
* This can be used to configure logging of requests, responses, retries, etc of SDK clients.
*
* **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
* performance considerations when dumping the request/response body. This is primarily a tool for
* debug purposes.
*/
override var logMode: LogMode? = null
/**
* The policy to use for evaluating operation results and determining whether/how to retry.
*/
override var retryPolicy: RetryPolicy? = null
/**
* The telemetry provider used to instrument the SDK operations with. By default, the global telemetry
* provider will be used.
*/
override var telemetryProvider: TelemetryProvider? = null
/**
* Flag to toggle whether to use dual-stack endpoints when making requests.
* See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
* ` Disabled by default.
*/
override var useDualStack: Boolean? = null
/**
* Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
* ` Disabled by default.
*/
override var useFips: Boolean? = null
/**
* An optional application specific identifier.
* When set it will be appended to the User-Agent header of every request in the form of: `app/{applicationId}`.
* When not explicitly set, the value will be loaded from the following locations:
*
* - JVM System Property: `aws.userAgentAppId`
* - Environment variable: `AWS_SDK_UA_APP_ID`
* - Shared configuration profile attribute: `sdk_ua_app_id`
*
* See [shared configuration settings](https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html)
* reference for more information on environment variables and shared config settings.
*/
override var applicationId: String? = null
/**
* Configure the provider used to resolve the authentication scheme to use for a particular operation.
*/
public var authSchemeProvider: SnowDeviceManagementAuthSchemeProvider? = null
override fun build(): Config = Config(this)
}
}
/**
* Sends a cancel request for a specified task. You can cancel a task only if it's still in a `QUEUED` state. Tasks that are already running can't be cancelled.
*
* A task might still run if it's processed from the queue before the `CancelTask` operation changes the task's state.
*/
public suspend fun cancelTask(input: CancelTaskRequest): CancelTaskResponse
/**
* Instructs one or more devices to start a task, such as unlocking or rebooting.
*/
public suspend fun createTask(input: CreateTaskRequest): CreateTaskResponse
/**
* Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
*/
public suspend fun describeDevice(input: DescribeDeviceRequest): DescribeDeviceResponse
/**
* Checks the current state of the Amazon EC2 instances. The output is similar to `describeDevice`, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.
*/
public suspend fun describeDeviceEc2Instances(input: DescribeDeviceEc2InstancesRequest): DescribeDeviceEc2InstancesResponse
/**
* Checks the status of a remote task running on one or more target devices.
*/
public suspend fun describeExecution(input: DescribeExecutionRequest): DescribeExecutionResponse
/**
* Checks the metadata for a given task on a device.
*/
public suspend fun describeTask(input: DescribeTaskRequest): DescribeTaskResponse
/**
* Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.
*/
public suspend fun listDeviceResources(input: ListDeviceResourcesRequest): ListDeviceResourcesResponse
/**
* Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.
*/
public suspend fun listDevices(input: ListDevicesRequest = ListDevicesRequest { }): ListDevicesResponse
/**
* Returns the status of tasks for one or more target devices.
*/
public suspend fun listExecutions(input: ListExecutionsRequest): ListExecutionsResponse
/**
* Returns a list of tags for a managed device or task.
*/
public suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse
/**
* Returns a list of tasks that can be filtered by state.
*/
public suspend fun listTasks(input: ListTasksRequest = ListTasksRequest { }): ListTasksResponse
/**
* Adds or replaces tags on a device or task.
*/
public suspend fun tagResource(input: TagResourceRequest): TagResourceResponse
/**
* Removes a tag from a device or task.
*/
public suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse
}
/**
* 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.
*
* Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
* If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
*/
public fun SnowDeviceManagementClient.withConfig(block: SnowDeviceManagementClient.Config.Builder.() -> Unit): SnowDeviceManagementClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultSnowDeviceManagementClient(newConfig)
}
/**
* Sends a cancel request for a specified task. You can cancel a task only if it's still in a `QUEUED` state. Tasks that are already running can't be cancelled.
*
* A task might still run if it's processed from the queue before the `CancelTask` operation changes the task's state.
*/
public suspend inline fun SnowDeviceManagementClient.cancelTask(crossinline block: CancelTaskRequest.Builder.() -> Unit): CancelTaskResponse = cancelTask(CancelTaskRequest.Builder().apply(block).build())
/**
* Instructs one or more devices to start a task, such as unlocking or rebooting.
*/
public suspend inline fun SnowDeviceManagementClient.createTask(crossinline block: CreateTaskRequest.Builder.() -> Unit): CreateTaskResponse = createTask(CreateTaskRequest.Builder().apply(block).build())
/**
* Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
*/
public suspend inline fun SnowDeviceManagementClient.describeDevice(crossinline block: DescribeDeviceRequest.Builder.() -> Unit): DescribeDeviceResponse = describeDevice(DescribeDeviceRequest.Builder().apply(block).build())
/**
* Checks the current state of the Amazon EC2 instances. The output is similar to `describeDevice`, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.
*/
public suspend inline fun SnowDeviceManagementClient.describeDeviceEc2Instances(crossinline block: DescribeDeviceEc2InstancesRequest.Builder.() -> Unit): DescribeDeviceEc2InstancesResponse = describeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest.Builder().apply(block).build())
/**
* Checks the status of a remote task running on one or more target devices.
*/
public suspend inline fun SnowDeviceManagementClient.describeExecution(crossinline block: DescribeExecutionRequest.Builder.() -> Unit): DescribeExecutionResponse = describeExecution(DescribeExecutionRequest.Builder().apply(block).build())
/**
* Checks the metadata for a given task on a device.
*/
public suspend inline fun SnowDeviceManagementClient.describeTask(crossinline block: DescribeTaskRequest.Builder.() -> Unit): DescribeTaskResponse = describeTask(DescribeTaskRequest.Builder().apply(block).build())
/**
* Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.
*/
public suspend inline fun SnowDeviceManagementClient.listDeviceResources(crossinline block: ListDeviceResourcesRequest.Builder.() -> Unit): ListDeviceResourcesResponse = listDeviceResources(ListDeviceResourcesRequest.Builder().apply(block).build())
/**
* Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.
*/
public suspend inline fun SnowDeviceManagementClient.listDevices(crossinline block: ListDevicesRequest.Builder.() -> Unit): ListDevicesResponse = listDevices(ListDevicesRequest.Builder().apply(block).build())
/**
* Returns the status of tasks for one or more target devices.
*/
public suspend inline fun SnowDeviceManagementClient.listExecutions(crossinline block: ListExecutionsRequest.Builder.() -> Unit): ListExecutionsResponse = listExecutions(ListExecutionsRequest.Builder().apply(block).build())
/**
* Returns a list of tags for a managed device or task.
*/
public suspend inline fun SnowDeviceManagementClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse = listTagsForResource(ListTagsForResourceRequest.Builder().apply(block).build())
/**
* Returns a list of tasks that can be filtered by state.
*/
public suspend inline fun SnowDeviceManagementClient.listTasks(crossinline block: ListTasksRequest.Builder.() -> Unit): ListTasksResponse = listTasks(ListTasksRequest.Builder().apply(block).build())
/**
* Adds or replaces tags on a device or task.
*/
public suspend inline fun SnowDeviceManagementClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse = tagResource(TagResourceRequest.Builder().apply(block).build())
/**
* Removes a tag from a device or task.
*/
public suspend inline fun SnowDeviceManagementClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse = untagResource(UntagResourceRequest.Builder().apply(block).build())
© 2015 - 2025 Weber Informatics LLC | Privacy Policy