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.ListDatasets

Description

Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDatasets Source #

See: newListDatasets smart constructor.

Constructors

ListDatasets' 

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 ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

ToHeaders ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

ToPath ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

ToQuery ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

AWSPager ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

AWSRequest ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

Associated Types

type AWSResponse ListDatasets #

Generic ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

Associated Types

type Rep ListDatasets :: Type -> Type #

Read ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

Show ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

NFData ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

Methods

rnf :: ListDatasets -> () #

Eq ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

Hashable ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

type AWSResponse ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

type Rep ListDatasets Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

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

newListDatasets :: ListDatasets Source #

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

ListDatasets, listDatasets_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

listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural) Source #

The number of items to return in the response.

listDatasets_nextToken :: Lens' ListDatasets (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 ListDatasetsResponse Source #

See: newListDatasetsResponse smart constructor.

Constructors

ListDatasetsResponse' 

Fields

  • datasets :: Maybe [DatasetSummary]

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

  • nextToken :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListDatasetsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

Associated Types

type Rep ListDatasetsResponse :: Type -> Type #

Read ListDatasetsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

Show ListDatasetsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

NFData ListDatasetsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

Methods

rnf :: ListDatasetsResponse -> () #

Eq ListDatasetsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

type Rep ListDatasetsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListDatasets

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

newListDatasetsResponse Source #

Create a value of ListDatasetsResponse 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:datasets:ListDatasetsResponse', listDatasetsResponse_datasets - An array of objects that summarize each dataset's properties.

ListDatasets, listDatasetsResponse_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:ListDatasetsResponse', listDatasetsResponse_httpStatus - The response's http status code.

Response Lenses

listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [DatasetSummary]) Source #

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

listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (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.