snowdevicemanagement/aws.sdk.kotlin.services.snowdevicemanagement

Package-level declarations

Types

SnowDeviceManagementClient

interface SnowDeviceManagementClient : SdkClient

Amazon Web Services Snow Device Management documentation.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

cancelTask

inline suspend fun SnowDeviceManagementClient.cancelTask(crossinline block: CancelTaskRequest.Builder.() -> Unit): CancelTaskResponse

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.

createTask

inline suspend fun SnowDeviceManagementClient.createTask(crossinline block: CreateTaskRequest.Builder.() -> Unit): CreateTaskResponse

Instructs one or more devices to start a task, such as unlocking or rebooting.

describeDevice

inline suspend fun SnowDeviceManagementClient.describeDevice(crossinline block: DescribeDeviceRequest.Builder.() -> Unit): DescribeDeviceResponse

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

describeDeviceEc2Instances

inline suspend fun SnowDeviceManagementClient.describeDeviceEc2Instances(crossinline block: DescribeDeviceEc2InstancesRequest.Builder.() -> Unit): DescribeDeviceEc2InstancesResponse

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.

describeExecution

inline suspend fun SnowDeviceManagementClient.describeExecution(crossinline block: DescribeExecutionRequest.Builder.() -> Unit): DescribeExecutionResponse

Checks the status of a remote task running on one or more target devices.

describeTask

inline suspend fun SnowDeviceManagementClient.describeTask(crossinline block: DescribeTaskRequest.Builder.() -> Unit): DescribeTaskResponse

Checks the metadata for a given task on a device.

listDeviceResources

inline suspend fun SnowDeviceManagementClient.listDeviceResources(crossinline block: ListDeviceResourcesRequest.Builder.() -> Unit): ListDeviceResourcesResponse

Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

listDevices

inline suspend fun SnowDeviceManagementClient.listDevices(crossinline block: ListDevicesRequest.Builder.() -> Unit): ListDevicesResponse

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.

listExecutions

inline suspend fun SnowDeviceManagementClient.listExecutions(crossinline block: ListExecutionsRequest.Builder.() -> Unit): ListExecutionsResponse

Returns the status of tasks for one or more target devices.

listTagsForResource

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

Returns a list of tags for a managed device or task.

listTasks

inline suspend fun SnowDeviceManagementClient.listTasks(crossinline block: ListTasksRequest.Builder.() -> Unit): ListTasksResponse

Returns a list of tasks that can be filtered by state.

tagResource

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

Adds or replaces tags on a device or task.

untagResource

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

Removes a tag from a device or task.

withConfig

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

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.