/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace SESV2 { namespace Model { /** *

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.

See * Also:

AWS * API Reference

*/ class ListDomainDeliverabilityCampaignsRequest : public SESV2Request { public: AWS_SESV2_API ListDomainDeliverabilityCampaignsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ListDomainDeliverabilityCampaigns"; } AWS_SESV2_API Aws::String SerializePayload() const override; AWS_SESV2_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The first day that you want to obtain deliverability data for.

*/ inline const Aws::Utils::DateTime& GetStartDate() const{ return m_startDate; } /** *

The first day that you want to obtain deliverability data for.

*/ inline bool StartDateHasBeenSet() const { return m_startDateHasBeenSet; } /** *

The first day that you want to obtain deliverability data for.

*/ inline void SetStartDate(const Aws::Utils::DateTime& value) { m_startDateHasBeenSet = true; m_startDate = value; } /** *

The first day that you want to obtain deliverability data for.

*/ inline void SetStartDate(Aws::Utils::DateTime&& value) { m_startDateHasBeenSet = true; m_startDate = std::move(value); } /** *

The first day that you want to obtain deliverability data for.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithStartDate(const Aws::Utils::DateTime& value) { SetStartDate(value); return *this;} /** *

The first day that you want to obtain deliverability data for.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithStartDate(Aws::Utils::DateTime&& value) { SetStartDate(std::move(value)); return *this;} /** *

The last day 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.

*/ inline const Aws::Utils::DateTime& GetEndDate() const{ return m_endDate; } /** *

The last day 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.

*/ inline bool EndDateHasBeenSet() const { return m_endDateHasBeenSet; } /** *

The last day 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.

*/ inline void SetEndDate(const Aws::Utils::DateTime& value) { m_endDateHasBeenSet = true; m_endDate = value; } /** *

The last day 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.

*/ inline void SetEndDate(Aws::Utils::DateTime&& value) { m_endDateHasBeenSet = true; m_endDate = std::move(value); } /** *

The last day 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.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithEndDate(const Aws::Utils::DateTime& value) { SetEndDate(value); return *this;} /** *

The last day 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.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithEndDate(Aws::Utils::DateTime&& value) { SetEndDate(std::move(value)); return *this;} /** *

The domain to obtain deliverability data for.

*/ inline const Aws::String& GetSubscribedDomain() const{ return m_subscribedDomain; } /** *

The domain to obtain deliverability data for.

*/ inline bool SubscribedDomainHasBeenSet() const { return m_subscribedDomainHasBeenSet; } /** *

The domain to obtain deliverability data for.

*/ inline void SetSubscribedDomain(const Aws::String& value) { m_subscribedDomainHasBeenSet = true; m_subscribedDomain = value; } /** *

The domain to obtain deliverability data for.

*/ inline void SetSubscribedDomain(Aws::String&& value) { m_subscribedDomainHasBeenSet = true; m_subscribedDomain = std::move(value); } /** *

The domain to obtain deliverability data for.

*/ inline void SetSubscribedDomain(const char* value) { m_subscribedDomainHasBeenSet = true; m_subscribedDomain.assign(value); } /** *

The domain to obtain deliverability data for.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithSubscribedDomain(const Aws::String& value) { SetSubscribedDomain(value); return *this;} /** *

The domain to obtain deliverability data for.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithSubscribedDomain(Aws::String&& value) { SetSubscribedDomain(std::move(value)); return *this;} /** *

The domain to obtain deliverability data for.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithSubscribedDomain(const char* value) { SetSubscribedDomain(value); return *this;} /** *

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.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

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.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

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.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

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.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

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.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

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.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

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.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

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.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

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.

*/ inline int GetPageSize() const{ return m_pageSize; } /** *

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.

*/ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

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.

*/ inline void SetPageSize(int value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

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.

*/ inline ListDomainDeliverabilityCampaignsRequest& WithPageSize(int value) { SetPageSize(value); return *this;} private: Aws::Utils::DateTime m_startDate; bool m_startDateHasBeenSet = false; Aws::Utils::DateTime m_endDate; bool m_endDateHasBeenSet = false; Aws::String m_subscribedDomain; bool m_subscribedDomainHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_pageSize; bool m_pageSizeHasBeenSet = false; }; } // namespace Model } // namespace SESV2 } // namespace Aws