Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Returns a list of DataSource
that match the search criteria in the
request.
This operation returns paginated results.
Synopsis
- data DescribeDataSources = DescribeDataSources' {}
- newDescribeDataSources :: DescribeDataSources
- describeDataSources_eq :: Lens' DescribeDataSources (Maybe Text)
- describeDataSources_ge :: Lens' DescribeDataSources (Maybe Text)
- describeDataSources_prefix :: Lens' DescribeDataSources (Maybe Text)
- describeDataSources_gt :: Lens' DescribeDataSources (Maybe Text)
- describeDataSources_ne :: Lens' DescribeDataSources (Maybe Text)
- describeDataSources_nextToken :: Lens' DescribeDataSources (Maybe Text)
- describeDataSources_sortOrder :: Lens' DescribeDataSources (Maybe SortOrder)
- describeDataSources_limit :: Lens' DescribeDataSources (Maybe Natural)
- describeDataSources_lt :: Lens' DescribeDataSources (Maybe Text)
- describeDataSources_filterVariable :: Lens' DescribeDataSources (Maybe DataSourceFilterVariable)
- describeDataSources_le :: Lens' DescribeDataSources (Maybe Text)
- data DescribeDataSourcesResponse = DescribeDataSourcesResponse' {
- results :: Maybe [DataSource]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeDataSourcesResponse :: Int -> DescribeDataSourcesResponse
- describeDataSourcesResponse_results :: Lens' DescribeDataSourcesResponse (Maybe [DataSource])
- describeDataSourcesResponse_nextToken :: Lens' DescribeDataSourcesResponse (Maybe Text)
- describeDataSourcesResponse_httpStatus :: Lens' DescribeDataSourcesResponse Int
Creating a Request
data DescribeDataSources Source #
See: newDescribeDataSources
smart constructor.
DescribeDataSources' | |
|
Instances
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: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: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: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:ne:DescribeDataSources'
, describeDataSources_ne
- The not equal to operator. The DataSource
results will have
FilterVariable
values not equal to the value specified with NE
.
$sel:nextToken:DescribeDataSources'
, describeDataSources_nextToken
- The ID of the page in the paginated results.
$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
.
$sel:limit:DescribeDataSources'
, describeDataSources_limit
- The maximum number of DataSource
to include in the result.
$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:filterVariable:DescribeDataSources'
, describeDataSources_filterVariable
- Use one of the following variables to filter a list of DataSource
:
CreatedAt
- Sets the search criteria toDataSource
creation dates.Status
- Sets the search criteria toDataSource
statuses.Name
- Sets the search criteria to the contents ofDataSource
Name
.DataUri
- Sets the search criteria to the URI of data files used to create theDataSource
. 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 theDataSource
creation.
$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
.
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_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_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_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_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_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
.
describeDataSources_limit :: Lens' DescribeDataSources (Maybe Natural) Source #
The maximum number of DataSource
to include in the result.
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_filterVariable :: Lens' DescribeDataSources (Maybe DataSourceFilterVariable) Source #
Use one of the following variables to filter a list of DataSource
:
CreatedAt
- Sets the search criteria toDataSource
creation dates.Status
- Sets the search criteria toDataSource
statuses.Name
- Sets the search criteria to the contents ofDataSource
Name
.DataUri
- Sets the search criteria to the URI of data files used to create theDataSource
. 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 theDataSource
creation.
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
.
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.
DescribeDataSourcesResponse' | |
|
Instances
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:
$sel:results:DescribeDataSourcesResponse'
, describeDataSourcesResponse_results
- A list of DataSource
that meet the search criteria.
$sel:nextToken:DescribeDataSources'
, describeDataSourcesResponse_nextToken
- An ID of the next page in the paginated results that indicates at least
one more page follows.
$sel:httpStatus:DescribeDataSourcesResponse'
, describeDataSourcesResponse_httpStatus
- The response's http status code.
Response Lenses
describeDataSourcesResponse_results :: Lens' DescribeDataSourcesResponse (Maybe [DataSource]) Source #
A list of DataSource
that meet the search criteria.
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_httpStatus :: Lens' DescribeDataSourcesResponse Int Source #
The response's http status code.