Class ListDomainDeliverabilityCampaignsRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListDomainDeliverabilityCampaignsRequest.Builder,ListDomainDeliverabilityCampaignsRequest>

@Generated("software.amazon.awssdk:codegen") public final class ListDomainDeliverabilityCampaignsRequest extends SesV2Request implements ToCopyableBuilder<ListDomainDeliverabilityCampaignsRequest.Builder,ListDomainDeliverabilityCampaignsRequest>

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.

  • Method Details

    • startDate

      public final Instant startDate()

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

      Returns:
      The first day that you want to obtain deliverability data for.
    • endDate

      public final Instant 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.

      Returns:
      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.
    • subscribedDomain

      public final String subscribedDomain()

      The domain to obtain deliverability data for.

      Returns:
      The domain to obtain deliverability data for.
    • nextToken

      public final String 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.

      Returns:
      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.
    • pageSize

      public final Integer 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.

      Returns:
      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.
    • toBuilder

      Specified by:
      toBuilder in interface ToCopyableBuilder<ListDomainDeliverabilityCampaignsRequest.Builder,ListDomainDeliverabilityCampaignsRequest>
      Specified by:
      toBuilder in class SesV2Request
    • builder

    • serializableBuilderClass

      public static Class<? extends ListDomainDeliverabilityCampaignsRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo