libZSservicesZSamazonka-forecastZSamazonka-forecast
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Forecast.DescribeDatasetGroup

Description

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties:

  • DatasetArns - The datasets belonging to the group.
  • CreationTime
  • LastModificationTime
  • Status
Synopsis

Creating a Request

data DescribeDatasetGroup Source #

See: newDescribeDatasetGroup smart constructor.

Constructors

DescribeDatasetGroup' 

Fields

Instances

Instances details
Eq DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Read DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Show DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Generic DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Associated Types

type Rep DescribeDatasetGroup :: Type -> Type #

NFData DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Methods

rnf :: DescribeDatasetGroup -> () #

Hashable DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

ToJSON DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

AWSRequest DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Associated Types

type AWSResponse DescribeDatasetGroup #

ToHeaders DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

ToPath DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

ToQuery DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

type Rep DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

type Rep DescribeDatasetGroup = D1 ('MetaData "DescribeDatasetGroup" "Amazonka.Forecast.DescribeDatasetGroup" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "DescribeDatasetGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDatasetGroup Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

newDescribeDatasetGroup Source #

Create a value of DescribeDatasetGroup 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:datasetGroupArn:DescribeDatasetGroup', describeDatasetGroup_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group.

Request Lenses

describeDatasetGroup_datasetGroupArn :: Lens' DescribeDatasetGroup Text Source #

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

Destructuring the Response

data DescribeDatasetGroupResponse Source #

See: newDescribeDatasetGroupResponse smart constructor.

Constructors

DescribeDatasetGroupResponse' 

Fields

  • creationTime :: Maybe POSIX

    When the dataset group was created.

  • datasetArns :: Maybe [Text]

    An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

  • status :: Maybe Text

    The status of the dataset group. States include:

    • ACTIVE
    • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

    The UPDATE states apply when you call the UpdateDatasetGroup operation.

    The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.

  • domain :: Maybe Domain

    The domain associated with the dataset group.

  • datasetGroupName :: Maybe Text

    The name of the dataset group.

  • datasetGroupArn :: Maybe Text

    The ARN of the dataset group.

  • lastModificationTime :: Maybe POSIX

    When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the DescribeDatasetGroup call.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeDatasetGroupResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Read DescribeDatasetGroupResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Show DescribeDatasetGroupResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Generic DescribeDatasetGroupResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

Associated Types

type Rep DescribeDatasetGroupResponse :: Type -> Type #

NFData DescribeDatasetGroupResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

type Rep DescribeDatasetGroupResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDatasetGroup

type Rep DescribeDatasetGroupResponse = D1 ('MetaData "DescribeDatasetGroupResponse" "Amazonka.Forecast.DescribeDatasetGroup" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "DescribeDatasetGroupResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "datasetArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain)))) :*: ((S1 ('MetaSel ('Just "datasetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeDatasetGroupResponse Source #

Create a value of DescribeDatasetGroupResponse 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:creationTime:DescribeDatasetGroupResponse', describeDatasetGroupResponse_creationTime - When the dataset group was created.

$sel:datasetArns:DescribeDatasetGroupResponse', describeDatasetGroupResponse_datasetArns - An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

$sel:status:DescribeDatasetGroupResponse', describeDatasetGroupResponse_status - The status of the dataset group. States include:

  • ACTIVE
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply when you call the UpdateDatasetGroup operation.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.

$sel:domain:DescribeDatasetGroupResponse', describeDatasetGroupResponse_domain - The domain associated with the dataset group.

$sel:datasetGroupName:DescribeDatasetGroupResponse', describeDatasetGroupResponse_datasetGroupName - The name of the dataset group.

$sel:datasetGroupArn:DescribeDatasetGroup', describeDatasetGroupResponse_datasetGroupArn - The ARN of the dataset group.

$sel:lastModificationTime:DescribeDatasetGroupResponse', describeDatasetGroupResponse_lastModificationTime - When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the DescribeDatasetGroup call.

$sel:httpStatus:DescribeDatasetGroupResponse', describeDatasetGroupResponse_httpStatus - The response's http status code.

Response Lenses

describeDatasetGroupResponse_datasetArns :: Lens' DescribeDatasetGroupResponse (Maybe [Text]) Source #

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

describeDatasetGroupResponse_status :: Lens' DescribeDatasetGroupResponse (Maybe Text) Source #

The status of the dataset group. States include:

  • ACTIVE
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply when you call the UpdateDatasetGroup operation.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.

describeDatasetGroupResponse_lastModificationTime :: Lens' DescribeDatasetGroupResponse (Maybe UTCTime) Source #

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the DescribeDatasetGroup call.