Get Endpoint

pinpoint_get_endpoint

R Documentation

Retrieves information about the settings and attributes of a specific endpoint for an application

Description

Retrieves information about the settings and attributes of a specific endpoint for an application.

Usage

pinpoint_get_endpoint(ApplicationId, EndpointId)

Arguments

ApplicationId

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

EndpointId

[required] The case insensitive unique identifier for the endpoint. The identifier can't contain $, ⁠\{⁠ or ⁠\}⁠.

Value

A list with the following syntax:

list(
  EndpointResponse = list(
    Address = "string",
    ApplicationId = "string",
    Attributes = list(
      list(
        "string"
      )
    ),
    ChannelType = "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP",
    CohortId = "string",
    CreationDate = "string",
    Demographic = list(
      AppVersion = "string",
      Locale = "string",
      Make = "string",
      Model = "string",
      ModelVersion = "string",
      Platform = "string",
      PlatformVersion = "string",
      Timezone = "string"
    ),
    EffectiveDate = "string",
    EndpointStatus = "string",
    Id = "string",
    Location = list(
      City = "string",
      Country = "string",
      Latitude = 123.0,
      Longitude = 123.0,
      PostalCode = "string",
      Region = "string"
    ),
    Metrics = list(
      123.0
    ),
    OptOut = "string",
    RequestId = "string",
    User = list(
      UserAttributes = list(
        list(
          "string"
        )
      ),
      UserId = "string"
    )
  )
)

Request syntax

svc$get_endpoint(
  ApplicationId = "string",
  EndpointId = "string"
)