« blib/lib/Paws/Pinpoint/CreateRecommenderConfigurationResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/CreateSegmentResponse.pm »
| 1 | |||
| 2 | package Paws::Pinpoint::CreateSegment; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1); | ||
| 5 | has WriteSegmentRequest => (is => 'ro', isa => 'Paws::Pinpoint::WriteSegmentRequest', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | class_has _stream_param => (is => 'ro', default => 'WriteSegmentRequest'); | ||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateSegment'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/segments'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::CreateSegmentResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Pinpoint::CreateSegment - Arguments for method CreateSegment on L<Paws::Pinpoint> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateSegment on the | ||
| 24 | L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateSegment. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSegment. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $pinpoint = Paws->service('Pinpoint'); | ||
| 32 | my $CreateSegmentResponse = $pinpoint->CreateSegment( | ||
| 33 | ApplicationId => 'My__string', | ||
| 34 | WriteSegmentRequest => { | ||
| 35 | Dimensions => { | ||
| 36 | Attributes => { | ||
| 37 | 'My__string' => { | ||
| 38 | Values => [ 'My__string', ... ], | ||
| 39 | AttributeType => 'INCLUSIVE' | ||
| 40 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 41 | }, | ||
| 42 | }, # OPTIONAL | ||
| 43 | Behavior => { | ||
| 44 | Recency => { | ||
| 45 | Duration => 'HR_24', # values: HR_24, DAY_7, DAY_14, DAY_30 | ||
| 46 | RecencyType => 'ACTIVE', # values: ACTIVE, INACTIVE | ||
| 47 | |||
| 48 | }, # OPTIONAL | ||
| 49 | }, # OPTIONAL | ||
| 50 | Demographic => { | ||
| 51 | AppVersion => { | ||
| 52 | Values => [ 'My__string', ... ], | ||
| 53 | DimensionType => | ||
| 54 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | Channel => { | ||
| 57 | Values => [ 'My__string', ... ], | ||
| 58 | DimensionType => | ||
| 59 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | DeviceType => { | ||
| 62 | Values => [ 'My__string', ... ], | ||
| 63 | DimensionType => | ||
| 64 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | Make => { | ||
| 67 | Values => [ 'My__string', ... ], | ||
| 68 | DimensionType => | ||
| 69 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 70 | }, # OPTIONAL | ||
| 71 | Model => { | ||
| 72 | Values => [ 'My__string', ... ], | ||
| 73 | DimensionType => | ||
| 74 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 75 | }, # OPTIONAL | ||
| 76 | Platform => { | ||
| 77 | Values => [ 'My__string', ... ], | ||
| 78 | DimensionType => | ||
| 79 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 80 | }, # OPTIONAL | ||
| 81 | }, # OPTIONAL | ||
| 82 | Location => { | ||
| 83 | Country => { | ||
| 84 | Values => [ 'My__string', ... ], | ||
| 85 | DimensionType => | ||
| 86 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 87 | }, # OPTIONAL | ||
| 88 | GPSPoint => { | ||
| 89 | Coordinates => { | ||
| 90 | Latitude => 1, | ||
| 91 | Longitude => 1, | ||
| 92 | |||
| 93 | }, | ||
| 94 | RangeInKilometers => 1, | ||
| 95 | }, # OPTIONAL | ||
| 96 | }, # OPTIONAL | ||
| 97 | Metrics => { | ||
| 98 | 'My__string' => { | ||
| 99 | ComparisonOperator => 'My__string', | ||
| 100 | Value => 1, | ||
| 101 | |||
| 102 | }, | ||
| 103 | }, # OPTIONAL | ||
| 104 | UserAttributes => { | ||
| 105 | 'My__string' => { | ||
| 106 | Values => [ 'My__string', ... ], | ||
| 107 | AttributeType => 'INCLUSIVE' | ||
| 108 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 109 | }, | ||
| 110 | }, # OPTIONAL | ||
| 111 | }, # OPTIONAL | ||
| 112 | Name => 'My__string', | ||
| 113 | SegmentGroups => { | ||
| 114 | Groups => [ | ||
| 115 | { | ||
| 116 | Dimensions => [ | ||
| 117 | { | ||
| 118 | Attributes => { | ||
| 119 | 'My__string' => { | ||
| 120 | Values => [ 'My__string', ... ], | ||
| 121 | AttributeType => 'INCLUSIVE' | ||
| 122 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 123 | }, | ||
| 124 | }, # OPTIONAL | ||
| 125 | Behavior => { | ||
| 126 | Recency => { | ||
| 127 | Duration => | ||
| 128 | 'HR_24', # values: HR_24, DAY_7, DAY_14, DAY_30 | ||
| 129 | RecencyType => 'ACTIVE', # values: ACTIVE, INACTIVE | ||
| 130 | |||
| 131 | }, # OPTIONAL | ||
| 132 | }, # OPTIONAL | ||
| 133 | Demographic => { | ||
| 134 | AppVersion => { | ||
| 135 | Values => [ 'My__string', ... ], | ||
| 136 | DimensionType => | ||
| 137 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 138 | }, # OPTIONAL | ||
| 139 | Channel => { | ||
| 140 | Values => [ 'My__string', ... ], | ||
| 141 | DimensionType => | ||
| 142 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 143 | }, # OPTIONAL | ||
| 144 | DeviceType => { | ||
| 145 | Values => [ 'My__string', ... ], | ||
| 146 | DimensionType => | ||
| 147 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 148 | }, # OPTIONAL | ||
| 149 | Make => { | ||
| 150 | Values => [ 'My__string', ... ], | ||
| 151 | DimensionType => | ||
| 152 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 153 | }, # OPTIONAL | ||
| 154 | Model => { | ||
| 155 | Values => [ 'My__string', ... ], | ||
| 156 | DimensionType => | ||
| 157 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 158 | }, # OPTIONAL | ||
| 159 | Platform => { | ||
| 160 | Values => [ 'My__string', ... ], | ||
| 161 | DimensionType => | ||
| 162 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 163 | }, # OPTIONAL | ||
| 164 | }, # OPTIONAL | ||
| 165 | Location => { | ||
| 166 | Country => { | ||
| 167 | Values => [ 'My__string', ... ], | ||
| 168 | DimensionType => | ||
| 169 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 170 | }, # OPTIONAL | ||
| 171 | GPSPoint => { | ||
| 172 | Coordinates => { | ||
| 173 | Latitude => 1, | ||
| 174 | Longitude => 1, | ||
| 175 | |||
| 176 | }, | ||
| 177 | RangeInKilometers => 1, | ||
| 178 | }, # OPTIONAL | ||
| 179 | }, # OPTIONAL | ||
| 180 | Metrics => { | ||
| 181 | 'My__string' => { | ||
| 182 | ComparisonOperator => 'My__string', | ||
| 183 | Value => 1, | ||
| 184 | |||
| 185 | }, | ||
| 186 | }, # OPTIONAL | ||
| 187 | UserAttributes => { | ||
| 188 | 'My__string' => { | ||
| 189 | Values => [ 'My__string', ... ], | ||
| 190 | AttributeType => 'INCLUSIVE' | ||
| 191 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 192 | }, | ||
| 193 | }, # OPTIONAL | ||
| 194 | }, | ||
| 195 | ... # OPTIONAL | ||
| 196 | ], # OPTIONAL | ||
| 197 | SourceSegments => [ | ||
| 198 | { | ||
| 199 | Id => 'My__string', | ||
| 200 | Version => 1, # OPTIONAL | ||
| 201 | }, | ||
| 202 | ... | ||
| 203 | ], # OPTIONAL | ||
| 204 | SourceType => 'ALL', # values: ALL, ANY, NONE; OPTIONAL | ||
| 205 | Type => 'ALL', # values: ALL, ANY, NONE; OPTIONAL | ||
| 206 | }, | ||
| 207 | ... | ||
| 208 | ], # OPTIONAL | ||
| 209 | Include => 'ALL', # values: ALL, ANY, NONE; OPTIONAL | ||
| 210 | }, # OPTIONAL | ||
| 211 | Tags => { 'My__string' => 'My__string', }, # OPTIONAL | ||
| 212 | }, | ||
| 213 | |||
| 214 | ); | ||
| 215 | |||
| 216 | # Results: | ||
| 217 | my $SegmentResponse = $CreateSegmentResponse->SegmentResponse; | ||
| 218 | |||
| 219 | # Returns a L<Paws::Pinpoint::CreateSegmentResponse> object. | ||
| 220 | |||
| 221 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 222 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/CreateSegment> | ||
| 223 | |||
| 224 | =head1 ATTRIBUTES | ||
| 225 | |||
| 226 | |||
| 227 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 228 | |||
| 229 | The unique identifier for the application. This identifier is displayed | ||
| 230 | as the B<Project ID> on the Amazon Pinpoint console. | ||
| 231 | |||
| 232 | |||
| 233 | |||
| 234 | =head2 B<REQUIRED> WriteSegmentRequest => L<Paws::Pinpoint::WriteSegmentRequest> | ||
| 235 | |||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | |||
| 240 | |||
| 241 | =head1 SEE ALSO | ||
| 242 | |||
| 243 | This class forms part of L<Paws>, documenting arguments for method CreateSegment in L<Paws::Pinpoint> | ||
| 244 | |||
| 245 | =head1 BUGS and CONTRIBUTIONS | ||
| 246 | |||
| 247 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 248 | |||
| 249 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 250 | |||
| 251 | =cut | ||
| 252 |