-
Notifications
You must be signed in to change notification settings - Fork 626
/
api_op_CreateDataset.go
240 lines (220 loc) · 8.46 KB
/
api_op_CreateDataset.go
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
// Code generated by smithy-go-codegen DO NOT EDIT.
package forecast
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/forecast/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates an Amazon Forecast dataset. The information about the dataset that you
// provide helps Forecast understand how to consume the data for model training.
// This includes the following:
//
// * DataFrequency - How frequently your historical
// time-series data is collected.
//
// * Domain and DatasetType - Each dataset has an
// associated dataset domain and a type within the domain. Amazon Forecast provides
// a list of predefined domains and types within each domain. For each unique
// dataset domain and type within the domain, Amazon Forecast requires your data to
// include a minimum set of predefined fields.
//
// * Schema - A schema specifies the
// fields in the dataset, including the field name and data type.
//
// After creating a
// dataset, you import your training data into it and add the dataset to a dataset
// group. You use the dataset group to create a predictor. For more information,
// see Importing datasets
// (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).
// To get a list of all your datasets, use the ListDatasets
// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html)
// operation. For example Forecast datasets, see the Amazon Forecast Sample GitHub
// repository (https://github.com/aws-samples/amazon-forecast-samples). The Status
// of a dataset must be ACTIVE before you can import training data. Use the
// DescribeDataset
// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)
// operation to get the status.
func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error) {
if params == nil {
params = &CreateDatasetInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateDataset", params, optFns, c.addOperationCreateDatasetMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateDatasetOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateDatasetInput struct {
// A name for the dataset.
//
// This member is required.
DatasetName *string
// The dataset type. Valid values depend on the chosen Domain.
//
// This member is required.
DatasetType types.DatasetType
// The domain associated with the dataset. When you add a dataset to a dataset
// group, this value and the value specified for the Domain parameter of the
// CreateDatasetGroup
// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)
// operation must match. The Domain and DatasetType that you choose determine the
// fields that must be present in the training data that you import to the dataset.
// For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the
// DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to
// be present in your data. For more information, see Importing datasets
// (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).
//
// This member is required.
Domain types.Domain
// The schema for the dataset. The schema attributes and their order must match the
// fields in your data. The dataset Domain and DatasetType that you choose
// determine the minimum required fields in your training data. For information
// about the required fields for a specific dataset domain and type, see Dataset
// Domains and Dataset Types
// (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html).
//
// This member is required.
Schema *types.Schema
// The frequency of data collection. This parameter is required for
// RELATED_TIME_SERIES datasets. Valid intervals are an integer followed by Y
// (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,
// "1D" indicates every day and "15min" indicates every 15 minutes. You cannot
// specify a value that would overlap with the next larger frequency. That means,
// for example, you cannot specify a frequency of 60 minutes, because that is
// equivalent to 1 hour. The valid values for each frequency are the following:
//
// *
// Minute - 1-59
//
// * Hour - 1-23
//
// * Day - 1-6
//
// * Week - 1-4
//
// * Month - 1-11
//
// * Year
// - 1
//
// Thus, if you want every other week forecasts, specify "2W". Or, if you want
// quarterly forecasts, you specify "3M".
DataFrequency *string
// An Key Management Service (KMS) key and the Identity and Access Management (IAM)
// role that Amazon Forecast can assume to access the key.
EncryptionConfig *types.EncryptionConfig
// The optional metadata that you apply to the dataset to help you categorize and
// organize them. Each tag consists of a key and an optional value, both of which
// you define. The following basic restrictions apply to tags:
//
// * Maximum number of
// tags per resource - 50.
//
// * For each resource, each tag key must be unique, and
// each tag key can have only one value.
//
// * Maximum key length - 128 Unicode
// characters in UTF-8.
//
// * Maximum value length - 256 Unicode characters in
// UTF-8.
//
// * If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
//
// * Tag keys and values are
// case sensitive.
//
// * Do not use aws:, AWS:, or any upper or lowercase combination
// of such as a prefix for keys as it is reserved for Amazon Web Services use. You
// cannot edit or delete tag keys with this prefix. Values can have this prefix. If
// a tag value has aws as its prefix but the key does not, then Forecast considers
// it to be a user tag and will count against the limit of 50 tags. Tags with only
// the key prefix of aws do not count against your tags per resource limit.
Tags []types.Tag
noSmithyDocumentSerde
}
type CreateDatasetOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateDatasetMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateDataset{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateDataset{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpCreateDatasetValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateDataset(options.Region), middleware.Before); 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
}
return nil
}
func newServiceMetadataMiddleware_opCreateDataset(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "forecast",
OperationName: "CreateDataset",
}
}