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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a specific case if it exists.

Synopsis

data GetCase = GetCase' {
- nextToken :: Maybe Text
- caseId :: Text
- domainId :: Text
- fields :: NonEmpty FieldIdentifier
}
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

data GetCase Source #

See: newGetCase smart constructor.

Constructors

GetCase'
Fields 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. fields :: NonEmpty FieldIdentifier A list of unique field identifiers.

Instances

Instances details

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

newGetCase Source #

Arguments

:: Text	`GetCase`
-> Text	`GetCase`
-> NonEmpty FieldIdentifier	`GetCase`
-> GetCase

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_caseId :: Lens' GetCase Text Source #

A unique identifier of the case.

getCase_domainId :: Lens' GetCase Text Source #

The unique identifier of the Cases domain.

getCase_fields :: Lens' GetCase (NonEmpty FieldIdentifier) Source #

A list of unique field identifiers.

Destructuring the Response

data GetCaseResponse Source #

See: newGetCaseResponse smart constructor.

Constructors

GetCaseResponse'

Fields

nextToken :: Maybe Text
The token for the next set of results. This is null if there are no more results to return.
tags :: Maybe (HashMap Text Text)
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.
httpStatus :: Int
The response's http status code.
fields :: [FieldValue]
A list of detailed field information.
templateId :: Text
A unique identifier of a template.

Instances

Instances details

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

newGetCaseResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetCaseResponse'`
-> Text	`GetCaseResponse`
-> GetCaseResponse

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.