Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Forecast.CreateDatasetGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

Creating a Request

data CreateDatasetGroup Source #

See: newCreateDatasetGroup smart constructor.

Constructors

CreateDatasetGroup'

Fields

datasetArns :: Maybe [Text]
An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
tags :: Maybe [Tag]
The optional metadata that you apply to the dataset group 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 AWS 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.
datasetGroupName :: Text
A name for the dataset group.
domain :: Domain
The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.
The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see Dataset groups.

Instances

Instances details

ToJSON CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods toJSON :: CreateDatasetGroup -> Value # toEncoding :: CreateDatasetGroup -> Encoding # toJSONList :: [CreateDatasetGroup] -> Value # toEncodingList :: [CreateDatasetGroup] -> Encoding #
ToHeaders CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods toHeaders :: CreateDatasetGroup -> [Header] #
ToPath CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods toPath :: CreateDatasetGroup -> ByteString #
ToQuery CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods toQuery :: CreateDatasetGroup -> QueryString #
AWSRequest CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Associated Types type AWSResponse CreateDatasetGroup # Methods request :: (Service -> Service) -> CreateDatasetGroup -> Request CreateDatasetGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDatasetGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDatasetGroup))) #
Generic CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Associated Types type Rep CreateDatasetGroup :: Type -> Type # Methods from :: CreateDatasetGroup -> Rep CreateDatasetGroup x # to :: Rep CreateDatasetGroup x -> CreateDatasetGroup #
Show CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods showsPrec :: Int -> CreateDatasetGroup -> ShowS # show :: CreateDatasetGroup -> String # showList :: [CreateDatasetGroup] -> ShowS #
NFData CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods rnf :: CreateDatasetGroup -> () #
Eq CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods (==) :: CreateDatasetGroup -> CreateDatasetGroup -> Bool # (/=) :: CreateDatasetGroup -> CreateDatasetGroup -> Bool #
Hashable CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods hashWithSalt :: Int -> CreateDatasetGroup -> Int # hash :: CreateDatasetGroup -> Int #
type AWSResponse CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup type AWSResponse CreateDatasetGroup = CreateDatasetGroupResponse
type Rep CreateDatasetGroup Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup type Rep CreateDatasetGroup = D1 ('MetaData "CreateDatasetGroup" "Amazonka.Forecast.CreateDatasetGroup" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "CreateDatasetGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "datasetArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "datasetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Domain))))

newCreateDatasetGroup Source #

Arguments

:: Text	`CreateDatasetGroup`
-> Domain	`CreateDatasetGroup`
-> CreateDatasetGroup

Create a value of CreateDatasetGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:datasetArns:CreateDatasetGroup', createDatasetGroup_datasetArns - An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

$sel:tags:CreateDatasetGroup', createDatasetGroup_tags - The optional metadata that you apply to the dataset group 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 AWS 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.

CreateDatasetGroup, createDatasetGroup_datasetGroupName - A name for the dataset group.

CreateDatasetGroup, createDatasetGroup_domain - The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see Dataset groups.

Request Lenses

createDatasetGroup_datasetArns :: Lens' CreateDatasetGroup (Maybe [Text]) Source #

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

createDatasetGroup_tags :: Lens' CreateDatasetGroup (Maybe [Tag]) Source #

The optional metadata that you apply to the dataset group 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 AWS 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.

createDatasetGroup_datasetGroupName :: Lens' CreateDatasetGroup Text Source #

A name for the dataset group.

createDatasetGroup_domain :: Lens' CreateDatasetGroup Domain Source #

The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see Dataset groups.

Destructuring the Response

data CreateDatasetGroupResponse Source #

See: newCreateDatasetGroupResponse smart constructor.

Constructors

CreateDatasetGroupResponse'
Fields datasetGroupArn :: Maybe Text The Amazon Resource Name (ARN) of the dataset group. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDatasetGroupResponse Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Associated Types type Rep CreateDatasetGroupResponse :: Type -> Type # Methods from :: CreateDatasetGroupResponse -> Rep CreateDatasetGroupResponse x # to :: Rep CreateDatasetGroupResponse x -> CreateDatasetGroupResponse #
Read CreateDatasetGroupResponse Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods readsPrec :: Int -> ReadS CreateDatasetGroupResponse # readList :: ReadS [CreateDatasetGroupResponse] # readPrec :: ReadPrec CreateDatasetGroupResponse # readListPrec :: ReadPrec [CreateDatasetGroupResponse] #
Show CreateDatasetGroupResponse Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods showsPrec :: Int -> CreateDatasetGroupResponse -> ShowS # show :: CreateDatasetGroupResponse -> String # showList :: [CreateDatasetGroupResponse] -> ShowS #
NFData CreateDatasetGroupResponse Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods rnf :: CreateDatasetGroupResponse -> () #
Eq CreateDatasetGroupResponse Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup Methods (==) :: CreateDatasetGroupResponse -> CreateDatasetGroupResponse -> Bool # (/=) :: CreateDatasetGroupResponse -> CreateDatasetGroupResponse -> Bool #
type Rep CreateDatasetGroupResponse Source #
Instance details Defined in Amazonka.Forecast.CreateDatasetGroup type Rep CreateDatasetGroupResponse = D1 ('MetaData "CreateDatasetGroupResponse" "Amazonka.Forecast.CreateDatasetGroup" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "CreateDatasetGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDatasetGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDatasetGroupResponse'`
-> CreateDatasetGroupResponse

Create a value of CreateDatasetGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDatasetGroupResponse, createDatasetGroupResponse_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group.

$sel:httpStatus:CreateDatasetGroupResponse', createDatasetGroupResponse_httpStatus - The response's http status code.

Response Lenses

createDatasetGroupResponse_datasetGroupArn :: Lens' CreateDatasetGroupResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group.

createDatasetGroupResponse_httpStatus :: Lens' CreateDatasetGroupResponse Int Source #

The response's http status code.