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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

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)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#campaign_idString

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

Returns:

  • (String)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#endString

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

Returns:

  • (String)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#idString

The unique identifier for the activity.

Returns:

  • (String)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#resultString

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

Returns:

  • (String)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#scheduled_startString

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

Returns:

  • (String)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#startString

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

Returns:

  • (String)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#stateString

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

Returns:

  • (String)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#successful_endpoint_countInteger

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

Returns:

  • (Integer)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#timezones_completed_countInteger

The total number of time zones that were completed.

Returns:

  • (Integer)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#timezones_total_countInteger

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

Returns:

  • (Integer)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#total_endpoint_countInteger

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

Returns:

  • (Integer)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end

#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)


1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1593

class ActivityResponse < Struct.new(
  :application_id,
  :campaign_id,
  :end,
  :id,
  :result,
  :scheduled_start,
  :start,
  :state,
  :successful_endpoint_count,
  :timezones_completed_count,
  :timezones_total_count,
  :total_endpoint_count,
  :treatment_id)
  include Aws::Structure
end