---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# aws_pinpoint_journey{% #aws_pinpoint_journey %}

## `account_id`{% #account_id %}

**Type**: `STRING`

## `activities`{% #activities %}

**Type**: `STRING`**Provider name**: `Activities`**Description**: A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

## `application_id`{% #application_id %}

**Type**: `STRING`**Provider name**: `ApplicationId`**Description**: The unique identifier for the application that the journey applies to.

## `closed_days`{% #closed_days %}

**Type**: `STRUCT`**Provider name**: `ClosedDays`**Description**: The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.

- `custom`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `CUSTOM`**Description**: Rules for the Custom channel.
  - `end_date_time`**Type**: `STRING`**Provider name**: `EndDateTime`**Description**: End DateTime ISO 8601 format
  - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the closed day rule.
  - `start_date_time`**Type**: `STRING`**Provider name**: `StartDateTime`**Description**: Start DateTime ISO 8601 format
- `email`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `EMAIL`**Description**: Rules for the Email channel.
  - `end_date_time`**Type**: `STRING`**Provider name**: `EndDateTime`**Description**: End DateTime ISO 8601 format
  - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the closed day rule.
  - `start_date_time`**Type**: `STRING`**Provider name**: `StartDateTime`**Description**: Start DateTime ISO 8601 format
- `push`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `PUSH`**Description**: Rules for the Push channel.
  - `end_date_time`**Type**: `STRING`**Provider name**: `EndDateTime`**Description**: End DateTime ISO 8601 format
  - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the closed day rule.
  - `start_date_time`**Type**: `STRING`**Provider name**: `StartDateTime`**Description**: Start DateTime ISO 8601 format
- `sms`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `SMS`**Description**: Rules for the SMS channel.
  - `end_date_time`**Type**: `STRING`**Provider name**: `EndDateTime`**Description**: End DateTime ISO 8601 format
  - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the closed day rule.
  - `start_date_time`**Type**: `STRING`**Provider name**: `StartDateTime`**Description**: Start DateTime ISO 8601 format
- `voice`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `VOICE`**Description**: Rules for the Voice channel.
  - `end_date_time`**Type**: `STRING`**Provider name**: `EndDateTime`**Description**: End DateTime ISO 8601 format
  - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the closed day rule.
  - `start_date_time`**Type**: `STRING`**Provider name**: `StartDateTime`**Description**: Start DateTime ISO 8601 format

## `creation_date`{% #creation_date %}

**Type**: `STRING`**Provider name**: `CreationDate`**Description**: The date, in ISO 8601 format, when the journey was created.

## `id`{% #id %}

**Type**: `STRING`**Provider name**: `Id`**Description**: The unique identifier for the journey.

## `journey_channel_settings`{% #journey_channel_settings %}

**Type**: `STRUCT`**Provider name**: `JourneyChannelSettings`**Description**: The channel-specific configurations for the journey.

- `connect_campaign_arn`**Type**: `STRING`**Provider name**: `ConnectCampaignArn`**Description**: Amazon Resource Name (ARN) of the Connect Campaign.
- `connect_campaign_execution_role_arn`**Type**: `STRING`**Provider name**: `ConnectCampaignExecutionRoleArn`**Description**: IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.

## `last_modified_date`{% #last_modified_date %}

**Type**: `STRING`**Provider name**: `LastModifiedDate`**Description**: The date, in ISO 8601 format, when the journey was last modified.

## `limits`{% #limits %}

**Type**: `STRUCT`**Provider name**: `Limits`**Description**: The messaging and entry limits for the journey.

- `daily_cap`**Type**: `INT32`**Provider name**: `DailyCap`**Description**: The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
- `endpoint_reentry_cap`**Type**: `INT32`**Provider name**: `EndpointReentryCap`**Description**: The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
- `endpoint_reentry_interval`**Type**: `STRING`**Provider name**: `EndpointReentryInterval`**Description**: Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
- `messages_per_second`**Type**: `INT32`**Provider name**: `MessagesPerSecond`**Description**: The maximum number of messages that the journey can send each second.
- `timeframe_cap`**Type**: `STRUCT`**Provider name**: `TimeframeCap`**Description**: The number of messages that an endpoint can receive during the specified timeframe.
  - `cap`**Type**: `INT32`**Provider name**: `Cap`**Description**: The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.
  - `days`**Type**: `INT32`**Provider name**: `Days`**Description**: The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.
- `total_cap`**Type**: `INT32`**Provider name**: `TotalCap`**Description**: The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

## `local_time`{% #local_time %}

**Type**: `BOOLEAN`**Provider name**: `LocalTime`**Description**: Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the journey.

## `open_hours`{% #open_hours %}

**Type**: `STRUCT`**Provider name**: `OpenHours`**Description**: The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.

- `custom`**Type**: `STRING`**Provider name**: `CUSTOM`**Description**: Specifies the schedule settings for the custom channel.
- `email`**Type**: `STRING`**Provider name**: `EMAIL`**Description**: Specifies the schedule settings for the email channel.
- `push`**Type**: `STRING`**Provider name**: `PUSH`**Description**: Specifies the schedule settings for the push channel.
- `sms`**Type**: `STRING`**Provider name**: `SMS`**Description**: Specifies the schedule settings for the SMS channel.
- `voice`**Type**: `STRING`**Provider name**: `VOICE`**Description**: Specifies the schedule settings for the voice channel.

## `quiet_time`{% #quiet_time %}

**Type**: `STRUCT`**Provider name**: `QuietTime`**Description**: The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

- The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
- The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
- The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.


- `end`**Type**: `STRING`**Provider name**: `End`**Description**: The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
- `start`**Type**: `STRING`**Provider name**: `Start`**Description**: The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

## `refresh_frequency`{% #refresh_frequency %}

**Type**: `STRING`**Provider name**: `RefreshFrequency`**Description**: The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

## `refresh_on_segment_update`{% #refresh_on_segment_update %}

**Type**: `BOOLEAN`**Provider name**: `RefreshOnSegmentUpdate`**Description**: Indicates whether the journey participants should be refreshed when a segment is updated.

## `schedule`{% #schedule %}

**Type**: `STRUCT`**Provider name**: `Schedule`**Description**: The schedule settings for the journey.

- `end_time`**Type**: `TIMESTAMP`**Provider name**: `EndTime`**Description**: The scheduled time, in ISO 8601 format, when the journey ended or will end.
- `start_time`**Type**: `TIMESTAMP`**Provider name**: `StartTime`**Description**: The scheduled time, in ISO 8601 format, when the journey began or will begin.
- `timezone`**Type**: `STRING`**Provider name**: `Timezone`**Description**: The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

## `sending_schedule`{% #sending_schedule %}

**Type**: `BOOLEAN`**Provider name**: `SendingSchedule`**Description**: Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.

## `start_activity`{% #start_activity %}

**Type**: `STRING`**Provider name**: `StartActivity`**Description**: The unique identifier for the first activity in the journey.

## `start_condition`{% #start_condition %}

**Type**: `STRUCT`**Provider name**: `StartCondition`**Description**: The segment that defines which users are participants in the journey.

- `description`**Type**: `STRING`**Provider name**: `Description`**Description**: The custom description of the condition.
- `event_start_condition`**Type**: `STRUCT`**Provider name**: `EventStartCondition`
  - `event_filter`**Type**: `STRUCT`**Provider name**: `EventFilter`
    - `dimensions`**Type**: `STRUCT`**Provider name**: `Dimensions`**Description**: The dimensions for the event filter to use for the campaign or the journey activity.
      - `attributes`**Type**: `STRING`**Provider name**: `Attributes`**Description**: One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
      - `event_type`**Type**: `STRUCT`**Provider name**: `EventType`**Description**: The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see [Streaming Amazon Pinpoint Events](https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) in the Amazon Pinpoint Developer Guide.
        - `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.
      - `metrics`**Type**: `STRING`**Provider name**: `Metrics`**Description**: One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
    - `filter_type`**Type**: `STRING`**Provider name**: `FilterType`**Description**: The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
  - `segment_id`**Type**: `STRING`**Provider name**: `SegmentId`
- `segment_start_condition`**Type**: `STRUCT`**Provider name**: `SegmentStartCondition`**Description**: The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
  - `segment_id`**Type**: `STRING`**Provider name**: `SegmentId`**Description**: The unique identifier for the segment to associate with the activity.

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `State`**Description**: The current status of the journey. Possible values are:

- DRAFT - The journey is being developed and hasn't been published yet.
- ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
- COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
- CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
- CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.



## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `timezone_estimation_methods`{% #timezone_estimation_methods %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `TimezoneEstimationMethods`**Description**: An array of time zone estimation methods, if any, to use for determining an [Endpoints](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html) time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

- PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.
- POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.



## `wait_for_quiet_time`{% #wait_for_quiet_time %}

**Type**: `BOOLEAN`**Provider name**: `WaitForQuietTime`**Description**: Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.