Get Segment Versions

pinpoint_get_segment_versions

R Documentation

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application

Description

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.

Usage

pinpoint_get_segment_versions(ApplicationId, PageSize, SegmentId, Token)

Arguments

ApplicationId

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

PageSize

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

SegmentId

[required] The unique identifier for the segment.

Token

The NextToken string that specifies which page of results to return in a paginated response.

Value

A list with the following syntax:

list(
  SegmentsResponse = list(
    Item = list(
      list(
        ApplicationId = "string",
        Arn = "string",
        CreationDate = "string",
        Dimensions = list(
          Attributes = list(
            list(
              AttributeType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
              Values = list(
                "string"
              )
            )
          ),
          Behavior = list(
            Recency = list(
              Duration = "HR_24"|"DAY_7"|"DAY_14"|"DAY_30",
              RecencyType = "ACTIVE"|"INACTIVE"
            )
          ),
          Demographic = list(
            AppVersion = list(
              DimensionType = "INCLUSIVE"|"EXCLUSIVE",
              Values = list(
                "string"
              )
            ),
            Channel = list(
              DimensionType = "INCLUSIVE"|"EXCLUSIVE",
              Values = list(
                "string"
              )
            ),
            DeviceType = list(
              DimensionType = "INCLUSIVE"|"EXCLUSIVE",
              Values = list(
                "string"
              )
            ),
            Make = list(
              DimensionType = "INCLUSIVE"|"EXCLUSIVE",
              Values = list(
                "string"
              )
            ),
            Model = list(
              DimensionType = "INCLUSIVE"|"EXCLUSIVE",
              Values = list(
                "string"
              )
            ),
            Platform = list(
              DimensionType = "INCLUSIVE"|"EXCLUSIVE",
              Values = list(
                "string"
              )
            )
          ),
          Location = list(
            Country = list(
              DimensionType = "INCLUSIVE"|"EXCLUSIVE",
              Values = list(
                "string"
              )
            ),
            GPSPoint = list(
              Coordinates = list(
                Latitude = 123.0,
                Longitude = 123.0
              ),
              RangeInKilometers = 123.0
            )
          ),
          Metrics = list(
            list(
              ComparisonOperator = "string",
              Value = 123.0
            )
          ),
          UserAttributes = list(
            list(
              AttributeType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
              Values = list(
                "string"
              )
            )
          )
        ),
        Id = "string",
        ImportDefinition = list(
          ChannelCounts = list(
            123
          ),
          ExternalId = "string",
          Format = "CSV"|"JSON",
          RoleArn = "string",
          S3Url = "string",
          Size = 123
        ),
        LastModifiedDate = "string",
        Name = "string",
        SegmentGroups = list(
          Groups = list(
            list(
              Dimensions = list(
                list(
                  Attributes = list(
                    list(
                      AttributeType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                      Values = list(
                        "string"
                      )
                    )
                  ),
                  Behavior = list(
                    Recency = list(
                      Duration = "HR_24"|"DAY_7"|"DAY_14"|"DAY_30",
                      RecencyType = "ACTIVE"|"INACTIVE"
                    )
                  ),
                  Demographic = list(
                    AppVersion = list(
                      DimensionType = "INCLUSIVE"|"EXCLUSIVE",
                      Values = list(
                        "string"
                      )
                    ),
                    Channel = list(
                      DimensionType = "INCLUSIVE"|"EXCLUSIVE",
                      Values = list(
                        "string"
                      )
                    ),
                    DeviceType = list(
                      DimensionType = "INCLUSIVE"|"EXCLUSIVE",
                      Values = list(
                        "string"
                      )
                    ),
                    Make = list(
                      DimensionType = "INCLUSIVE"|"EXCLUSIVE",
                      Values = list(
                        "string"
                      )
                    ),
                    Model = list(
                      DimensionType = "INCLUSIVE"|"EXCLUSIVE",
                      Values = list(
                        "string"
                      )
                    ),
                    Platform = list(
                      DimensionType = "INCLUSIVE"|"EXCLUSIVE",
                      Values = list(
                        "string"
                      )
                    )
                  ),
                  Location = list(
                    Country = list(
                      DimensionType = "INCLUSIVE"|"EXCLUSIVE",
                      Values = list(
                        "string"
                      )
                    ),
                    GPSPoint = list(
                      Coordinates = list(
                        Latitude = 123.0,
                        Longitude = 123.0
                      ),
                      RangeInKilometers = 123.0
                    )
                  ),
                  Metrics = list(
                    list(
                      ComparisonOperator = "string",
                      Value = 123.0
                    )
                  ),
                  UserAttributes = list(
                    list(
                      AttributeType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                      Values = list(
                        "string"
                      )
                    )
                  )
                )
              ),
              SourceSegments = list(
                list(
                  Id = "string",
                  Version = 123
                )
              ),
              SourceType = "ALL"|"ANY"|"NONE",
              Type = "ALL"|"ANY"|"NONE"
            )
          ),
          Include = "ALL"|"ANY"|"NONE"
        ),
        SegmentType = "DIMENSIONAL"|"IMPORT",
        tags = list(
          "string"
        ),
        Version = 123
      )
    ),
    NextToken = "string"
  )
)

Request syntax

svc$get_segment_versions(
  ApplicationId = "string",
  PageSize = "string",
  SegmentId = "string",
  Token = "string"
)