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 |
Lists all of the field options for a field identifier in the domain.
Synopsis
- data ListFieldOptions = ListFieldOptions' {}
- 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.
ListFieldOptions' | |
|
Instances
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.
ListFieldOptionsResponse' | |
|
Instances
newListFieldOptionsResponse Source #
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.