Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::ActivityResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides information about an activity that was performed by a campaign.

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The unique identifier for the application that the campaign applies to.

Returns:

  • (String)

    The unique identifier for the application that the campaign applies to.

#campaign_idString

The unique identifier for the campaign that the activity applies to.

Returns:

  • (String)

    The unique identifier for the campaign that the activity applies to.

#endString

The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

Returns:

  • (String)

    The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

#idString

The unique identifier for the activity.

Returns:

  • (String)

    The unique identifier for the activity.

#resultString

Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

Returns:

  • (String)

    Specifies whether the activity succeeded.

#scheduled_startString

The scheduled start time, in ISO 8601 format, for the activity.

Returns:

  • (String)

    The scheduled start time, in ISO 8601 format, for the activity.

#startString

The actual start time, in ISO 8601 format, of the activity.

Returns:

  • (String)

    The actual start time, in ISO 8601 format, of the activity.

#stateString

The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

Returns:

  • (String)

    The current status of the activity.

#successful_endpoint_countInteger

The total number of endpoints that the campaign successfully delivered messages to.

Returns:

  • (Integer)

    The total number of endpoints that the campaign successfully delivered messages to.

#timezones_completed_countInteger

The total number of time zones that were completed.

Returns:

  • (Integer)

    The total number of time zones that were completed.

#timezones_total_countInteger

The total number of unique time zones that are in the segment for the campaign.

Returns:

  • (Integer)

    The total number of unique time zones that are in the segment for the campaign.

#total_endpoint_countInteger

The total number of endpoints that the campaign attempted to deliver messages to.

Returns:

  • (Integer)

    The total number of endpoints that the campaign attempted to deliver messages to.

#treatment_idString

The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that\'s used for A/B testing of a campaign.

Returns:

  • (String)

    The unique identifier for the campaign treatment that the activity applies to.