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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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*.

[1]: docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html

Returns:

  • (Hash<String,String>) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File '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