AWSCore::ServiceRequest Class Reference

#include <ServiceRequestJob.h>

Inherited by AWSCore::ServiceAPI::AWSAttributionRequest.

Classes
struct	EmptyResult
struct	NoParameters

Public Types
using	ServiceTraits = void
	ServiceTraits must be overridden by the derived type.
using	HttpMethod = Aws::Http::HttpMethod

Public Member Functions
bool	UseAWSCredentials ()

Static Public Member Functions
static HttpMethod	Method ()
	Must be overridden if the request method is not GET.
static const char *	Path ()

Public Attributes
NoParameters	parameters
EmptyResult	result
Error	error

Detailed Description

Base class for service requests. To use, derive a class and then provide that class as the argument to the ServiceRequestJob template class.

This class provide defaults, but many of these need to be overridden in the derived type for most requests, and ServiceTraits must be overridden for all requests. Use the SERVICE_REQUEST macro to implement the common overrides.

Member Function Documentation

Path()

static const char * AWSCore::ServiceRequest::Path ( )

inlinestatic

Must be overridden if the request requires an URL path. By default the service url alone will be used.

UseAWSCredentials()

bool AWSCore::ServiceRequest::UseAWSCredentials ( )

inline

Determines if the AWS credentials, as supplied by the credentialsProvider from the ServiceRequestJobConfig object (which defaults to the user's credentials), are used to sign the request. The default is true. Override this and return false if calling a public API and want to avoid the overhead of signing requests.

Member Data Documentation

error

Error AWSCore::ServiceRequest::error

Stores error information should the request fail. There is no need to override this member and doing so will waste a little memory.

parameters

NoParameters AWSCore::ServiceRequest::parameters

Stores parameter values. Must be overridden if the request has parameters.

result

EmptyResult AWSCore::ServiceRequest::result

Stores result data. Must be overridden if the request has result data.

---

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

• Gems/AWSCore/Code/Include/Framework/ServiceRequestJob.h