| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- AddAttachmentsToSet
- AddCommunicationToCase
- CreateCase
- DescribeAttachment
- DescribeCases (Paginated)
- DescribeCommunications (Paginated)
- DescribeServices
- DescribeSeverityLevels
- DescribeTrustedAdvisorCheckRefreshStatuses
- DescribeTrustedAdvisorCheckResult
- DescribeTrustedAdvisorCheckSummaries
- DescribeTrustedAdvisorChecks
- RefreshTrustedAdvisorCheck
- ResolveCase
- Types
- Attachment
- AttachmentDetails
- CaseDetails
- Category
- Communication
- RecentCaseCommunications
- SeverityLevel
- SupportService
- TrustedAdvisorCategorySpecificSummary
- TrustedAdvisorCheckDescription
- TrustedAdvisorCheckRefreshStatus
- TrustedAdvisorCheckResult
- TrustedAdvisorCheckSummary
- TrustedAdvisorCostOptimizingSummary
- TrustedAdvisorResourceDetail
- TrustedAdvisorResourcesSummary
Description
Derived from API version 2013-04-15 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Web Services Support
The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
- 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
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
You can manage your support cases with the following Amazon Web Services Support API operations:
- The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
- The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.
- The DescribeServices and DescribeSeverityLevels operations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.
You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the /Amazon Web Services Support User Guide/.
For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.
For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
Synopsis
- defaultService :: Service
- _AttachmentIdNotFound :: AsError a => Fold a ServiceError
- _AttachmentLimitExceeded :: AsError a => Fold a ServiceError
- _AttachmentSetExpired :: AsError a => Fold a ServiceError
- _AttachmentSetIdNotFound :: AsError a => Fold a ServiceError
- _AttachmentSetSizeLimitExceeded :: AsError a => Fold a ServiceError
- _CaseCreationLimitExceeded :: AsError a => Fold a ServiceError
- _CaseIdNotFound :: AsError a => Fold a ServiceError
- _DescribeAttachmentLimitExceeded :: AsError a => Fold a ServiceError
- _InternalServerError :: AsError a => Fold a ServiceError
- data AddAttachmentsToSet = AddAttachmentsToSet' (Maybe Text) [Attachment]
- newAddAttachmentsToSet :: AddAttachmentsToSet
- data AddAttachmentsToSetResponse = AddAttachmentsToSetResponse' (Maybe Text) (Maybe Text) Int
- newAddAttachmentsToSetResponse :: Int -> AddAttachmentsToSetResponse
- data AddCommunicationToCase = AddCommunicationToCase' (Maybe Text) (Maybe Text) (Maybe [Text]) Text
- newAddCommunicationToCase :: Text -> AddCommunicationToCase
- data AddCommunicationToCaseResponse = AddCommunicationToCaseResponse' (Maybe Bool) Int
- newAddCommunicationToCaseResponse :: Int -> AddCommunicationToCaseResponse
- data CreateCase = CreateCase' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newCreateCase :: Text -> Text -> CreateCase
- data CreateCaseResponse = CreateCaseResponse' (Maybe Text) Int
- newCreateCaseResponse :: Int -> CreateCaseResponse
- data DescribeAttachment = DescribeAttachment' Text
- newDescribeAttachment :: Text -> DescribeAttachment
- data DescribeAttachmentResponse = DescribeAttachmentResponse' (Maybe Attachment) Int
- newDescribeAttachmentResponse :: Int -> DescribeAttachmentResponse
- data DescribeCases = DescribeCases' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeCases :: DescribeCases
- data DescribeCasesResponse = DescribeCasesResponse' (Maybe [CaseDetails]) (Maybe Text) Int
- newDescribeCasesResponse :: Int -> DescribeCasesResponse
- data DescribeCommunications = DescribeCommunications' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newDescribeCommunications :: Text -> DescribeCommunications
- data DescribeCommunicationsResponse = DescribeCommunicationsResponse' (Maybe [Communication]) (Maybe Text) Int
- newDescribeCommunicationsResponse :: Int -> DescribeCommunicationsResponse
- data DescribeServices = DescribeServices' (Maybe Text) (Maybe [Text])
- newDescribeServices :: DescribeServices
- data DescribeServicesResponse = DescribeServicesResponse' (Maybe [SupportService]) Int
- newDescribeServicesResponse :: Int -> DescribeServicesResponse
- data DescribeSeverityLevels = DescribeSeverityLevels' (Maybe Text)
- newDescribeSeverityLevels :: DescribeSeverityLevels
- data DescribeSeverityLevelsResponse = DescribeSeverityLevelsResponse' (Maybe [SeverityLevel]) Int
- newDescribeSeverityLevelsResponse :: Int -> DescribeSeverityLevelsResponse
- data DescribeTrustedAdvisorCheckRefreshStatuses = DescribeTrustedAdvisorCheckRefreshStatuses' [Text]
- newDescribeTrustedAdvisorCheckRefreshStatuses :: DescribeTrustedAdvisorCheckRefreshStatuses
- data DescribeTrustedAdvisorCheckRefreshStatusesResponse = DescribeTrustedAdvisorCheckRefreshStatusesResponse' Int [TrustedAdvisorCheckRefreshStatus]
- newDescribeTrustedAdvisorCheckRefreshStatusesResponse :: Int -> DescribeTrustedAdvisorCheckRefreshStatusesResponse
- data DescribeTrustedAdvisorCheckResult = DescribeTrustedAdvisorCheckResult' (Maybe Text) Text
- newDescribeTrustedAdvisorCheckResult :: Text -> DescribeTrustedAdvisorCheckResult
- data DescribeTrustedAdvisorCheckResultResponse = DescribeTrustedAdvisorCheckResultResponse' (Maybe TrustedAdvisorCheckResult) Int
- newDescribeTrustedAdvisorCheckResultResponse :: Int -> DescribeTrustedAdvisorCheckResultResponse
- data DescribeTrustedAdvisorCheckSummaries = DescribeTrustedAdvisorCheckSummaries' [Text]
- newDescribeTrustedAdvisorCheckSummaries :: DescribeTrustedAdvisorCheckSummaries
- data DescribeTrustedAdvisorCheckSummariesResponse = DescribeTrustedAdvisorCheckSummariesResponse' Int [TrustedAdvisorCheckSummary]
- newDescribeTrustedAdvisorCheckSummariesResponse :: Int -> DescribeTrustedAdvisorCheckSummariesResponse
- data DescribeTrustedAdvisorChecks = DescribeTrustedAdvisorChecks' Text
- newDescribeTrustedAdvisorChecks :: Text -> DescribeTrustedAdvisorChecks
- data DescribeTrustedAdvisorChecksResponse = DescribeTrustedAdvisorChecksResponse' Int [TrustedAdvisorCheckDescription]
- newDescribeTrustedAdvisorChecksResponse :: Int -> DescribeTrustedAdvisorChecksResponse
- data RefreshTrustedAdvisorCheck = RefreshTrustedAdvisorCheck' Text
- newRefreshTrustedAdvisorCheck :: Text -> RefreshTrustedAdvisorCheck
- data RefreshTrustedAdvisorCheckResponse = RefreshTrustedAdvisorCheckResponse' Int TrustedAdvisorCheckRefreshStatus
- newRefreshTrustedAdvisorCheckResponse :: Int -> TrustedAdvisorCheckRefreshStatus -> RefreshTrustedAdvisorCheckResponse
- data ResolveCase = ResolveCase' (Maybe Text)
- newResolveCase :: ResolveCase
- data ResolveCaseResponse = ResolveCaseResponse' (Maybe Text) (Maybe Text) Int
- newResolveCaseResponse :: Int -> ResolveCaseResponse
- data Attachment = Attachment' (Maybe Base64) (Maybe Text)
- newAttachment :: Attachment
- data AttachmentDetails = AttachmentDetails' (Maybe Text) (Maybe Text)
- newAttachmentDetails :: AttachmentDetails
- data CaseDetails = CaseDetails' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe RecentCaseCommunications) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newCaseDetails :: CaseDetails
- data Category = Category' (Maybe Text) (Maybe Text)
- newCategory :: Category
- data Communication = Communication' (Maybe [AttachmentDetails]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newCommunication :: Communication
- data RecentCaseCommunications = RecentCaseCommunications' (Maybe [Communication]) (Maybe Text)
- newRecentCaseCommunications :: RecentCaseCommunications
- data SeverityLevel = SeverityLevel' (Maybe Text) (Maybe Text)
- newSeverityLevel :: SeverityLevel
- data SupportService = SupportService' (Maybe [Category]) (Maybe Text) (Maybe Text)
- newSupportService :: SupportService
- data TrustedAdvisorCategorySpecificSummary = TrustedAdvisorCategorySpecificSummary' (Maybe TrustedAdvisorCostOptimizingSummary)
- newTrustedAdvisorCategorySpecificSummary :: TrustedAdvisorCategorySpecificSummary
- data TrustedAdvisorCheckDescription = TrustedAdvisorCheckDescription' Text Text Text Text [Text]
- newTrustedAdvisorCheckDescription :: Text -> Text -> Text -> Text -> TrustedAdvisorCheckDescription
- data TrustedAdvisorCheckRefreshStatus = TrustedAdvisorCheckRefreshStatus' Text Text Integer
- newTrustedAdvisorCheckRefreshStatus :: Text -> Text -> Integer -> TrustedAdvisorCheckRefreshStatus
- data TrustedAdvisorCheckResult = TrustedAdvisorCheckResult' Text Text Text TrustedAdvisorResourcesSummary TrustedAdvisorCategorySpecificSummary [TrustedAdvisorResourceDetail]
- newTrustedAdvisorCheckResult :: Text -> Text -> Text -> TrustedAdvisorResourcesSummary -> TrustedAdvisorCategorySpecificSummary -> TrustedAdvisorCheckResult
- data TrustedAdvisorCheckSummary = TrustedAdvisorCheckSummary' (Maybe Bool) Text Text Text TrustedAdvisorResourcesSummary TrustedAdvisorCategorySpecificSummary
- newTrustedAdvisorCheckSummary :: Text -> Text -> Text -> TrustedAdvisorResourcesSummary -> TrustedAdvisorCategorySpecificSummary -> TrustedAdvisorCheckSummary
- data TrustedAdvisorCostOptimizingSummary = TrustedAdvisorCostOptimizingSummary' Double Double
- newTrustedAdvisorCostOptimizingSummary :: Double -> Double -> TrustedAdvisorCostOptimizingSummary
- data TrustedAdvisorResourceDetail = TrustedAdvisorResourceDetail' (Maybe Bool) (Maybe Text) Text Text [Text]
- newTrustedAdvisorResourceDetail :: Text -> Text -> TrustedAdvisorResourceDetail
- data TrustedAdvisorResourcesSummary = TrustedAdvisorResourcesSummary' Integer Integer Integer Integer
- newTrustedAdvisorResourcesSummary :: Integer -> Integer -> Integer -> Integer -> TrustedAdvisorResourcesSummary
Service Configuration
defaultService :: Service Source #
API version 2013-04-15 of the Amazon Support SDK configuration.
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.
AttachmentIdNotFound
_AttachmentIdNotFound :: AsError a => Fold a ServiceError Source #
An attachment with the specified ID could not be found.
AttachmentLimitExceeded
_AttachmentLimitExceeded :: AsError a => Fold a ServiceError Source #
The limit for the number of attachment sets created in a short period of time has been exceeded.
AttachmentSetExpired
_AttachmentSetExpired :: AsError a => Fold a ServiceError Source #
The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
AttachmentSetIdNotFound
_AttachmentSetIdNotFound :: AsError a => Fold a ServiceError Source #
An attachment set with the specified ID could not be found.
AttachmentSetSizeLimitExceeded
_AttachmentSetSizeLimitExceeded :: AsError a => Fold a ServiceError Source #
A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.
CaseCreationLimitExceeded
_CaseCreationLimitExceeded :: AsError a => Fold a ServiceError Source #
The case creation limit for the account has been exceeded.
CaseIdNotFound
_CaseIdNotFound :: AsError a => Fold a ServiceError Source #
The requested caseId couldn't be located.
DescribeAttachmentLimitExceeded
_DescribeAttachmentLimitExceeded :: AsError a => Fold a ServiceError Source #
The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
InternalServerError
_InternalServerError :: AsError a => Fold a ServiceError Source #
An internal server error occurred.
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.
AddAttachmentsToSet
data AddAttachmentsToSet Source #
See: newAddAttachmentsToSet smart constructor.
Constructors
| AddAttachmentsToSet' (Maybe Text) [Attachment] |
Instances
newAddAttachmentsToSet :: AddAttachmentsToSet Source #
Create a value of AddAttachmentsToSet 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:
AddAttachmentsToSet, addAttachmentsToSet_attachmentSetId - The ID of the attachment set. If an attachmentSetId is not specified,
a new attachment set is created, and the ID of the set is returned in
the response. If an attachmentSetId is specified, the attachments are
added to the specified set, if it exists.
$sel:attachments:AddAttachmentsToSet', addAttachmentsToSet_attachments - One or more attachments to add to the set. You can add up to three
attachments per set. The size limit is 5 MB per attachment.
In the Attachment object, use the data parameter to specify the
contents of the attachment file. In the previous request syntax, the
value for data appear as blob, which is represented as a
base64-encoded string. The value for fileName is the name of the
attachment, such as troubleshoot-screenshot.png.
data AddAttachmentsToSetResponse Source #
The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
See: newAddAttachmentsToSetResponse smart constructor.
Instances
newAddAttachmentsToSetResponse Source #
Create a value of AddAttachmentsToSetResponse 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:
AddAttachmentsToSet, addAttachmentsToSetResponse_attachmentSetId - The ID of the attachment set. If an attachmentSetId was not specified,
a new attachment set is created, and the ID of the set is returned in
the response. If an attachmentSetId was specified, the attachments are
added to the specified set, if it exists.
$sel:expiryTime:AddAttachmentsToSetResponse', addAttachmentsToSetResponse_expiryTime - The time and date when the attachment set expires.
$sel:httpStatus:AddAttachmentsToSetResponse', addAttachmentsToSetResponse_httpStatus - The response's http status code.
AddCommunicationToCase
data AddCommunicationToCase Source #
See: newAddCommunicationToCase smart constructor.
Instances
newAddCommunicationToCase Source #
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: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
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
AddCommunicationToCase, addCommunicationToCase_ccEmailAddresses - The email addresses in the CC line of an email to be added to the
support case.
$sel:communicationBody:AddCommunicationToCase', addCommunicationToCase_communicationBody - The body of an email communication to add to the support case.
data AddCommunicationToCaseResponse Source #
The result of the AddCommunicationToCase operation.
See: newAddCommunicationToCaseResponse smart constructor.
Constructors
| AddCommunicationToCaseResponse' (Maybe Bool) Int |
Instances
newAddCommunicationToCaseResponse Source #
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.
CreateCase
data CreateCase Source #
See: newCreateCase smart constructor.
Constructors
| CreateCase' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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.
data CreateCaseResponse Source #
The support case ID returned by a successful completion of the CreateCase operation.
See: newCreateCaseResponse smart constructor.
Constructors
| CreateCaseResponse' (Maybe Text) Int |
Instances
newCreateCaseResponse Source #
Arguments
| :: Int | |
| -> 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.
DescribeAttachment
data DescribeAttachment Source #
See: newDescribeAttachment smart constructor.
Constructors
| DescribeAttachment' Text |
Instances
newDescribeAttachment Source #
Arguments
| :: Text | |
| -> DescribeAttachment |
Create a value of DescribeAttachment 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:
DescribeAttachment, describeAttachment_attachmentId - The ID of the attachment to return. Attachment IDs are returned by the
DescribeCommunications operation.
data DescribeAttachmentResponse Source #
The content and file name of the attachment returned by the DescribeAttachment operation.
See: newDescribeAttachmentResponse smart constructor.
Constructors
| DescribeAttachmentResponse' (Maybe Attachment) Int |
Instances
newDescribeAttachmentResponse Source #
Create a value of DescribeAttachmentResponse 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:attachment:DescribeAttachmentResponse', describeAttachmentResponse_attachment - This object includes the attachment content and file name.
In the previous response syntax, the value for the data parameter
appears as blob, which is represented as a base64-encoded string. The
value for fileName is the name of the attachment, such as
troubleshoot-screenshot.png.
$sel:httpStatus:DescribeAttachmentResponse', describeAttachmentResponse_httpStatus - The response's http status code.
DescribeCases (Paginated)
data DescribeCases Source #
See: newDescribeCases smart constructor.
Constructors
| DescribeCases' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Text) |
Instances
newDescribeCases :: DescribeCases Source #
Create a value of DescribeCases 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:afterTime:DescribeCases', describeCases_afterTime - The start date for a filtered date search on support case
communications. Case communications are available for 12 months after
creation.
$sel:beforeTime:DescribeCases', describeCases_beforeTime - The end date for a filtered date search on support case communications.
Case communications are available for 12 months after creation.
$sel:caseIdList:DescribeCases', describeCases_caseIdList - A list of ID numbers of the support cases you want returned. The maximum
number of cases is 100.
DescribeCases, describeCases_displayId - The ID displayed for a case in the Amazon Web Services Support Center
user interface.
$sel:includeCommunications:DescribeCases', describeCases_includeCommunications - Specifies whether to include communications in the DescribeCases
response. By default, communications are included.
$sel:includeResolvedCases:DescribeCases', describeCases_includeResolvedCases - Specifies whether to include resolved support cases in the
DescribeCases response. By default, resolved cases aren't included.
DescribeCases, describeCases_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:maxResults:DescribeCases', describeCases_maxResults - The maximum number of results to return before paginating.
DescribeCases, describeCases_nextToken - A resumption point for pagination.
data DescribeCasesResponse Source #
Returns an array of
CaseDetails
objects and a nextToken that defines a point for pagination in the
result set.
See: newDescribeCasesResponse smart constructor.
Constructors
| DescribeCasesResponse' (Maybe [CaseDetails]) (Maybe Text) Int |
Instances
newDescribeCasesResponse Source #
Create a value of DescribeCasesResponse 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:cases:DescribeCasesResponse', describeCasesResponse_cases - The details for the cases that match the request.
DescribeCases, describeCasesResponse_nextToken - A resumption point for pagination.
$sel:httpStatus:DescribeCasesResponse', describeCasesResponse_httpStatus - The response's http status code.
DescribeCommunications (Paginated)
data DescribeCommunications Source #
See: newDescribeCommunications smart constructor.
Instances
newDescribeCommunications Source #
Arguments
| :: Text | |
| -> DescribeCommunications |
Create a value of DescribeCommunications 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:afterTime:DescribeCommunications', describeCommunications_afterTime - The start date for a filtered date search on support case
communications. Case communications are available for 12 months after
creation.
$sel:beforeTime:DescribeCommunications', describeCommunications_beforeTime - The end date for a filtered date search on support case communications.
Case communications are available for 12 months after creation.
$sel:maxResults:DescribeCommunications', describeCommunications_maxResults - The maximum number of results to return before paginating.
DescribeCommunications, describeCommunications_nextToken - A resumption point for pagination.
DescribeCommunications, describeCommunications_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
data DescribeCommunicationsResponse Source #
The communications returned by the DescribeCommunications operation.
See: newDescribeCommunicationsResponse smart constructor.
Constructors
| DescribeCommunicationsResponse' (Maybe [Communication]) (Maybe Text) Int |
Instances
newDescribeCommunicationsResponse Source #
Create a value of DescribeCommunicationsResponse 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:
DescribeCommunicationsResponse, describeCommunicationsResponse_communications - The communications for the case.
DescribeCommunications, describeCommunicationsResponse_nextToken - A resumption point for pagination.
$sel:httpStatus:DescribeCommunicationsResponse', describeCommunicationsResponse_httpStatus - The response's http status code.
DescribeServices
data DescribeServices Source #
See: newDescribeServices smart constructor.
Constructors
| DescribeServices' (Maybe Text) (Maybe [Text]) |
Instances
newDescribeServices :: DescribeServices Source #
Create a value of DescribeServices 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:
DescribeServices, describeServices_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:serviceCodeList:DescribeServices', describeServices_serviceCodeList - A JSON-formatted list of service codes available for Amazon Web Services
services.
data DescribeServicesResponse Source #
The list of Amazon Web Services services returned by the DescribeServices operation.
See: newDescribeServicesResponse smart constructor.
Constructors
| DescribeServicesResponse' (Maybe [SupportService]) Int |
Instances
newDescribeServicesResponse Source #
Create a value of DescribeServicesResponse 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:services:DescribeServicesResponse', describeServicesResponse_services - A JSON-formatted list of Amazon Web Services services.
$sel:httpStatus:DescribeServicesResponse', describeServicesResponse_httpStatus - The response's http status code.
DescribeSeverityLevels
data DescribeSeverityLevels Source #
See: newDescribeSeverityLevels smart constructor.
Constructors
| DescribeSeverityLevels' (Maybe Text) |
Instances
newDescribeSeverityLevels :: DescribeSeverityLevels Source #
Create a value of DescribeSeverityLevels 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:
DescribeSeverityLevels, describeSeverityLevels_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.
data DescribeSeverityLevelsResponse Source #
The list of severity levels returned by the DescribeSeverityLevels operation.
See: newDescribeSeverityLevelsResponse smart constructor.
Constructors
| DescribeSeverityLevelsResponse' (Maybe [SeverityLevel]) Int |
Instances
newDescribeSeverityLevelsResponse Source #
Create a value of DescribeSeverityLevelsResponse 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:severityLevels:DescribeSeverityLevelsResponse', describeSeverityLevelsResponse_severityLevels - The available severity levels for the support case. Available severity
levels are defined by your service level agreement with Amazon Web
Services.
$sel:httpStatus:DescribeSeverityLevelsResponse', describeSeverityLevelsResponse_httpStatus - The response's http status code.
DescribeTrustedAdvisorCheckRefreshStatuses
data DescribeTrustedAdvisorCheckRefreshStatuses Source #
See: newDescribeTrustedAdvisorCheckRefreshStatuses smart constructor.
Constructors
| DescribeTrustedAdvisorCheckRefreshStatuses' [Text] |
Instances
newDescribeTrustedAdvisorCheckRefreshStatuses :: DescribeTrustedAdvisorCheckRefreshStatuses Source #
Create a value of DescribeTrustedAdvisorCheckRefreshStatuses 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:checkIds:DescribeTrustedAdvisorCheckRefreshStatuses', describeTrustedAdvisorCheckRefreshStatuses_checkIds - The IDs of the Trusted Advisor checks to get the status.
If you specify the check ID of a check that is automatically refreshed,
you might see an InvalidParameterValue error.
data DescribeTrustedAdvisorCheckRefreshStatusesResponse Source #
The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
See: newDescribeTrustedAdvisorCheckRefreshStatusesResponse smart constructor.
Constructors
| DescribeTrustedAdvisorCheckRefreshStatusesResponse' Int [TrustedAdvisorCheckRefreshStatus] |
Instances
newDescribeTrustedAdvisorCheckRefreshStatusesResponse Source #
Arguments
| :: Int |
|
| -> DescribeTrustedAdvisorCheckRefreshStatusesResponse |
Create a value of DescribeTrustedAdvisorCheckRefreshStatusesResponse 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:httpStatus:DescribeTrustedAdvisorCheckRefreshStatusesResponse', describeTrustedAdvisorCheckRefreshStatusesResponse_httpStatus - The response's http status code.
$sel:statuses:DescribeTrustedAdvisorCheckRefreshStatusesResponse', describeTrustedAdvisorCheckRefreshStatusesResponse_statuses - The refresh status of the specified Trusted Advisor checks.
DescribeTrustedAdvisorCheckResult
data DescribeTrustedAdvisorCheckResult Source #
See: newDescribeTrustedAdvisorCheckResult smart constructor.
Constructors
| DescribeTrustedAdvisorCheckResult' (Maybe Text) Text |
Instances
newDescribeTrustedAdvisorCheckResult Source #
Create a value of DescribeTrustedAdvisorCheckResult 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:
DescribeTrustedAdvisorCheckResult, describeTrustedAdvisorCheckResult_language - The ISO 639-1 code for the language that you want your check results to
appear in.
The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:
- Chinese, Simplified -
zh - Chinese, Traditional -
zh_TW - English -
en - French -
fr - German -
de - Indonesian -
id - Italian -
it - Japanese -
ja - Korean -
ko - Portuguese, Brazilian -
pt_BR - Spanish -
es
DescribeTrustedAdvisorCheckResult, describeTrustedAdvisorCheckResult_checkId - The unique identifier for the Trusted Advisor check.
data DescribeTrustedAdvisorCheckResultResponse Source #
The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
See: newDescribeTrustedAdvisorCheckResultResponse smart constructor.
Instances
newDescribeTrustedAdvisorCheckResultResponse Source #
Arguments
| :: Int | |
| -> DescribeTrustedAdvisorCheckResultResponse |
Create a value of DescribeTrustedAdvisorCheckResultResponse 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:DescribeTrustedAdvisorCheckResultResponse', describeTrustedAdvisorCheckResultResponse_result - The detailed results of the Trusted Advisor check.
$sel:httpStatus:DescribeTrustedAdvisorCheckResultResponse', describeTrustedAdvisorCheckResultResponse_httpStatus - The response's http status code.
DescribeTrustedAdvisorCheckSummaries
data DescribeTrustedAdvisorCheckSummaries Source #
See: newDescribeTrustedAdvisorCheckSummaries smart constructor.
Constructors
| DescribeTrustedAdvisorCheckSummaries' [Text] |
Instances
newDescribeTrustedAdvisorCheckSummaries :: DescribeTrustedAdvisorCheckSummaries Source #
Create a value of DescribeTrustedAdvisorCheckSummaries 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:checkIds:DescribeTrustedAdvisorCheckSummaries', describeTrustedAdvisorCheckSummaries_checkIds - The IDs of the Trusted Advisor checks.
data DescribeTrustedAdvisorCheckSummariesResponse Source #
The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
See: newDescribeTrustedAdvisorCheckSummariesResponse smart constructor.
Instances
newDescribeTrustedAdvisorCheckSummariesResponse Source #
Arguments
| :: Int |
|
| -> DescribeTrustedAdvisorCheckSummariesResponse |
Create a value of DescribeTrustedAdvisorCheckSummariesResponse 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:httpStatus:DescribeTrustedAdvisorCheckSummariesResponse', describeTrustedAdvisorCheckSummariesResponse_httpStatus - The response's http status code.
$sel:summaries:DescribeTrustedAdvisorCheckSummariesResponse', describeTrustedAdvisorCheckSummariesResponse_summaries - The summary information for the requested Trusted Advisor checks.
DescribeTrustedAdvisorChecks
data DescribeTrustedAdvisorChecks Source #
See: newDescribeTrustedAdvisorChecks smart constructor.
Constructors
| DescribeTrustedAdvisorChecks' Text |
Instances
newDescribeTrustedAdvisorChecks Source #
Arguments
| :: Text | |
| -> DescribeTrustedAdvisorChecks |
Create a value of DescribeTrustedAdvisorChecks 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:
DescribeTrustedAdvisorChecks, describeTrustedAdvisorChecks_language - The ISO 639-1 code for the language that you want your checks to appear
in.
The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:
- Chinese, Simplified -
zh - Chinese, Traditional -
zh_TW - English -
en - French -
fr - German -
de - Indonesian -
id - Italian -
it - Japanese -
ja - Korean -
ko - Portuguese, Brazilian -
pt_BR - Spanish -
es
data DescribeTrustedAdvisorChecksResponse Source #
Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
See: newDescribeTrustedAdvisorChecksResponse smart constructor.
Instances
newDescribeTrustedAdvisorChecksResponse Source #
Arguments
| :: Int | |
| -> DescribeTrustedAdvisorChecksResponse |
Create a value of DescribeTrustedAdvisorChecksResponse 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:httpStatus:DescribeTrustedAdvisorChecksResponse', describeTrustedAdvisorChecksResponse_httpStatus - The response's http status code.
$sel:checks:DescribeTrustedAdvisorChecksResponse', describeTrustedAdvisorChecksResponse_checks - Information about all available Trusted Advisor checks.
RefreshTrustedAdvisorCheck
data RefreshTrustedAdvisorCheck Source #
See: newRefreshTrustedAdvisorCheck smart constructor.
Constructors
| RefreshTrustedAdvisorCheck' Text |
Instances
newRefreshTrustedAdvisorCheck Source #
Arguments
| :: Text | |
| -> RefreshTrustedAdvisorCheck |
Create a value of RefreshTrustedAdvisorCheck 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:
RefreshTrustedAdvisorCheck, refreshTrustedAdvisorCheck_checkId - The unique identifier for the Trusted Advisor check to refresh.
Specifying the check ID of a check that is automatically refreshed
causes an InvalidParameterValue error.
data RefreshTrustedAdvisorCheckResponse Source #
The current refresh status of a Trusted Advisor check.
See: newRefreshTrustedAdvisorCheckResponse smart constructor.
Instances
newRefreshTrustedAdvisorCheckResponse Source #
Arguments
| :: Int | |
| -> TrustedAdvisorCheckRefreshStatus | |
| -> RefreshTrustedAdvisorCheckResponse |
Create a value of RefreshTrustedAdvisorCheckResponse 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:httpStatus:RefreshTrustedAdvisorCheckResponse', refreshTrustedAdvisorCheckResponse_httpStatus - The response's http status code.
RefreshTrustedAdvisorCheckResponse, refreshTrustedAdvisorCheckResponse_status - The current refresh status for a check, including the amount of time
until the check is eligible for refresh.
ResolveCase
data ResolveCase Source #
See: newResolveCase smart constructor.
Constructors
| ResolveCase' (Maybe Text) |
Instances
newResolveCase :: ResolveCase Source #
Create a value of ResolveCase 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:
ResolveCase, resolveCase_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
data ResolveCaseResponse Source #
The status of the case returned by the ResolveCase operation.
See: newResolveCaseResponse smart constructor.
Instances
newResolveCaseResponse Source #
Arguments
| :: Int | |
| -> ResolveCaseResponse |
Create a value of ResolveCaseResponse 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:finalCaseStatus:ResolveCaseResponse', resolveCaseResponse_finalCaseStatus - The status of the case after the ResolveCase request was processed.
$sel:initialCaseStatus:ResolveCaseResponse', resolveCaseResponse_initialCaseStatus - The status of the case when the ResolveCase request was sent.
$sel:httpStatus:ResolveCaseResponse', resolveCaseResponse_httpStatus - The response's http status code.
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: newAttachment smart constructor.
Constructors
| Attachment' (Maybe Base64) (Maybe Text) |
Instances
newAttachment :: Attachment Source #
Create a value of Attachment 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:data':Attachment', attachment_data - The content of the attachment file.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- 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.
$sel:fileName:Attachment', attachment_fileName - 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: newAttachmentDetails smart constructor.
Constructors
| AttachmentDetails' (Maybe Text) (Maybe Text) |
Instances
newAttachmentDetails :: AttachmentDetails Source #
Create a value of AttachmentDetails 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:attachmentId:AttachmentDetails', attachmentDetails_attachmentId - The ID of the attachment.
$sel:fileName:AttachmentDetails', attachmentDetails_fileName - 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 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
CategoryCodevalues 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
languageparameter 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, andtimeCreated. - 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, andcritical. 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' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe RecentCaseCommunications) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newCaseDetails :: CaseDetails Source #
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.
Category
A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each Amazon Web Services service.
See: newCategory smart constructor.
Instances
| FromJSON Category Source # | |
| Generic Category Source # | |
| Read Category Source # | |
| Show Category Source # | |
| NFData Category Source # | |
Defined in Amazonka.Support.Types.Category | |
| Eq Category Source # | |
| Hashable Category Source # | |
Defined in Amazonka.Support.Types.Category | |
| type Rep Category Source # | |
Defined in Amazonka.Support.Types.Category type Rep Category = D1 ('MetaData "Category" "Amazonka.Support.Types.Category" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "Category'" 'PrefixI 'True) (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newCategory :: Category Source #
Create a value of Category 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:code:Category', category_code - The category code for the support case.
$sel:name:Category', category_name - The category name for the support case.
Communication
data Communication Source #
A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.
See: newCommunication smart constructor.
Constructors
| Communication' (Maybe [AttachmentDetails]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newCommunication :: Communication Source #
Create a value of Communication 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:attachmentSet:Communication', communication_attachmentSet - Information about the attachments to the case communication.
$sel:body:Communication', communication_body - The text of the communication between the customer and Amazon Web
Services Support.
$sel:caseId:Communication', communication_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:submittedBy:Communication', communication_submittedBy - The identity of the account that submitted, or responded to, the support
case. Customer entries include the role or IAM user as well as the email
address. For example, "AdminRole (Role) <janedoe@example.com>.
Entries from the Amazon Web Services Support team display "Amazon Web
Services," and don't show an email address.
$sel:timeCreated:Communication', communication_timeCreated - The time the communication was created.
RecentCaseCommunications
data RecentCaseCommunications Source #
The five most recent communications associated with the case.
See: newRecentCaseCommunications smart constructor.
Constructors
| RecentCaseCommunications' (Maybe [Communication]) (Maybe Text) |
Instances
newRecentCaseCommunications :: RecentCaseCommunications Source #
Create a value of RecentCaseCommunications 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:communications:RecentCaseCommunications', recentCaseCommunications_communications - The five most recent communications associated with the case.
$sel:nextToken:RecentCaseCommunications', recentCaseCommunications_nextToken - A resumption point for pagination.
SeverityLevel
data SeverityLevel Source #
A code and name pair that represents the severity level of a support case. The available values depend on the support plan for the account. For more information, see Choosing a severity in the Amazon Web Services Support User Guide.
See: newSeverityLevel smart constructor.
Constructors
| SeverityLevel' (Maybe Text) (Maybe Text) |
Instances
newSeverityLevel :: SeverityLevel Source #
Create a value of SeverityLevel 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:code:SeverityLevel', severityLevel_code - The code for case severity level.
Valid values: low | normal | high | urgent | critical
$sel:name:SeverityLevel', severityLevel_name - The name of the severity level that corresponds to the severity level
code.
The values returned by the API are different from the values that appear
in the Amazon Web Services Support Center. For example, the API uses the
code low, but the name appears as General guidance in Support Center.
The following are the API code names and how they appear in the console:
low- General guidancenormal- System impairedhigh- Production system impairedurgent- Production system downcritical- Business-critical system down
For more information, see Choosing a severity in the Amazon Web Services Support User Guide.
SupportService
data SupportService Source #
Information about an Amazon Web Services service returned by the DescribeServices operation.
See: newSupportService smart constructor.
Instances
newSupportService :: SupportService Source #
Create a value of SupportService 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:categories:SupportService', supportService_categories - 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 Amazon Web Services Support when
you call CreateCase.
SupportService, supportService_code - The code for an Amazon Web Services service returned by the
DescribeServices response. The name element contains the corresponding
friendly name.
SupportService, supportService_name - The friendly name for an Amazon Web Services service. The code element
contains the corresponding code.
TrustedAdvisorCategorySpecificSummary
data TrustedAdvisorCategorySpecificSummary Source #
The container for summary information that relates to the category of the Trusted Advisor check.
See: newTrustedAdvisorCategorySpecificSummary smart constructor.
Instances
newTrustedAdvisorCategorySpecificSummary :: TrustedAdvisorCategorySpecificSummary Source #
Create a value of TrustedAdvisorCategorySpecificSummary 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:costOptimizing:TrustedAdvisorCategorySpecificSummary', trustedAdvisorCategorySpecificSummary_costOptimizing - The summary information about cost savings for a Trusted Advisor check
that is in the Cost Optimizing category.
TrustedAdvisorCheckDescription
data TrustedAdvisorCheckDescription Source #
The description and metadata for a Trusted Advisor check.
See: newTrustedAdvisorCheckDescription smart constructor.
Instances
newTrustedAdvisorCheckDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> TrustedAdvisorCheckDescription |
Create a value of TrustedAdvisorCheckDescription 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:id:TrustedAdvisorCheckDescription', trustedAdvisorCheckDescription_id - The unique identifier for the Trusted Advisor check.
$sel:name:TrustedAdvisorCheckDescription', trustedAdvisorCheckDescription_name - The display name for the Trusted Advisor check.
$sel:description:TrustedAdvisorCheckDescription', trustedAdvisorCheckDescription_description - The description of the Trusted Advisor check, which includes the alert
criteria and recommended operations (contains HTML markup).
$sel:category:TrustedAdvisorCheckDescription', trustedAdvisorCheckDescription_category - The category of the Trusted Advisor check.
$sel:metadata:TrustedAdvisorCheckDescription', trustedAdvisorCheckDescription_metadata - 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
data TrustedAdvisorCheckRefreshStatus Source #
The refresh status of a Trusted Advisor check.
See: newTrustedAdvisorCheckRefreshStatus smart constructor.
Constructors
| TrustedAdvisorCheckRefreshStatus' Text Text Integer |
Instances
newTrustedAdvisorCheckRefreshStatus Source #
Arguments
| :: Text | |
| -> Text | |
| -> Integer |
|
| -> TrustedAdvisorCheckRefreshStatus |
Create a value of TrustedAdvisorCheckRefreshStatus 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:checkId:TrustedAdvisorCheckRefreshStatus', trustedAdvisorCheckRefreshStatus_checkId - The unique identifier for the Trusted Advisor check.
$sel:status:TrustedAdvisorCheckRefreshStatus', trustedAdvisorCheckRefreshStatus_status - The status of the Trusted Advisor check for which a refresh has been
requested:
none- The check is not refreshed or the non-success status exceeds the timeoutenqueued- The check refresh requests has entered the refresh queueprocessing- The check refresh request is picked up by the rule processing enginesuccess- The check is successfully refreshedabandoned- The check refresh has failed
$sel:millisUntilNextRefreshable:TrustedAdvisorCheckRefreshStatus', trustedAdvisorCheckRefreshStatus_millisUntilNextRefreshable - The amount of time, in milliseconds, until the Trusted Advisor check is
eligible for refresh.
TrustedAdvisorCheckResult
data TrustedAdvisorCheckResult Source #
The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.
See: newTrustedAdvisorCheckResult smart constructor.
Constructors
| TrustedAdvisorCheckResult' Text Text Text TrustedAdvisorResourcesSummary TrustedAdvisorCategorySpecificSummary [TrustedAdvisorResourceDetail] |
Instances
newTrustedAdvisorCheckResult Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TrustedAdvisorResourcesSummary | |
| -> TrustedAdvisorCategorySpecificSummary | |
| -> TrustedAdvisorCheckResult |
Create a value of TrustedAdvisorCheckResult 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:checkId:TrustedAdvisorCheckResult', trustedAdvisorCheckResult_checkId - The unique identifier for the Trusted Advisor check.
$sel:timestamp:TrustedAdvisorCheckResult', trustedAdvisorCheckResult_timestamp - The time of the last refresh of the check.
TrustedAdvisorCheckResult, trustedAdvisorCheckResult_status - The alert status of the check: "ok" (green), "warning" (yellow),
"error" (red), or "not_available".
$sel:resourcesSummary:TrustedAdvisorCheckResult', trustedAdvisorCheckResult_resourcesSummary - Undocumented member.
$sel:categorySpecificSummary:TrustedAdvisorCheckResult', trustedAdvisorCheckResult_categorySpecificSummary - Summary information that relates to the category of the check. Cost
Optimizing is the only category that is currently supported.
$sel:flaggedResources:TrustedAdvisorCheckResult', trustedAdvisorCheckResult_flaggedResources - The details about each resource listed in the check result.
TrustedAdvisorCheckSummary
data TrustedAdvisorCheckSummary Source #
A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.
See: newTrustedAdvisorCheckSummary smart constructor.
Constructors
| TrustedAdvisorCheckSummary' (Maybe Bool) Text Text Text TrustedAdvisorResourcesSummary TrustedAdvisorCategorySpecificSummary |
Instances
newTrustedAdvisorCheckSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TrustedAdvisorResourcesSummary | |
| -> TrustedAdvisorCategorySpecificSummary | |
| -> TrustedAdvisorCheckSummary |
Create a value of TrustedAdvisorCheckSummary 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:hasFlaggedResources:TrustedAdvisorCheckSummary', trustedAdvisorCheckSummary_hasFlaggedResources - Specifies whether the Trusted Advisor check has flagged resources.
$sel:checkId:TrustedAdvisorCheckSummary', trustedAdvisorCheckSummary_checkId - The unique identifier for the Trusted Advisor check.
$sel:timestamp:TrustedAdvisorCheckSummary', trustedAdvisorCheckSummary_timestamp - The time of the last refresh of the check.
$sel:status:TrustedAdvisorCheckSummary', trustedAdvisorCheckSummary_status - The alert status of the check: "ok" (green), "warning" (yellow),
"error" (red), or "not_available".
$sel:resourcesSummary:TrustedAdvisorCheckSummary', trustedAdvisorCheckSummary_resourcesSummary - Undocumented member.
$sel:categorySpecificSummary:TrustedAdvisorCheckSummary', trustedAdvisorCheckSummary_categorySpecificSummary - Summary information that relates to the category of the check. Cost
Optimizing is the only category that is currently supported.
TrustedAdvisorCostOptimizingSummary
data TrustedAdvisorCostOptimizingSummary Source #
The estimated cost savings that might be realized if the recommended operations are taken.
See: newTrustedAdvisorCostOptimizingSummary smart constructor.
Constructors
| TrustedAdvisorCostOptimizingSummary' Double Double |
Instances
newTrustedAdvisorCostOptimizingSummary Source #
Arguments
| :: Double |
|
| -> Double |
|
| -> TrustedAdvisorCostOptimizingSummary |
Create a value of TrustedAdvisorCostOptimizingSummary 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:estimatedMonthlySavings:TrustedAdvisorCostOptimizingSummary', trustedAdvisorCostOptimizingSummary_estimatedMonthlySavings - The estimated monthly savings that might be realized if the recommended
operations are taken.
$sel:estimatedPercentMonthlySavings:TrustedAdvisorCostOptimizingSummary', trustedAdvisorCostOptimizingSummary_estimatedPercentMonthlySavings - The estimated percentage of savings that might be realized if the
recommended operations are taken.
TrustedAdvisorResourceDetail
data TrustedAdvisorResourceDetail Source #
Contains information about a resource identified by a Trusted Advisor check.
See: newTrustedAdvisorResourceDetail smart constructor.
Instances
newTrustedAdvisorResourceDetail Source #
Arguments
| :: Text | |
| -> Text | |
| -> TrustedAdvisorResourceDetail |
Create a value of TrustedAdvisorResourceDetail 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:isSuppressed:TrustedAdvisorResourceDetail', trustedAdvisorResourceDetail_isSuppressed - Specifies whether the Amazon Web Services resource was ignored by
Trusted Advisor because it was marked as suppressed by the user.
$sel:region:TrustedAdvisorResourceDetail', trustedAdvisorResourceDetail_region - The Amazon Web Services Region in which the identified resource is
located.
$sel:status:TrustedAdvisorResourceDetail', trustedAdvisorResourceDetail_status - The status code for the resource identified in the Trusted Advisor
check.
$sel:resourceId:TrustedAdvisorResourceDetail', trustedAdvisorResourceDetail_resourceId - The unique identifier for the identified resource.
$sel:metadata:TrustedAdvisorResourceDetail', trustedAdvisorResourceDetail_metadata - 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
data TrustedAdvisorResourcesSummary Source #
Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
See: newTrustedAdvisorResourcesSummary smart constructor.
Constructors
| TrustedAdvisorResourcesSummary' Integer Integer Integer Integer |
Instances
newTrustedAdvisorResourcesSummary Source #
Arguments
| :: Integer | |
| -> Integer | |
| -> Integer | |
| -> Integer | |
| -> TrustedAdvisorResourcesSummary |
Create a value of TrustedAdvisorResourcesSummary 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:resourcesProcessed:TrustedAdvisorResourcesSummary', trustedAdvisorResourcesSummary_resourcesProcessed - The number of Amazon Web Services resources that were analyzed by the
Trusted Advisor check.
$sel:resourcesFlagged:TrustedAdvisorResourcesSummary', trustedAdvisorResourcesSummary_resourcesFlagged - The number of Amazon Web Services resources that were flagged (listed)
by the Trusted Advisor check.
$sel:resourcesIgnored:TrustedAdvisorResourcesSummary', trustedAdvisorResourcesSummary_resourcesIgnored - The number of Amazon Web Services resources ignored by Trusted Advisor
because information was unavailable.
$sel:resourcesSuppressed:TrustedAdvisorResourcesSummary', trustedAdvisorResourcesSummary_resourcesSuppressed - The number of Amazon Web Services resources ignored by Trusted Advisor
because they were marked as suppressed by the user.