| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::SegmentResponse; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Arn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has CreationDate => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Dimensions => (is => 'ro', isa => 'Paws::Pinpoint::SegmentDimensions'); | ||
| 8 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ImportDefinition => (is => 'ro', isa => 'Paws::Pinpoint::SegmentImportResource'); | ||
| 10 | has LastModifiedDate => (is => 'ro', isa => 'Str'); | ||
| 11 | has Name => (is => 'ro', isa => 'Str'); | ||
| 12 | has SegmentGroups => (is => 'ro', isa => 'Paws::Pinpoint::SegmentGroupList'); | ||
| 13 | has SegmentType => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has Tags => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 15 | has Version => (is => 'ro', isa => 'Int'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Pinpoint::SegmentResponse | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::Pinpoint::SegmentResponse object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { ApplicationId => $value, ..., Version => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::SegmentResponse object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->ApplicationId | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Provides information about the configuration, dimension, and other | ||
| 48 | settings for a segment. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 54 | |||
| 55 | The unique identifier for the application that the segment is | ||
| 56 | associated with. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> Arn => Str | ||
| 60 | |||
| 61 | The Amazon Resource Name (ARN) of the segment. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> CreationDate => Str | ||
| 65 | |||
| 66 | The date and time when the segment was created. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Dimensions => L<Paws::Pinpoint::SegmentDimensions> | ||
| 70 | |||
| 71 | The dimension settings for the segment. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> Id => Str | ||
| 75 | |||
| 76 | The unique identifier for the segment. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 ImportDefinition => L<Paws::Pinpoint::SegmentImportResource> | ||
| 80 | |||
| 81 | The settings for the import job that's associated with the segment. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 LastModifiedDate => Str | ||
| 85 | |||
| 86 | The date and time when the segment was last modified. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 Name => Str | ||
| 90 | |||
| 91 | The name of the segment. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 SegmentGroups => L<Paws::Pinpoint::SegmentGroupList> | ||
| 95 | |||
| 96 | A list of one or more segment groups that apply to the segment. Each | ||
| 97 | segment group consists of zero or more base segments and the dimensions | ||
| 98 | that are applied to those base segments. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> SegmentType => Str | ||
| 102 | |||
| 103 | The segment type. Valid values are: | ||
| 104 | |||
| 105 | =over | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | DIMENSIONAL - A dynamic segment, which is a segment that uses selection | ||
| 110 | criteria that you specify and is based on endpoint data that's reported | ||
| 111 | by your app. Dynamic segments can change over time. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | IMPORT - A static segment, which is a segment that uses selection | ||
| 116 | criteria that you specify and is based on endpoint definitions that you | ||
| 117 | import from a file. Imported segments are static; they don't change | ||
| 118 | over time. | ||
| 119 | |||
| 120 | =back | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 125 | |||
| 126 | A string-to-string map of key-value pairs that identifies the tags that | ||
| 127 | are associated with the segment. Each tag consists of a required tag | ||
| 128 | key and an associated tag value. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 Version => Int | ||
| 132 | |||
| 133 | The version number of the segment. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head1 SEE ALSO | ||
| 138 | |||
| 139 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 140 | |||
| 141 | =head1 BUGS and CONTRIBUTIONS | ||
| 142 | |||
| 143 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 144 | |||
| 145 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 146 | |||
| 147 | =cut | ||
| 148 |