Amazonka.Support.Types.CaseDetails

Documentation

data CaseDetails

A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:

• 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.
• categoryCode - The category of problem for the support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.
• displayId - The identifier for the case on pages in the Amazon Web Services Support Center.
• 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.
• nextToken - A resumption point for pagination.
• recentCommunications - One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.
• serviceCode - The identifier for the Amazon Web Services service that corresponds to the service code defined in the call to DescribeServices.
• severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: low, normal, high, urgent, and critical.

• status - The status of the case in the Amazon Web Services Support Center. Valid values:

  • opened

  • pending-customer-action

  • reopened

  • resolved

  • unassigned

  • work-in-progress

• subject - The subject line of the case.
• submittedBy - The email address of the account that submitted the case.
• timeCreated - The time the case was created, in ISO-8601 format.

See: newCaseDetails smart constructor.

Constructors

CaseDetails'

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

• categoryCode :: Maybe Text

  The category of problem for the support case.

• ccEmailAddresses :: Maybe [Text]

  The email addresses that receive copies of communication about the case.

• displayId :: Maybe Text

  The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

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

• recentCommunications :: Maybe RecentCaseCommunications

  The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

• serviceCode :: Maybe Text

  The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.

• severityCode :: Maybe Text

  The code for the severity level returned by the call to DescribeSeverityLevels.

• status :: Maybe Text

  The status of the case.

  Valid values:

  • opened

  • pending-customer-action

  • reopened

  • resolved

  • unassigned

  • work-in-progress

• subject :: Maybe Text

  The subject line for the case in the Amazon Web Services Support Center.

• submittedBy :: Maybe Text

  The email address of the account that submitted the case.

• timeCreated :: Maybe Text

  The time that the case was created in the Amazon Web Services Support Center.

Instances

FromJSON CaseDetails

Defined in Amazonka.Support.Types.CaseDetails

Methods

parseJSON :: Value -> Parser CaseDetails

parseJSONList :: Value -> Parser [CaseDetails]

Generic CaseDetails

Defined in Amazonka.Support.Types.CaseDetails

Associated Types

type Rep CaseDetails :: Type -> Type

Methods

from :: CaseDetails -> Rep CaseDetails x

to :: Rep CaseDetails x -> CaseDetails

Read CaseDetails

Defined in Amazonka.Support.Types.CaseDetails

Methods

readsPrec :: Int -> ReadS CaseDetails

readList :: ReadS [CaseDetails]

readPrec :: ReadPrec CaseDetails

readListPrec :: ReadPrec [CaseDetails]

Show CaseDetails

Defined in Amazonka.Support.Types.CaseDetails

Methods

showsPrec :: Int -> CaseDetails -> ShowS

show :: CaseDetails -> String

showList :: [CaseDetails] -> ShowS

NFData CaseDetails

Defined in Amazonka.Support.Types.CaseDetails

Methods

rnf :: CaseDetails -> ()

Eq CaseDetails

Defined in Amazonka.Support.Types.CaseDetails

Methods

(==) :: CaseDetails -> CaseDetails -> Bool

(/=) :: CaseDetails -> CaseDetails -> Bool

Hashable CaseDetails

Defined in Amazonka.Support.Types.CaseDetails

Methods

hashWithSalt :: Int -> CaseDetails -> Int

hash :: CaseDetails -> Int

type Rep CaseDetails

Defined in Amazonka.Support.Types.CaseDetails

type Rep CaseDetails = D1 ('MetaData "CaseDetails" "Amazonka.Support.Types.CaseDetails" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "CaseDetails'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "caseId") '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 "displayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recentCommunications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecentCaseCommunications))))) :*: ((S1 ('MetaSel ('Just "serviceCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "severityCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "submittedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timeCreated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newCaseDetails :: CaseDetails

Create a value of CaseDetails 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:CaseDetails', caseDetails_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:categoryCode:CaseDetails', caseDetails_categoryCode - The category of problem for the support case.

$sel:ccEmailAddresses:CaseDetails', caseDetails_ccEmailAddresses - The email addresses that receive copies of communication about the case.

$sel:displayId:CaseDetails', caseDetails_displayId - The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

$sel:language:CaseDetails', caseDetails_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.

$sel:recentCommunications:CaseDetails', caseDetails_recentCommunications - The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

$sel:serviceCode:CaseDetails', caseDetails_serviceCode - The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.

$sel:severityCode:CaseDetails', caseDetails_severityCode - The code for the severity level returned by the call to DescribeSeverityLevels.

$sel:status:CaseDetails', caseDetails_status - The status of the case.

Valid values:

• opened

• pending-customer-action

• reopened

• resolved

• unassigned

• work-in-progress

$sel:subject:CaseDetails', caseDetails_subject - The subject line for the case in the Amazon Web Services Support Center.

$sel:submittedBy:CaseDetails', caseDetails_submittedBy - The email address of the account that submitted the case.

$sel:timeCreated:CaseDetails', caseDetails_timeCreated - The time that the case was created in the Amazon Web Services Support Center.

caseDetails_caseId :: Lens' CaseDetails (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

caseDetails_categoryCode :: Lens' CaseDetails (Maybe Text)

The category of problem for the support case.

caseDetails_ccEmailAddresses :: Lens' CaseDetails (Maybe [Text])

The email addresses that receive copies of communication about the case.

caseDetails_displayId :: Lens' CaseDetails (Maybe Text)

The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

caseDetails_language :: Lens' CaseDetails (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.

caseDetails_recentCommunications :: Lens' CaseDetails (Maybe RecentCaseCommunications)

The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

caseDetails_serviceCode :: Lens' CaseDetails (Maybe Text)

The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.

caseDetails_severityCode :: Lens' CaseDetails (Maybe Text)

The code for the severity level returned by the call to DescribeSeverityLevels.

caseDetails_status :: Lens' CaseDetails (Maybe Text)

The status of the case.

Valid values:

• opened

• pending-customer-action

• reopened

• resolved

• unassigned

• work-in-progress

caseDetails_subject :: Lens' CaseDetails (Maybe Text)

The subject line for the case in the Amazon Web Services Support Center.

caseDetails_submittedBy :: Lens' CaseDetails (Maybe Text)

The email address of the account that submitted the case.

caseDetails_timeCreated :: Lens' CaseDetails (Maybe Text)

The time that the case was created in the Amazon Web Services Support Center.