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

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

Activity definition

See Also:

• AWS API Documentation

Instance Attribute Summary

• #application_id ⇒ String

  The ID of the application to which the campaign applies.

• #campaign_id ⇒ String

  The ID of the campaign to which the activity applies.

• #end ⇒ String

  The actual time the activity was marked CANCELLED or COMPLETED.

• #id ⇒ String

  The unique activity ID.

• #result ⇒ String

  Indicates whether the activity succeeded.

• #scheduled_start ⇒ String

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

• #start ⇒ String

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

• #state ⇒ String

  The state of the activity.

• #successful_endpoint_count ⇒ Integer

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

• #timezones_completed_count ⇒ Integer

  The total number of timezones completed.

• #timezones_total_count ⇒ Integer

  The total number of unique timezones present in the segment.

• #total_endpoint_count ⇒ Integer

  The total number of endpoints to which the campaign attempts to deliver messages.

• #treatment_id ⇒ String

  The ID of a variation of the campaign used for A/B testing.

Instance Attribute Details

#application_id ⇒ String

The ID of the application to which the campaign applies.

Returns:

• (String)

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

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_id ⇒ String

The ID of the campaign to which the activity applies.

Returns:

• (String)

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

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

#end ⇒ String

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

Returns:

• (String)

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

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

#id ⇒ String

The unique activity ID.

Returns:

• (String)

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

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

#result ⇒ String

Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL

Returns:

• (String)

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

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_start ⇒ String

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

Returns:

• (String)

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

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

#start ⇒ String

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

Returns:

• (String)

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

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

#state ⇒ String

The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED

Returns:

• (String)

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

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_count ⇒ Integer

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

Returns:

• (Integer)

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

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_count ⇒ Integer

The total number of timezones completed.

Returns:

• (Integer)

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

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_count ⇒ Integer

The total number of unique timezones present in the segment.

Returns:

• (Integer)

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

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_count ⇒ Integer

The total number of endpoints to which the campaign attempts to deliver messages.

Returns:

• (Integer)

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

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_id ⇒ String

The ID of a variation of the campaign used for A/B testing.

Returns:

• (String)

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

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