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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.

customer_id is a required field when creating a case.

Synopsis

data CreateCase = CreateCase' {
- clientToken :: Maybe Text
- domainId :: Text
- fields :: [FieldValue]
- templateId :: Text
}
newCreateCase :: Text -> Text -> CreateCase
createCase_clientToken :: Lens' CreateCase (Maybe Text)
createCase_domainId :: Lens' CreateCase Text
createCase_fields :: Lens' CreateCase [FieldValue]
createCase_templateId :: Lens' CreateCase Text
data CreateCaseResponse = CreateCaseResponse' {
- httpStatus :: Int
- caseArn :: Text
- caseId :: Text
}
newCreateCaseResponse :: Int -> Text -> Text -> CreateCaseResponse
createCaseResponse_httpStatus :: Lens' CreateCaseResponse Int
createCaseResponse_caseArn :: Lens' CreateCaseResponse Text
createCaseResponse_caseId :: Lens' CreateCaseResponse Text

Creating a Request

data CreateCase Source #

See: newCreateCase smart constructor.

Constructors

CreateCase'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
domainId :: Text
The unique identifier of the Cases domain.
fields :: [FieldValue]
An array of objects with field ID (matching ListFields/DescribeField) and value union data.
templateId :: Text
A unique identifier of a template.

Instances

Instances details

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

newCreateCase Source #

Arguments

:: Text	`CreateCase`
-> Text	`CreateCase`
-> CreateCase

Create a value of CreateCase 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:clientToken:CreateCase', createCase_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

CreateCase, createCase_domainId - The unique identifier of the Cases domain.

CreateCase, createCase_fields - An array of objects with field ID (matching ListFields/DescribeField) and value union data.

CreateCase, createCase_templateId - A unique identifier of a template.

Request Lenses

createCase_clientToken :: Lens' CreateCase (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

createCase_domainId :: Lens' CreateCase Text Source #

The unique identifier of the Cases domain.

createCase_fields :: Lens' CreateCase [FieldValue] Source #

An array of objects with field ID (matching ListFields/DescribeField) and value union data.

createCase_templateId :: Lens' CreateCase Text Source #

A unique identifier of a template.

Destructuring the Response

data CreateCaseResponse Source #

See: newCreateCaseResponse smart constructor.

Constructors

CreateCaseResponse'
Fields httpStatus :: Int The response's http status code. caseArn :: Text The Amazon Resource Name (ARN) of the case. caseId :: Text A unique identifier of the case.

Instances

Instances details

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

newCreateCaseResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateCaseResponse'`
-> Text	`$sel:caseArn:CreateCaseResponse'`
-> Text	`CreateCaseResponse`
-> CreateCaseResponse

Create a value of CreateCaseResponse 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:httpStatus:CreateCaseResponse', createCaseResponse_httpStatus - The response's http status code.

$sel:caseArn:CreateCaseResponse', createCaseResponse_caseArn - The Amazon Resource Name (ARN) of the case.

CreateCaseResponse, createCaseResponse_caseId - A unique identifier of the case.

Response Lenses

createCaseResponse_httpStatus :: Lens' CreateCaseResponse Int Source #

The response's http status code.

createCaseResponse_caseArn :: Lens' CreateCaseResponse Text Source #

The Amazon Resource Name (ARN) of the case.

createCaseResponse_caseId :: Lens' CreateCaseResponse Text Source #

A unique identifier of the case.