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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a related item (comments, tasks, and contacts) and associates it with a case.

A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.

Synopsis

data CreateRelatedItem = CreateRelatedItem' {
- caseId :: Text
- content :: RelatedItemInputContent
- domainId :: Text
- type' :: RelatedItemType
}
newCreateRelatedItem :: Text -> RelatedItemInputContent -> Text -> RelatedItemType -> CreateRelatedItem
createRelatedItem_caseId :: Lens' CreateRelatedItem Text
createRelatedItem_content :: Lens' CreateRelatedItem RelatedItemInputContent
createRelatedItem_domainId :: Lens' CreateRelatedItem Text
createRelatedItem_type :: Lens' CreateRelatedItem RelatedItemType
data CreateRelatedItemResponse = CreateRelatedItemResponse' {
- httpStatus :: Int
- relatedItemArn :: Text
- relatedItemId :: Text
}
newCreateRelatedItemResponse :: Int -> Text -> Text -> CreateRelatedItemResponse
createRelatedItemResponse_httpStatus :: Lens' CreateRelatedItemResponse Int
createRelatedItemResponse_relatedItemArn :: Lens' CreateRelatedItemResponse Text
createRelatedItemResponse_relatedItemId :: Lens' CreateRelatedItemResponse Text

Creating a Request

data CreateRelatedItem Source #

See: newCreateRelatedItem smart constructor.

Constructors

CreateRelatedItem'
Fields caseId :: Text A unique identifier of the case. content :: RelatedItemInputContent The content of a related item to be created. domainId :: Text The unique identifier of the Cases domain. type' :: RelatedItemType The type of a related item.

Instances

Instances details

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

newCreateRelatedItem Source #

Arguments

:: Text	`CreateRelatedItem`
-> RelatedItemInputContent	`CreateRelatedItem`
-> Text	`CreateRelatedItem`
-> RelatedItemType	`CreateRelatedItem`
-> CreateRelatedItem

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

CreateRelatedItem, createRelatedItem_caseId - A unique identifier of the case.

CreateRelatedItem, createRelatedItem_content - The content of a related item to be created.

CreateRelatedItem, createRelatedItem_domainId - The unique identifier of the Cases domain.

CreateRelatedItem, createRelatedItem_type - The type of a related item.

Request Lenses

A unique identifier of the case.

The content of a related item to be created.

The unique identifier of the Cases domain.

The type of a related item.

Destructuring the Response

data CreateRelatedItemResponse Source #

See: newCreateRelatedItemResponse smart constructor.

Constructors

CreateRelatedItemResponse'
Fields httpStatus :: Int The response's http status code. relatedItemArn :: Text The Amazon Resource Name (ARN) of the related item. relatedItemId :: Text The unique identifier of the related item.

Instances

Instances details

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

newCreateRelatedItemResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateRelatedItemResponse'`
-> Text	`$sel:relatedItemArn:CreateRelatedItemResponse'`
-> Text	`CreateRelatedItemResponse`
-> CreateRelatedItemResponse

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

$sel:relatedItemArn:CreateRelatedItemResponse', createRelatedItemResponse_relatedItemArn - The Amazon Resource Name (ARN) of the related item.

CreateRelatedItemResponse, createRelatedItemResponse_relatedItemId - The unique identifier of the related item.

Response Lenses

The response's http status code.

The Amazon Resource Name (ARN) of the related item.

The unique identifier of the related item.