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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all of the field options for a field identifier in the domain.

Synopsis

data ListFieldOptions = ListFieldOptions' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- values :: Maybe [Text]
- domainId :: Text
- fieldId :: Text
}
newListFieldOptions :: Text -> Text -> ListFieldOptions
listFieldOptions_maxResults :: Lens' ListFieldOptions (Maybe Natural)
listFieldOptions_nextToken :: Lens' ListFieldOptions (Maybe Text)
listFieldOptions_values :: Lens' ListFieldOptions (Maybe [Text])
listFieldOptions_domainId :: Lens' ListFieldOptions Text
listFieldOptions_fieldId :: Lens' ListFieldOptions Text
data ListFieldOptionsResponse = ListFieldOptionsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- options :: [FieldOption]
}
newListFieldOptionsResponse :: Int -> ListFieldOptionsResponse
listFieldOptionsResponse_nextToken :: Lens' ListFieldOptionsResponse (Maybe Text)
listFieldOptionsResponse_httpStatus :: Lens' ListFieldOptionsResponse Int
listFieldOptionsResponse_options :: Lens' ListFieldOptionsResponse [FieldOption]

Creating a Request

data ListFieldOptions Source #

See: newListFieldOptions smart constructor.

Constructors

ListFieldOptions'

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.
values :: Maybe [Text]
A list of FieldOption values to filter on for ListFieldOptions.
domainId :: Text
The unique identifier of the Cases domain.
fieldId :: Text
The unique identifier of a field.

Instances

Instances details

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

newListFieldOptions Source #

Arguments

:: Text	`ListFieldOptions`
-> Text	`ListFieldOptions`
-> ListFieldOptions

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

ListFieldOptions, listFieldOptions_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:values:ListFieldOptions', listFieldOptions_values - A list of FieldOption values to filter on for ListFieldOptions.

ListFieldOptions, listFieldOptions_domainId - The unique identifier of the Cases domain.

ListFieldOptions, listFieldOptions_fieldId - The unique identifier of a field.

Request Lenses

listFieldOptions_maxResults :: Lens' ListFieldOptions (Maybe Natural) Source #

The maximum number of results to return per page.

listFieldOptions_nextToken :: Lens' ListFieldOptions (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.

listFieldOptions_values :: Lens' ListFieldOptions (Maybe [Text]) Source #

A list of FieldOption values to filter on for ListFieldOptions.

listFieldOptions_domainId :: Lens' ListFieldOptions Text Source #

The unique identifier of the Cases domain.

listFieldOptions_fieldId :: Lens' ListFieldOptions Text Source #

The unique identifier of a field.

Destructuring the Response

data ListFieldOptionsResponse Source #

See: newListFieldOptionsResponse smart constructor.

Constructors

ListFieldOptionsResponse'
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. options :: [FieldOption] A list of `FieldOption` objects.

Instances

Instances details

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

newListFieldOptionsResponse Source #

Arguments

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

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

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

$sel:httpStatus:ListFieldOptionsResponse', listFieldOptionsResponse_httpStatus - The response's http status code.

$sel:options:ListFieldOptionsResponse', listFieldOptionsResponse_options - A list of FieldOption objects.

Response Lenses

listFieldOptionsResponse_nextToken :: Lens' ListFieldOptionsResponse (Maybe Text) Source #

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

listFieldOptionsResponse_httpStatus :: Lens' ListFieldOptionsResponse Int Source #

The response's http status code.

listFieldOptionsResponse_options :: Lens' ListFieldOptionsResponse [FieldOption] Source #

A list of FieldOption objects.