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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all fields in a Cases domain.

Synopsis

Creating a Request

data ListFields Source #

See: newListFields smart constructor.

Constructors

ListFields'
Fields 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. domainId :: Text The unique identifier of the Cases domain.

Instances

Instances details

ToJSON ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Methods toJSON :: ListFields -> Value # toEncoding :: ListFields -> Encoding # toJSONList :: [ListFields] -> Value # toEncodingList :: [ListFields] -> Encoding #
ToHeaders ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Methods toHeaders :: ListFields -> [Header] #
ToPath ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Methods toPath :: ListFields -> ByteString #
ToQuery ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Methods toQuery :: ListFields -> QueryString #
AWSRequest ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Associated Types type AWSResponse ListFields # Methods request :: (Service -> Service) -> ListFields -> Request ListFields # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListFields -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListFields))) #
Generic ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Associated Types type Rep ListFields :: Type -> Type # Methods from :: ListFields -> Rep ListFields x # to :: Rep ListFields x -> ListFields #
Read ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Methods readsPrec :: Int -> ReadS ListFields # readList :: ReadS [ListFields] # readPrec :: ReadPrec ListFields # readListPrec :: ReadPrec [ListFields] #
Show ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Methods showsPrec :: Int -> ListFields -> ShowS # show :: ListFields -> String # showList :: [ListFields] -> ShowS #
NFData ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Methods rnf :: ListFields -> () #
Eq ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Methods (==) :: ListFields -> ListFields -> Bool # (/=) :: ListFields -> ListFields -> Bool #
Hashable ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields Methods hashWithSalt :: Int -> ListFields -> Int # hash :: ListFields -> Int #
type AWSResponse ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields type AWSResponse ListFields = ListFieldsResponse
type Rep ListFields Source #
Instance details Defined in Amazonka.ConnectCases.ListFields type Rep ListFields = D1 ('MetaData "ListFields" "Amazonka.ConnectCases.ListFields" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "ListFields'" '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 "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListFields Source #

Arguments

:: Text	`ListFields`
-> ListFields

Create a value of ListFields 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:ListFields', listFields_maxResults - The maximum number of results to return per page.

ListFields, listFields_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.

ListFields, listFields_domainId - The unique identifier of the Cases domain.

Request Lenses

listFields_maxResults :: Lens' ListFields (Maybe Natural) Source #

The maximum number of results to return per page.

listFields_nextToken :: Lens' ListFields (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.

listFields_domainId :: Lens' ListFields Text Source #

The unique identifier of the Cases domain.

Destructuring the Response

data ListFieldsResponse Source #

See: newListFieldsResponse smart constructor.

Constructors

ListFieldsResponse'
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. fields :: [FieldSummary] List of detailed field information.

Instances

Instances details

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

newListFieldsResponse Source #

Arguments

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

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

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

$sel:httpStatus:ListFieldsResponse', listFieldsResponse_httpStatus - The response's http status code.

ListFieldsResponse, listFieldsResponse_fields - List of detailed field information.

Response Lenses

listFieldsResponse_nextToken :: Lens' ListFieldsResponse (Maybe Text) Source #

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

listFieldsResponse_httpStatus :: Lens' ListFieldsResponse Int Source #

The response's http status code.

listFieldsResponse_fields :: Lens' ListFieldsResponse [FieldSummary] Source #

List of detailed field information.