NAME
Paws::Pinpoint::CampaignResponse
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::Pinpoint::CampaignResponse object:
$service_obj->Method(Att1 => { AdditionalTreatments => $value, ..., Version => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::CampaignResponse object:
$result = $service_obj->Method(...);
$result->Att1->AdditionalTreatmentsDESCRIPTION
Provides information about the status, configuration, and other settings for a campaign.
ATTRIBUTES
AdditionalTreatments => ArrayRef[Paws::Pinpoint::TreatmentResource]
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
REQUIRED ApplicationId => Str
The unique identifier for the application that the campaign applies to.
REQUIRED Arn => Str
The Amazon Resource Name (ARN) of the campaign.
REQUIRED CreationDate => Str
The date, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration => Paws::Pinpoint::CustomDeliveryConfiguration
The delivery configuration settings for sending the campaign through a custom channel.
DefaultState => Paws::Pinpoint::CampaignState
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
Description => Str
The custom description of the campaign.
HoldoutPercent => Int
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook => Paws::Pinpoint::CampaignHook
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
REQUIRED Id => Str
The unique identifier for the campaign.
IsPaused => Bool
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
REQUIRED LastModifiedDate => Str
The date, in ISO 8601 format, when the campaign was last modified.
Limits => Paws::Pinpoint::CampaignLimits
The messaging limits for the campaign.
MessageConfiguration => Paws::Pinpoint::MessageConfiguration
The message configuration settings for the campaign.
Name => Str
The name of the campaign.
Schedule => Paws::Pinpoint::Schedule
The schedule settings for the campaign.
REQUIRED SegmentId => Str
The unique identifier for the segment that's associated with the campaign.
REQUIRED SegmentVersion => Int
The version number of the segment that's associated with the campaign.
State => Paws::Pinpoint::CampaignState
The current status of the campaign.
Tags => Paws::Pinpoint::MapOf__string
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TemplateConfiguration => Paws::Pinpoint::TemplateConfiguration
The message template that’s used for the campaign.
TreatmentDescription => Str
The custom description of the default treatment for the campaign.
TreatmentName => Str
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version => Int
The version number of the campaign.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::Pinpoint
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues