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

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

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

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

The requested caseId couldn't be located.

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

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

An attachment with the specified ID could not be found.

An internal server error occurred.

The case creation limit for the account has been exceeded.

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

See: newAttachment smart constructor.

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.

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.

The name of the attachment file.

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.

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.

The ID of the attachment.

The file name of the attachment.

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 CategoryCode values returned by a call to DescribeServices.
• displayId - The identifier for the case on pages in the AWS Support Center.
• language - The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
• nextToken - A resumption point for pagination.
• recentCommunications - One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.
• serviceCode - The identifier for the AWS 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, and critical.

• status - The status of the case in the AWS 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.

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:subject:CaseDetails', caseDetails_subject - The subject line for the case in the AWS Support Center.

$sel:status:CaseDetails', caseDetails_status - The status of the case.

Valid values:

• opened

• pending-customer-action

• reopened

• resolved

• unassigned

• work-in-progress

$sel:recentCommunications:CaseDetails', caseDetails_recentCommunications - The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

$sel:severityCode:CaseDetails', caseDetails_severityCode - The code for the severity level returned by the call to DescribeSeverityLevels.

$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: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 AWS Support Center. This is a numeric string.

$sel:submittedBy:CaseDetails', caseDetails_submittedBy - The email address of the account that submitted the case.

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

$sel:timeCreated:CaseDetails', caseDetails_timeCreated - The time that the case was created in the AWS Support Center.

$sel:categoryCode:CaseDetails', caseDetails_categoryCode - The category of problem for the support case.

$sel:serviceCode:CaseDetails', caseDetails_serviceCode - The code for the AWS service. You can get a list of codes and the corresponding service names by calling DescribeServices.

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

The status of the case.

Valid values:

• opened

• pending-customer-action

• reopened

• resolved

• unassigned

• work-in-progress

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

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

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

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

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

The email address of the account that submitted the case.

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

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

The category of problem for the support case.

The code for the AWS service. You can get a list of codes and the corresponding service names by calling DescribeServices.

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

See: newCategory smart constructor.

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:name:Category', category_name - The category name for the support case.

$sel:code:Category', category_code - The category code for the support case.

The category name for the support case.

The category code for the support case.

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.

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:body:Communication', communication_body - The text of the communication between the customer and AWS 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 AWS Support team display "Amazon Web Services," and don't show an email address.

$sel:timeCreated:Communication', communication_timeCreated - The time the communication was created.

$sel:attachmentSet:Communication', communication_attachmentSet - Information about the attachments to the case communication.

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

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

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 AWS Support team display "Amazon Web Services," and don't show an email address.

The time the communication was created.

Information about the attachments to the case communication.

The five most recent communications associated with the case.

See: newRecentCaseCommunications smart constructor.

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:nextToken:RecentCaseCommunications', recentCaseCommunications_nextToken - A resumption point for pagination.

$sel:communications:RecentCaseCommunications', recentCaseCommunications_communications - The five most recent communications associated with the case.

A resumption point for pagination.

The five most recent communications associated with the case.

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 AWS Support User Guide.

See: newSeverityLevel smart constructor.

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: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 AWS 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 AWS Support User Guide.

$sel:code:SeverityLevel', severityLevel_code - The code for case severity level.

Valid values: low | normal | high | urgent | critical

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 AWS 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 AWS Support User Guide.

The code for case severity level.

Valid values: low | normal | high | urgent | critical

Information about an AWS service returned by the DescribeServices operation.

See: newSupportService smart constructor.

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 AWS Support when you call CreateCase.

$sel:name:SupportService', supportService_name - The friendly name for an AWS service. The code element contains the corresponding code.

$sel:code:SupportService', supportService_code - The code for an AWS service returned by the DescribeServices response. The name element contains the corresponding friendly name.

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

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

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

The container for summary information that relates to the category of the Trusted Advisor check.

See: newTrustedAdvisorCategorySpecificSummary smart constructor.

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.

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

The description and metadata for a Trusted Advisor check.

See: newTrustedAdvisorCheckDescription smart constructor.

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.

The unique identifier for the Trusted Advisor check.

The display name for the Trusted Advisor check.

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

The category of the Trusted Advisor check.

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.

The refresh status of a Trusted Advisor check.

See: newTrustedAdvisorCheckRefreshStatus smart constructor.

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

$sel:millisUntilNextRefreshable:TrustedAdvisorCheckRefreshStatus', trustedAdvisorCheckRefreshStatus_millisUntilNextRefreshable - The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

The unique identifier for the Trusted Advisor check.

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

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

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

See: newTrustedAdvisorCheckResult smart constructor.

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.

$sel:status: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.

The unique identifier for the Trusted Advisor check.

The time of the last refresh of the check.

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

Undocumented member.

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

The details about each resource listed in the check result.

A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

See: newTrustedAdvisorCheckSummary smart constructor.

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.

Specifies whether the Trusted Advisor check has flagged resources.

The unique identifier for the Trusted Advisor check.

The time of the last refresh of the check.

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

Undocumented member.

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

The estimated cost savings that might be realized if the recommended operations are taken.

See: newTrustedAdvisorCostOptimizingSummary smart constructor.

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.

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

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

Contains information about a resource identified by a Trusted Advisor check.

See: newTrustedAdvisorResourceDetail smart constructor.

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 AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

$sel:region:TrustedAdvisorResourceDetail', trustedAdvisorResourceDetail_region - The AWS 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.

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

The AWS Region in which the identified resource is located.

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

The unique identifier for the identified resource.

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.

Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

See: newTrustedAdvisorResourcesSummary smart constructor.

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 AWS resources that were analyzed by the Trusted Advisor check.