get-campaign-activities¶
Description¶
Retrieves information about all the activities for a campaign.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-campaign-activities
--application-id <value>
--campaign-id <value>
[--page-size <value>]
[--token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--application-id (string)
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
--campaign-id (string)
The unique identifier for the campaign.
--page-size (string)
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
--token (string)
The NextToken string that specifies which page of results to return in a paginated response.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
ActivitiesResponse -> (structure)
Provides information about the activities that were performed by a campaign.
Item -> (list)
An array of responses, one for each activity that was performed by the campaign.
(structure)
Provides information about an activity that was performed by a campaign.
ApplicationId -> (string)
The unique identifier for the application that the campaign applies to.
CampaignId -> (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.
Id -> (string)
The unique identifier for the activity.
Result -> (string)
Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
ScheduledStart -> (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. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
SuccessfulEndpointCount -> (integer)
The total number of endpoints that the campaign successfully delivered messages to.
TimezonesCompletedCount -> (integer)
The total number of time zones that were completed.
TimezonesTotalCount -> (integer)
The total number of unique time zones that are in the segment for the campaign.
TotalEndpointCount -> (integer)
The total number of endpoints that the campaign attempted to deliver messages to.
TreatmentId -> (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.
NextToken -> (string)
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.