NAME

Paws::Pinpoint::CreateSegment - Arguments for method CreateSegment on Paws::Pinpoint

DESCRIPTION

This class represents the parameters used for calling the method CreateSegment on the Amazon Pinpoint service. Use the attributes of this class as arguments to method CreateSegment.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSegment.

SYNOPSIS

            

              
              
my $pinpoint = Paws->service('Pinpoint');
my $CreateSegmentResponse = $pinpoint->CreateSegment(
  ApplicationId       => 'My__string',
  WriteSegmentRequest => {
    Dimensions => {
      Attributes => {
        'My__string' => {
          Values        => [ 'My__string', ... ],
          AttributeType => 'INCLUSIVE'
          , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
        },
      },    # OPTIONAL
      Behavior => {
        Recency => {
          Duration    => 'HR_24',     # values: HR_24, DAY_7, DAY_14, DAY_30
          RecencyType => 'ACTIVE',    # values: ACTIVE, INACTIVE
        },    # OPTIONAL
      },    # OPTIONAL
      Demographic => {
        AppVersion => {
          Values        => [ 'My__string', ... ],
          DimensionType =>
            'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
        },    # OPTIONAL
        Channel => {
          Values        => [ 'My__string', ... ],
          DimensionType =>
            'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
        },    # OPTIONAL
        DeviceType => {
          Values        => [ 'My__string', ... ],
          DimensionType =>
            'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
        },    # OPTIONAL
        Make => {
          Values        => [ 'My__string', ... ],
          DimensionType =>
            'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
        },    # OPTIONAL
        Model => {
          Values        => [ 'My__string', ... ],
          DimensionType =>
            'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
        },    # OPTIONAL
        Platform => {
          Values        => [ 'My__string', ... ],
          DimensionType =>
            'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
        },    # OPTIONAL
      },    # OPTIONAL
      Location => {
        Country => {
          Values        => [ 'My__string', ... ],
          DimensionType =>
            'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
        },    # OPTIONAL
        GPSPoint => {
          Coordinates => {
            Latitude  => 1,
            Longitude => 1,
          },
          RangeInKilometers => 1,
        },    # OPTIONAL
      },    # OPTIONAL
      Metrics => {
        'My__string' => {
          ComparisonOperator => 'My__string',
          Value              => 1,
        },
      },    # OPTIONAL
      UserAttributes => {
        'My__string' => {
          Values        => [ 'My__string', ... ],
          AttributeType => 'INCLUSIVE'
          , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
        },
      },    # OPTIONAL
    },    # OPTIONAL
    Name          => 'My__string',
    SegmentGroups => {
      Groups => [
        {
          Dimensions => [
            {
              Attributes => {
                'My__string' => {
                  Values        => [ 'My__string', ... ],
                  AttributeType => 'INCLUSIVE'
                  , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
                },
              },    # OPTIONAL
              Behavior => {
                Recency => {
                  Duration =>
                    'HR_24',    # values: HR_24, DAY_7, DAY_14, DAY_30
                  RecencyType => 'ACTIVE',    # values: ACTIVE, INACTIVE
                },    # OPTIONAL
              },    # OPTIONAL
              Demographic => {
                AppVersion => {
                  Values        => [ 'My__string', ... ],
                  DimensionType =>
                    'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                },    # OPTIONAL
                Channel => {
                  Values        => [ 'My__string', ... ],
                  DimensionType =>
                    'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                },    # OPTIONAL
                DeviceType => {
                  Values        => [ 'My__string', ... ],
                  DimensionType =>
                    'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                },    # OPTIONAL
                Make => {
                  Values        => [ 'My__string', ... ],
                  DimensionType =>
                    'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                },    # OPTIONAL
                Model => {
                  Values        => [ 'My__string', ... ],
                  DimensionType =>
                    'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                },    # OPTIONAL
                Platform => {
                  Values        => [ 'My__string', ... ],
                  DimensionType =>
                    'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                },    # OPTIONAL
              },    # OPTIONAL
              Location => {
                Country => {
                  Values        => [ 'My__string', ... ],
                  DimensionType =>
                    'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                },    # OPTIONAL
                GPSPoint => {
                  Coordinates => {
                    Latitude  => 1,
                    Longitude => 1,
                  },
                  RangeInKilometers => 1,
                },    # OPTIONAL
              },    # OPTIONAL
              Metrics => {
                'My__string' => {
                  ComparisonOperator => 'My__string',
                  Value              => 1,
                },
              },    # OPTIONAL
              UserAttributes => {
                'My__string' => {
                  Values        => [ 'My__string', ... ],
                  AttributeType => 'INCLUSIVE'
                  , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
                },
              },    # OPTIONAL
            },
            ...     # OPTIONAL
          ],    # OPTIONAL
          SourceSegments => [
            {
              Id      => 'My__string',
              Version => 1,              # OPTIONAL
            },
            ...
          ],    # OPTIONAL
          SourceType => 'ALL',    # values: ALL, ANY, NONE; OPTIONAL
          Type       => 'ALL',    # values: ALL, ANY, NONE; OPTIONAL
        },
        ...
      ],    # OPTIONAL
      Include => 'ALL',    # values: ALL, ANY, NONE; OPTIONAL
    },    # OPTIONAL
    Tags => { 'My__string' => 'My__string', },    # OPTIONAL
  },
);
# Results:
my $SegmentResponse = $CreateSegmentResponse->SegmentResponse;
# Returns a L<Paws::Pinpoint::CreateSegmentResponse> object.
            
          

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/pinpoint/CreateSegment

ATTRIBUTES

REQUIRED ApplicationId => Str

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

REQUIRED WriteSegmentRequest => Paws::Pinpoint::WriteSegmentRequest

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateSegment 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