/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace SnowDeviceManagement { /** *

Amazon Web Services Snow Device Management documentation.

*/ class AWS_SNOWDEVICEMANAGEMENT_API SnowDeviceManagementClient : public Aws::Client::AWSJsonClient, public Aws::Client::ClientWithAsyncTemplateMethods { public: typedef Aws::Client::AWSJsonClient BASECLASS; static const char* SERVICE_NAME; static const char* ALLOCATION_TAG; typedef SnowDeviceManagementClientConfiguration ClientConfigurationType; typedef SnowDeviceManagementEndpointProvider EndpointProviderType; /** * Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ SnowDeviceManagementClient(const Aws::SnowDeviceManagement::SnowDeviceManagementClientConfiguration& clientConfiguration = Aws::SnowDeviceManagement::SnowDeviceManagementClientConfiguration(), std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG)); /** * Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ SnowDeviceManagementClient(const Aws::Auth::AWSCredentials& credentials, std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG), const Aws::SnowDeviceManagement::SnowDeviceManagementClientConfiguration& clientConfiguration = Aws::SnowDeviceManagement::SnowDeviceManagementClientConfiguration()); /** * Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, * the default http client factory will be used */ SnowDeviceManagementClient(const std::shared_ptr& credentialsProvider, std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG), const Aws::SnowDeviceManagement::SnowDeviceManagementClientConfiguration& clientConfiguration = Aws::SnowDeviceManagement::SnowDeviceManagementClientConfiguration()); /* Legacy constructors due deprecation */ /** * Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ SnowDeviceManagementClient(const Aws::Client::ClientConfiguration& clientConfiguration); /** * Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ SnowDeviceManagementClient(const Aws::Auth::AWSCredentials& credentials, const Aws::Client::ClientConfiguration& clientConfiguration); /** * Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, * the default http client factory will be used */ SnowDeviceManagementClient(const std::shared_ptr& credentialsProvider, const Aws::Client::ClientConfiguration& clientConfiguration); /* End of legacy constructors due deprecation */ virtual ~SnowDeviceManagementClient(); /** *

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.

*

See Also:

AWS * API Reference

*/ virtual Model::CancelTaskOutcome CancelTask(const Model::CancelTaskRequest& request) const; /** * A Callable wrapper for CancelTask that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::CancelTaskOutcomeCallable CancelTaskCallable(const CancelTaskRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::CancelTask, request); } /** * An Async wrapper for CancelTask that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void CancelTaskAsync(const CancelTaskRequestT& request, const CancelTaskResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::CancelTask, request, handler, context); } /** *

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

See Also:

AWS * API Reference

*/ virtual Model::CreateTaskOutcome CreateTask(const Model::CreateTaskRequest& request) const; /** * A Callable wrapper for CreateTask that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::CreateTaskOutcomeCallable CreateTaskCallable(const CreateTaskRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::CreateTask, request); } /** * An Async wrapper for CreateTask that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void CreateTaskAsync(const CreateTaskRequestT& request, const CreateTaskResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::CreateTask, request, handler, context); } /** *

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

See Also:

AWS * API Reference

*/ virtual Model::DescribeDeviceOutcome DescribeDevice(const Model::DescribeDeviceRequest& request) const; /** * A Callable wrapper for DescribeDevice that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::DescribeDeviceOutcomeCallable DescribeDeviceCallable(const DescribeDeviceRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::DescribeDevice, request); } /** * An Async wrapper for DescribeDevice that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void DescribeDeviceAsync(const DescribeDeviceRequestT& request, const DescribeDeviceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::DescribeDevice, request, handler, context); } /** *

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.

See Also:

AWS * API Reference

*/ virtual Model::DescribeDeviceEc2InstancesOutcome DescribeDeviceEc2Instances(const Model::DescribeDeviceEc2InstancesRequest& request) const; /** * A Callable wrapper for DescribeDeviceEc2Instances that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::DescribeDeviceEc2InstancesOutcomeCallable DescribeDeviceEc2InstancesCallable(const DescribeDeviceEc2InstancesRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::DescribeDeviceEc2Instances, request); } /** * An Async wrapper for DescribeDeviceEc2Instances that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void DescribeDeviceEc2InstancesAsync(const DescribeDeviceEc2InstancesRequestT& request, const DescribeDeviceEc2InstancesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::DescribeDeviceEc2Instances, request, handler, context); } /** *

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

See Also:

AWS * API Reference

*/ virtual Model::DescribeExecutionOutcome DescribeExecution(const Model::DescribeExecutionRequest& request) const; /** * A Callable wrapper for DescribeExecution that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::DescribeExecutionOutcomeCallable DescribeExecutionCallable(const DescribeExecutionRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::DescribeExecution, request); } /** * An Async wrapper for DescribeExecution that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void DescribeExecutionAsync(const DescribeExecutionRequestT& request, const DescribeExecutionResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::DescribeExecution, request, handler, context); } /** *

Checks the metadata for a given task on a device.

See Also:

* AWS * API Reference

*/ virtual Model::DescribeTaskOutcome DescribeTask(const Model::DescribeTaskRequest& request) const; /** * A Callable wrapper for DescribeTask that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::DescribeTaskOutcomeCallable DescribeTaskCallable(const DescribeTaskRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::DescribeTask, request); } /** * An Async wrapper for DescribeTask that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void DescribeTaskAsync(const DescribeTaskRequestT& request, const DescribeTaskResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::DescribeTask, request, handler, context); } /** *

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

See Also:

AWS * API Reference

*/ virtual Model::ListDeviceResourcesOutcome ListDeviceResources(const Model::ListDeviceResourcesRequest& request) const; /** * A Callable wrapper for ListDeviceResources that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::ListDeviceResourcesOutcomeCallable ListDeviceResourcesCallable(const ListDeviceResourcesRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::ListDeviceResources, request); } /** * An Async wrapper for ListDeviceResources that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void ListDeviceResourcesAsync(const ListDeviceResourcesRequestT& request, const ListDeviceResourcesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::ListDeviceResources, request, handler, context); } /** *

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.

See Also:

AWS * API Reference

*/ virtual Model::ListDevicesOutcome ListDevices(const Model::ListDevicesRequest& request) const; /** * A Callable wrapper for ListDevices that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::ListDevicesOutcomeCallable ListDevicesCallable(const ListDevicesRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::ListDevices, request); } /** * An Async wrapper for ListDevices that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void ListDevicesAsync(const ListDevicesRequestT& request, const ListDevicesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::ListDevices, request, handler, context); } /** *

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

See * Also:

AWS * API Reference

*/ virtual Model::ListExecutionsOutcome ListExecutions(const Model::ListExecutionsRequest& request) const; /** * A Callable wrapper for ListExecutions that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::ListExecutionsOutcomeCallable ListExecutionsCallable(const ListExecutionsRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::ListExecutions, request); } /** * An Async wrapper for ListExecutions that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void ListExecutionsAsync(const ListExecutionsRequestT& request, const ListExecutionsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::ListExecutions, request, handler, context); } /** *

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

See Also:

* AWS * API Reference

*/ virtual Model::ListTagsForResourceOutcome ListTagsForResource(const Model::ListTagsForResourceRequest& request) const; /** * A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable(const ListTagsForResourceRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::ListTagsForResource, request); } /** * An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void ListTagsForResourceAsync(const ListTagsForResourceRequestT& request, const ListTagsForResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::ListTagsForResource, request, handler, context); } /** *

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

See * Also:

AWS * API Reference

*/ virtual Model::ListTasksOutcome ListTasks(const Model::ListTasksRequest& request) const; /** * A Callable wrapper for ListTasks that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::ListTasksOutcomeCallable ListTasksCallable(const ListTasksRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::ListTasks, request); } /** * An Async wrapper for ListTasks that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void ListTasksAsync(const ListTasksRequestT& request, const ListTasksResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::ListTasks, request, handler, context); } /** *

Adds or replaces tags on a device or task.

See Also:

AWS * API Reference

*/ virtual Model::TagResourceOutcome TagResource(const Model::TagResourceRequest& request) const; /** * A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::TagResourceOutcomeCallable TagResourceCallable(const TagResourceRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::TagResource, request); } /** * An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void TagResourceAsync(const TagResourceRequestT& request, const TagResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::TagResource, request, handler, context); } /** *

Removes a tag from a device or task.

See Also:

AWS * API Reference

*/ virtual Model::UntagResourceOutcome UntagResource(const Model::UntagResourceRequest& request) const; /** * A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::UntagResourceOutcomeCallable UntagResourceCallable(const UntagResourceRequestT& request) const { return SubmitCallable(&SnowDeviceManagementClient::UntagResource, request); } /** * An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void UntagResourceAsync(const UntagResourceRequestT& request, const UntagResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&SnowDeviceManagementClient::UntagResource, request, handler, context); } void OverrideEndpoint(const Aws::String& endpoint); std::shared_ptr& accessEndpointProvider(); private: friend class Aws::Client::ClientWithAsyncTemplateMethods; void init(const SnowDeviceManagementClientConfiguration& clientConfiguration); SnowDeviceManagementClientConfiguration m_clientConfiguration; std::shared_ptr m_executor; std::shared_ptr m_endpointProvider; }; } // namespace SnowDeviceManagement } // namespace Aws