« blib/lib/Paws/Pinpoint/WriteJourneyRequest.pm
↑ Summary
blib/lib/Paws/Pinpoint/WriteTreatmentResource.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::WriteSegmentRequest; | ||
| 3 | use Moose; | ||
| 4 | has Dimensions => (is => 'ro', isa => 'Paws::Pinpoint::SegmentDimensions'); | ||
| 5 | has Name => (is => 'ro', isa => 'Str'); | ||
| 6 | has SegmentGroups => (is => 'ro', isa => 'Paws::Pinpoint::SegmentGroupList'); | ||
| 7 | has Tags => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Pinpoint::WriteSegmentRequest | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Pinpoint::WriteSegmentRequest object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Dimensions => $value, ..., Tags => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::WriteSegmentRequest object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Dimensions | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Specifies the configuration, dimension, and other settings for a | ||
| 40 | segment. A WriteSegmentRequest object can include a Dimensions object | ||
| 41 | or a SegmentGroups object, but not both. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Dimensions => L<Paws::Pinpoint::SegmentDimensions> | ||
| 47 | |||
| 48 | The criteria that define the dimensions for the segment. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Name => Str | ||
| 52 | |||
| 53 | The name of the segment. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 SegmentGroups => L<Paws::Pinpoint::SegmentGroupList> | ||
| 57 | |||
| 58 | The segment group to use and the dimensions to apply to the group's | ||
| 59 | base segments in order to build the segment. A segment group can | ||
| 60 | consist of zero or more base segments. Your request can include only | ||
| 61 | one segment group. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 65 | |||
| 66 | A string-to-string map of key-value pairs that defines the tags to | ||
| 67 | associate with the segment. Each tag consists of a required tag key and | ||
| 68 | an associated tag value. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head1 SEE ALSO | ||
| 73 | |||
| 74 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 75 | |||
| 76 | =head1 BUGS and CONTRIBUTIONS | ||
| 77 | |||
| 78 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 79 | |||
| 80 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 81 | |||
| 82 | =cut | ||
| 83 |