Este producto no es compatible con el sitio Datadog seleccionado. ().
Esta página aún no está disponible en español. Estamos trabajando en su traducción.
Si tienes alguna pregunta o comentario sobre nuestro actual proyecto de traducción, no dudes en ponerte en contacto con nosotros.

aws_pinpoint_segment

account_id

Type: STRING

application_id

Type: STRING
Provider name: ApplicationId
Description: The unique identifier for the application that the segment is associated with.

arn

Type: STRING
Provider name: Arn
Description: The Amazon Resource Name (ARN) of the segment.

creation_date

Type: STRING
Provider name: CreationDate
Description: The date and time when the segment was created.

dimensions

Type: STRUCT
Provider name: Dimensions
Description: The dimension settings for the segment.

  • attributes
    Type: STRING
    Provider name: Attributes
    Description: One or more custom attributes to use as criteria for the segment.
  • behavior
    Type: STRUCT
    Provider name: Behavior
    Description: The behavior-based criteria, such as how recently users have used your app, for the segment.
    • recency
      Type: STRUCT
      Provider name: Recency
      Description: The dimension settings that are based on how recently an endpoint was active.
      • duration
        Type: STRING
        Provider name: Duration
        Description: The duration to use when determining whether an endpoint is active or inactive.
      • recency_type
        Type: STRING
        Provider name: RecencyType
        Description: The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren’t active within the specified duration are included in the segment.
  • demographic
    Type: STRUCT
    Provider name: Demographic
    Description: The demographic-based criteria, such as device platform, for the segment.
    • app_version
      Type: STRUCT
      Provider name: AppVersion
      Description: The app version criteria for the segment.
      • dimension_type
        Type: STRING
        Provider name: DimensionType
        Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: Values
        Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
    • channel
      Type: STRUCT
      Provider name: Channel
      Description: The channel criteria for the segment.
      • dimension_type
        Type: STRING
        Provider name: DimensionType
        Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: Values
        Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
    • device_type
      Type: STRUCT
      Provider name: DeviceType
      Description: The device type criteria for the segment.
      • dimension_type
        Type: STRING
        Provider name: DimensionType
        Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: Values
        Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
    • make
      Type: STRUCT
      Provider name: Make
      Description: The device make criteria for the segment.
      • dimension_type
        Type: STRING
        Provider name: DimensionType
        Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: Values
        Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
    • model
      Type: STRUCT
      Provider name: Model
      Description: The device model criteria for the segment.
      • dimension_type
        Type: STRING
        Provider name: DimensionType
        Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: Values
        Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
    • platform
      Type: STRUCT
      Provider name: Platform
      Description: The device platform criteria for the segment.
      • dimension_type
        Type: STRING
        Provider name: DimensionType
        Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: Values
        Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
  • location
    Type: STRUCT
    Provider name: Location
    Description: The location-based criteria, such as region or GPS coordinates, for the segment.
    • country
      Type: STRUCT
      Provider name: Country
      Description: The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
      • dimension_type
        Type: STRING
        Provider name: DimensionType
        Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: Values
        Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
    • gps_point
      Type: STRUCT
      Provider name: GPSPoint
      Description: The GPS location and range for the segment.
      • coordinates
        Type: STRUCT
        Provider name: Coordinates
        Description: The GPS coordinates to measure distance from.
        • latitude
          Type: DOUBLE
          Provider name: Latitude
          Description: The latitude coordinate of the location.
        • longitude
          Type: DOUBLE
          Provider name: Longitude
          Description: The longitude coordinate of the location.
      • range_in_kilometers
        Type: DOUBLE
        Provider name: RangeInKilometers
        Description: The range, in kilometers, from the GPS coordinates.
  • metrics
    Type: STRING
    Provider name: Metrics
    Description: One or more custom metrics to use as criteria for the segment.
  • user_attributes
    Type: STRING
    Provider name: UserAttributes
    Description: One or more custom user attributes to use as criteria for the segment.

id

Type: STRING
Provider name: Id
Description: The unique identifier for the segment.

import_definition

Type: STRUCT
Provider name: ImportDefinition
Description: The settings for the import job that’s associated with the segment.

  • channel_counts
    Type: MAP_STRING_INT32
    Provider name: ChannelCounts
    Description: The number of channel types in the endpoint definitions that were imported to create the segment.
  • external_id
    Type: STRING
    Provider name: ExternalId
    Description: (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don’t recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
  • format
    Type: STRING
    Provider name: Format
    Description: The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
  • role_arn
    Type: STRING
    Provider name: RoleArn
    Description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
  • s3_url
    Type: STRING
    Provider name: S3Url
    Description: The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
  • size
    Type: INT32
    Provider name: Size
    Description: The number of endpoint definitions that were imported successfully to create the segment.

last_modified_date

Type: STRING
Provider name: LastModifiedDate
Description: The date and time when the segment was last modified.

name

Type: STRING
Provider name: Name
Description: The name of the segment.

segment_groups

Type: STRUCT
Provider name: SegmentGroups
Description: A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

  • groups
    Type: UNORDERED_LIST_STRUCT
    Provider name: Groups
    Description: An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
    • dimensions
      Type: UNORDERED_LIST_STRUCT
      Provider name: Dimensions
      Description: An array that defines the dimensions for the segment.
      • attributes
        Type: STRING
        Provider name: Attributes
        Description: One or more custom attributes to use as criteria for the segment.
      • behavior
        Type: STRUCT
        Provider name: Behavior
        Description: The behavior-based criteria, such as how recently users have used your app, for the segment.
        • recency
          Type: STRUCT
          Provider name: Recency
          Description: The dimension settings that are based on how recently an endpoint was active.
          • duration
            Type: STRING
            Provider name: Duration
            Description: The duration to use when determining whether an endpoint is active or inactive.
          • recency_type
            Type: STRING
            Provider name: RecencyType
            Description: The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren’t active within the specified duration are included in the segment.
      • demographic
        Type: STRUCT
        Provider name: Demographic
        Description: The demographic-based criteria, such as device platform, for the segment.
        • app_version
          Type: STRUCT
          Provider name: AppVersion
          Description: The app version criteria for the segment.
          • dimension_type
            Type: STRING
            Provider name: DimensionType
            Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
          • values
            Type: UNORDERED_LIST_STRING
            Provider name: Values
            Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
        • channel
          Type: STRUCT
          Provider name: Channel
          Description: The channel criteria for the segment.
          • dimension_type
            Type: STRING
            Provider name: DimensionType
            Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
          • values
            Type: UNORDERED_LIST_STRING
            Provider name: Values
            Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
        • device_type
          Type: STRUCT
          Provider name: DeviceType
          Description: The device type criteria for the segment.
          • dimension_type
            Type: STRING
            Provider name: DimensionType
            Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
          • values
            Type: UNORDERED_LIST_STRING
            Provider name: Values
            Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
        • make
          Type: STRUCT
          Provider name: Make
          Description: The device make criteria for the segment.
          • dimension_type
            Type: STRING
            Provider name: DimensionType
            Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
          • values
            Type: UNORDERED_LIST_STRING
            Provider name: Values
            Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
        • model
          Type: STRUCT
          Provider name: Model
          Description: The device model criteria for the segment.
          • dimension_type
            Type: STRING
            Provider name: DimensionType
            Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
          • values
            Type: UNORDERED_LIST_STRING
            Provider name: Values
            Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
        • platform
          Type: STRUCT
          Provider name: Platform
          Description: The device platform criteria for the segment.
          • dimension_type
            Type: STRING
            Provider name: DimensionType
            Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
          • values
            Type: UNORDERED_LIST_STRING
            Provider name: Values
            Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
      • location
        Type: STRUCT
        Provider name: Location
        Description: The location-based criteria, such as region or GPS coordinates, for the segment.
        • country
          Type: STRUCT
          Provider name: Country
          Description: The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
          • dimension_type
            Type: STRING
            Provider name: DimensionType
            Description: The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
          • values
            Type: UNORDERED_LIST_STRING
            Provider name: Values
            Description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
        • gps_point
          Type: STRUCT
          Provider name: GPSPoint
          Description: The GPS location and range for the segment.
          • coordinates
            Type: STRUCT
            Provider name: Coordinates
            Description: The GPS coordinates to measure distance from.
            • latitude
              Type: DOUBLE
              Provider name: Latitude
              Description: The latitude coordinate of the location.
            • longitude
              Type: DOUBLE
              Provider name: Longitude
              Description: The longitude coordinate of the location.
          • range_in_kilometers
            Type: DOUBLE
            Provider name: RangeInKilometers
            Description: The range, in kilometers, from the GPS coordinates.
      • metrics
        Type: STRING
        Provider name: Metrics
        Description: One or more custom metrics to use as criteria for the segment.
      • user_attributes
        Type: STRING
        Provider name: UserAttributes
        Description: One or more custom user attributes to use as criteria for the segment.
    • source_segments
      Type: UNORDERED_LIST_STRUCT
      Provider name: SourceSegments
      Description: The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
      • id
        Type: STRING
        Provider name: Id
        Description: The unique identifier for the segment.
      • version
        Type: INT32
        Provider name: Version
        Description: The version number of the segment.
    • source_type
      Type: STRING
      Provider name: SourceType
      Description: Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
    • type
      Type: STRING
      Provider name: Type
      Description: Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
  • include
    Type: STRING
    Provider name: Include
    Description: Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

segment_type

Type: STRING
Provider name: SegmentType
Description: The segment type. Valid values are:

  • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that’s reported by your app. Dynamic segments can change over time.
  • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don’t change over time.

tags

Type: UNORDERED_LIST_STRING

version

Type: INT32
Provider name: Version
Description: The version number of the segment.