Amazonka.ConnectCases.SearchRelatedItems

Searches for related items that are associated with a case.

If no filters are provided, this returns all related items associated with a case.

This operation returns paginated results.

Creating a Request

data SearchRelatedItems

See: newSearchRelatedItems smart constructor.

Constructors

SearchRelatedItems'

Fields

• filters :: Maybe [RelatedItemTypeFilter]

  The list of types of related items and their parameters to use for filtering.

• maxResults :: Maybe Natural

  The maximum number of results to return per page.

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

• caseId :: Text

  A unique identifier of the case.

• domainId :: Text

  The unique identifier of the Cases domain.

Instances

ToJSON SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

toJSON :: SearchRelatedItems -> Value

toEncoding :: SearchRelatedItems -> Encoding

toJSONList :: [SearchRelatedItems] -> Value

toEncodingList :: [SearchRelatedItems] -> Encoding

ToHeaders SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

toHeaders :: SearchRelatedItems -> [Header]

ToPath SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

toPath :: SearchRelatedItems -> ByteString

ToQuery SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

toQuery :: SearchRelatedItems -> QueryString

AWSPager SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

page :: SearchRelatedItems -> AWSResponse SearchRelatedItems -> Maybe SearchRelatedItems

AWSRequest SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Associated Types

type AWSResponse SearchRelatedItems

Methods

request :: (Service -> Service) -> SearchRelatedItems -> Request SearchRelatedItems

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchRelatedItems -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchRelatedItems)))

Generic SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Associated Types

type Rep SearchRelatedItems :: Type -> Type

Methods

from :: SearchRelatedItems -> Rep SearchRelatedItems x

to :: Rep SearchRelatedItems x -> SearchRelatedItems

Read SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

readsPrec :: Int -> ReadS SearchRelatedItems

readList :: ReadS [SearchRelatedItems]

readPrec :: ReadPrec SearchRelatedItems

readListPrec :: ReadPrec [SearchRelatedItems]

Show SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

showsPrec :: Int -> SearchRelatedItems -> ShowS

show :: SearchRelatedItems -> String

showList :: [SearchRelatedItems] -> ShowS

NFData SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

rnf :: SearchRelatedItems -> ()

Eq SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

(==) :: SearchRelatedItems -> SearchRelatedItems -> Bool

(/=) :: SearchRelatedItems -> SearchRelatedItems -> Bool

Hashable SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

hashWithSalt :: Int -> SearchRelatedItems -> Int

hash :: SearchRelatedItems -> Int

type AWSResponse SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

type AWSResponse SearchRelatedItems = SearchRelatedItemsResponse

type Rep SearchRelatedItems

Defined in Amazonka.ConnectCases.SearchRelatedItems

type Rep SearchRelatedItems = D1 ('MetaData "SearchRelatedItems" "Amazonka.ConnectCases.SearchRelatedItems" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "SearchRelatedItems'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RelatedItemTypeFilter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "caseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSearchRelatedItems

Arguments

:: Text

SearchRelatedItems

-> Text

SearchRelatedItems

-> SearchRelatedItems

Create a value of SearchRelatedItems 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:filters:SearchRelatedItems', searchRelatedItems_filters - The list of types of related items and their parameters to use for filtering.

$sel:maxResults:SearchRelatedItems', searchRelatedItems_maxResults - The maximum number of results to return per page.

SearchRelatedItems, searchRelatedItems_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.

SearchRelatedItems, searchRelatedItems_caseId - A unique identifier of the case.

SearchRelatedItems, searchRelatedItems_domainId - The unique identifier of the Cases domain.

Request Lenses

searchRelatedItems_filters :: Lens' SearchRelatedItems (Maybe [RelatedItemTypeFilter])

The list of types of related items and their parameters to use for filtering.

searchRelatedItems_maxResults :: Lens' SearchRelatedItems (Maybe Natural)

The maximum number of results to return per page.

searchRelatedItems_nextToken :: Lens' SearchRelatedItems (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.

searchRelatedItems_caseId :: Lens' SearchRelatedItems Text

A unique identifier of the case.

searchRelatedItems_domainId :: Lens' SearchRelatedItems Text

The unique identifier of the Cases domain.

Destructuring the Response

data SearchRelatedItemsResponse

See: newSearchRelatedItemsResponse smart constructor.

Constructors

SearchRelatedItemsResponse'

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.

• relatedItems :: [SearchRelatedItemsResponseItem]

  A list of items related to a case.

Instances

Generic SearchRelatedItemsResponse

Defined in Amazonka.ConnectCases.SearchRelatedItems

Associated Types

type Rep SearchRelatedItemsResponse :: Type -> Type

Methods

from :: SearchRelatedItemsResponse -> Rep SearchRelatedItemsResponse x

to :: Rep SearchRelatedItemsResponse x -> SearchRelatedItemsResponse

Read SearchRelatedItemsResponse

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

readsPrec :: Int -> ReadS SearchRelatedItemsResponse

readList :: ReadS [SearchRelatedItemsResponse]

readPrec :: ReadPrec SearchRelatedItemsResponse

readListPrec :: ReadPrec [SearchRelatedItemsResponse]

Show SearchRelatedItemsResponse

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

showsPrec :: Int -> SearchRelatedItemsResponse -> ShowS

show :: SearchRelatedItemsResponse -> String

showList :: [SearchRelatedItemsResponse] -> ShowS

NFData SearchRelatedItemsResponse

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

rnf :: SearchRelatedItemsResponse -> ()

Eq SearchRelatedItemsResponse

Defined in Amazonka.ConnectCases.SearchRelatedItems

Methods

(==) :: SearchRelatedItemsResponse -> SearchRelatedItemsResponse -> Bool

(/=) :: SearchRelatedItemsResponse -> SearchRelatedItemsResponse -> Bool

type Rep SearchRelatedItemsResponse

Defined in Amazonka.ConnectCases.SearchRelatedItems

type Rep SearchRelatedItemsResponse = D1 ('MetaData "SearchRelatedItemsResponse" "Amazonka.ConnectCases.SearchRelatedItems" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "SearchRelatedItemsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "relatedItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SearchRelatedItemsResponseItem]))))

newSearchRelatedItemsResponse

Arguments

:: Int

$sel:httpStatus:SearchRelatedItemsResponse'

-> SearchRelatedItemsResponse

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

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

$sel:httpStatus:SearchRelatedItemsResponse', searchRelatedItemsResponse_httpStatus - The response's http status code.

$sel:relatedItems:SearchRelatedItemsResponse', searchRelatedItemsResponse_relatedItems - A list of items related to a case.

Response Lenses

searchRelatedItemsResponse_nextToken :: Lens' SearchRelatedItemsResponse (Maybe Text)

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

searchRelatedItemsResponse_httpStatus :: Lens' SearchRelatedItemsResponse Int

The response's http status code.

searchRelatedItemsResponse_relatedItems :: Lens' SearchRelatedItemsResponse [SearchRelatedItemsResponseItem]

A list of items related to a case.