Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.
Synopsis
- data ListImports = ListImports' {}
- newListImports :: ListImports
- listImports_botId :: Lens' ListImports (Maybe Text)
- listImports_botVersion :: Lens' ListImports (Maybe Text)
- listImports_filters :: Lens' ListImports (Maybe (NonEmpty ImportFilter))
- listImports_localeId :: Lens' ListImports (Maybe Text)
- listImports_maxResults :: Lens' ListImports (Maybe Natural)
- listImports_nextToken :: Lens' ListImports (Maybe Text)
- listImports_sortBy :: Lens' ListImports (Maybe ImportSortBy)
- data ListImportsResponse = ListImportsResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- importSummaries :: Maybe [ImportSummary]
- localeId :: Maybe Text
- nextToken :: Maybe Text
- httpStatus :: Int
- newListImportsResponse :: Int -> ListImportsResponse
- listImportsResponse_botId :: Lens' ListImportsResponse (Maybe Text)
- listImportsResponse_botVersion :: Lens' ListImportsResponse (Maybe Text)
- listImportsResponse_importSummaries :: Lens' ListImportsResponse (Maybe [ImportSummary])
- listImportsResponse_localeId :: Lens' ListImportsResponse (Maybe Text)
- listImportsResponse_nextToken :: Lens' ListImportsResponse (Maybe Text)
- listImportsResponse_httpStatus :: Lens' ListImportsResponse Int
Creating a Request
data ListImports Source #
See: newListImports
smart constructor.
ListImports' | |
|
Instances
newListImports :: ListImports Source #
Create a value of ListImports
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:
ListImports
, listImports_botId
- The unique identifier that Amazon Lex assigned to the bot.
ListImports
, listImports_botVersion
- The version of the bot to list imports for.
$sel:filters:ListImports'
, listImports_filters
- Provides the specification of a filter used to limit the bots in the
response to only those that match the filter specification. You can only
specify one filter and one string to filter on.
ListImports
, listImports_localeId
- Specifies the locale that should be present in the list. If you don't
specify a resource type in the filters
parameter, the list contains
both bot locales and custom vocabularies.
$sel:maxResults:ListImports'
, listImports_maxResults
- The maximum number of imports to return in each page of results. If
there are fewer results than the max page size, only the actual number
of results are returned.
ListImports
, listImports_nextToken
- If the response from the ListImports
operation contains more results
than specified in the maxResults
parameter, a token is returned in the
response.
Use the returned token in the nextToken
parameter of a ListImports
request to return the next page of results. For a complete set of
results, call the ListImports
operation until the nextToken
returned
in the response is null.
$sel:sortBy:ListImports'
, listImports_sortBy
- Determines the field that the list of imports is sorted by. You can sort
by the LastUpdatedDateTime
field in ascending or descending order.
Request Lenses
listImports_botId :: Lens' ListImports (Maybe Text) Source #
The unique identifier that Amazon Lex assigned to the bot.
listImports_botVersion :: Lens' ListImports (Maybe Text) Source #
The version of the bot to list imports for.
listImports_filters :: Lens' ListImports (Maybe (NonEmpty ImportFilter)) Source #
Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
listImports_localeId :: Lens' ListImports (Maybe Text) Source #
Specifies the locale that should be present in the list. If you don't
specify a resource type in the filters
parameter, the list contains
both bot locales and custom vocabularies.
listImports_maxResults :: Lens' ListImports (Maybe Natural) Source #
The maximum number of imports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
listImports_nextToken :: Lens' ListImports (Maybe Text) Source #
If the response from the ListImports
operation contains more results
than specified in the maxResults
parameter, a token is returned in the
response.
Use the returned token in the nextToken
parameter of a ListImports
request to return the next page of results. For a complete set of
results, call the ListImports
operation until the nextToken
returned
in the response is null.
listImports_sortBy :: Lens' ListImports (Maybe ImportSortBy) Source #
Determines the field that the list of imports is sorted by. You can sort
by the LastUpdatedDateTime
field in ascending or descending order.
Destructuring the Response
data ListImportsResponse Source #
See: newListImportsResponse
smart constructor.
ListImportsResponse' | |
|
Instances
newListImportsResponse Source #
Create a value of ListImportsResponse
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:
ListImports
, listImportsResponse_botId
- The unique identifier assigned by Amazon Lex to the bot.
ListImports
, listImportsResponse_botVersion
- The version of the bot that was imported. It will always be DRAFT
.
$sel:importSummaries:ListImportsResponse'
, listImportsResponse_importSummaries
- Summary information for the imports that meet the filter criteria
specified in the request. The length of the list is specified in the
maxResults
parameter. If there are more imports available, the
nextToken
field contains a token to get the next page of results.
ListImports
, listImportsResponse_localeId
- The locale specified in the request.
ListImports
, listImportsResponse_nextToken
- A token that indicates whether there are more results to return in a
response to the ListImports
operation. If the nextToken
field is
present, you send the contents as the nextToken
parameter of a
ListImports
operation request to get the next page of results.
$sel:httpStatus:ListImportsResponse'
, listImportsResponse_httpStatus
- The response's http status code.
Response Lenses
listImportsResponse_botId :: Lens' ListImportsResponse (Maybe Text) Source #
The unique identifier assigned by Amazon Lex to the bot.
listImportsResponse_botVersion :: Lens' ListImportsResponse (Maybe Text) Source #
The version of the bot that was imported. It will always be DRAFT
.
listImportsResponse_importSummaries :: Lens' ListImportsResponse (Maybe [ImportSummary]) Source #
Summary information for the imports that meet the filter criteria
specified in the request. The length of the list is specified in the
maxResults
parameter. If there are more imports available, the
nextToken
field contains a token to get the next page of results.
listImportsResponse_localeId :: Lens' ListImportsResponse (Maybe Text) Source #
The locale specified in the request.
listImportsResponse_nextToken :: Lens' ListImportsResponse (Maybe Text) Source #
A token that indicates whether there are more results to return in a
response to the ListImports
operation. If the nextToken
field is
present, you send the contents as the nextToken
parameter of a
ListImports
operation request to get the next page of results.
listImportsResponse_httpStatus :: Lens' ListImportsResponse Int Source #
The response's http status code.