amazonka-support-1.4.0: Amazon Support SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Support.Types

Contents

Description

 

Synopsis

Service Configuration

support :: Service Source

API version '2013-04-15' of the Amazon Support SDK configuration.

Errors

_AttachmentSetExpired :: AsError a => Getting (First ServiceError) a ServiceError Source

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

_AttachmentLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source

The limit for the number of attachment sets created in a short period of time has been exceeded.

_DescribeAttachmentLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

_CaseIdNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source

The requested CaseId could not be located.

_AttachmentSetIdNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source

An attachment set with the specified ID could not be found.

_AttachmentSetSizeLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source

A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

_AttachmentIdNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source

An attachment with the specified ID could not be found.

_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source

An internal server error occurred.

_CaseCreationLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source

The case creation limit for the account has been exceeded.

Attachment

data Attachment Source

An attachment to a case communication. The attachment consists of the file name and the content of the file.

See: attachment smart constructor.

attachment :: Attachment Source

Creates a value of Attachment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aData :: Lens' Attachment (Maybe ByteString) Source

The content of the attachment file.

Note: This Lens automatically encodes and decodes Base64 data, despite what the AWS documentation might say. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

aFileName :: Lens' Attachment (Maybe Text) Source

The name of the attachment file.

AttachmentDetails

data AttachmentDetails Source

The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

See: attachmentDetails smart constructor.

attachmentDetails :: AttachmentDetails Source

Creates a value of AttachmentDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

adAttachmentId :: Lens' AttachmentDetails (Maybe Text) Source

The ID of the attachment.

adFileName :: Lens' AttachmentDetails (Maybe Text) Source

The file name of the attachment.

CaseDetails

data CaseDetails Source

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

  1. CaseID. The AWS 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.
  2. CategoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.
  3. DisplayId. The identifier for the case on pages in the AWS Support Center.
  4. Language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
  5. RecentCommunications. One or more Communication objects. Fields of these objects are Attachments, Body, CaseId, SubmittedBy, and TimeCreated.
  6. NextToken. A resumption point for pagination.
  7. ServiceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.
  8. SeverityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels.
  9. Status. The status of the case in the AWS Support Center.
  10. Subject. The subject line of the case.
  11. SubmittedBy. The email address of the account that submitted the case.
  12. TimeCreated. The time the case was created, in ISO-8601 format.

See: caseDetails smart constructor.

caseDetails :: CaseDetails Source

Creates a value of CaseDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cdSubject :: Lens' CaseDetails (Maybe Text) Source

The subject line for the case in the AWS Support Center.

cdStatus :: Lens' CaseDetails (Maybe Text) Source

The status of the case.

cdRecentCommunications :: Lens' CaseDetails (Maybe RecentCaseCommunications) Source

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

cdSeverityCode :: Lens' CaseDetails (Maybe Text) Source

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

cdCaseId :: Lens' CaseDetails (Maybe Text) Source

The AWS 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

cdCcEmailAddresses :: Lens' CaseDetails [Text] Source

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

cdDisplayId :: Lens' CaseDetails (Maybe Text) Source

The ID displayed for the case in the AWS Support Center. This is a numeric string.

cdSubmittedBy :: Lens' CaseDetails (Maybe Text) Source

The email address of the account that submitted the case.

cdLanguage :: Lens' CaseDetails (Maybe Text) Source

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

cdTimeCreated :: Lens' CaseDetails (Maybe Text) Source

The time that the case was case created in the AWS Support Center.

cdCategoryCode :: Lens' CaseDetails (Maybe Text) Source

The category of problem for the AWS Support case.

cdServiceCode :: Lens' CaseDetails (Maybe Text) Source

The code for the AWS service returned by the call to DescribeServices.

Category

data Category Source

A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.

See: category smart constructor.

category :: Category Source

Creates a value of Category with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cName :: Lens' Category (Maybe Text) Source

The category name for the support case.

cCode :: Lens' Category (Maybe Text) Source

The category code for the support case.

Communication

data Communication Source

A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

See: communication smart constructor.

communication :: Communication Source

Creates a value of Communication with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cBody :: Lens' Communication (Maybe Text) Source

The text of the communication between the customer and AWS Support.

cCaseId :: Lens' Communication (Maybe Text) Source

The AWS 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

cSubmittedBy :: Lens' Communication (Maybe Text) Source

The email address of the account that submitted the AWS Support case.

cTimeCreated :: Lens' Communication (Maybe Text) Source

The time the communication was created.

cAttachmentSet :: Lens' Communication [AttachmentDetails] Source

Information about the attachments to the case communication.

RecentCaseCommunications

recentCaseCommunications :: RecentCaseCommunications Source

Creates a value of RecentCaseCommunications with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rccNextToken :: Lens' RecentCaseCommunications (Maybe Text) Source

A resumption point for pagination.

rccCommunications :: Lens' RecentCaseCommunications [Communication] Source

The five most recent communications associated with the case.

SeverityLevel

data SeverityLevel Source

A code and name pair that represent a severity level that can be applied to a support case.

See: severityLevel smart constructor.

severityLevel :: SeverityLevel Source

Creates a value of SeverityLevel with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

slName :: Lens' SeverityLevel (Maybe Text) Source

The name of the severity level that corresponds to the severity level code.

slCode :: Lens' SeverityLevel (Maybe Text) Source

One of four values: "low," "medium," "high," and "urgent". These values correspond to response times returned to the caller in name.

SupportService

supportService :: SupportService Source

Creates a value of SupportService with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ssCategories :: Lens' SupportService [Category] Source

A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.

ssName :: Lens' SupportService (Maybe Text) Source

The friendly name for an AWS service. The Code element contains the corresponding code.

ssCode :: Lens' SupportService (Maybe Text) Source

The code for an AWS service returned by the DescribeServices response. The Name element contains the corresponding friendly name.

TrustedAdvisorCategorySpecificSummary

trustedAdvisorCategorySpecificSummary :: TrustedAdvisorCategorySpecificSummary Source

Creates a value of TrustedAdvisorCategorySpecificSummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tacssCostOptimizing :: Lens' TrustedAdvisorCategorySpecificSummary (Maybe TrustedAdvisorCostOptimizingSummary) Source

The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

TrustedAdvisorCheckDescription

trustedAdvisorCheckDescription Source

Creates a value of TrustedAdvisorCheckDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tacdId :: Lens' TrustedAdvisorCheckDescription Text Source

The unique identifier for the Trusted Advisor check.

tacdName :: Lens' TrustedAdvisorCheckDescription Text Source

The display name for the Trusted Advisor check.

tacdDescription :: Lens' TrustedAdvisorCheckDescription Text Source

The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).

tacdCategory :: Lens' TrustedAdvisorCheckDescription Text Source

The category of the Trusted Advisor check.

tacdMetadata :: Lens' TrustedAdvisorCheckDescription [Text] Source

The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

TrustedAdvisorCheckRefreshStatus

trustedAdvisorCheckRefreshStatus Source

Creates a value of TrustedAdvisorCheckRefreshStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tacrsCheckId :: Lens' TrustedAdvisorCheckRefreshStatus Text Source

The unique identifier for the Trusted Advisor check.

tacrsStatus :: Lens' TrustedAdvisorCheckRefreshStatus Text Source

The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned".

tacrsMillisUntilNextRefreshable :: Lens' TrustedAdvisorCheckRefreshStatus Integer Source

The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

TrustedAdvisorCheckResult

tacrCheckId :: Lens' TrustedAdvisorCheckResult Text Source

The unique identifier for the Trusted Advisor check.

tacrTimestamp :: Lens' TrustedAdvisorCheckResult Text Source

The time of the last refresh of the check.

tacrStatus :: Lens' TrustedAdvisorCheckResult Text Source

The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

tacrCategorySpecificSummary :: Lens' TrustedAdvisorCheckResult TrustedAdvisorCategorySpecificSummary Source

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

tacrFlaggedResources :: Lens' TrustedAdvisorCheckResult [TrustedAdvisorResourceDetail] Source

The details about each resource listed in the check result.

TrustedAdvisorCheckSummary

tacsHasFlaggedResources :: Lens' TrustedAdvisorCheckSummary (Maybe Bool) Source

Specifies whether the Trusted Advisor check has flagged resources.

tacsCheckId :: Lens' TrustedAdvisorCheckSummary Text Source

The unique identifier for the Trusted Advisor check.

tacsTimestamp :: Lens' TrustedAdvisorCheckSummary Text Source

The time of the last refresh of the check.

tacsStatus :: Lens' TrustedAdvisorCheckSummary Text Source

The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

tacsCategorySpecificSummary :: Lens' TrustedAdvisorCheckSummary TrustedAdvisorCategorySpecificSummary Source

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

TrustedAdvisorCostOptimizingSummary

tacosEstimatedMonthlySavings :: Lens' TrustedAdvisorCostOptimizingSummary Double Source

The estimated monthly savings that might be realized if the recommended actions are taken.

tacosEstimatedPercentMonthlySavings :: Lens' TrustedAdvisorCostOptimizingSummary Double Source

The estimated percentage of savings that might be realized if the recommended actions are taken.

TrustedAdvisorResourceDetail

trustedAdvisorResourceDetail Source

Creates a value of TrustedAdvisorResourceDetail with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tardIsSuppressed :: Lens' TrustedAdvisorResourceDetail (Maybe Bool) Source

Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

tardStatus :: Lens' TrustedAdvisorResourceDetail Text Source

The status code for the resource identified in the Trusted Advisor check.

tardRegion :: Lens' TrustedAdvisorResourceDetail Text Source

The AWS region in which the identified resource is located.

tardResourceId :: Lens' TrustedAdvisorResourceDetail Text Source

The unique identifier for the identified resource.

tardMetadata :: Lens' TrustedAdvisorResourceDetail [Text] Source

Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

TrustedAdvisorResourcesSummary

tarsResourcesProcessed :: Lens' TrustedAdvisorResourcesSummary Integer Source

The number of AWS resources that were analyzed by the Trusted Advisor check.

tarsResourcesFlagged :: Lens' TrustedAdvisorResourcesSummary Integer Source

The number of AWS resources that were flagged (listed) by the Trusted Advisor check.

tarsResourcesIgnored :: Lens' TrustedAdvisorResourcesSummary Integer Source

The number of AWS resources ignored by Trusted Advisor because information was unavailable.

tarsResourcesSuppressed :: Lens' TrustedAdvisorResourcesSummary Integer Source

The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.