amazonka-forecast-2.0: Amazon Forecast Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Forecast.ListDatasetGroups

Description

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDatasetGroups Source #

See: newListDatasetGroups smart constructor.

Constructors

ListDatasetGroups' 

Fields

  • maxResults :: Maybe Natural

    The number of items to return in the response.

  • nextToken :: Maybe Text

    If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Instances

Instances details
ToJSON ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

ToHeaders ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

ToPath ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

ToQuery ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

AWSPager ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

AWSRequest ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

Associated Types

type AWSResponse ListDatasetGroups #

Generic ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

Associated Types

type Rep ListDatasetGroups :: Type -> Type #

Read ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

Show ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

NFData ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

Methods

rnf :: ListDatasetGroups -> () #

Eq ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

Hashable ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

type AWSResponse ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

type Rep ListDatasetGroups Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

type Rep ListDatasetGroups = D1 ('MetaData "ListDatasetGroups" "Amazonka.Forecast.ListDatasetGroups" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListDatasetGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListDatasetGroups :: ListDatasetGroups Source #

Create a value of ListDatasetGroups 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:maxResults:ListDatasetGroups', listDatasetGroups_maxResults - The number of items to return in the response.

ListDatasetGroups, listDatasetGroups_nextToken - If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Request Lenses

listDatasetGroups_maxResults :: Lens' ListDatasetGroups (Maybe Natural) Source #

The number of items to return in the response.

listDatasetGroups_nextToken :: Lens' ListDatasetGroups (Maybe Text) Source #

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Destructuring the Response

data ListDatasetGroupsResponse Source #

See: newListDatasetGroupsResponse smart constructor.

Constructors

ListDatasetGroupsResponse' 

Fields

Instances

Instances details
Generic ListDatasetGroupsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

Associated Types

type Rep ListDatasetGroupsResponse :: Type -> Type #

Read ListDatasetGroupsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

Show ListDatasetGroupsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

NFData ListDatasetGroupsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

Eq ListDatasetGroupsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

type Rep ListDatasetGroupsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasetGroups

type Rep ListDatasetGroupsResponse = D1 ('MetaData "ListDatasetGroupsResponse" "Amazonka.Forecast.ListDatasetGroups" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListDatasetGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DatasetGroupSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDatasetGroupsResponse Source #

Create a value of ListDatasetGroupsResponse 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:datasetGroups:ListDatasetGroupsResponse', listDatasetGroupsResponse_datasetGroups - An array of objects that summarize each dataset group's properties.

ListDatasetGroups, listDatasetGroupsResponse_nextToken - If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

$sel:httpStatus:ListDatasetGroupsResponse', listDatasetGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listDatasetGroupsResponse_datasetGroups :: Lens' ListDatasetGroupsResponse (Maybe [DatasetGroupSummary]) Source #

An array of objects that summarize each dataset group's properties.

listDatasetGroupsResponse_nextToken :: Lens' ListDatasetGroupsResponse (Maybe Text) Source #

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.