amazonka-ml-2.0: Amazon Machine Learning 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.MachineLearning.DescribeDataSources

Description

Returns a list of DataSource that match the search criteria in the request.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDataSources Source #

See: newDescribeDataSources smart constructor.

Constructors

DescribeDataSources' 

Fields

  • eq :: Maybe Text

    The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

  • filterVariable :: Maybe DataSourceFilterVariable

    Use one of the following variables to filter a list of DataSource:

    • CreatedAt - Sets the search criteria to DataSource creation dates.
    • Status - Sets the search criteria to DataSource statuses.
    • Name - Sets the search criteria to the contents of DataSource Name.
    • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
    • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.
  • ge :: Maybe Text

    The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.

  • gt :: Maybe Text

    The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

  • le :: Maybe Text

    The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.

  • lt :: Maybe Text

    The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

  • limit :: Maybe Natural

    The maximum number of DataSource to include in the result.

  • ne :: Maybe Text

    The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

  • nextToken :: Maybe Text

    The ID of the page in the paginated results.

  • prefix :: Maybe Text

    A string that is found at the beginning of a variable, such as Name or Id.

    For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:

    • 2014-09
    • 2014-09-09
    • 2014-09-09-Holiday
  • sortOrder :: Maybe SortOrder

    A two-value parameter that determines the sequence of the resulting list of DataSource.

    • asc - Arranges the list in ascending order (A-Z, 0-9).
    • dsc - Arranges the list in descending order (Z-A, 9-0).

    Results are sorted by FilterVariable.

Instances

Instances details
ToJSON DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

ToHeaders DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

ToPath DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

ToQuery DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

AWSPager DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

AWSRequest DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

Associated Types

type AWSResponse DescribeDataSources #

Generic DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

Associated Types

type Rep DescribeDataSources :: Type -> Type #

Read DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

Show DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

NFData DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

Methods

rnf :: DescribeDataSources -> () #

Eq DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

Hashable DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

type AWSResponse DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

type Rep DescribeDataSources Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

newDescribeDataSources :: DescribeDataSources Source #

Create a value of DescribeDataSources 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:eq:DescribeDataSources', describeDataSources_eq - The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

$sel:filterVariable:DescribeDataSources', describeDataSources_filterVariable - Use one of the following variables to filter a list of DataSource:

  • CreatedAt - Sets the search criteria to DataSource creation dates.
  • Status - Sets the search criteria to DataSource statuses.
  • Name - Sets the search criteria to the contents of DataSource Name.
  • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
  • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.

$sel:ge:DescribeDataSources', describeDataSources_ge - The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.

$sel:gt:DescribeDataSources', describeDataSources_gt - The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

$sel:le:DescribeDataSources', describeDataSources_le - The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.

$sel:lt:DescribeDataSources', describeDataSources_lt - The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

$sel:limit:DescribeDataSources', describeDataSources_limit - The maximum number of DataSource to include in the result.

$sel:ne:DescribeDataSources', describeDataSources_ne - The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

DescribeDataSources, describeDataSources_nextToken - The ID of the page in the paginated results.

$sel:prefix:DescribeDataSources', describeDataSources_prefix - A string that is found at the beginning of a variable, such as Name or Id.

For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09
  • 2014-09-09
  • 2014-09-09-Holiday

$sel:sortOrder:DescribeDataSources', describeDataSources_sortOrder - A two-value parameter that determines the sequence of the resulting list of DataSource.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Request Lenses

describeDataSources_eq :: Lens' DescribeDataSources (Maybe Text) Source #

The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

describeDataSources_filterVariable :: Lens' DescribeDataSources (Maybe DataSourceFilterVariable) Source #

Use one of the following variables to filter a list of DataSource:

  • CreatedAt - Sets the search criteria to DataSource creation dates.
  • Status - Sets the search criteria to DataSource statuses.
  • Name - Sets the search criteria to the contents of DataSource Name.
  • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
  • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.

describeDataSources_ge :: Lens' DescribeDataSources (Maybe Text) Source #

The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.

describeDataSources_gt :: Lens' DescribeDataSources (Maybe Text) Source #

The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

describeDataSources_le :: Lens' DescribeDataSources (Maybe Text) Source #

The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.

describeDataSources_lt :: Lens' DescribeDataSources (Maybe Text) Source #

The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

describeDataSources_limit :: Lens' DescribeDataSources (Maybe Natural) Source #

The maximum number of DataSource to include in the result.

describeDataSources_ne :: Lens' DescribeDataSources (Maybe Text) Source #

The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

describeDataSources_nextToken :: Lens' DescribeDataSources (Maybe Text) Source #

The ID of the page in the paginated results.

describeDataSources_prefix :: Lens' DescribeDataSources (Maybe Text) Source #

A string that is found at the beginning of a variable, such as Name or Id.

For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09
  • 2014-09-09
  • 2014-09-09-Holiday

describeDataSources_sortOrder :: Lens' DescribeDataSources (Maybe SortOrder) Source #

A two-value parameter that determines the sequence of the resulting list of DataSource.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Destructuring the Response

data DescribeDataSourcesResponse Source #

Represents the query results from a DescribeDataSources operation. The content is essentially a list of DataSource.

See: newDescribeDataSourcesResponse smart constructor.

Constructors

DescribeDataSourcesResponse' 

Fields

Instances

Instances details
Generic DescribeDataSourcesResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

Associated Types

type Rep DescribeDataSourcesResponse :: Type -> Type #

Read DescribeDataSourcesResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

Show DescribeDataSourcesResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

NFData DescribeDataSourcesResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

Eq DescribeDataSourcesResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

type Rep DescribeDataSourcesResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeDataSources

type Rep DescribeDataSourcesResponse = D1 ('MetaData "DescribeDataSourcesResponse" "Amazonka.MachineLearning.DescribeDataSources" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "DescribeDataSourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSource])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDataSourcesResponse Source #

Create a value of DescribeDataSourcesResponse 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:

DescribeDataSources, describeDataSourcesResponse_nextToken - An ID of the next page in the paginated results that indicates at least one more page follows.

$sel:results:DescribeDataSourcesResponse', describeDataSourcesResponse_results - A list of DataSource that meet the search criteria.

$sel:httpStatus:DescribeDataSourcesResponse', describeDataSourcesResponse_httpStatus - The response's http status code.

Response Lenses

describeDataSourcesResponse_nextToken :: Lens' DescribeDataSourcesResponse (Maybe Text) Source #

An ID of the next page in the paginated results that indicates at least one more page follows.

describeDataSourcesResponse_results :: Lens' DescribeDataSourcesResponse (Maybe [DataSource]) Source #

A list of DataSource that meet the search criteria.