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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.

The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:

Submit a request from the Amazon Web Services Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.

A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.

The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId.

You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Synopsis

data CreateCase = CreateCase' {
- attachmentSetId :: Maybe Text
- categoryCode :: Maybe Text
- ccEmailAddresses :: Maybe [Text]
- issueType :: Maybe Text
- language :: Maybe Text
- serviceCode :: Maybe Text
- severityCode :: Maybe Text
- subject :: Text
- communicationBody :: Text
}
newCreateCase :: Text -> Text -> CreateCase
createCase_attachmentSetId :: Lens' CreateCase (Maybe Text)
createCase_categoryCode :: Lens' CreateCase (Maybe Text)
createCase_ccEmailAddresses :: Lens' CreateCase (Maybe [Text])
createCase_issueType :: Lens' CreateCase (Maybe Text)
createCase_language :: Lens' CreateCase (Maybe Text)
createCase_serviceCode :: Lens' CreateCase (Maybe Text)
createCase_severityCode :: Lens' CreateCase (Maybe Text)
createCase_subject :: Lens' CreateCase Text
createCase_communicationBody :: Lens' CreateCase Text
data CreateCaseResponse = CreateCaseResponse' {
- caseId :: Maybe Text
- httpStatus :: Int
}
newCreateCaseResponse :: Int -> CreateCaseResponse
createCaseResponse_caseId :: Lens' CreateCaseResponse (Maybe Text)
createCaseResponse_httpStatus :: Lens' CreateCaseResponse Int

Creating a Request

data CreateCase Source #

See: newCreateCase smart constructor.

Constructors

CreateCase'

Fields

attachmentSetId :: Maybe Text
The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.
categoryCode :: Maybe Text
The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.
ccEmailAddresses :: Maybe [Text]
A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs.
issueType :: Maybe Text
The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical.
language :: Maybe Text
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.
serviceCode :: Maybe Text
The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.
severityCode :: Maybe Text
A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with Amazon Web Services Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode.
For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide.
The availability of severity levels depends on the support plan for the Amazon Web Services account.
subject :: Text
The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.
communicationBody :: Text
The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.

Instances

Instances details

ToJSON CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase Methods toJSON :: CreateCase -> Value # toEncoding :: CreateCase -> Encoding # toJSONList :: [CreateCase] -> Value # toEncodingList :: [CreateCase] -> Encoding #
ToHeaders CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase Methods toHeaders :: CreateCase -> [Header] #
ToPath CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase Methods toPath :: CreateCase -> ByteString #
ToQuery CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase Methods toQuery :: CreateCase -> QueryString #
AWSRequest CreateCase Source #
Instance details Defined in Amazonka.Support.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.Support.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.Support.CreateCase Methods readsPrec :: Int -> ReadS CreateCase # readList :: ReadS [CreateCase] # readPrec :: ReadPrec CreateCase # readListPrec :: ReadPrec [CreateCase] #
Show CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase Methods showsPrec :: Int -> CreateCase -> ShowS # show :: CreateCase -> String # showList :: [CreateCase] -> ShowS #
NFData CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase Methods rnf :: CreateCase -> () #
Eq CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase Methods (==) :: CreateCase -> CreateCase -> Bool # (/=) :: CreateCase -> CreateCase -> Bool #
Hashable CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase Methods hashWithSalt :: Int -> CreateCase -> Int # hash :: CreateCase -> Int #
type AWSResponse CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase type AWSResponse CreateCase = CreateCaseResponse
type Rep CreateCase Source #
Instance details Defined in Amazonka.Support.CreateCase type Rep CreateCase = D1 ('MetaData "CreateCase" "Amazonka.Support.CreateCase" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "CreateCase'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "categoryCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ccEmailAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "issueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "severityCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "communicationBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateCase Source #

Arguments

:: Text	`CreateCase`
-> Text	`$sel:communicationBody: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:attachmentSetId:CreateCase', createCase_attachmentSetId - The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.

CreateCase, createCase_categoryCode - The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

CreateCase, createCase_ccEmailAddresses - A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs.

$sel:issueType:CreateCase', createCase_issueType - The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical.

CreateCase, createCase_language - The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

CreateCase, createCase_serviceCode - The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

CreateCase, createCase_severityCode - A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with Amazon Web Services Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode.

For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide.

The availability of severity levels depends on the support plan for the Amazon Web Services account.

CreateCase, createCase_subject - The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.

$sel:communicationBody:CreateCase', createCase_communicationBody - The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.

Request Lenses

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

The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.

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

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

createCase_ccEmailAddresses :: Lens' CreateCase (Maybe [Text]) Source #

A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs.

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

The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical.

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

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

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

The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

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

A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with Amazon Web Services Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode.

For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide.

The availability of severity levels depends on the support plan for the Amazon Web Services account.

createCase_subject :: Lens' CreateCase Text Source #

The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.

createCase_communicationBody :: Lens' CreateCase Text Source #

The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.

Destructuring the Response

data CreateCaseResponse Source #

The support case ID returned by a successful completion of the CreateCase operation.

See: newCreateCaseResponse smart constructor.

Constructors

CreateCaseResponse'
Fields caseId :: Maybe Text The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47 httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateCaseResponse Source #
Instance details Defined in Amazonka.Support.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.Support.CreateCase Methods readsPrec :: Int -> ReadS CreateCaseResponse # readList :: ReadS [CreateCaseResponse] # readPrec :: ReadPrec CreateCaseResponse # readListPrec :: ReadPrec [CreateCaseResponse] #
Show CreateCaseResponse Source #
Instance details Defined in Amazonka.Support.CreateCase Methods showsPrec :: Int -> CreateCaseResponse -> ShowS # show :: CreateCaseResponse -> String # showList :: [CreateCaseResponse] -> ShowS #
NFData CreateCaseResponse Source #
Instance details Defined in Amazonka.Support.CreateCase Methods rnf :: CreateCaseResponse -> () #
Eq CreateCaseResponse Source #
Instance details Defined in Amazonka.Support.CreateCase Methods (==) :: CreateCaseResponse -> CreateCaseResponse -> Bool # (/=) :: CreateCaseResponse -> CreateCaseResponse -> Bool #
type Rep CreateCaseResponse Source #
Instance details Defined in Amazonka.Support.CreateCase type Rep CreateCaseResponse = D1 ('MetaData "CreateCaseResponse" "Amazonka.Support.CreateCase" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "CreateCaseResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "caseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCaseResponse Source #

Arguments

:: Int	`$sel:httpStatus: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:

CreateCaseResponse, createCaseResponse_caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47

$sel:httpStatus:CreateCaseResponse', createCaseResponse_httpStatus - The response's http status code.

Response Lenses

createCaseResponse_caseId :: Lens' CreateCaseResponse (Maybe Text) Source #

The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47

createCaseResponse_httpStatus :: Lens' CreateCaseResponse Int Source #

The response's http status code.