amazonka-lex-runtime-2.0: gen/Amazonka/LexRuntime.hs

{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- |
-- Module      : Amazonka.LexRuntime
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Derived from API version @2016-11-28@ of the AWS service descriptions, licensed under Apache 2.0.
--
-- Amazon Lex provides both build and runtime endpoints. Each endpoint
-- provides a set of operations (API). Your conversational bot uses the
-- runtime API to understand user utterances (user input text or voice).
-- For example, suppose a user says \"I want pizza\", your bot sends this
-- input to Amazon Lex using the runtime API. Amazon Lex recognizes that
-- the user request is for the OrderPizza intent (one of the intents
-- defined in the bot). Then Amazon Lex engages in user conversation on
-- behalf of the bot to elicit required information (slot values, such as
-- pizza size and crust type), and then performs fulfillment activity (that
-- you configured when you created the bot). You use the build-time API to
-- create and manage your Amazon Lex bot. For a list of build-time
-- operations, see the build-time API, .
module Amazonka.LexRuntime
  ( -- * Service Configuration
    defaultService,

    -- * Errors
    -- $errors

    -- ** BadGatewayException
    _BadGatewayException,

    -- ** BadRequestException
    _BadRequestException,

    -- ** ConflictException
    _ConflictException,

    -- ** DependencyFailedException
    _DependencyFailedException,

    -- ** InternalFailureException
    _InternalFailureException,

    -- ** LimitExceededException
    _LimitExceededException,

    -- ** LoopDetectedException
    _LoopDetectedException,

    -- ** NotAcceptableException
    _NotAcceptableException,

    -- ** NotFoundException
    _NotFoundException,

    -- ** RequestTimeoutException
    _RequestTimeoutException,

    -- ** UnsupportedMediaTypeException
    _UnsupportedMediaTypeException,

    -- * Waiters
    -- $waiters

    -- * Operations
    -- $operations

    -- ** DeleteSession
    DeleteSession (DeleteSession'),
    newDeleteSession,
    DeleteSessionResponse (DeleteSessionResponse'),
    newDeleteSessionResponse,

    -- ** GetSession
    GetSession (GetSession'),
    newGetSession,
    GetSessionResponse (GetSessionResponse'),
    newGetSessionResponse,

    -- ** PostContent
    PostContent (PostContent'),
    newPostContent,
    PostContentResponse (PostContentResponse'),
    newPostContentResponse,

    -- ** PostText
    PostText (PostText'),
    newPostText,
    PostTextResponse (PostTextResponse'),
    newPostTextResponse,

    -- ** PutSession
    PutSession (PutSession'),
    newPutSession,
    PutSessionResponse (PutSessionResponse'),
    newPutSessionResponse,

    -- * Types

    -- ** ConfirmationStatus
    ConfirmationStatus (..),

    -- ** ContentType
    ContentType (..),

    -- ** DialogActionType
    DialogActionType (..),

    -- ** DialogState
    DialogState (..),

    -- ** FulfillmentState
    FulfillmentState (..),

    -- ** MessageFormatType
    MessageFormatType (..),

    -- ** ActiveContext
    ActiveContext (ActiveContext'),
    newActiveContext,

    -- ** ActiveContextTimeToLive
    ActiveContextTimeToLive (ActiveContextTimeToLive'),
    newActiveContextTimeToLive,

    -- ** Button
    Button (Button'),
    newButton,

    -- ** DialogAction
    DialogAction (DialogAction'),
    newDialogAction,

    -- ** GenericAttachment
    GenericAttachment (GenericAttachment'),
    newGenericAttachment,

    -- ** IntentConfidence
    IntentConfidence (IntentConfidence'),
    newIntentConfidence,

    -- ** IntentSummary
    IntentSummary (IntentSummary'),
    newIntentSummary,

    -- ** PredictedIntent
    PredictedIntent (PredictedIntent'),
    newPredictedIntent,

    -- ** ResponseCard
    ResponseCard (ResponseCard'),
    newResponseCard,

    -- ** SentimentResponse
    SentimentResponse (SentimentResponse'),
    newSentimentResponse,
  )
where

import Amazonka.LexRuntime.DeleteSession
import Amazonka.LexRuntime.GetSession
import Amazonka.LexRuntime.Lens
import Amazonka.LexRuntime.PostContent
import Amazonka.LexRuntime.PostText
import Amazonka.LexRuntime.PutSession
import Amazonka.LexRuntime.Types
import Amazonka.LexRuntime.Waiters

-- $errors
-- Error matchers are designed for use with the functions provided by
-- <http://hackage.haskell.org/package/lens/docs/Control-Exception-Lens.html Control.Exception.Lens>.
-- This allows catching (and rethrowing) service specific errors returned
-- by 'LexRuntime'.

-- $operations
-- Some AWS operations return results that are incomplete and require subsequent
-- requests in order to obtain the entire result set. The process of sending
-- subsequent requests to continue where a previous request left off is called
-- pagination. For example, the 'ListObjects' operation of Amazon S3 returns up to
-- 1000 objects at a time, and you must send subsequent requests with the
-- appropriate Marker in order to retrieve the next page of results.
--
-- Operations that have an 'AWSPager' instance can transparently perform subsequent
-- requests, correctly setting Markers and other request facets to iterate through
-- the entire result set of a truncated API operation. Operations which support
-- this have an additional note in the documentation.
--
-- Many operations have the ability to filter results on the server side. See the
-- individual operation parameters for details.

-- $waiters
-- Waiters poll by repeatedly sending a request until some remote success condition
-- configured by the 'Wait' specification is fulfilled. The 'Wait' specification
-- determines how many attempts should be made, in addition to delay and retry strategies.