Aws::Pinpoint::PinpointRequest Class Reference

#include <PinpointRequest.h>

Inherits Aws::AmazonSerializableWebServiceRequest.

Inherited by Aws::Pinpoint::Model::CreateAppRequest, Aws::Pinpoint::Model::CreateCampaignRequest, Aws::Pinpoint::Model::CreateEmailTemplateRequest, Aws::Pinpoint::Model::CreateExportJobRequest, Aws::Pinpoint::Model::CreateImportJobRequest, Aws::Pinpoint::Model::CreateInAppTemplateRequest, Aws::Pinpoint::Model::CreateJourneyRequest, Aws::Pinpoint::Model::CreatePushTemplateRequest, Aws::Pinpoint::Model::CreateRecommenderConfigurationRequest, Aws::Pinpoint::Model::CreateSegmentRequest, Aws::Pinpoint::Model::CreateSmsTemplateRequest, Aws::Pinpoint::Model::CreateVoiceTemplateRequest, Aws::Pinpoint::Model::DeleteAdmChannelRequest, Aws::Pinpoint::Model::DeleteApnsChannelRequest, Aws::Pinpoint::Model::DeleteApnsSandboxChannelRequest, Aws::Pinpoint::Model::DeleteApnsVoipChannelRequest, Aws::Pinpoint::Model::DeleteApnsVoipSandboxChannelRequest, Aws::Pinpoint::Model::DeleteAppRequest, Aws::Pinpoint::Model::DeleteBaiduChannelRequest, Aws::Pinpoint::Model::DeleteCampaignRequest, Aws::Pinpoint::Model::DeleteEmailChannelRequest, Aws::Pinpoint::Model::DeleteEmailTemplateRequest, Aws::Pinpoint::Model::DeleteEndpointRequest, Aws::Pinpoint::Model::DeleteEventStreamRequest, Aws::Pinpoint::Model::DeleteGcmChannelRequest, Aws::Pinpoint::Model::DeleteInAppTemplateRequest, Aws::Pinpoint::Model::DeleteJourneyRequest, Aws::Pinpoint::Model::DeletePushTemplateRequest, Aws::Pinpoint::Model::DeleteRecommenderConfigurationRequest, Aws::Pinpoint::Model::DeleteSegmentRequest, Aws::Pinpoint::Model::DeleteSmsChannelRequest, Aws::Pinpoint::Model::DeleteSmsTemplateRequest, Aws::Pinpoint::Model::DeleteUserEndpointsRequest, Aws::Pinpoint::Model::DeleteVoiceChannelRequest, Aws::Pinpoint::Model::DeleteVoiceTemplateRequest, Aws::Pinpoint::Model::GetAdmChannelRequest, Aws::Pinpoint::Model::GetApnsChannelRequest, Aws::Pinpoint::Model::GetApnsSandboxChannelRequest, Aws::Pinpoint::Model::GetApnsVoipChannelRequest, Aws::Pinpoint::Model::GetApnsVoipSandboxChannelRequest, Aws::Pinpoint::Model::GetAppRequest, Aws::Pinpoint::Model::GetApplicationDateRangeKpiRequest, Aws::Pinpoint::Model::GetApplicationSettingsRequest, Aws::Pinpoint::Model::GetAppsRequest, Aws::Pinpoint::Model::GetBaiduChannelRequest, Aws::Pinpoint::Model::GetCampaignActivitiesRequest, Aws::Pinpoint::Model::GetCampaignDateRangeKpiRequest, Aws::Pinpoint::Model::GetCampaignRequest, Aws::Pinpoint::Model::GetCampaignVersionRequest, Aws::Pinpoint::Model::GetCampaignVersionsRequest, Aws::Pinpoint::Model::GetCampaignsRequest, Aws::Pinpoint::Model::GetChannelsRequest, Aws::Pinpoint::Model::GetEmailChannelRequest, Aws::Pinpoint::Model::GetEmailTemplateRequest, Aws::Pinpoint::Model::GetEndpointRequest, Aws::Pinpoint::Model::GetEventStreamRequest, Aws::Pinpoint::Model::GetExportJobRequest, Aws::Pinpoint::Model::GetExportJobsRequest, Aws::Pinpoint::Model::GetGcmChannelRequest, Aws::Pinpoint::Model::GetImportJobRequest, Aws::Pinpoint::Model::GetImportJobsRequest, Aws::Pinpoint::Model::GetInAppMessagesRequest, Aws::Pinpoint::Model::GetInAppTemplateRequest, Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest, Aws::Pinpoint::Model::GetJourneyExecutionActivityMetricsRequest, Aws::Pinpoint::Model::GetJourneyExecutionMetricsRequest, Aws::Pinpoint::Model::GetJourneyRequest, Aws::Pinpoint::Model::GetJourneyRunExecutionActivityMetricsRequest, Aws::Pinpoint::Model::GetJourneyRunExecutionMetricsRequest, Aws::Pinpoint::Model::GetJourneyRunsRequest, Aws::Pinpoint::Model::GetPushTemplateRequest, Aws::Pinpoint::Model::GetRecommenderConfigurationRequest, Aws::Pinpoint::Model::GetRecommenderConfigurationsRequest, Aws::Pinpoint::Model::GetSegmentExportJobsRequest, Aws::Pinpoint::Model::GetSegmentImportJobsRequest, Aws::Pinpoint::Model::GetSegmentRequest, Aws::Pinpoint::Model::GetSegmentVersionRequest, Aws::Pinpoint::Model::GetSegmentVersionsRequest, Aws::Pinpoint::Model::GetSegmentsRequest, Aws::Pinpoint::Model::GetSmsChannelRequest, Aws::Pinpoint::Model::GetSmsTemplateRequest, Aws::Pinpoint::Model::GetUserEndpointsRequest, Aws::Pinpoint::Model::GetVoiceChannelRequest, Aws::Pinpoint::Model::GetVoiceTemplateRequest, Aws::Pinpoint::Model::ListJourneysRequest, Aws::Pinpoint::Model::ListTagsForResourceRequest, Aws::Pinpoint::Model::ListTemplateVersionsRequest, Aws::Pinpoint::Model::ListTemplatesRequest, Aws::Pinpoint::Model::PhoneNumberValidateRequest, Aws::Pinpoint::Model::PutEventStreamRequest, Aws::Pinpoint::Model::PutEventsRequest, Aws::Pinpoint::Model::RemoveAttributesRequest, Aws::Pinpoint::Model::SendMessagesRequest, Aws::Pinpoint::Model::SendOTPMessageRequest, Aws::Pinpoint::Model::SendUsersMessagesRequest, Aws::Pinpoint::Model::TagResourceRequest, Aws::Pinpoint::Model::UntagResourceRequest, Aws::Pinpoint::Model::UpdateAdmChannelRequest, Aws::Pinpoint::Model::UpdateApnsChannelRequest, Aws::Pinpoint::Model::UpdateApnsSandboxChannelRequest, Aws::Pinpoint::Model::UpdateApnsVoipChannelRequest, Aws::Pinpoint::Model::UpdateApnsVoipSandboxChannelRequest, Aws::Pinpoint::Model::UpdateApplicationSettingsRequest, Aws::Pinpoint::Model::UpdateBaiduChannelRequest, Aws::Pinpoint::Model::UpdateCampaignRequest, Aws::Pinpoint::Model::UpdateEmailChannelRequest, Aws::Pinpoint::Model::UpdateEmailTemplateRequest, Aws::Pinpoint::Model::UpdateEndpointRequest, Aws::Pinpoint::Model::UpdateEndpointsBatchRequest, Aws::Pinpoint::Model::UpdateGcmChannelRequest, Aws::Pinpoint::Model::UpdateInAppTemplateRequest, Aws::Pinpoint::Model::UpdateJourneyRequest, Aws::Pinpoint::Model::UpdateJourneyStateRequest, Aws::Pinpoint::Model::UpdatePushTemplateRequest, Aws::Pinpoint::Model::UpdateRecommenderConfigurationRequest, Aws::Pinpoint::Model::UpdateSegmentRequest, Aws::Pinpoint::Model::UpdateSmsChannelRequest, Aws::Pinpoint::Model::UpdateSmsTemplateRequest, Aws::Pinpoint::Model::UpdateTemplateActiveVersionRequest, Aws::Pinpoint::Model::UpdateVoiceChannelRequest, Aws::Pinpoint::Model::UpdateVoiceTemplateRequest, and Aws::Pinpoint::Model::VerifyOTPMessageRequest.

Public Types

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Public Member Functions

virtual ~PinpointRequest ()

 

void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

 

Aws::Http::HeaderValueCollection GetHeaders () const override

 

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest

 AmazonSerializableWebServiceRequest ()

 

virtual ~AmazonSerializableWebServiceRequest ()

 

virtual Aws::String SerializePayload () const=0

 

std::shared_ptr< Aws::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

virtual void AddQueryStringParameters (Aws::Http::URI &uri) const

 

virtual void PutToPresignedUrl (Aws::Http::URI &uri) const

 

virtual bool IsStreaming () const

 

virtual bool IsEventStreamRequest () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual const char * GetServiceRequestName () const=0

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Protected Member Functions

virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Additional Inherited Members

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 17 of file PinpointRequest.h.

Member Typedef Documentation

EndpointParameter

using Aws::Pinpoint::PinpointRequest::EndpointParameter = Aws::Endpoint::EndpointParameter

Definition at line 20 of file PinpointRequest.h.

EndpointParameters

using Aws::Pinpoint::PinpointRequest::EndpointParameters = Aws::Endpoint::EndpointParameters

Definition at line 21 of file PinpointRequest.h.

Constructor & Destructor Documentation

~PinpointRequest()

virtual Aws::Pinpoint::PinpointRequest::~PinpointRequest ( )

inlinevirtual

Definition at line 23 of file PinpointRequest.h.

Member Function Documentation

AddParametersToRequest()

void Aws::Pinpoint::PinpointRequest::AddParametersToRequest ( Aws::Http::HttpRequest &  httpRequest) const

inline

Definition at line 25 of file PinpointRequest.h.

GetHeaders()

Aws::Http::HeaderValueCollection Aws::Pinpoint::PinpointRequest::GetHeaders ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 27 of file PinpointRequest.h.

GetRequestSpecificHeaders()

virtual Aws::Http::HeaderValueCollection Aws::Pinpoint::PinpointRequest::GetRequestSpecificHeaders ( ) const

inlineprotectedvirtual

Definition at line 40 of file PinpointRequest.h.

---

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

• generated/src/aws-cpp-sdk-pinpoint/include/aws/pinpoint/PinpointRequest.h