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 |
Search for associated transcripts that meet the specified criteria.
Synopsis
- data SearchAssociatedTranscripts = SearchAssociatedTranscripts' {}
- newSearchAssociatedTranscripts :: Text -> Text -> Text -> Text -> NonEmpty AssociatedTranscriptFilter -> SearchAssociatedTranscripts
- searchAssociatedTranscripts_maxResults :: Lens' SearchAssociatedTranscripts (Maybe Natural)
- searchAssociatedTranscripts_nextIndex :: Lens' SearchAssociatedTranscripts (Maybe Natural)
- searchAssociatedTranscripts_searchOrder :: Lens' SearchAssociatedTranscripts (Maybe SearchOrder)
- searchAssociatedTranscripts_botId :: Lens' SearchAssociatedTranscripts Text
- searchAssociatedTranscripts_botVersion :: Lens' SearchAssociatedTranscripts Text
- searchAssociatedTranscripts_localeId :: Lens' SearchAssociatedTranscripts Text
- searchAssociatedTranscripts_botRecommendationId :: Lens' SearchAssociatedTranscripts Text
- searchAssociatedTranscripts_filters :: Lens' SearchAssociatedTranscripts (NonEmpty AssociatedTranscriptFilter)
- data SearchAssociatedTranscriptsResponse = SearchAssociatedTranscriptsResponse' {}
- newSearchAssociatedTranscriptsResponse :: Int -> SearchAssociatedTranscriptsResponse
- searchAssociatedTranscriptsResponse_associatedTranscripts :: Lens' SearchAssociatedTranscriptsResponse (Maybe [AssociatedTranscript])
- searchAssociatedTranscriptsResponse_botId :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text)
- searchAssociatedTranscriptsResponse_botRecommendationId :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text)
- searchAssociatedTranscriptsResponse_botVersion :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text)
- searchAssociatedTranscriptsResponse_localeId :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text)
- searchAssociatedTranscriptsResponse_nextIndex :: Lens' SearchAssociatedTranscriptsResponse (Maybe Natural)
- searchAssociatedTranscriptsResponse_totalResults :: Lens' SearchAssociatedTranscriptsResponse (Maybe Natural)
- searchAssociatedTranscriptsResponse_httpStatus :: Lens' SearchAssociatedTranscriptsResponse Int
Creating a Request
data SearchAssociatedTranscripts Source #
See: newSearchAssociatedTranscripts
smart constructor.
SearchAssociatedTranscripts' | |
|
Instances
newSearchAssociatedTranscripts Source #
Create a value of SearchAssociatedTranscripts
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:maxResults:SearchAssociatedTranscripts'
, searchAssociatedTranscripts_maxResults
- The maximum number of bot recommendations 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.
SearchAssociatedTranscripts
, searchAssociatedTranscripts_nextIndex
- If the response from the SearchAssociatedTranscriptsRequest operation
contains more results than specified in the maxResults parameter, an
index is returned in the response. Use that index in the nextIndex
parameter to return the next page of results.
$sel:searchOrder:SearchAssociatedTranscripts'
, searchAssociatedTranscripts_searchOrder
- How SearchResults are ordered. Valid values are Ascending or Descending.
The default is Descending.
SearchAssociatedTranscripts
, searchAssociatedTranscripts_botId
- The unique identifier of the bot associated with the transcripts that
you are searching.
SearchAssociatedTranscripts
, searchAssociatedTranscripts_botVersion
- The version of the bot containing the transcripts that you are
searching.
SearchAssociatedTranscripts
, searchAssociatedTranscripts_localeId
- The identifier of the language and locale of the transcripts to search.
The string must match one of the supported locales. For more
information, see
Supported languages
SearchAssociatedTranscripts
, searchAssociatedTranscripts_botRecommendationId
- The unique identifier of the bot recommendation associated with the
transcripts to search.
$sel:filters:SearchAssociatedTranscripts'
, searchAssociatedTranscripts_filters
- A list of filter objects.
Request Lenses
searchAssociatedTranscripts_maxResults :: Lens' SearchAssociatedTranscripts (Maybe Natural) Source #
The maximum number of bot recommendations 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.
searchAssociatedTranscripts_nextIndex :: Lens' SearchAssociatedTranscripts (Maybe Natural) Source #
If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.
searchAssociatedTranscripts_searchOrder :: Lens' SearchAssociatedTranscripts (Maybe SearchOrder) Source #
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
searchAssociatedTranscripts_botId :: Lens' SearchAssociatedTranscripts Text Source #
The unique identifier of the bot associated with the transcripts that you are searching.
searchAssociatedTranscripts_botVersion :: Lens' SearchAssociatedTranscripts Text Source #
The version of the bot containing the transcripts that you are searching.
searchAssociatedTranscripts_localeId :: Lens' SearchAssociatedTranscripts Text Source #
The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages
searchAssociatedTranscripts_botRecommendationId :: Lens' SearchAssociatedTranscripts Text Source #
The unique identifier of the bot recommendation associated with the transcripts to search.
searchAssociatedTranscripts_filters :: Lens' SearchAssociatedTranscripts (NonEmpty AssociatedTranscriptFilter) Source #
A list of filter objects.
Destructuring the Response
data SearchAssociatedTranscriptsResponse Source #
See: newSearchAssociatedTranscriptsResponse
smart constructor.
SearchAssociatedTranscriptsResponse' | |
|
Instances
newSearchAssociatedTranscriptsResponse Source #
Create a value of SearchAssociatedTranscriptsResponse
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:associatedTranscripts:SearchAssociatedTranscriptsResponse'
, searchAssociatedTranscriptsResponse_associatedTranscripts
- The object that contains the associated transcript that meet the
criteria you specified.
SearchAssociatedTranscripts
, searchAssociatedTranscriptsResponse_botId
- The unique identifier of the bot associated with the transcripts that
you are searching.
SearchAssociatedTranscripts
, searchAssociatedTranscriptsResponse_botRecommendationId
- The unique identifier of the bot recommendation associated with the
transcripts to search.
SearchAssociatedTranscripts
, searchAssociatedTranscriptsResponse_botVersion
- The version of the bot containing the transcripts that you are
searching.
SearchAssociatedTranscripts
, searchAssociatedTranscriptsResponse_localeId
- The identifier of the language and locale of the transcripts to search.
The string must match one of the supported locales. For more
information, see
Supported languages
SearchAssociatedTranscripts
, searchAssociatedTranscriptsResponse_nextIndex
- A index that indicates whether there are more results to return in a
response to the SearchAssociatedTranscripts operation. If the nextIndex
field is present, you send the contents as the nextIndex parameter of a
SearchAssociatedTranscriptsRequest operation to get the next page of
results.
$sel:totalResults:SearchAssociatedTranscriptsResponse'
, searchAssociatedTranscriptsResponse_totalResults
- The total number of transcripts returned by the search.
$sel:httpStatus:SearchAssociatedTranscriptsResponse'
, searchAssociatedTranscriptsResponse_httpStatus
- The response's http status code.
Response Lenses
searchAssociatedTranscriptsResponse_associatedTranscripts :: Lens' SearchAssociatedTranscriptsResponse (Maybe [AssociatedTranscript]) Source #
The object that contains the associated transcript that meet the criteria you specified.
searchAssociatedTranscriptsResponse_botId :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text) Source #
The unique identifier of the bot associated with the transcripts that you are searching.
searchAssociatedTranscriptsResponse_botRecommendationId :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text) Source #
The unique identifier of the bot recommendation associated with the transcripts to search.
searchAssociatedTranscriptsResponse_botVersion :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text) Source #
The version of the bot containing the transcripts that you are searching.
searchAssociatedTranscriptsResponse_localeId :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text) Source #
The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages
searchAssociatedTranscriptsResponse_nextIndex :: Lens' SearchAssociatedTranscriptsResponse (Maybe Natural) Source #
A index that indicates whether there are more results to return in a response to the SearchAssociatedTranscripts operation. If the nextIndex field is present, you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest operation to get the next page of results.
searchAssociatedTranscriptsResponse_totalResults :: Lens' SearchAssociatedTranscriptsResponse (Maybe Natural) Source #
The total number of transcripts returned by the search.
searchAssociatedTranscriptsResponse_httpStatus :: Lens' SearchAssociatedTranscriptsResponse Int Source #
The response's http status code.