1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package pinpoint
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/pinpoint/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Retrieves (queries) pre-aggregated data for a standard metric that applies to a
// campaign.
func (c *Client) GetCampaignDateRangeKpi(ctx context.Context, params *GetCampaignDateRangeKpiInput, optFns ...func(*Options)) (*GetCampaignDateRangeKpiOutput, error) {
if params == nil {
params = &GetCampaignDateRangeKpiInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetCampaignDateRangeKpi", params, optFns, c.addOperationGetCampaignDateRangeKpiMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetCampaignDateRangeKpiOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetCampaignDateRangeKpiInput struct {
// The unique identifier for the application. This identifier is displayed as the
// Project ID on the Amazon Pinpoint console.
//
// This member is required.
ApplicationId *string
// The unique identifier for the campaign.
//
// This member is required.
CampaignId *string
// The name of the metric, also referred to as a key performance indicator (KPI),
// to retrieve data for. This value describes the associated metric and consists of
// two or more terms, which are comprised of lowercase alphanumeric characters,
// separated by a hyphen. Examples are email-open-rate and
// successful-delivery-rate. For a list of valid values, see the [Amazon Pinpoint Developer Guide].
//
// [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
//
// This member is required.
KpiName *string
// The last date and time to retrieve data for, as part of an inclusive date range
// that filters the query results. This value should be in extended ISO 8601 format
// and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for
// 8:00 PM UTC July 26, 2019.
EndTime *time.Time
// The string that specifies which page of results to return in a paginated
// response. This parameter is not supported for application, campaign, and journey
// metrics.
NextToken *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.
PageSize *string
// The first date and time to retrieve data for, as part of an inclusive date
// range that filters the query results. This value should be in extended ISO 8601
// format and use Coordinated Universal Time (UTC), for example:
// 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be
// fewer than 90 days from the current day.
StartTime *time.Time
noSmithyDocumentSerde
}
type GetCampaignDateRangeKpiOutput struct {
// Provides the results of a query that retrieved the data for a standard metric
// that applies to a campaign, and provides information about that query.
//
// This member is required.
CampaignDateRangeKpiResponse *types.CampaignDateRangeKpiResponse
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetCampaignDateRangeKpiMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetCampaignDateRangeKpi{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetCampaignDateRangeKpi{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetCampaignDateRangeKpi"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpGetCampaignDateRangeKpiValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetCampaignDateRangeKpi(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetCampaignDateRangeKpi(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetCampaignDateRangeKpi",
}
}
|
