---
title: "AwsPinpointPush: Get job"
method: GET
path: "/job/aws-pinpoint-push/{id}"
tags: ["Jobs"]
---

# AwsPinpointPush: Get job

`GET /job/aws-pinpoint-push/{id}`

Get the summary of a AwsPinpointPush job

## Path parameters

- `id` string, required

## Query parameters

- `account_id` string

## Response `200`

AwsPinpointPush Job

- object
  - `_meta` object — Response Metadata
  - `data` object — Response Payload
    - `account_id` string — Lytics Account ID
    - `anomaly_rule` ModelsAnomalyRuleResp
      - `aid` integer
      - `checks` ModelsRuleCheckConfigReq[]
        - `allowable_violations` integer
        - `interval` string
        - `lookback_count` integer
        - `max_threshold` integer
        - `metric_type` string
        - `min_threshold` integer
        - `type` string
        - `variance_pct` number
      - `created` string
      - `id` string
      - `subject_id` string
      - `subject_type` string
      - `updated` string
    - `api_token_auth_id` string — this is set when work is create using access token
    - `auth_ids` string[] — Authorization IDs associated with the Job
    - `config` object, required — Job configuration, unique per-workflow
      - `action` string — (For Apple/GCM Channel - Optional) Specify action to occur if the recipient taps the notification message
      - `body` string — (For Apple/GCM, Email, SMS Channel) The body of the notification message/Email/SMS
      - `channel_type` string — Select Pinpoint channel type (Supported channels: Email, SMS, APNS, GCM)
      - `from_email` string — (For Email Channel Only - Optional) The verified email address to send the email message from. The default value is the FromAddress specified in Pinpoint for the email channel
      - `id_field` string — Field that contains the address that uniquely identifies device/email to send message to
      - `keyword` string — (For SMS Channel Only - Optional) The SMS program name that you provided to AWS Support when you requested your dedicated number
      - `message_type` string — (For SMS Channel Only - Optional) The SMS message type. If you plan to send time-sensitive content, specify TRANSACTIONAL. If you plan to send marketing-related content, specify PROMOTIONAL
      - `origination_number` string — (For SMS Channel Only - Optional) The number to send the SMS message from. The phone number or short code that you specify has to be associated with your Amazon Pinpoint account
      - `priority` string — (For Apple/GCM Channel - Optional) Priority for the message you are sending
      - `project` string — Select Pinpoint project
      - `region` string — AWS region that Pinpoint project resides in (us-east-2, etc.)
      - `reply_to_address` string — (For Email Channel Only - Optional) The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply. For multiple email addresses, please separate them using ",`"
      - `segment_ids` string[] — Select Lytics audiences to send messages via Pinpoint channels
      - `sender_id` string — (For SMS Channel Only - Optional) The sender ID to display as the sender of the message on a recipient's device
      - `silent_push` boolean — (For Apple/GCM Channel - Optional) Specify whether the notification is a silent notification message
      - `sound` string — (For Apple/GCM Channel - Optional) Specify sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file cannot be found or you specify default for the value, the system plays the default alert sound
      - `title` string — (For Apple/GCM, Email Channel) The title to display above the notification message on the recipient's device. If you are sending an Email Notification, then this would be the subject for the email.
      - `url` string — (For Apple/GCM Channel - Optional) Specify the URL to open in the recipient's default mobile browser, if a recipient taps the notification message and the value of the Action property is URL
      - `withbackfill` boolean — Send messages to users who are already in the selected Lytics audiences
    - `created` string
    - `deleted` boolean — The Job has been deleted
    - `description` string — A user-defined description
    - `drop_events_during_quiet_window` boolean
    - `expires_at` string, date-time
    - `id` string — A Lytics-assigned, immutable unique ID for the Job
    - `meta` object — Extra meta data about the job
    - `monitoring` object — Inline monitoring config. On write: omit to keep, null to clear, or a config to set.
    - `name` string, required — A user-defined name
    - `quiet_period` integer
    - `quiet_time_of_day` string
    - `quiet_timezone` string
    - `sleep_until` string
    - `status` 'runnable' | 'sleeping' | 'paused' | 'completed' | 'fault' | 'failed' | 'killed' | 'deleted' | 'unknown' — The status of the job
    - `updated` string
    - `user_id` string — The user ID that created or updated the job
    - `workflow` string — The workflow slug
    - `workflow_id` string — The workflow ID
  - `request_id` string
  - `status` integer — HTTP Status Code

## Other responses

- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/lytics/apis/lytics-api.md) · [All operations](https://skmtc.net/lytics/apis/lytics-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lytics/lytics-api/versions/366eeabcb6de/schema)