AWS SDK for C++  1.9.44
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient Class Reference

#include <IoTJobsDataPlaneClient.h>

+ Inheritance diagram for Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 IoTJobsDataPlaneClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 IoTJobsDataPlaneClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 IoTJobsDataPlaneClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~IoTJobsDataPlaneClient ()
 
virtual Model::DescribeJobExecutionOutcome DescribeJobExecution (const Model::DescribeJobExecutionRequest &request) const
 
virtual Model::DescribeJobExecutionOutcomeCallable DescribeJobExecutionCallable (const Model::DescribeJobExecutionRequest &request) const
 
virtual void DescribeJobExecutionAsync (const Model::DescribeJobExecutionRequest &request, const DescribeJobExecutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetPendingJobExecutionsOutcome GetPendingJobExecutions (const Model::GetPendingJobExecutionsRequest &request) const
 
virtual Model::GetPendingJobExecutionsOutcomeCallable GetPendingJobExecutionsCallable (const Model::GetPendingJobExecutionsRequest &request) const
 
virtual void GetPendingJobExecutionsAsync (const Model::GetPendingJobExecutionsRequest &request, const GetPendingJobExecutionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::StartNextPendingJobExecutionOutcome StartNextPendingJobExecution (const Model::StartNextPendingJobExecutionRequest &request) const
 
virtual Model::StartNextPendingJobExecutionOutcomeCallable StartNextPendingJobExecutionCallable (const Model::StartNextPendingJobExecutionRequest &request) const
 
virtual void StartNextPendingJobExecutionAsync (const Model::StartNextPendingJobExecutionRequest &request, const StartNextPendingJobExecutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateJobExecutionOutcome UpdateJobExecution (const Model::UpdateJobExecutionRequest &request) const
 
virtual Model::UpdateJobExecutionOutcomeCallable UpdateJobExecutionCallable (const Model::UpdateJobExecutionRequest &request) const
 
virtual void UpdateJobExecutionAsync (const Model::UpdateJobExecutionRequest &request, const UpdateJobExecutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.

To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.

AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job

Definition at line 95 of file IoTJobsDataPlaneClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 98 of file IoTJobsDataPlaneClient.h.

Constructor & Destructor Documentation

◆ IoTJobsDataPlaneClient() [1/3]

Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::IoTJobsDataPlaneClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

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.

◆ IoTJobsDataPlaneClient() [2/3]

Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::IoTJobsDataPlaneClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::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.

◆ IoTJobsDataPlaneClient() [3/3]

Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::IoTJobsDataPlaneClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::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

◆ ~IoTJobsDataPlaneClient()

virtual Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::~IoTJobsDataPlaneClient ( )
virtual

Member Function Documentation

◆ DescribeJobExecution()

virtual Model::DescribeJobExecutionOutcome Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::DescribeJobExecution ( const Model::DescribeJobExecutionRequest request) const
virtual

Gets details of a job execution.

See Also:

AWS API Reference

◆ DescribeJobExecutionAsync()

virtual void Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::DescribeJobExecutionAsync ( const Model::DescribeJobExecutionRequest request,
const DescribeJobExecutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets details of a job execution.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeJobExecutionCallable()

virtual Model::DescribeJobExecutionOutcomeCallable Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::DescribeJobExecutionCallable ( const Model::DescribeJobExecutionRequest request) const
virtual

Gets details of a job execution.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetPendingJobExecutions()

virtual Model::GetPendingJobExecutionsOutcome Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::GetPendingJobExecutions ( const Model::GetPendingJobExecutionsRequest request) const
virtual

Gets the list of all jobs for a thing that are not in a terminal status.

See Also:

AWS API Reference

◆ GetPendingJobExecutionsAsync()

virtual void Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::GetPendingJobExecutionsAsync ( const Model::GetPendingJobExecutionsRequest request,
const GetPendingJobExecutionsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets the list of all jobs for a thing that are not in a terminal status.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetPendingJobExecutionsCallable()

virtual Model::GetPendingJobExecutionsOutcomeCallable Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::GetPendingJobExecutionsCallable ( const Model::GetPendingJobExecutionsRequest request) const
virtual

Gets the list of all jobs for a thing that are not in a terminal status.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::OverrideEndpoint ( const Aws::String endpoint)

◆ StartNextPendingJobExecution()

virtual Model::StartNextPendingJobExecutionOutcome Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::StartNextPendingJobExecution ( const Model::StartNextPendingJobExecutionRequest request) const
virtual

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

See Also:

AWS API Reference

◆ StartNextPendingJobExecutionAsync()

virtual void Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::StartNextPendingJobExecutionAsync ( const Model::StartNextPendingJobExecutionRequest request,
const StartNextPendingJobExecutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ StartNextPendingJobExecutionCallable()

virtual Model::StartNextPendingJobExecutionOutcomeCallable Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::StartNextPendingJobExecutionCallable ( const Model::StartNextPendingJobExecutionRequest request) const
virtual

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateJobExecution()

virtual Model::UpdateJobExecutionOutcome Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::UpdateJobExecution ( const Model::UpdateJobExecutionRequest request) const
virtual

Updates the status of a job execution.

See Also:

AWS API Reference

◆ UpdateJobExecutionAsync()

virtual void Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::UpdateJobExecutionAsync ( const Model::UpdateJobExecutionRequest request,
const UpdateJobExecutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates the status of a job execution.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateJobExecutionCallable()

virtual Model::UpdateJobExecutionOutcomeCallable Aws::IoTJobsDataPlane::IoTJobsDataPlaneClient::UpdateJobExecutionCallable ( const Model::UpdateJobExecutionRequest request) const
virtual

Updates the status of a job execution.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


The documentation for this class was generated from the following file: