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.Connect.ListPrompts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about the prompts for the specified Amazon Connect instance.

This operation returns paginated results.

Creating a Request

data ListPrompts Source #

See: newListPrompts smart constructor.

Constructors

ListPrompts'
Fields maxResults :: Maybe Natural The maximum number of results to return per page. The default MaxResult size is 100. nextToken :: Maybe Text The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. instanceId :: Text The identifier of the Amazon Connect instance.

Instances

Instances details

ToHeaders ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods toHeaders :: ListPrompts -> [Header] #
ToPath ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods toPath :: ListPrompts -> ByteString #
ToQuery ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods toQuery :: ListPrompts -> QueryString #
AWSPager ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods page :: ListPrompts -> AWSResponse ListPrompts -> Maybe ListPrompts #
AWSRequest ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Associated Types type AWSResponse ListPrompts # Methods request :: (Service -> Service) -> ListPrompts -> Request ListPrompts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPrompts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPrompts))) #
Generic ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Associated Types type Rep ListPrompts :: Type -> Type # Methods from :: ListPrompts -> Rep ListPrompts x # to :: Rep ListPrompts x -> ListPrompts #
Read ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods readsPrec :: Int -> ReadS ListPrompts # readList :: ReadS [ListPrompts] # readPrec :: ReadPrec ListPrompts # readListPrec :: ReadPrec [ListPrompts] #
Show ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods showsPrec :: Int -> ListPrompts -> ShowS # show :: ListPrompts -> String # showList :: [ListPrompts] -> ShowS #
NFData ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods rnf :: ListPrompts -> () #
Eq ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods (==) :: ListPrompts -> ListPrompts -> Bool # (/=) :: ListPrompts -> ListPrompts -> Bool #
Hashable ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods hashWithSalt :: Int -> ListPrompts -> Int # hash :: ListPrompts -> Int #
type AWSResponse ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts type AWSResponse ListPrompts = ListPromptsResponse
type Rep ListPrompts Source #
Instance details Defined in Amazonka.Connect.ListPrompts type Rep ListPrompts = D1 ('MetaData "ListPrompts" "Amazonka.Connect.ListPrompts" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListPrompts'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListPrompts Source #

Arguments

:: Text	`ListPrompts`
-> ListPrompts

Create a value of ListPrompts 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:ListPrompts', listPrompts_maxResults - The maximum number of results to return per page. The default MaxResult size is 100.

ListPrompts, listPrompts_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ListPrompts, listPrompts_instanceId - The identifier of the Amazon Connect instance.

Request Lenses

listPrompts_maxResults :: Lens' ListPrompts (Maybe Natural) Source #

The maximum number of results to return per page. The default MaxResult size is 100.

listPrompts_nextToken :: Lens' ListPrompts (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listPrompts_instanceId :: Lens' ListPrompts Text Source #

The identifier of the Amazon Connect instance.

Destructuring the Response

data ListPromptsResponse Source #

See: newListPromptsResponse smart constructor.

Constructors

ListPromptsResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. promptSummaryList :: Maybe [PromptSummary] Information about the prompts. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListPromptsResponse Source #
Instance details Defined in Amazonka.Connect.ListPrompts Associated Types type Rep ListPromptsResponse :: Type -> Type # Methods from :: ListPromptsResponse -> Rep ListPromptsResponse x # to :: Rep ListPromptsResponse x -> ListPromptsResponse #
Read ListPromptsResponse Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods readsPrec :: Int -> ReadS ListPromptsResponse # readList :: ReadS [ListPromptsResponse] # readPrec :: ReadPrec ListPromptsResponse # readListPrec :: ReadPrec [ListPromptsResponse] #
Show ListPromptsResponse Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods showsPrec :: Int -> ListPromptsResponse -> ShowS # show :: ListPromptsResponse -> String # showList :: [ListPromptsResponse] -> ShowS #
NFData ListPromptsResponse Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods rnf :: ListPromptsResponse -> () #
Eq ListPromptsResponse Source #
Instance details Defined in Amazonka.Connect.ListPrompts Methods (==) :: ListPromptsResponse -> ListPromptsResponse -> Bool # (/=) :: ListPromptsResponse -> ListPromptsResponse -> Bool #
type Rep ListPromptsResponse Source #
Instance details Defined in Amazonka.Connect.ListPrompts type Rep ListPromptsResponse = D1 ('MetaData "ListPromptsResponse" "Amazonka.Connect.ListPrompts" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListPromptsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "promptSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PromptSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPromptsResponse Source #

Arguments

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

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

ListPrompts, listPromptsResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:promptSummaryList:ListPromptsResponse', listPromptsResponse_promptSummaryList - Information about the prompts.

$sel:httpStatus:ListPromptsResponse', listPromptsResponse_httpStatus - The response's http status code.

Response Lenses

listPromptsResponse_nextToken :: Lens' ListPromptsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listPromptsResponse_promptSummaryList :: Lens' ListPromptsResponse (Maybe [PromptSummary]) Source #

Information about the prompts.

listPromptsResponse_httpStatus :: Lens' ListPromptsResponse Int Source #

The response's http status code.