AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest Class Reference

#include <ListDomainDeliverabilityCampaignsRequest.h>

+ Inheritance diagram for Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest:

Public Member Functions

 ListDomainDeliverabilityCampaignsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::Utils::DateTimeGetStartDate () const
 
bool StartDateHasBeenSet () const
 
void SetStartDate (const Aws::Utils::DateTime &value)
 
void SetStartDate (Aws::Utils::DateTime &&value)
 
ListDomainDeliverabilityCampaignsRequestWithStartDate (const Aws::Utils::DateTime &value)
 
ListDomainDeliverabilityCampaignsRequestWithStartDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndDate () const
 
bool EndDateHasBeenSet () const
 
void SetEndDate (const Aws::Utils::DateTime &value)
 
void SetEndDate (Aws::Utils::DateTime &&value)
 
ListDomainDeliverabilityCampaignsRequestWithEndDate (const Aws::Utils::DateTime &value)
 
ListDomainDeliverabilityCampaignsRequestWithEndDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetSubscribedDomain () const
 
bool SubscribedDomainHasBeenSet () const
 
void SetSubscribedDomain (const Aws::String &value)
 
void SetSubscribedDomain (Aws::String &&value)
 
void SetSubscribedDomain (const char *value)
 
ListDomainDeliverabilityCampaignsRequestWithSubscribedDomain (const Aws::String &value)
 
ListDomainDeliverabilityCampaignsRequestWithSubscribedDomain (Aws::String &&value)
 
ListDomainDeliverabilityCampaignsRequestWithSubscribedDomain (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListDomainDeliverabilityCampaignsRequestWithNextToken (const Aws::String &value)
 
ListDomainDeliverabilityCampaignsRequestWithNextToken (Aws::String &&value)
 
ListDomainDeliverabilityCampaignsRequestWithNextToken (const char *value)
 
int GetPageSize () const
 
bool PageSizeHasBeenSet () const
 
void SetPageSize (int value)
 
ListDomainDeliverabilityCampaignsRequestWithPageSize (int value)
 
- Public Member Functions inherited from Aws::PinpointEmail::PinpointEmailRequest
virtual ~PinpointEmailRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::PinpointEmail::PinpointEmailRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

See Also:

AWS API Reference

Definition at line 33 of file ListDomainDeliverabilityCampaignsRequest.h.

Constructor & Destructor Documentation

◆ ListDomainDeliverabilityCampaignsRequest()

Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::ListDomainDeliverabilityCampaignsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EndDateHasBeenSet()

bool Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::EndDateHasBeenSet ( ) const
inline

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

Definition at line 98 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ GetEndDate()

const Aws::Utils::DateTime& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::GetEndDate ( ) const
inline

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

Definition at line 91 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::GetNextToken ( ) const
inline

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

Definition at line 175 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ GetPageSize()

int Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::GetPageSize ( ) const
inline

The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

Definition at line 234 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetStartDate()

const Aws::Utils::DateTime& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::GetStartDate ( ) const
inline

The first day, in Unix time format, that you want to obtain deliverability data for.

Definition at line 53 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ GetSubscribedDomain()

const Aws::String& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::GetSubscribedDomain ( ) const
inline

The domain to obtain deliverability data for.

Definition at line 132 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::NextTokenHasBeenSet ( ) const
inline

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

Definition at line 182 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ PageSizeHasBeenSet()

bool Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::PageSizeHasBeenSet ( ) const
inline

The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

Definition at line 243 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SerializePayload()

Aws::String Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEndDate() [1/2]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetEndDate ( const Aws::Utils::DateTime value)
inline

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

Definition at line 105 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetEndDate() [2/2]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetEndDate ( Aws::Utils::DateTime &&  value)
inline

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

Definition at line 112 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetNextToken() [1/3]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetNextToken ( const Aws::String value)
inline

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

Definition at line 189 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetNextToken() [2/3]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetNextToken ( Aws::String &&  value)
inline

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

Definition at line 196 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetNextToken() [3/3]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetNextToken ( const char *  value)
inline

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

Definition at line 203 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetPageSize()

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetPageSize ( int  value)
inline

The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

Definition at line 252 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetStartDate() [1/2]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetStartDate ( const Aws::Utils::DateTime value)
inline

The first day, in Unix time format, that you want to obtain deliverability data for.

Definition at line 65 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetStartDate() [2/2]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetStartDate ( Aws::Utils::DateTime &&  value)
inline

The first day, in Unix time format, that you want to obtain deliverability data for.

Definition at line 71 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetSubscribedDomain() [1/3]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetSubscribedDomain ( const Aws::String value)
inline

The domain to obtain deliverability data for.

Definition at line 142 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetSubscribedDomain() [2/3]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetSubscribedDomain ( Aws::String &&  value)
inline

The domain to obtain deliverability data for.

Definition at line 147 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SetSubscribedDomain() [3/3]

void Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SetSubscribedDomain ( const char *  value)
inline

The domain to obtain deliverability data for.

Definition at line 152 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ StartDateHasBeenSet()

bool Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::StartDateHasBeenSet ( ) const
inline

The first day, in Unix time format, that you want to obtain deliverability data for.

Definition at line 59 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ SubscribedDomainHasBeenSet()

bool Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::SubscribedDomainHasBeenSet ( ) const
inline

The domain to obtain deliverability data for.

Definition at line 137 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithEndDate() [1/2]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithEndDate ( const Aws::Utils::DateTime value)
inline

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

Definition at line 119 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithEndDate() [2/2]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithEndDate ( Aws::Utils::DateTime &&  value)
inline

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

Definition at line 126 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithNextToken() [1/3]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithNextToken ( const Aws::String value)
inline

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

Definition at line 210 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithNextToken() [2/3]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithNextToken ( Aws::String &&  value)
inline

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

Definition at line 217 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithNextToken() [3/3]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithNextToken ( const char *  value)
inline

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

Definition at line 224 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithPageSize()

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithPageSize ( int  value)
inline

The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

Definition at line 261 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithStartDate() [1/2]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithStartDate ( const Aws::Utils::DateTime value)
inline

The first day, in Unix time format, that you want to obtain deliverability data for.

Definition at line 77 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithStartDate() [2/2]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithStartDate ( Aws::Utils::DateTime &&  value)
inline

The first day, in Unix time format, that you want to obtain deliverability data for.

Definition at line 83 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithSubscribedDomain() [1/3]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithSubscribedDomain ( const Aws::String value)
inline

The domain to obtain deliverability data for.

Definition at line 157 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithSubscribedDomain() [2/3]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithSubscribedDomain ( Aws::String &&  value)
inline

The domain to obtain deliverability data for.

Definition at line 162 of file ListDomainDeliverabilityCampaignsRequest.h.

◆ WithSubscribedDomain() [3/3]

ListDomainDeliverabilityCampaignsRequest& Aws::PinpointEmail::Model::ListDomainDeliverabilityCampaignsRequest::WithSubscribedDomain ( const char *  value)
inline

The domain to obtain deliverability data for.

Definition at line 167 of file ListDomainDeliverabilityCampaignsRequest.h.


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