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.ConnectCases.SearchCases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

This operation returns paginated results.

Synopsis

data SearchCases = SearchCases' {
- fields :: Maybe [FieldIdentifier]
- filter' :: Maybe CaseFilter
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- searchTerm :: Maybe Text
- sorts :: Maybe [Sort]
- domainId :: Text
}
newSearchCases :: Text -> SearchCases
searchCases_fields :: Lens' SearchCases (Maybe [FieldIdentifier])
searchCases_filter :: Lens' SearchCases (Maybe CaseFilter)
searchCases_maxResults :: Lens' SearchCases (Maybe Natural)
searchCases_nextToken :: Lens' SearchCases (Maybe Text)
searchCases_searchTerm :: Lens' SearchCases (Maybe Text)
searchCases_sorts :: Lens' SearchCases (Maybe [Sort])
searchCases_domainId :: Lens' SearchCases Text
data SearchCasesResponse = SearchCasesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- cases :: [SearchCasesResponseItem]
}
newSearchCasesResponse :: Int -> SearchCasesResponse
searchCasesResponse_nextToken :: Lens' SearchCasesResponse (Maybe Text)
searchCasesResponse_httpStatus :: Lens' SearchCasesResponse Int
searchCasesResponse_cases :: Lens' SearchCasesResponse [SearchCasesResponseItem]

Creating a Request

data SearchCases Source #

See: newSearchCases smart constructor.

Constructors

SearchCases'

Fields

fields :: Maybe [FieldIdentifier]
The list of field identifiers to be returned as part of the response.
filter' :: Maybe CaseFilter
A list of filter objects.
maxResults :: Maybe Natural
The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
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.
searchTerm :: Maybe Text
A word or phrase used to perform a quick search.
sorts :: Maybe [Sort]
A list of sorts where each sort specifies a field and their sort order to be applied to the results.
domainId :: Text
The unique identifier of the Cases domain.

Instances

Instances details

ToJSON SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods toJSON :: SearchCases -> Value # toEncoding :: SearchCases -> Encoding # toJSONList :: [SearchCases] -> Value # toEncodingList :: [SearchCases] -> Encoding #
ToHeaders SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods toHeaders :: SearchCases -> [Header] #
ToPath SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods toPath :: SearchCases -> ByteString #
ToQuery SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods toQuery :: SearchCases -> QueryString #
AWSPager SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods page :: SearchCases -> AWSResponse SearchCases -> Maybe SearchCases #
AWSRequest SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Associated Types type AWSResponse SearchCases # Methods request :: (Service -> Service) -> SearchCases -> Request SearchCases # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchCases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchCases))) #
Generic SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Associated Types type Rep SearchCases :: Type -> Type # Methods from :: SearchCases -> Rep SearchCases x # to :: Rep SearchCases x -> SearchCases #
Read SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods readsPrec :: Int -> ReadS SearchCases # readList :: ReadS [SearchCases] # readPrec :: ReadPrec SearchCases # readListPrec :: ReadPrec [SearchCases] #
Show SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods showsPrec :: Int -> SearchCases -> ShowS # show :: SearchCases -> String # showList :: [SearchCases] -> ShowS #
NFData SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods rnf :: SearchCases -> () #
Eq SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods (==) :: SearchCases -> SearchCases -> Bool # (/=) :: SearchCases -> SearchCases -> Bool #
Hashable SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases Methods hashWithSalt :: Int -> SearchCases -> Int # hash :: SearchCases -> Int #
type AWSResponse SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases type AWSResponse SearchCases = SearchCasesResponse
type Rep SearchCases Source #
Instance details Defined in Amazonka.ConnectCases.SearchCases type Rep SearchCases = D1 ('MetaData "SearchCases" "Amazonka.ConnectCases.SearchCases" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "SearchCases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FieldIdentifier])) :: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CaseFilter)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "searchTerm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sorts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Sort])) :: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSearchCases Source #

Arguments

:: Text	`SearchCases`
-> SearchCases

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

SearchCases, searchCases_fields - The list of field identifiers to be returned as part of the response.

$sel:filter':SearchCases', searchCases_filter - A list of filter objects.

$sel:maxResults:SearchCases', searchCases_maxResults - The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

SearchCases, searchCases_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.

$sel:searchTerm:SearchCases', searchCases_searchTerm - A word or phrase used to perform a quick search.

$sel:sorts:SearchCases', searchCases_sorts - A list of sorts where each sort specifies a field and their sort order to be applied to the results.

SearchCases, searchCases_domainId - The unique identifier of the Cases domain.

Request Lenses

searchCases_fields :: Lens' SearchCases (Maybe [FieldIdentifier]) Source #

The list of field identifiers to be returned as part of the response.

searchCases_filter :: Lens' SearchCases (Maybe CaseFilter) Source #

A list of filter objects.

searchCases_maxResults :: Lens' SearchCases (Maybe Natural) Source #

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

searchCases_nextToken :: Lens' SearchCases (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.

searchCases_searchTerm :: Lens' SearchCases (Maybe Text) Source #

A word or phrase used to perform a quick search.

searchCases_sorts :: Lens' SearchCases (Maybe [Sort]) Source #

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

searchCases_domainId :: Lens' SearchCases Text Source #

The unique identifier of the Cases domain.

Destructuring the Response

data SearchCasesResponse Source #

See: newSearchCasesResponse smart constructor.

Constructors

SearchCasesResponse'
Fields nextToken :: Maybe Text The token for the next set of results. This is null if there are no more results to return. httpStatus :: Int The response's http status code. cases :: [SearchCasesResponseItem] A list of case documents where each case contains the properties `CaseId` and `Fields` where each field is a complex union structure.

Instances

Instances details

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

newSearchCasesResponse Source #

Arguments

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

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

SearchCases, searchCasesResponse_nextToken - The token for the next set of results. This is null if there are no more results to return.

$sel:httpStatus:SearchCasesResponse', searchCasesResponse_httpStatus - The response's http status code.

$sel:cases:SearchCasesResponse', searchCasesResponse_cases - A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.

Response Lenses

searchCasesResponse_nextToken :: Lens' SearchCasesResponse (Maybe Text) Source #

The token for the next set of results. This is null if there are no more results to return.

searchCasesResponse_httpStatus :: Lens' SearchCasesResponse Int Source #

The response's http status code.

searchCasesResponse_cases :: Lens' SearchCasesResponse [SearchCasesResponseItem] Source #

A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.