String 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.
SdkInternalList<T> 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
.
String 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.
String expiryTime
The time and date when the attachment set expires.
String 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
String communicationBody
The body of an email communication to add to the support case.
SdkInternalList<T> ccEmailAddresses
The email addresses in the CC line of an email to be added to the support case.
String 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
Boolean result
True if AddCommunicationToCase succeeds. Otherwise, returns an error.
String fileName
The name of the attachment file.
ByteBuffer data
The content of the attachment file.
String 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
String displayId
The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.
String subject
The subject line for the case in the Amazon Web Services Support Center.
String status
The status of the case.
Valid values:
opened
pending-customer-action
reopened
resolved
unassigned
work-in-progress
String serviceCode
The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.
String categoryCode
The category of problem for the support case.
String severityCode
The code for the severity level returned by the call to DescribeSeverityLevels.
String submittedBy
The email address of the account that submitted the case.
String timeCreated
The time that the case was created in the Amazon Web Services Support Center.
RecentCaseCommunications 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.
SdkInternalList<T> ccEmailAddresses
The email addresses that receive copies of communication about the case.
String language
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently
supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code
for the language
parameter if you want support in that language.
String 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
String body
The text of the communication between the customer and Amazon Web Services Support.
String submittedBy
The identity of the account that submitted, or responded to, the support case. Customer entries include the IAM role as well as the email address (for example, "AdminRole (Role) <[email protected]>). Entries from the Amazon Web Services Support team display "Amazon Web Services," and don't show an email address.
String timeCreated
The time the communication was created.
SdkInternalList<T> attachmentSet
Information about the attachments to the case communication.
String type
A string value indicating the communication type. At the moment the type value can assume one of 3 values at the moment chat, web and call.
SdkInternalList<T> supportedHours
A JSON-formatted list containing time ranges when support is available.
SdkInternalList<T> datesWithoutSupport
A JSON-formatted list containing date and time ranges for periods without support
String subject
The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.
String serviceCode
The code for the Amazon Web Services service. You can use the DescribeServices operation to get the
possible serviceCode
values.
String 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.
String 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.
String 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.
SdkInternalList<T> 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.
String language
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently
supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code
for the language
parameter if you want support in that language.
String 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
.
String attachmentSetId
The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.
String 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
String attachmentId
The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
Attachment 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
.
SdkInternalList<T> caseIdList
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
String displayId
The ID displayed for a case in the Amazon Web Services Support Center user interface.
String afterTime
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
String beforeTime
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
Boolean includeResolvedCases
Specifies whether to include resolved support cases in the DescribeCases
response. By default,
resolved cases aren't included.
String nextToken
A resumption point for pagination.
Integer maxResults
The maximum number of results to return before paginating.
String language
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently
supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code
for the language
parameter if you want support in that language.
Boolean includeCommunications
Specifies whether to include communications in the DescribeCases
response. By default,
communications are included.
SdkInternalList<T> cases
The details for the cases that match the request.
String nextToken
A resumption point for pagination.
String 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
String beforeTime
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
String afterTime
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
String nextToken
A resumption point for pagination.
Integer maxResults
The maximum number of results to return before paginating.
SdkInternalList<T> communications
The communications for the case.
String nextToken
A resumption point for pagination.
String 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
.
String serviceCode
The code for the Amazon Web Services service. You can use the DescribeServices operation to get the
possible serviceCode
values.
String language
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently
supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code
for the language
parameter if you want support in that language.
String 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.
String languageAvailability
Language availability can be any of the following:
available
best_effort
unavailable
SdkInternalList<T> communicationTypes
A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.
SdkInternalList<T> serviceCodeList
A JSON-formatted list of service codes available for Amazon Web Services services.
String language
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently
supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code
for the language
parameter if you want support in that language.
SdkInternalList<T> services
A JSON-formatted list of Amazon Web Services services.
String language
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently
supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code
for the language
parameter if you want support in that language.
SdkInternalList<T> severityLevels
The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.
String issueType
The type of issue for the case. You can specify customer-service
or technical
.
String serviceCode
The code for the Amazon Web Services service. You can use the DescribeServices operation to get the
possible serviceCode
values.
String 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.
SdkInternalList<T> supportedLanguages
A JSON-formatted array that contains the available ISO 639-1 language codes.
SdkInternalList<T> 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.
SdkInternalList<T> statuses
The refresh status of the specified Trusted Advisor checks.
String checkId
The unique identifier for the Trusted Advisor check.
String 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
TrustedAdvisorCheckResult result
The detailed results of the Trusted Advisor check.
String 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
SdkInternalList<T> checks
Information about all available Trusted Advisor checks.
SdkInternalList<T> checkIds
The IDs of the Trusted Advisor checks.
SdkInternalList<T> summaries
The summary information for the requested Trusted Advisor checks.
SdkInternalList<T> communications
The five most recent communications associated with the case.
String nextToken
A resumption point for pagination.
String 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.
TrustedAdvisorCheckRefreshStatus status
The current refresh status for a check, including the amount of time until the check is eligible for refresh.
String 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
String initialCaseStatus
The status of the case when the ResolveCase request was sent.
String finalCaseStatus
The status of the case after the ResolveCase request was processed.
String code
The code for an Amazon Web Services service returned by the DescribeServices response. The
name
element contains the corresponding friendly name.
String name
The friendly name for an Amazon Web Services service. The code
element contains the corresponding
code.
SdkInternalList<T> 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.
String code
The code for case severity level.
Valid values: low
| normal
| high
| urgent
|
critical
String 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 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.
TrustedAdvisorCostOptimizingSummary costOptimizing
The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
String id
The unique identifier for the Trusted Advisor check.
String name
The display name for the Trusted Advisor check.
String description
The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
String category
The category of the Trusted Advisor check.
SdkInternalList<T> 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.
String checkId
The unique identifier for the Trusted Advisor check.
String 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
Long millisUntilNextRefreshable
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
String checkId
The unique identifier for the Trusted Advisor check.
String timestamp
The time of the last refresh of the check.
String status
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
SdkInternalList<T> flaggedResources
The details about each resource listed in the check result.
String checkId
The unique identifier for the Trusted Advisor check.
String timestamp
The time of the last refresh of the check.
String status
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
Boolean hasFlaggedResources
Specifies whether the Trusted Advisor check has flagged resources.
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
Double estimatedMonthlySavings
The estimated monthly savings that might be realized if the recommended operations are taken.
Double estimatedPercentMonthlySavings
The estimated percentage of savings that might be realized if the recommended operations are taken.
String status
The status code for the resource identified in the Trusted Advisor check.
String region
The Amazon Web Services Region in which the identified resource is located.
String resourceId
The unique identifier for the identified resource.
Boolean isSuppressed
Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
SdkInternalList<T> 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.
Long resourcesProcessed
The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.
Long resourcesFlagged
The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.
Long resourcesIgnored
The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.
Long resourcesSuppressed
The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.
Copyright © 2023. All rights reserved.