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
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Activity definition

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The ID of the application to which the campaign applies.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 ID of the campaign to which the activity applies.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 activity ID.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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

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

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 for the activity in ISO 8601 format.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 of the activity in ISO 8601 format.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 to which the campaign successfully delivered messages.

Returns:

  • (Integer)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 timezones completed.

Returns:

  • (Integer)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 timezones present in the segment.

Returns:

  • (Integer)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 to which the campaign attempts to deliver messages.

Returns:

  • (Integer)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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 ID of a variation of the campaign used for A/B testing.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

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