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.SearchAssociatedTranscripts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Search for associated transcripts that meet the specified criteria.

Synopsis

Creating a Request

data SearchAssociatedTranscripts Source #

See: newSearchAssociatedTranscripts smart constructor.

Constructors

SearchAssociatedTranscripts'

Fields

maxResults :: Maybe Natural
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.
nextIndex :: Maybe Natural
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.
searchOrder :: Maybe SearchOrder
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
botId :: Text
The unique identifier of the bot associated with the transcripts that you are searching.
botVersion :: Text
The version of the bot containing the transcripts that you are searching.
localeId :: Text
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
botRecommendationId :: Text
The unique identifier of the bot recommendation associated with the transcripts to search.
filters :: NonEmpty AssociatedTranscriptFilter
A list of filter objects.

Instances

Instances details

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

newSearchAssociatedTranscripts Source #

Arguments

:: Text	`SearchAssociatedTranscripts`
-> Text	`SearchAssociatedTranscripts`
-> Text	`SearchAssociatedTranscripts`
-> Text	`SearchAssociatedTranscripts`
-> NonEmpty AssociatedTranscriptFilter	`$sel:filters:SearchAssociatedTranscripts'`
-> SearchAssociatedTranscripts

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.

Constructors

SearchAssociatedTranscriptsResponse'

Fields

associatedTranscripts :: Maybe [AssociatedTranscript]
The object that contains the associated transcript that meet the criteria you specified.
botId :: Maybe Text
The unique identifier of the bot associated with the transcripts that you are searching.
botRecommendationId :: Maybe Text
The unique identifier of the bot recommendation associated with the transcripts to search.
botVersion :: Maybe Text
The version of the bot containing the transcripts that you are searching.
localeId :: Maybe Text
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
nextIndex :: Maybe Natural
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.
totalResults :: Maybe Natural
The total number of transcripts returned by the search.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newSearchAssociatedTranscriptsResponse Source #

Arguments

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

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.