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 |
Returns information about a specific case if it exists.
Synopsis
- data GetCase = GetCase' {}
- newGetCase :: Text -> Text -> NonEmpty FieldIdentifier -> GetCase
- getCase_nextToken :: Lens' GetCase (Maybe Text)
- getCase_caseId :: Lens' GetCase Text
- getCase_domainId :: Lens' GetCase Text
- getCase_fields :: Lens' GetCase (NonEmpty FieldIdentifier)
- data GetCaseResponse = GetCaseResponse' {
- nextToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- fields :: [FieldValue]
- templateId :: Text
- newGetCaseResponse :: Int -> Text -> GetCaseResponse
- getCaseResponse_nextToken :: Lens' GetCaseResponse (Maybe Text)
- getCaseResponse_tags :: Lens' GetCaseResponse (Maybe (HashMap Text Text))
- getCaseResponse_httpStatus :: Lens' GetCaseResponse Int
- getCaseResponse_fields :: Lens' GetCaseResponse [FieldValue]
- getCaseResponse_templateId :: Lens' GetCaseResponse Text
Creating a Request
See: newGetCase
smart constructor.
GetCase' | |
|
Instances
Create a value of GetCase
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:
GetCase
, getCase_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.
GetCase
, getCase_caseId
- A unique identifier of the case.
GetCase
, getCase_domainId
- The unique identifier of the Cases domain.
GetCase
, getCase_fields
- A list of unique field identifiers.
Request Lenses
getCase_nextToken :: Lens' GetCase (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.
getCase_fields :: Lens' GetCase (NonEmpty FieldIdentifier) Source #
A list of unique field identifiers.
Destructuring the Response
data GetCaseResponse Source #
See: newGetCaseResponse
smart constructor.
GetCaseResponse' | |
|
Instances
Create a value of GetCaseResponse
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:
GetCase
, getCaseResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
GetCaseResponse
, getCaseResponse_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
$sel:httpStatus:GetCaseResponse'
, getCaseResponse_httpStatus
- The response's http status code.
GetCase
, getCaseResponse_fields
- A list of detailed field information.
GetCaseResponse
, getCaseResponse_templateId
- A unique identifier of a template.
Response Lenses
getCaseResponse_nextToken :: Lens' GetCaseResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
getCaseResponse_tags :: Lens' GetCaseResponse (Maybe (HashMap Text Text)) Source #
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
getCaseResponse_httpStatus :: Lens' GetCaseResponse Int Source #
The response's http status code.
getCaseResponse_fields :: Lens' GetCaseResponse [FieldValue] Source #
A list of detailed field information.
getCaseResponse_templateId :: Lens' GetCaseResponse Text Source #
A unique identifier of a template.