amazonka-support-1.0.1: Amazon Support SDK.

Copyright(c) 2013-2015 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

Contents

Description

AWS Support

The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.

The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

The following list describes the AWS Support case management operations:

  • Service names, issue categories, and available severity levels. The DescribeServices and DescribeSeverityLevels operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.
  • Case creation, case details, and case resolution. The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create AWS Support cases, retrieve information about cases, and resolve cases.
  • Case communication. The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases.

The following list describes the operations available from the AWS Support service for Trusted Advisor:

  • DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.
  • Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check you specified.
  • DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks.
  • RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check.
  • DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status of one or more checks.

For authentication of requests, AWS Support uses Signature Version 4 Signing Process.

See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

See: AWS API Reference

Synopsis

Service

data Support Source

Version 2013-04-15 of the Amazon Support SDK.

Instances

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by Support.

AttachmentSetExpired

_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

_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

_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

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

The requested CaseId could not be located.

AttachmentSetIdNotFound

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

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

AttachmentSetSizeLimitExceeded

_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

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

An attachment with the specified ID could not be found.

InternalServerError

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

An internal server error occurred.

CaseCreationLimitExceeded

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

The case creation limit for the account has been exceeded.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

RefreshTrustedAdvisorCheck

DescribeCases (Paginated)

DescribeTrustedAdvisorCheckRefreshStatuses

CreateCase

DescribeTrustedAdvisorCheckSummaries

ResolveCase

DescribeSeverityLevels

DescribeTrustedAdvisorChecks

DescribeAttachment

AddAttachmentsToSet

DescribeTrustedAdvisorCheckResult

DescribeServices

DescribeCommunications (Paginated)

AddCommunicationToCase

Types

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.

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.

cdCategoryCode :: Lens' CaseDetails (Maybe Text) Source

The category of problem for the AWS Support case.

cdTimeCreated :: Lens' CaseDetails (Maybe Text) Source

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

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

data SupportService Source

Information about an AWS service returned by the DescribeServices operation.

See: supportService smart constructor.

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.