amazonka-support-2.0: Amazon Support SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Support.Lens

Description

 
Synopsis

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.

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.

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

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.

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.

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_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

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.

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.

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.

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.

DescribeTrustedAdvisorCheckSummaries

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

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

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_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

category_code :: Lens' Category (Maybe Text) Source #

The category code for the support case.

category_name :: Lens' Category (Maybe Text) Source #

The category name for the support case.

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.

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 guidance
  • normal - System impaired
  • high - Production system impaired
  • urgent - Production system down
  • critical - 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_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 timeout
  • enqueued - The check refresh requests has entered the refresh queue
  • processing - The check refresh request is picked up by the rule processing engine
  • success - The check is successfully refreshed
  • abandoned - 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_status :: Lens' TrustedAdvisorCheckResult Text Source #

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

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.

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_status :: Lens' TrustedAdvisorCheckSummary Text Source #

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

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.