Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Support.AddCommunicationToCase

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds additional customer communication to an AWS Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.

You must have a Business or Enterprise Support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Synopsis

Creating a Request

data AddCommunicationToCase Source #

See: newAddCommunicationToCase smart constructor.

Constructors

AddCommunicationToCase'

Fields

caseId :: Maybe Text
The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
ccEmailAddresses :: Maybe [Text]
The email addresses in the CC line of an email to be added to the support case.
attachmentSetId :: Maybe Text
The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet
communicationBody :: Text
The body of an email communication to add to the support case.

Instances

Instances details

Eq AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods (==) :: AddCommunicationToCase -> AddCommunicationToCase -> Bool # (/=) :: AddCommunicationToCase -> AddCommunicationToCase -> Bool #
Read AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods readsPrec :: Int -> ReadS AddCommunicationToCase # readList :: ReadS [AddCommunicationToCase] # readPrec :: ReadPrec AddCommunicationToCase # readListPrec :: ReadPrec [AddCommunicationToCase] #
Show AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods showsPrec :: Int -> AddCommunicationToCase -> ShowS # show :: AddCommunicationToCase -> String # showList :: [AddCommunicationToCase] -> ShowS #
Generic AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Associated Types type Rep AddCommunicationToCase :: Type -> Type # Methods from :: AddCommunicationToCase -> Rep AddCommunicationToCase x # to :: Rep AddCommunicationToCase x -> AddCommunicationToCase #
NFData AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods rnf :: AddCommunicationToCase -> () #
Hashable AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods hashWithSalt :: Int -> AddCommunicationToCase -> Int # hash :: AddCommunicationToCase -> Int #
ToJSON AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods toJSON :: AddCommunicationToCase -> Value # toEncoding :: AddCommunicationToCase -> Encoding # toJSONList :: [AddCommunicationToCase] -> Value # toEncodingList :: [AddCommunicationToCase] -> Encoding #
AWSRequest AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Associated Types type AWSResponse AddCommunicationToCase # Methods request :: AddCommunicationToCase -> Request AddCommunicationToCase # response :: MonadResource m => Logger -> Service -> Proxy AddCommunicationToCase -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AddCommunicationToCase))) #
ToHeaders AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods toHeaders :: AddCommunicationToCase -> [Header] #
ToPath AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods toPath :: AddCommunicationToCase -> ByteString #
ToQuery AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods toQuery :: AddCommunicationToCase -> QueryString #
type Rep AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase type Rep AddCommunicationToCase = D1 ('MetaData "AddCommunicationToCase" "Amazonka.Support.AddCommunicationToCase" "libZSservicesZSamazonka-supportZSamazonka-support" 'False) (C1 ('MetaCons "AddCommunicationToCase'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "caseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ccEmailAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "attachmentSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "communicationBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse AddCommunicationToCase Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase type AWSResponse AddCommunicationToCase = AddCommunicationToCaseResponse

newAddCommunicationToCase Source #

Arguments

:: Text	`$sel:communicationBody:AddCommunicationToCase'`
-> AddCommunicationToCase

Create a value of AddCommunicationToCase 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:caseId:AddCommunicationToCase', addCommunicationToCase_caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

$sel:ccEmailAddresses:AddCommunicationToCase', addCommunicationToCase_ccEmailAddresses - The email addresses in the CC line of an email to be added to the support case.

$sel:attachmentSetId:AddCommunicationToCase', addCommunicationToCase_attachmentSetId - The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet

$sel:communicationBody:AddCommunicationToCase', addCommunicationToCase_communicationBody - The body of an email communication to add to the support case.

Request Lenses

addCommunicationToCase_caseId :: Lens' AddCommunicationToCase (Maybe Text) Source #

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

addCommunicationToCase_ccEmailAddresses :: Lens' AddCommunicationToCase (Maybe [Text]) Source #

The email addresses in the CC line of an email to be added to the support case.

addCommunicationToCase_attachmentSetId :: Lens' AddCommunicationToCase (Maybe Text) Source #

The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet

addCommunicationToCase_communicationBody :: Lens' AddCommunicationToCase Text Source #

The body of an email communication to add to the support case.

Destructuring the Response

data AddCommunicationToCaseResponse Source #

The result of the AddCommunicationToCase operation.

See: newAddCommunicationToCaseResponse smart constructor.

Constructors

AddCommunicationToCaseResponse'
Fields result :: Maybe Bool True if AddCommunicationToCase succeeds. Otherwise, returns an error. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq AddCommunicationToCaseResponse Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods (==) :: AddCommunicationToCaseResponse -> AddCommunicationToCaseResponse -> Bool # (/=) :: AddCommunicationToCaseResponse -> AddCommunicationToCaseResponse -> Bool #
Read AddCommunicationToCaseResponse Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods readsPrec :: Int -> ReadS AddCommunicationToCaseResponse # readList :: ReadS [AddCommunicationToCaseResponse] # readPrec :: ReadPrec AddCommunicationToCaseResponse # readListPrec :: ReadPrec [AddCommunicationToCaseResponse] #
Show AddCommunicationToCaseResponse Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods showsPrec :: Int -> AddCommunicationToCaseResponse -> ShowS # show :: AddCommunicationToCaseResponse -> String # showList :: [AddCommunicationToCaseResponse] -> ShowS #
Generic AddCommunicationToCaseResponse Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Associated Types type Rep AddCommunicationToCaseResponse :: Type -> Type # Methods from :: AddCommunicationToCaseResponse -> Rep AddCommunicationToCaseResponse x # to :: Rep AddCommunicationToCaseResponse x -> AddCommunicationToCaseResponse #
NFData AddCommunicationToCaseResponse Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase Methods rnf :: AddCommunicationToCaseResponse -> () #
type Rep AddCommunicationToCaseResponse Source #
Instance details Defined in Amazonka.Support.AddCommunicationToCase type Rep AddCommunicationToCaseResponse = D1 ('MetaData "AddCommunicationToCaseResponse" "Amazonka.Support.AddCommunicationToCase" "libZSservicesZSamazonka-supportZSamazonka-support" 'False) (C1 ('MetaCons "AddCommunicationToCaseResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAddCommunicationToCaseResponse Source #

Arguments

:: Int	`$sel:httpStatus:AddCommunicationToCaseResponse'`
-> AddCommunicationToCaseResponse

Create a value of AddCommunicationToCaseResponse 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:result:AddCommunicationToCaseResponse', addCommunicationToCaseResponse_result - True if AddCommunicationToCase succeeds. Otherwise, returns an error.

$sel:httpStatus:AddCommunicationToCaseResponse', addCommunicationToCaseResponse_httpStatus - The response's http status code.

Response Lenses

addCommunicationToCaseResponse_result :: Lens' AddCommunicationToCaseResponse (Maybe Bool) Source #

True if AddCommunicationToCase succeeds. Otherwise, returns an error.

addCommunicationToCaseResponse_httpStatus :: Lens' AddCommunicationToCaseResponse Int Source #

The response's http status code.