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 |
- Operations
- AddAttachmentsToSet
- AddCommunicationToCase
- CreateCase
- DescribeAttachment
- DescribeCases
- DescribeCommunications
- 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
Synopsis
- addAttachmentsToSet_attachmentSetId :: Lens' AddAttachmentsToSet (Maybe Text)
- addAttachmentsToSet_attachments :: Lens' AddAttachmentsToSet [Attachment]
- addAttachmentsToSetResponse_attachmentSetId :: Lens' AddAttachmentsToSetResponse (Maybe Text)
- addAttachmentsToSetResponse_expiryTime :: Lens' AddAttachmentsToSetResponse (Maybe Text)
- addAttachmentsToSetResponse_httpStatus :: Lens' AddAttachmentsToSetResponse Int
- addCommunicationToCase_attachmentSetId :: Lens' AddCommunicationToCase (Maybe Text)
- addCommunicationToCase_caseId :: Lens' AddCommunicationToCase (Maybe Text)
- addCommunicationToCase_ccEmailAddresses :: Lens' AddCommunicationToCase (Maybe [Text])
- addCommunicationToCase_communicationBody :: Lens' AddCommunicationToCase Text
- addCommunicationToCaseResponse_result :: Lens' AddCommunicationToCaseResponse (Maybe Bool)
- addCommunicationToCaseResponse_httpStatus :: Lens' AddCommunicationToCaseResponse Int
- createCase_attachmentSetId :: Lens' CreateCase (Maybe Text)
- createCase_categoryCode :: Lens' CreateCase (Maybe Text)
- createCase_ccEmailAddresses :: Lens' CreateCase (Maybe [Text])
- createCase_issueType :: Lens' CreateCase (Maybe Text)
- createCase_language :: Lens' CreateCase (Maybe Text)
- createCase_serviceCode :: Lens' CreateCase (Maybe Text)
- createCase_severityCode :: Lens' CreateCase (Maybe Text)
- createCase_subject :: Lens' CreateCase Text
- createCase_communicationBody :: Lens' CreateCase Text
- createCaseResponse_caseId :: Lens' CreateCaseResponse (Maybe Text)
- createCaseResponse_httpStatus :: Lens' CreateCaseResponse Int
- describeAttachment_attachmentId :: Lens' DescribeAttachment Text
- describeAttachmentResponse_attachment :: Lens' DescribeAttachmentResponse (Maybe Attachment)
- describeAttachmentResponse_httpStatus :: Lens' DescribeAttachmentResponse Int
- describeCases_afterTime :: Lens' DescribeCases (Maybe Text)
- describeCases_beforeTime :: Lens' DescribeCases (Maybe Text)
- describeCases_caseIdList :: Lens' DescribeCases (Maybe [Text])
- describeCases_displayId :: Lens' DescribeCases (Maybe Text)
- describeCases_includeCommunications :: Lens' DescribeCases (Maybe Bool)
- describeCases_includeResolvedCases :: Lens' DescribeCases (Maybe Bool)
- describeCases_language :: Lens' DescribeCases (Maybe Text)
- describeCases_maxResults :: Lens' DescribeCases (Maybe Natural)
- describeCases_nextToken :: Lens' DescribeCases (Maybe Text)
- describeCasesResponse_cases :: Lens' DescribeCasesResponse (Maybe [CaseDetails])
- describeCasesResponse_nextToken :: Lens' DescribeCasesResponse (Maybe Text)
- describeCasesResponse_httpStatus :: Lens' DescribeCasesResponse Int
- describeCommunications_afterTime :: Lens' DescribeCommunications (Maybe Text)
- describeCommunications_beforeTime :: Lens' DescribeCommunications (Maybe Text)
- describeCommunications_maxResults :: Lens' DescribeCommunications (Maybe Natural)
- describeCommunications_nextToken :: Lens' DescribeCommunications (Maybe Text)
- describeCommunications_caseId :: Lens' DescribeCommunications Text
- describeCommunicationsResponse_communications :: Lens' DescribeCommunicationsResponse (Maybe [Communication])
- describeCommunicationsResponse_nextToken :: Lens' DescribeCommunicationsResponse (Maybe Text)
- describeCommunicationsResponse_httpStatus :: Lens' DescribeCommunicationsResponse Int
- describeServices_language :: Lens' DescribeServices (Maybe Text)
- describeServices_serviceCodeList :: Lens' DescribeServices (Maybe [Text])
- describeServicesResponse_services :: Lens' DescribeServicesResponse (Maybe [SupportService])
- describeServicesResponse_httpStatus :: Lens' DescribeServicesResponse Int
- describeSeverityLevels_language :: Lens' DescribeSeverityLevels (Maybe Text)
- describeSeverityLevelsResponse_severityLevels :: Lens' DescribeSeverityLevelsResponse (Maybe [SeverityLevel])
- describeSeverityLevelsResponse_httpStatus :: Lens' DescribeSeverityLevelsResponse Int
- describeTrustedAdvisorCheckRefreshStatuses_checkIds :: Lens' DescribeTrustedAdvisorCheckRefreshStatuses [Text]
- describeTrustedAdvisorCheckRefreshStatusesResponse_httpStatus :: Lens' DescribeTrustedAdvisorCheckRefreshStatusesResponse Int
- describeTrustedAdvisorCheckRefreshStatusesResponse_statuses :: Lens' DescribeTrustedAdvisorCheckRefreshStatusesResponse [TrustedAdvisorCheckRefreshStatus]
- describeTrustedAdvisorCheckResult_language :: Lens' DescribeTrustedAdvisorCheckResult (Maybe Text)
- describeTrustedAdvisorCheckResult_checkId :: Lens' DescribeTrustedAdvisorCheckResult Text
- describeTrustedAdvisorCheckResultResponse_result :: Lens' DescribeTrustedAdvisorCheckResultResponse (Maybe TrustedAdvisorCheckResult)
- describeTrustedAdvisorCheckResultResponse_httpStatus :: Lens' DescribeTrustedAdvisorCheckResultResponse Int
- describeTrustedAdvisorCheckSummaries_checkIds :: Lens' DescribeTrustedAdvisorCheckSummaries [Text]
- describeTrustedAdvisorCheckSummariesResponse_httpStatus :: Lens' DescribeTrustedAdvisorCheckSummariesResponse Int
- describeTrustedAdvisorCheckSummariesResponse_summaries :: Lens' DescribeTrustedAdvisorCheckSummariesResponse [TrustedAdvisorCheckSummary]
- describeTrustedAdvisorChecks_language :: Lens' DescribeTrustedAdvisorChecks Text
- describeTrustedAdvisorChecksResponse_httpStatus :: Lens' DescribeTrustedAdvisorChecksResponse Int
- describeTrustedAdvisorChecksResponse_checks :: Lens' DescribeTrustedAdvisorChecksResponse [TrustedAdvisorCheckDescription]
- refreshTrustedAdvisorCheck_checkId :: Lens' RefreshTrustedAdvisorCheck Text
- refreshTrustedAdvisorCheckResponse_httpStatus :: Lens' RefreshTrustedAdvisorCheckResponse Int
- refreshTrustedAdvisorCheckResponse_status :: Lens' RefreshTrustedAdvisorCheckResponse TrustedAdvisorCheckRefreshStatus
- resolveCase_caseId :: Lens' ResolveCase (Maybe Text)
- resolveCaseResponse_finalCaseStatus :: Lens' ResolveCaseResponse (Maybe Text)
- resolveCaseResponse_initialCaseStatus :: Lens' ResolveCaseResponse (Maybe Text)
- resolveCaseResponse_httpStatus :: Lens' ResolveCaseResponse Int
- attachment_data :: Lens' Attachment (Maybe ByteString)
- attachment_fileName :: Lens' Attachment (Maybe Text)
- attachmentDetails_attachmentId :: Lens' AttachmentDetails (Maybe Text)
- attachmentDetails_fileName :: Lens' AttachmentDetails (Maybe Text)
- caseDetails_caseId :: Lens' CaseDetails (Maybe Text)
- caseDetails_categoryCode :: Lens' CaseDetails (Maybe Text)
- caseDetails_ccEmailAddresses :: Lens' CaseDetails (Maybe [Text])
- caseDetails_displayId :: Lens' CaseDetails (Maybe Text)
- caseDetails_language :: Lens' CaseDetails (Maybe Text)
- caseDetails_recentCommunications :: Lens' CaseDetails (Maybe RecentCaseCommunications)
- caseDetails_serviceCode :: Lens' CaseDetails (Maybe Text)
- caseDetails_severityCode :: Lens' CaseDetails (Maybe Text)
- caseDetails_status :: Lens' CaseDetails (Maybe Text)
- caseDetails_subject :: Lens' CaseDetails (Maybe Text)
- caseDetails_submittedBy :: Lens' CaseDetails (Maybe Text)
- caseDetails_timeCreated :: Lens' CaseDetails (Maybe Text)
- category_code :: Lens' Category (Maybe Text)
- category_name :: Lens' Category (Maybe Text)
- communication_attachmentSet :: Lens' Communication (Maybe [AttachmentDetails])
- communication_body :: Lens' Communication (Maybe Text)
- communication_caseId :: Lens' Communication (Maybe Text)
- communication_submittedBy :: Lens' Communication (Maybe Text)
- communication_timeCreated :: Lens' Communication (Maybe Text)
- recentCaseCommunications_communications :: Lens' RecentCaseCommunications (Maybe [Communication])
- recentCaseCommunications_nextToken :: Lens' RecentCaseCommunications (Maybe Text)
- severityLevel_code :: Lens' SeverityLevel (Maybe Text)
- severityLevel_name :: Lens' SeverityLevel (Maybe Text)
- supportService_categories :: Lens' SupportService (Maybe [Category])
- supportService_code :: Lens' SupportService (Maybe Text)
- supportService_name :: Lens' SupportService (Maybe Text)
- trustedAdvisorCategorySpecificSummary_costOptimizing :: Lens' TrustedAdvisorCategorySpecificSummary (Maybe TrustedAdvisorCostOptimizingSummary)
- trustedAdvisorCheckDescription_id :: Lens' TrustedAdvisorCheckDescription Text
- trustedAdvisorCheckDescription_name :: Lens' TrustedAdvisorCheckDescription Text
- trustedAdvisorCheckDescription_description :: Lens' TrustedAdvisorCheckDescription Text
- trustedAdvisorCheckDescription_category :: Lens' TrustedAdvisorCheckDescription Text
- trustedAdvisorCheckDescription_metadata :: Lens' TrustedAdvisorCheckDescription [Text]
- trustedAdvisorCheckRefreshStatus_checkId :: Lens' TrustedAdvisorCheckRefreshStatus Text
- trustedAdvisorCheckRefreshStatus_status :: Lens' TrustedAdvisorCheckRefreshStatus Text
- trustedAdvisorCheckRefreshStatus_millisUntilNextRefreshable :: Lens' TrustedAdvisorCheckRefreshStatus Integer
- trustedAdvisorCheckResult_checkId :: Lens' TrustedAdvisorCheckResult Text
- trustedAdvisorCheckResult_timestamp :: Lens' TrustedAdvisorCheckResult Text
- trustedAdvisorCheckResult_status :: Lens' TrustedAdvisorCheckResult Text
- trustedAdvisorCheckResult_resourcesSummary :: Lens' TrustedAdvisorCheckResult TrustedAdvisorResourcesSummary
- trustedAdvisorCheckResult_categorySpecificSummary :: Lens' TrustedAdvisorCheckResult TrustedAdvisorCategorySpecificSummary
- trustedAdvisorCheckResult_flaggedResources :: Lens' TrustedAdvisorCheckResult [TrustedAdvisorResourceDetail]
- trustedAdvisorCheckSummary_hasFlaggedResources :: Lens' TrustedAdvisorCheckSummary (Maybe Bool)
- trustedAdvisorCheckSummary_checkId :: Lens' TrustedAdvisorCheckSummary Text
- trustedAdvisorCheckSummary_timestamp :: Lens' TrustedAdvisorCheckSummary Text
- trustedAdvisorCheckSummary_status :: Lens' TrustedAdvisorCheckSummary Text
- trustedAdvisorCheckSummary_resourcesSummary :: Lens' TrustedAdvisorCheckSummary TrustedAdvisorResourcesSummary
- trustedAdvisorCheckSummary_categorySpecificSummary :: Lens' TrustedAdvisorCheckSummary TrustedAdvisorCategorySpecificSummary
- trustedAdvisorCostOptimizingSummary_estimatedMonthlySavings :: Lens' TrustedAdvisorCostOptimizingSummary Double
- trustedAdvisorCostOptimizingSummary_estimatedPercentMonthlySavings :: Lens' TrustedAdvisorCostOptimizingSummary Double
- trustedAdvisorResourceDetail_isSuppressed :: Lens' TrustedAdvisorResourceDetail (Maybe Bool)
- trustedAdvisorResourceDetail_region :: Lens' TrustedAdvisorResourceDetail (Maybe Text)
- trustedAdvisorResourceDetail_status :: Lens' TrustedAdvisorResourceDetail Text
- trustedAdvisorResourceDetail_resourceId :: Lens' TrustedAdvisorResourceDetail Text
- trustedAdvisorResourceDetail_metadata :: Lens' TrustedAdvisorResourceDetail [Text]
- trustedAdvisorResourcesSummary_resourcesProcessed :: Lens' TrustedAdvisorResourcesSummary Integer
- trustedAdvisorResourcesSummary_resourcesFlagged :: Lens' TrustedAdvisorResourcesSummary Integer
- trustedAdvisorResourcesSummary_resourcesIgnored :: Lens' TrustedAdvisorResourcesSummary Integer
- trustedAdvisorResourcesSummary_resourcesSuppressed :: Lens' TrustedAdvisorResourcesSummary Integer
Operations
AddAttachmentsToSet
addAttachmentsToSet_attachmentSetId :: Lens' AddAttachmentsToSet (Maybe Text) Source #
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.
addAttachmentsToSet_attachments :: Lens' AddAttachmentsToSet [Attachment] Source #
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
.
addAttachmentsToSetResponse_attachmentSetId :: Lens' AddAttachmentsToSetResponse (Maybe Text) Source #
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.
addAttachmentsToSetResponse_expiryTime :: Lens' AddAttachmentsToSetResponse (Maybe Text) Source #
The time and date when the attachment set expires.
addAttachmentsToSetResponse_httpStatus :: Lens' AddAttachmentsToSetResponse Int Source #
The response's http status code.
AddCommunicationToCase
addCommunicationToCase_attachmentSetId :: Lens' AddCommunicationToCase (Maybe Text) Source #
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_caseId :: Lens' AddCommunicationToCase (Maybe Text) Source #
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_ccEmailAddresses :: Lens' AddCommunicationToCase (Maybe [Text]) Source #
The email addresses in the CC line of an email to be added to the support case.
addCommunicationToCase_communicationBody :: Lens' AddCommunicationToCase Text Source #
The body of an email communication to add to the support case.
addCommunicationToCaseResponse_result :: Lens' AddCommunicationToCaseResponse (Maybe Bool) Source #
True if AddCommunicationToCase succeeds. Otherwise, returns an error.
addCommunicationToCaseResponse_httpStatus :: Lens' AddCommunicationToCaseResponse Int Source #
The response's http status code.
CreateCase
createCase_attachmentSetId :: Lens' CreateCase (Maybe Text) Source #
The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.
createCase_categoryCode :: Lens' CreateCase (Maybe Text) Source #
The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.
createCase_ccEmailAddresses :: Lens' CreateCase (Maybe [Text]) Source #
A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs.
createCase_issueType :: Lens' CreateCase (Maybe Text) Source #
The type of issue for the case. You can specify customer-service
or
technical
. If you don't specify a value, the default is technical
.
createCase_language :: Lens' CreateCase (Maybe Text) Source #
The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports English ("en") and
Japanese ("ja"). You must specify the ISO 639-1 code for the
language
parameter if you want support in that language.
createCase_serviceCode :: Lens' CreateCase (Maybe Text) Source #
The code for the Amazon Web Services service. You can use the
DescribeServices operation to get the possible serviceCode
values.
createCase_severityCode :: Lens' CreateCase (Maybe Text) Source #
A value that indicates the urgency of the case. This value determines
the response time according to your service level agreement with Amazon
Web Services Support. You can use the DescribeSeverityLevels operation
to get the possible values for severityCode
.
For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide.
The availability of severity levels depends on the support plan for the Amazon Web Services account.
createCase_subject :: Lens' CreateCase Text Source #
The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.
createCase_communicationBody :: Lens' CreateCase Text Source #
The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.
createCaseResponse_caseId :: Lens' CreateCaseResponse (Maybe Text) Source #
The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47
createCaseResponse_httpStatus :: Lens' CreateCaseResponse Int Source #
The response's http status code.
DescribeAttachment
describeAttachment_attachmentId :: Lens' DescribeAttachment Text Source #
The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
describeAttachmentResponse_attachment :: Lens' DescribeAttachmentResponse (Maybe Attachment) Source #
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
.
describeAttachmentResponse_httpStatus :: Lens' DescribeAttachmentResponse Int Source #
The response's http status code.
DescribeCases
describeCases_afterTime :: Lens' DescribeCases (Maybe Text) Source #
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
describeCases_beforeTime :: Lens' DescribeCases (Maybe Text) Source #
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
describeCases_caseIdList :: Lens' DescribeCases (Maybe [Text]) Source #
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
describeCases_displayId :: Lens' DescribeCases (Maybe Text) Source #
The ID displayed for a case in the Amazon Web Services Support Center user interface.
describeCases_includeCommunications :: Lens' DescribeCases (Maybe Bool) Source #
Specifies whether to include communications in the DescribeCases
response. By default, communications are included.
describeCases_includeResolvedCases :: Lens' DescribeCases (Maybe Bool) Source #
Specifies whether to include resolved support cases in the
DescribeCases
response. By default, resolved cases aren't included.
describeCases_language :: Lens' DescribeCases (Maybe Text) Source #
The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports English ("en") and
Japanese ("ja"). You must specify the ISO 639-1 code for the
language
parameter if you want support in that language.
describeCases_maxResults :: Lens' DescribeCases (Maybe Natural) Source #
The maximum number of results to return before paginating.
describeCases_nextToken :: Lens' DescribeCases (Maybe Text) Source #
A resumption point for pagination.
describeCasesResponse_cases :: Lens' DescribeCasesResponse (Maybe [CaseDetails]) Source #
The details for the cases that match the request.
describeCasesResponse_nextToken :: Lens' DescribeCasesResponse (Maybe Text) Source #
A resumption point for pagination.
describeCasesResponse_httpStatus :: Lens' DescribeCasesResponse Int Source #
The response's http status code.
DescribeCommunications
describeCommunications_afterTime :: Lens' DescribeCommunications (Maybe Text) Source #
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
describeCommunications_beforeTime :: Lens' DescribeCommunications (Maybe Text) Source #
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
describeCommunications_maxResults :: Lens' DescribeCommunications (Maybe Natural) Source #
The maximum number of results to return before paginating.
describeCommunications_nextToken :: Lens' DescribeCommunications (Maybe Text) Source #
A resumption point for pagination.
describeCommunications_caseId :: Lens' DescribeCommunications Text Source #
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
describeCommunicationsResponse_communications :: Lens' DescribeCommunicationsResponse (Maybe [Communication]) Source #
The communications for the case.
describeCommunicationsResponse_nextToken :: Lens' DescribeCommunicationsResponse (Maybe Text) Source #
A resumption point for pagination.
describeCommunicationsResponse_httpStatus :: Lens' DescribeCommunicationsResponse Int Source #
The response's http status code.
DescribeServices
describeServices_language :: Lens' DescribeServices (Maybe Text) Source #
The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports English ("en") and
Japanese ("ja"). You must specify the ISO 639-1 code for the
language
parameter if you want support in that language.
describeServices_serviceCodeList :: Lens' DescribeServices (Maybe [Text]) Source #
A JSON-formatted list of service codes available for Amazon Web Services services.
describeServicesResponse_services :: Lens' DescribeServicesResponse (Maybe [SupportService]) Source #
A JSON-formatted list of Amazon Web Services services.
describeServicesResponse_httpStatus :: Lens' DescribeServicesResponse Int Source #
The response's http status code.
DescribeSeverityLevels
describeSeverityLevels_language :: Lens' DescribeSeverityLevels (Maybe Text) Source #
The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports English ("en") and
Japanese ("ja"). You must specify the ISO 639-1 code for the
language
parameter if you want support in that language.
describeSeverityLevelsResponse_severityLevels :: Lens' DescribeSeverityLevelsResponse (Maybe [SeverityLevel]) Source #
The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.
describeSeverityLevelsResponse_httpStatus :: Lens' DescribeSeverityLevelsResponse Int Source #
The response's http status code.
DescribeTrustedAdvisorCheckRefreshStatuses
describeTrustedAdvisorCheckRefreshStatuses_checkIds :: Lens' DescribeTrustedAdvisorCheckRefreshStatuses [Text] Source #
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.
describeTrustedAdvisorCheckRefreshStatusesResponse_httpStatus :: Lens' DescribeTrustedAdvisorCheckRefreshStatusesResponse Int Source #
The response's http status code.
describeTrustedAdvisorCheckRefreshStatusesResponse_statuses :: Lens' DescribeTrustedAdvisorCheckRefreshStatusesResponse [TrustedAdvisorCheckRefreshStatus] Source #
The refresh status of the specified Trusted Advisor checks.
DescribeTrustedAdvisorCheckResult
describeTrustedAdvisorCheckResult_language :: Lens' DescribeTrustedAdvisorCheckResult (Maybe Text) Source #
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_checkId :: Lens' DescribeTrustedAdvisorCheckResult Text Source #
The unique identifier for the Trusted Advisor check.
describeTrustedAdvisorCheckResultResponse_result :: Lens' DescribeTrustedAdvisorCheckResultResponse (Maybe TrustedAdvisorCheckResult) Source #
The detailed results of the Trusted Advisor check.
describeTrustedAdvisorCheckResultResponse_httpStatus :: Lens' DescribeTrustedAdvisorCheckResultResponse Int Source #
The response's http status code.
DescribeTrustedAdvisorCheckSummaries
describeTrustedAdvisorCheckSummaries_checkIds :: Lens' DescribeTrustedAdvisorCheckSummaries [Text] Source #
The IDs of the Trusted Advisor checks.
describeTrustedAdvisorCheckSummariesResponse_httpStatus :: Lens' DescribeTrustedAdvisorCheckSummariesResponse Int Source #
The response's http status code.
describeTrustedAdvisorCheckSummariesResponse_summaries :: Lens' DescribeTrustedAdvisorCheckSummariesResponse [TrustedAdvisorCheckSummary] Source #
The summary information for the requested Trusted Advisor checks.
DescribeTrustedAdvisorChecks
describeTrustedAdvisorChecks_language :: Lens' DescribeTrustedAdvisorChecks Text Source #
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
describeTrustedAdvisorChecksResponse_httpStatus :: Lens' DescribeTrustedAdvisorChecksResponse Int Source #
The response's http status code.
describeTrustedAdvisorChecksResponse_checks :: Lens' DescribeTrustedAdvisorChecksResponse [TrustedAdvisorCheckDescription] Source #
Information about all available Trusted Advisor checks.
RefreshTrustedAdvisorCheck
refreshTrustedAdvisorCheck_checkId :: Lens' RefreshTrustedAdvisorCheck Text Source #
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.
refreshTrustedAdvisorCheckResponse_httpStatus :: Lens' RefreshTrustedAdvisorCheckResponse Int Source #
The response's http status code.
refreshTrustedAdvisorCheckResponse_status :: Lens' RefreshTrustedAdvisorCheckResponse TrustedAdvisorCheckRefreshStatus Source #
The current refresh status for a check, including the amount of time until the check is eligible for refresh.
ResolveCase
resolveCase_caseId :: Lens' ResolveCase (Maybe Text) Source #
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
resolveCaseResponse_finalCaseStatus :: Lens' ResolveCaseResponse (Maybe Text) Source #
The status of the case after the ResolveCase request was processed.
resolveCaseResponse_initialCaseStatus :: Lens' ResolveCaseResponse (Maybe Text) Source #
The status of the case when the ResolveCase request was sent.
resolveCaseResponse_httpStatus :: Lens' ResolveCaseResponse Int Source #
The response's http status code.
Types
Attachment
attachment_data :: Lens' Attachment (Maybe ByteString) Source #
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.
attachment_fileName :: Lens' Attachment (Maybe Text) Source #
The name of the attachment file.
AttachmentDetails
attachmentDetails_attachmentId :: Lens' AttachmentDetails (Maybe Text) Source #
The ID of the attachment.
attachmentDetails_fileName :: Lens' AttachmentDetails (Maybe Text) Source #
The file name of the attachment.
CaseDetails
caseDetails_caseId :: Lens' CaseDetails (Maybe Text) Source #
The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
caseDetails_categoryCode :: Lens' CaseDetails (Maybe Text) Source #
The category of problem for the support case.
caseDetails_ccEmailAddresses :: Lens' CaseDetails (Maybe [Text]) Source #
The email addresses that receive copies of communication about the case.
caseDetails_displayId :: Lens' CaseDetails (Maybe Text) Source #
The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.
caseDetails_language :: Lens' CaseDetails (Maybe Text) Source #
The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports English ("en") and
Japanese ("ja"). You must specify the ISO 639-1 code for the
language
parameter if you want support in that language.
caseDetails_recentCommunications :: Lens' CaseDetails (Maybe RecentCaseCommunications) Source #
The five most recent communications between you and Amazon Web Services
Support Center, including the IDs of any attachments to the
communications. Also includes a nextToken
that you can use to retrieve
earlier communications.
caseDetails_serviceCode :: Lens' CaseDetails (Maybe Text) Source #
The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.
caseDetails_severityCode :: Lens' CaseDetails (Maybe Text) Source #
The code for the severity level returned by the call to DescribeSeverityLevels.
caseDetails_status :: Lens' CaseDetails (Maybe Text) Source #
The status of the case.
Valid values:
opened
pending-customer-action
reopened
resolved
unassigned
work-in-progress
caseDetails_subject :: Lens' CaseDetails (Maybe Text) Source #
The subject line for the case in the Amazon Web Services Support Center.
caseDetails_submittedBy :: Lens' CaseDetails (Maybe Text) Source #
The email address of the account that submitted the case.
caseDetails_timeCreated :: Lens' CaseDetails (Maybe Text) Source #
The time that the case was created in the Amazon Web Services Support Center.
Category
Communication
communication_attachmentSet :: Lens' Communication (Maybe [AttachmentDetails]) Source #
Information about the attachments to the case communication.
communication_body :: Lens' Communication (Maybe Text) Source #
The text of the communication between the customer and Amazon Web Services Support.
communication_caseId :: Lens' Communication (Maybe Text) Source #
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
communication_submittedBy :: Lens' Communication (Maybe Text) Source #
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.
communication_timeCreated :: Lens' Communication (Maybe Text) Source #
The time the communication was created.
RecentCaseCommunications
recentCaseCommunications_communications :: Lens' RecentCaseCommunications (Maybe [Communication]) Source #
The five most recent communications associated with the case.
recentCaseCommunications_nextToken :: Lens' RecentCaseCommunications (Maybe Text) Source #
A resumption point for pagination.
SeverityLevel
severityLevel_code :: Lens' SeverityLevel (Maybe Text) Source #
The code for case severity level.
Valid values: low
| normal
| high
| urgent
| critical
severityLevel_name :: Lens' SeverityLevel (Maybe Text) Source #
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
supportService_categories :: Lens' SupportService (Maybe [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 Amazon Web Services Support when you call CreateCase.
supportService_code :: Lens' SupportService (Maybe Text) Source #
The code for an Amazon Web Services service returned by the
DescribeServices response. The name
element contains the corresponding
friendly name.
supportService_name :: Lens' SupportService (Maybe Text) Source #
The friendly name for an Amazon Web Services service. The code
element
contains the corresponding code.
TrustedAdvisorCategorySpecificSummary
trustedAdvisorCategorySpecificSummary_costOptimizing :: 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_id :: Lens' TrustedAdvisorCheckDescription Text Source #
The unique identifier for the Trusted Advisor check.
trustedAdvisorCheckDescription_name :: Lens' TrustedAdvisorCheckDescription Text Source #
The display name for the Trusted Advisor check.
trustedAdvisorCheckDescription_description :: Lens' TrustedAdvisorCheckDescription Text Source #
The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
trustedAdvisorCheckDescription_category :: Lens' TrustedAdvisorCheckDescription Text Source #
The category of the Trusted Advisor check.
trustedAdvisorCheckDescription_metadata :: 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_checkId :: Lens' TrustedAdvisorCheckRefreshStatus Text Source #
The unique identifier for the Trusted Advisor check.
trustedAdvisorCheckRefreshStatus_status :: Lens' TrustedAdvisorCheckRefreshStatus Text Source #
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
trustedAdvisorCheckRefreshStatus_millisUntilNextRefreshable :: Lens' TrustedAdvisorCheckRefreshStatus Integer Source #
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
TrustedAdvisorCheckResult
trustedAdvisorCheckResult_checkId :: Lens' TrustedAdvisorCheckResult Text Source #
The unique identifier for the Trusted Advisor check.
trustedAdvisorCheckResult_timestamp :: Lens' TrustedAdvisorCheckResult Text Source #
The time of the last refresh of the check.
trustedAdvisorCheckResult_status :: Lens' TrustedAdvisorCheckResult Text Source #
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
trustedAdvisorCheckResult_resourcesSummary :: Lens' TrustedAdvisorCheckResult TrustedAdvisorResourcesSummary Source #
Undocumented member.
trustedAdvisorCheckResult_categorySpecificSummary :: Lens' TrustedAdvisorCheckResult TrustedAdvisorCategorySpecificSummary Source #
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
trustedAdvisorCheckResult_flaggedResources :: Lens' TrustedAdvisorCheckResult [TrustedAdvisorResourceDetail] Source #
The details about each resource listed in the check result.
TrustedAdvisorCheckSummary
trustedAdvisorCheckSummary_hasFlaggedResources :: Lens' TrustedAdvisorCheckSummary (Maybe Bool) Source #
Specifies whether the Trusted Advisor check has flagged resources.
trustedAdvisorCheckSummary_checkId :: Lens' TrustedAdvisorCheckSummary Text Source #
The unique identifier for the Trusted Advisor check.
trustedAdvisorCheckSummary_timestamp :: Lens' TrustedAdvisorCheckSummary Text Source #
The time of the last refresh of the check.
trustedAdvisorCheckSummary_status :: Lens' TrustedAdvisorCheckSummary Text Source #
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
trustedAdvisorCheckSummary_resourcesSummary :: Lens' TrustedAdvisorCheckSummary TrustedAdvisorResourcesSummary Source #
Undocumented member.
trustedAdvisorCheckSummary_categorySpecificSummary :: 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
trustedAdvisorCostOptimizingSummary_estimatedMonthlySavings :: Lens' TrustedAdvisorCostOptimizingSummary Double Source #
The estimated monthly savings that might be realized if the recommended operations are taken.
trustedAdvisorCostOptimizingSummary_estimatedPercentMonthlySavings :: Lens' TrustedAdvisorCostOptimizingSummary Double Source #
The estimated percentage of savings that might be realized if the recommended operations are taken.
TrustedAdvisorResourceDetail
trustedAdvisorResourceDetail_isSuppressed :: Lens' TrustedAdvisorResourceDetail (Maybe Bool) Source #
Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
trustedAdvisorResourceDetail_region :: Lens' TrustedAdvisorResourceDetail (Maybe Text) Source #
The Amazon Web Services Region in which the identified resource is located.
trustedAdvisorResourceDetail_status :: Lens' TrustedAdvisorResourceDetail Text Source #
The status code for the resource identified in the Trusted Advisor check.
trustedAdvisorResourceDetail_resourceId :: Lens' TrustedAdvisorResourceDetail Text Source #
The unique identifier for the identified resource.
trustedAdvisorResourceDetail_metadata :: 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
trustedAdvisorResourcesSummary_resourcesProcessed :: Lens' TrustedAdvisorResourcesSummary Integer Source #
The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.
trustedAdvisorResourcesSummary_resourcesFlagged :: Lens' TrustedAdvisorResourcesSummary Integer Source #
The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.
trustedAdvisorResourcesSummary_resourcesIgnored :: Lens' TrustedAdvisorResourcesSummary Integer Source #
The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.
trustedAdvisorResourcesSummary_resourcesSuppressed :: Lens' TrustedAdvisorResourcesSummary Integer Source #
The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.