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

Amazonka.LexV2Models.ListExports

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

Synopsis

data ListExports = ListExports' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- filters :: Maybe (NonEmpty ExportFilter)
- localeId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe ExportSortBy
}
newListExports :: ListExports
listExports_botId :: Lens' ListExports (Maybe Text)
listExports_botVersion :: Lens' ListExports (Maybe Text)
listExports_filters :: Lens' ListExports (Maybe (NonEmpty ExportFilter))
listExports_localeId :: Lens' ListExports (Maybe Text)
listExports_maxResults :: Lens' ListExports (Maybe Natural)
listExports_nextToken :: Lens' ListExports (Maybe Text)
listExports_sortBy :: Lens' ListExports (Maybe ExportSortBy)
data ListExportsResponse = ListExportsResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- exportSummaries :: Maybe [ExportSummary]
- localeId :: Maybe Text
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListExportsResponse :: Int -> ListExportsResponse
listExportsResponse_botId :: Lens' ListExportsResponse (Maybe Text)
listExportsResponse_botVersion :: Lens' ListExportsResponse (Maybe Text)
listExportsResponse_exportSummaries :: Lens' ListExportsResponse (Maybe [ExportSummary])
listExportsResponse_localeId :: Lens' ListExportsResponse (Maybe Text)
listExportsResponse_nextToken :: Lens' ListExportsResponse (Maybe Text)
listExportsResponse_httpStatus :: Lens' ListExportsResponse Int

Creating a Request

data ListExports Source #

See: newListExports smart constructor.

Constructors

ListExports'

Fields

botId :: Maybe Text
The unique identifier that Amazon Lex assigned to the bot.
botVersion :: Maybe Text
The version of the bot to list exports for.
filters :: Maybe (NonEmpty ExportFilter)
Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
localeId :: Maybe Text
Specifies the resources that should be exported. If you don't specify a resource type in the filters parameter, both bot locales and custom vocabularies are exported.
maxResults :: Maybe Natural
The maximum number of exports 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.
nextToken :: Maybe Text
If the response from the ListExports operation contains more results that specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListExports request to return the next page of results. For a complete set of results, call the ListExports operation until the nextToken returned in the response is null.
sortBy :: Maybe ExportSortBy
Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

Instances

Instances details

ToJSON ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods toJSON :: ListExports -> Value # toEncoding :: ListExports -> Encoding # toJSONList :: [ListExports] -> Value # toEncodingList :: [ListExports] -> Encoding #
ToHeaders ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods toHeaders :: ListExports -> [Header] #
ToPath ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods toPath :: ListExports -> ByteString #
ToQuery ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods toQuery :: ListExports -> QueryString #
AWSRequest ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Associated Types type AWSResponse ListExports # Methods request :: (Service -> Service) -> ListExports -> Request ListExports # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListExports -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListExports))) #
Generic ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Associated Types type Rep ListExports :: Type -> Type # Methods from :: ListExports -> Rep ListExports x # to :: Rep ListExports x -> ListExports #
Read ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods readsPrec :: Int -> ReadS ListExports # readList :: ReadS [ListExports] # readPrec :: ReadPrec ListExports # readListPrec :: ReadPrec [ListExports] #
Show ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods showsPrec :: Int -> ListExports -> ShowS # show :: ListExports -> String # showList :: [ListExports] -> ShowS #
NFData ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods rnf :: ListExports -> () #
Eq ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods (==) :: ListExports -> ListExports -> Bool # (/=) :: ListExports -> ListExports -> Bool #
Hashable ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods hashWithSalt :: Int -> ListExports -> Int # hash :: ListExports -> Int #
type AWSResponse ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports type AWSResponse ListExports = ListExportsResponse
type Rep ListExports Source #
Instance details Defined in Amazonka.LexV2Models.ListExports type Rep ListExports = D1 ('MetaData "ListExports" "Amazonka.LexV2Models.ListExports" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListExports'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExportFilter))))) :: ((S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportSortBy))))))

newListExports :: ListExports Source #

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

ListExports, listExports_botId - The unique identifier that Amazon Lex assigned to the bot.

ListExports, listExports_botVersion - The version of the bot to list exports for.

$sel:filters:ListExports', listExports_filters - Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

ListExports, listExports_localeId - Specifies the resources that should be exported. If you don't specify a resource type in the filters parameter, both bot locales and custom vocabularies are exported.

$sel:maxResults:ListExports', listExports_maxResults - The maximum number of exports 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.

ListExports, listExports_nextToken - If the response from the ListExports operation contains more results that specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListExports request to return the next page of results. For a complete set of results, call the ListExports operation until the nextToken returned in the response is null.

$sel:sortBy:ListExports', listExports_sortBy - Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

Request Lenses

listExports_botId :: Lens' ListExports (Maybe Text) Source #

The unique identifier that Amazon Lex assigned to the bot.

listExports_botVersion :: Lens' ListExports (Maybe Text) Source #

The version of the bot to list exports for.

listExports_filters :: Lens' ListExports (Maybe (NonEmpty ExportFilter)) Source #

Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

listExports_localeId :: Lens' ListExports (Maybe Text) Source #

Specifies the resources that should be exported. If you don't specify a resource type in the filters parameter, both bot locales and custom vocabularies are exported.

listExports_maxResults :: Lens' ListExports (Maybe Natural) Source #

The maximum number of exports 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.

listExports_nextToken :: Lens' ListExports (Maybe Text) Source #

If the response from the ListExports operation contains more results that specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListExports request to return the next page of results. For a complete set of results, call the ListExports operation until the nextToken returned in the response is null.

listExports_sortBy :: Lens' ListExports (Maybe ExportSortBy) Source #

Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

Destructuring the Response

data ListExportsResponse Source #

See: newListExportsResponse smart constructor.

Constructors

ListExportsResponse'

Fields

botId :: Maybe Text
The unique identifier assigned to the bot by Amazon Lex.
botVersion :: Maybe Text
The version of the bot that was exported.
exportSummaries :: Maybe [ExportSummary]
Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter. If there are more exports available, the nextToken field contains a token to get the next page of results.
localeId :: Maybe Text
The locale specified in the request.
nextToken :: Maybe Text
A token that indicates whether there are more results to return in a response to the ListExports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListExports operation request to get the next page of results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListExportsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Associated Types type Rep ListExportsResponse :: Type -> Type # Methods from :: ListExportsResponse -> Rep ListExportsResponse x # to :: Rep ListExportsResponse x -> ListExportsResponse #
Read ListExportsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods readsPrec :: Int -> ReadS ListExportsResponse # readList :: ReadS [ListExportsResponse] # readPrec :: ReadPrec ListExportsResponse # readListPrec :: ReadPrec [ListExportsResponse] #
Show ListExportsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods showsPrec :: Int -> ListExportsResponse -> ShowS # show :: ListExportsResponse -> String # showList :: [ListExportsResponse] -> ShowS #
NFData ListExportsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods rnf :: ListExportsResponse -> () #
Eq ListExportsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListExports Methods (==) :: ListExportsResponse -> ListExportsResponse -> Bool # (/=) :: ListExportsResponse -> ListExportsResponse -> Bool #
type Rep ListExportsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListExports type Rep ListExportsResponse = D1 ('MetaData "ListExportsResponse" "Amazonka.LexV2Models.ListExports" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListExportsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "exportSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExportSummary])))) :: (S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListExportsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListExportsResponse'`
-> ListExportsResponse

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

ListExports, listExportsResponse_botId - The unique identifier assigned to the bot by Amazon Lex.

ListExports, listExportsResponse_botVersion - The version of the bot that was exported.

$sel:exportSummaries:ListExportsResponse', listExportsResponse_exportSummaries - Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter. If there are more exports available, the nextToken field contains a token to get the next page of results.

ListExports, listExportsResponse_localeId - The locale specified in the request.

ListExports, listExportsResponse_nextToken - A token that indicates whether there are more results to return in a response to the ListExports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListExports operation request to get the next page of results.

$sel:httpStatus:ListExportsResponse', listExportsResponse_httpStatus - The response's http status code.

Response Lenses

listExportsResponse_botId :: Lens' ListExportsResponse (Maybe Text) Source #

The unique identifier assigned to the bot by Amazon Lex.

listExportsResponse_botVersion :: Lens' ListExportsResponse (Maybe Text) Source #

The version of the bot that was exported.

listExportsResponse_exportSummaries :: Lens' ListExportsResponse (Maybe [ExportSummary]) Source #

Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter. If there are more exports available, the nextToken field contains a token to get the next page of results.

listExportsResponse_localeId :: Lens' ListExportsResponse (Maybe Text) Source #

The locale specified in the request.

listExportsResponse_nextToken :: Lens' ListExportsResponse (Maybe Text) Source #

A token that indicates whether there are more results to return in a response to the ListExports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListExports operation request to get the next page of results.

listExportsResponse_httpStatus :: Lens' ListExportsResponse Int Source #

The response's http status code.