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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::ActivityResponse

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

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

• #campaign_id ⇒ String

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

• #end ⇒ String

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

• #execution_metrics ⇒ Hash<String,String>

  A JSON object that contains metrics relating to the campaign execution for this campaign activity.

• #id ⇒ String

  The unique identifier for the activity.

• #result ⇒ String

  Specifies whether the activity succeeded.

• #scheduled_start ⇒ String

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

• #start ⇒ String

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

• #state ⇒ String

  The current status of the activity.

• #successful_endpoint_count ⇒ Integer

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

• #timezones_completed_count ⇒ Integer

  The total number of time zones that were completed.

• #timezones_total_count ⇒ Integer

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

• #total_endpoint_count ⇒ Integer

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

• #treatment_id ⇒ String

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

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#campaign_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#end ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#execution_metrics ⇒ Hash<String,String>

A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier for the activity.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#result ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_start ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#start ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#successful_endpoint_count ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#timezones_completed_count ⇒ Integer

The total number of time zones that were completed.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#timezones_total_count ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#total_endpoint_count ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_id ⇒ String

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)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1273

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,
  :execution_metrics)
  SENSITIVE = []
  include Aws::Structure
end