文档 AWS SDK 示例 GitHub 存储库中还有更多 [S AWS DK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# 使用的基本示 支持 例 AWS SDKs
以下代码示例说明如何使用 with 的基础 AWS 支持 知识 AWS SDKs。
**Contents**
+ [你好 支持](support_example_support_Hello_section.md)
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
+ [操作](support_code_examples_actions.md)
+ [`AddAttachmentsToSet`](support_example_support_AddAttachmentsToSet_section.md)
+ [`AddCommunicationToCase`](support_example_support_AddCommunicationToCase_section.md)
+ [`CreateCase`](support_example_support_CreateCase_section.md)
+ [`DescribeAttachment`](support_example_support_DescribeAttachment_section.md)
+ [`DescribeCases`](support_example_support_DescribeCases_section.md)
+ [`DescribeCommunications`](support_example_support_DescribeCommunications_section.md)
+ [`DescribeServices`](support_example_support_DescribeServices_section.md)
+ [`DescribeSeverityLevels`](support_example_support_DescribeSeverityLevels_section.md)
+ [`DescribeTrustedAdvisorCheckRefreshStatuses`](support_example_support_DescribeTrustedAdvisorCheckRefreshStatuses_section.md)
+ [`DescribeTrustedAdvisorCheckResult`](support_example_support_DescribeTrustedAdvisorCheckResult_section.md)
+ [`DescribeTrustedAdvisorCheckSummaries`](support_example_support_DescribeTrustedAdvisorCheckSummaries_section.md)
+ [`DescribeTrustedAdvisorChecks`](support_example_support_DescribeTrustedAdvisorChecks_section.md)
+ [`RefreshTrustedAdvisorCheck`](support_example_support_RefreshTrustedAdvisorCheck_section.md)
+ [`ResolveCase`](support_example_support_ResolveCase_section.md)
# 你好 支持
以下代码示例展示了如何开始使用 支持。
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
using Amazon.AWSSupport;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
public static class HelloSupport
{
static async Task Main(string[] args)
{
// Use the AWS .NET Core Setup package to set up dependency injection for the AWS Support service.
// Use your AWS profile name, or leave it blank to use the default profile.
// You must have one of the following AWS Support plans: Business, Enterprise On-Ramp, or Enterprise. Otherwise, an exception will be thrown.
using var host = Host.CreateDefaultBuilder(args)
.ConfigureServices((_, services) =>
services.AddAWSService()
).Build();
// Now the client is available for injection.
var supportClient = host.Services.GetRequiredService();
// You can use await and any of the async methods to get a response.
var response = await supportClient.DescribeServicesAsync();
Console.WriteLine($"\tHello AWS Support! There are {response.Services.Count} services available.");
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DescribeServices](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeServices)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.support.SupportClient;
import software.amazon.awssdk.services.support.model.Category;
import software.amazon.awssdk.services.support.model.DescribeServicesRequest;
import software.amazon.awssdk.services.support.model.DescribeServicesResponse;
import software.amazon.awssdk.services.support.model.Service;
import software.amazon.awssdk.services.support.model.SupportException;
import java.util.ArrayList;
import java.util.List;
/**
* Before running this Java (v2) code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*
* In addition, you must have the AWS Business Support Plan to use the AWS
* Support Java API. For more information, see:
*
* https://aws.amazon.com/premiumsupport/plans/
*
* This Java example performs the following task:
*
* 1. Gets and displays available services.
*
*
* NOTE: To see multiple operations, see SupportScenario.
*/
public class HelloSupport {
public static void main(String[] args) {
Region region = Region.US_WEST_2;
SupportClient supportClient = SupportClient.builder()
.region(region)
.build();
System.out.println("***** Step 1. Get and display available services.");
displayServices(supportClient);
}
// Return a List that contains a Service name and Category name.
public static void displayServices(SupportClient supportClient) {
try {
DescribeServicesRequest servicesRequest = DescribeServicesRequest.builder()
.language("en")
.build();
DescribeServicesResponse response = supportClient.describeServices(servicesRequest);
List services = response.services();
System.out.println("Get the first 10 services");
int index = 1;
for (Service service : services) {
if (index == 11)
break;
System.out.println("The Service name is: " + service.name());
// Display the Categories for this service.
List categories = service.categories();
for (Category cat : categories) {
System.out.println("The category name is: " + cat.name());
}
index++;
}
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeServices](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeServices)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
调用 `main()` 运行该示例。
```
import {
DescribeServicesCommand,
SupportClient,
} from "@aws-sdk/client-support";
// Change the value of 'region' to your preferred AWS Region.
const client = new SupportClient({ region: "us-east-1" });
const getServiceCount = async () => {
try {
const { services } = await client.send(new DescribeServicesCommand({}));
return services.length;
} catch (err) {
if (err.name === "SubscriptionRequiredException") {
throw new Error(
"You must be subscribed to the AWS Support plan to use this feature.",
);
}
throw err;
}
};
export const main = async () => {
try {
const count = await getServiceCount();
console.log(`Hello, AWS Support! There are ${count} services available.`);
} catch (err) {
console.error("Failed to get service count: ", err.message);
}
};
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[DescribeServices](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeServicesCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
Before running this Kotlin code example, set up your development environment,
including your credentials.
For more information, see the following documentation topic:
https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup.html
In addition, you must have the AWS Business Support Plan to use the AWS Support Java API. For more information, see:
https://aws.amazon.com/premiumsupport/plans/
This Kotlin example performs the following task:
1. Gets and displays available services.
*/
suspend fun main() {
displaySomeServices()
}
// Return a List that contains a Service name and Category name.
suspend fun displaySomeServices() {
val servicesRequest =
DescribeServicesRequest {
language = "en"
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeServices(servicesRequest)
println("Get the first 10 services")
var index = 1
response.services?.forEach { service ->
if (index == 11) {
return@forEach
}
println("The Service name is: " + service.name)
// Get the categories for this service.
service.categories?.forEach { cat ->
println("The category name is ${cat.name}")
index++
}
}
}
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeServices](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
def hello_support(support_client):
"""
Use the AWS SDK for Python (Boto3) to create an AWS Support client and count
the available services in your account.
This example uses the default settings specified in your shared credentials
and config files.
:param support_client: A Boto3 Support Client object.
"""
try:
print("Hello, AWS Support! Let's count the available Support services:")
response = support_client.describe_services()
print(f"There are {len(response['services'])} services available.")
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't count services. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
if __name__ == "__main__":
hello_support(boto3.client("support"))
```
+ 有关 API 的详细信息，请参阅适用[DescribeServices](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeServices)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# 学习 支持 使用 AWS SDK 的基础知识
以下代码示例演示了如何：
+ 获取并显示案例的可用服务和严重级别。
+ 使用选定的服务、类别和严重性级别创建支持案例。
+ 获取并显示当天打开案例的列表。
+ 向新案例添加附件集和通信。
+ 描述该案例的新附件和通信。
+ 解析案例。
+ 获取并显示当天未解决的案例列表。
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
在命令提示符中运行交互式场景。
```
///
/// Hello AWS Support example.
///
public static class SupportCaseScenario
{
/*
Before running this .NET code example, set up your development environment, including your credentials.
To use the AWS Support API, you must have one of the following AWS Support plans: Business, Enterprise On-Ramp, or Enterprise.
This .NET example performs the following tasks:
1. Get and display services. Select a service from the list.
2. Select a category from the selected service.
3. Get and display severity levels and select a severity level from the list.
4. Create a support case using the selected service, category, and severity level.
5. Get and display a list of open support cases for the current day.
6. Create an attachment set with a sample text file to add to the case.
7. Add a communication with the attachment to the support case.
8. List the communications of the support case.
9. Describe the attachment set.
10. Resolve the support case.
11. Get a list of resolved cases for the current day.
*/
private static SupportWrapper _supportWrapper = null!;
static async Task Main(string[] args)
{
// Set up dependency injection for the AWS Support service.
// Use your AWS profile name, or leave it blank to use the default profile.
using var host = Host.CreateDefaultBuilder(args)
.ConfigureLogging(logging =>
logging.AddFilter("System", LogLevel.Debug)
.AddFilter("Microsoft", LogLevel.Information)
.AddFilter("Microsoft", LogLevel.Trace))
.ConfigureServices((_, services) =>
services.AddAWSService(new AWSOptions() { Profile = "default" })
.AddTransient()
)
.Build();
var logger = LoggerFactory.Create(builder =>
{
builder.AddConsole();
}).CreateLogger(typeof(SupportCaseScenario));
_supportWrapper = host.Services.GetRequiredService();
Console.WriteLine(new string('-', 80));
Console.WriteLine("Welcome to the AWS Support case example scenario.");
Console.WriteLine(new string('-', 80));
try
{
var apiSupported = await _supportWrapper.VerifySubscription();
if (!apiSupported)
{
logger.LogError("You must have a Business, Enterprise On-Ramp, or Enterprise Support " +
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these examples.");
return;
}
var service = await DisplayAndSelectServices();
var category = DisplayAndSelectCategories(service);
var severityLevel = await DisplayAndSelectSeverity();
var caseId = await CreateSupportCase(service, category, severityLevel);
await DescribeTodayOpenCases();
var attachmentSetId = await CreateAttachmentSet();
await AddCommunicationToCase(attachmentSetId, caseId);
var attachmentId = await ListCommunicationsForCase(caseId);
await DescribeCaseAttachment(attachmentId);
await ResolveCase(caseId);
await DescribeTodayResolvedCases();
Console.WriteLine(new string('-', 80));
Console.WriteLine("AWS Support case example scenario complete.");
Console.WriteLine(new string('-', 80));
}
catch (Exception ex)
{
logger.LogError(ex, "There was a problem executing the scenario.");
}
}
///
/// List some available services from AWS Support, and select a service for the example.
///
/// The selected service.
private static async Task DisplayAndSelectServices()
{
Console.WriteLine(new string('-', 80));
var services = await _supportWrapper.DescribeServices();
Console.WriteLine($"AWS Support client returned {services.Count} services.");
Console.WriteLine($"1. Displaying first 10 services:");
for (int i = 0; i < 10 && i < services.Count; i++)
{
Console.WriteLine($"\t{i + 1}. {services[i].Name}");
}
var choiceNumber = 0;
while (choiceNumber < 1 || choiceNumber > services.Count)
{
Console.WriteLine(
"Select an example support service by entering a number from the preceding list:");
var choice = Console.ReadLine();
Int32.TryParse(choice, out choiceNumber);
}
Console.WriteLine(new string('-', 80));
return services[choiceNumber - 1];
}
///
/// List the available categories for a service and select a category for the example.
///
/// Service to use for displaying categories.
/// The selected category.
private static Category DisplayAndSelectCategories(Service service)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"2. Available support categories for Service \"{service.Name}\":");
for (int i = 0; i < service.Categories.Count; i++)
{
Console.WriteLine($"\t{i + 1}. {service.Categories[i].Name}");
}
var choiceNumber = 0;
while (choiceNumber < 1 || choiceNumber > service.Categories.Count)
{
Console.WriteLine(
"Select an example support category by entering a number from the preceding list:");
var choice = Console.ReadLine();
Int32.TryParse(choice, out choiceNumber);
}
Console.WriteLine(new string('-', 80));
return service.Categories[choiceNumber - 1];
}
///
/// List available severity levels from AWS Support, and select a level for the example.
///
/// The selected severity level.
private static async Task DisplayAndSelectSeverity()
{
Console.WriteLine(new string('-', 80));
var severityLevels = await _supportWrapper.DescribeSeverityLevels();
Console.WriteLine($"3. Get and display available severity levels:");
for (int i = 0; i < 10 && i < severityLevels.Count; i++)
{
Console.WriteLine($"\t{i + 1}. {severityLevels[i].Name}");
}
var choiceNumber = 0;
while (choiceNumber < 1 || choiceNumber > severityLevels.Count)
{
Console.WriteLine(
"Select an example severity level by entering a number from the preceding list:");
var choice = Console.ReadLine();
Int32.TryParse(choice, out choiceNumber);
}
Console.WriteLine(new string('-', 80));
return severityLevels[choiceNumber - 1];
}
///
/// Create an example support case.
///
/// Service to use for the new case.
/// Category to use for the new case.
/// Severity to use for the new case.
/// The caseId of the new support case.
private static async Task CreateSupportCase(Service service,
Category category, SeverityLevel severity)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"4. Create an example support case" +
$" with the following settings:" +
$" \n\tService: {service.Name}, Category: {category.Name} " +
$"and Severity Level: {severity.Name}.");
var caseId = await _supportWrapper.CreateCase(service.Code, category.Code, severity.Code,
"Example case for testing, ignore.", "This is my example support case.");
Console.WriteLine($"\tNew case created with ID {caseId}");
Console.WriteLine(new string('-', 80));
return caseId;
}
///
/// List open cases for the current day.
///
/// Async task.
private static async Task DescribeTodayOpenCases()
{
Console.WriteLine($"5. List the open support cases for the current day.");
// Describe the cases. If it is empty, try again and allow time for the new case to appear.
List currentOpenCases = null!;
while (currentOpenCases == null || currentOpenCases.Count == 0)
{
Thread.Sleep(1000);
currentOpenCases = await _supportWrapper.DescribeCases(
new List(),
null,
false,
false,
DateTime.UtcNow.Date,
DateTime.UtcNow);
}
foreach (var openCase in currentOpenCases)
{
Console.WriteLine($"\tCase: {openCase.CaseId} created {openCase.TimeCreated}");
}
Console.WriteLine(new string('-', 80));
}
///
/// Create an attachment set for a support case.
///
/// The attachment set id.
private static async Task CreateAttachmentSet()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"6. Create an attachment set for a support case.");
var fileName = "example_attachment.txt";
// Create the file if it does not already exist.
if (!File.Exists(fileName))
{
await using StreamWriter sw = File.CreateText(fileName);
await sw.WriteLineAsync(
"This is a sample file for attachment to a support case.");
}
await using var ms = new MemoryStream(await File.ReadAllBytesAsync(fileName));
var attachmentSetId = await _supportWrapper.AddAttachmentToSet(
ms,
fileName);
Console.WriteLine($"\tNew attachment set created with id: \n\t{attachmentSetId.Substring(0, 65)}...");
Console.WriteLine(new string('-', 80));
return attachmentSetId;
}
///
/// Add an attachment set and communication to a case.
///
/// Id of the attachment set.
/// Id of the case to receive the attachment set.
/// Async task.
private static async Task AddCommunicationToCase(string attachmentSetId, string caseId)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"7. Add attachment set and communication to {caseId}.");
await _supportWrapper.AddCommunicationToCase(
caseId,
"This is an example communication added to a support case.",
attachmentSetId);
Console.WriteLine($"\tNew attachment set and communication added to {caseId}");
Console.WriteLine(new string('-', 80));
}
///
/// List the communications for a case.
///
/// Id of the case to describe.
/// An attachment id.
private static async Task ListCommunicationsForCase(string caseId)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"8. List communications for case {caseId}.");
var communications = await _supportWrapper.DescribeCommunications(caseId);
var attachmentId = "";
foreach (var communication in communications)
{
Console.WriteLine(
$"\tCommunication created on: {communication.TimeCreated} has {communication.AttachmentSet.Count} attachments.");
if (communication.AttachmentSet.Any())
{
attachmentId = communication.AttachmentSet.First().AttachmentId;
}
}
Console.WriteLine(new string('-', 80));
return attachmentId;
}
///
/// Describe an attachment by id.
///
/// Id of the attachment to describe.
/// Async task.
private static async Task DescribeCaseAttachment(string attachmentId)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"9. Describe the attachment set.");
var attachment = await _supportWrapper.DescribeAttachment(attachmentId);
var data = Encoding.ASCII.GetString(attachment.Data.ToArray());
Console.WriteLine($"\tAttachment includes {attachment.FileName} with data: \n\t{data}");
Console.WriteLine(new string('-', 80));
}
///
/// Resolve the support case.
///
/// Id of the case to resolve.
/// Async task.
private static async Task ResolveCase(string caseId)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"10. Resolve case {caseId}.");
var status = await _supportWrapper.ResolveCase(caseId);
Console.WriteLine($"\tCase {caseId} has final status {status}");
Console.WriteLine(new string('-', 80));
}
///
/// List resolved cases for the current day.
///
/// Async Task.
private static async Task DescribeTodayResolvedCases()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"11. List the resolved support cases for the current day.");
var currentCases = await _supportWrapper.DescribeCases(
new List(),
null,
false,
true,
DateTime.UtcNow.Date,
DateTime.UtcNow);
foreach (var currentCase in currentCases)
{
if (currentCase.Status == "resolved")
{
Console.WriteLine(
$"\tCase: {currentCase.CaseId}: status {currentCase.Status}");
}
}
Console.WriteLine(new string('-', 80));
}
}
```
场景用于 支持 操作的封装方法。
```
///
/// Wrapper methods to use AWS Support for working with support cases.
///
public class SupportWrapper
{
private readonly IAmazonAWSSupport _amazonSupport;
public SupportWrapper(IAmazonAWSSupport amazonSupport)
{
_amazonSupport = amazonSupport;
}
///
/// Get the descriptions of AWS services.
///
/// Optional language for services.
/// Currently Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”) are supported.
/// The list of AWS service descriptions.
public async Task> DescribeServices(string language = "en")
{
var response = await _amazonSupport.DescribeServicesAsync(
new DescribeServicesRequest()
{
Language = language
});
return response.Services;
}
///
/// Get the descriptions of support severity levels.
///
/// Optional language for severity levels.
/// Currently Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”) are supported.
/// The list of support severity levels.
public async Task> DescribeSeverityLevels(string language = "en")
{
var response = await _amazonSupport.DescribeSeverityLevelsAsync(
new DescribeSeverityLevelsRequest()
{
Language = language
});
return response.SeverityLevels;
}
///
/// Create a new support case.
///
/// Service code for the new case.
/// Category for the new case.
/// Severity code for the new case.
/// Subject of the new case.
/// Body text of the new case.
/// Optional language support for your case.
/// Currently Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”) are supported.
/// Optional Id for an attachment set for the new case.
/// Optional issue type for the new case. Options are "customer-service" or "technical".
/// The caseId of the new support case.
public async Task CreateCase(string serviceCode, string categoryCode, string severityCode, string subject,
string body, string language = "en", string? attachmentSetId = null, string issueType = "customer-service")
{
var response = await _amazonSupport.CreateCaseAsync(
new CreateCaseRequest()
{
ServiceCode = serviceCode,
CategoryCode = categoryCode,
SeverityCode = severityCode,
Subject = subject,
Language = language,
AttachmentSetId = attachmentSetId,
IssueType = issueType,
CommunicationBody = body
});
return response.CaseId;
}
///
/// Add an attachment to a set, or create a new attachment set if one does not exist.
///
/// The data for the attachment.
/// The file name for the attachment.
/// Optional setId for the attachment. Creates a new attachment set if empty.
/// The setId of the attachment.
public async Task AddAttachmentToSet(MemoryStream data, string fileName, string? attachmentSetId = null)
{
var response = await _amazonSupport.AddAttachmentsToSetAsync(
new AddAttachmentsToSetRequest
{
AttachmentSetId = attachmentSetId,
Attachments = new List
{
new Attachment
{
Data = data,
FileName = fileName
}
}
});
return response.AttachmentSetId;
}
///
/// Get description of a specific attachment.
///
/// Id of the attachment, usually fetched by describing the communications of a case.
/// The attachment object.
public async Task DescribeAttachment(string attachmentId)
{
var response = await _amazonSupport.DescribeAttachmentAsync(
new DescribeAttachmentRequest()
{
AttachmentId = attachmentId
});
return response.Attachment;
}
///
/// Add communication to a case, including optional attachment set ID and CC email addresses.
///
/// Id for the support case.
/// Body text of the communication.
/// Optional Id for an attachment set.
/// Optional list of CC email addresses.
/// True if successful.
public async Task AddCommunicationToCase(string caseId, string body,
string? attachmentSetId = null, List? ccEmailAddresses = null)
{
var response = await _amazonSupport.AddCommunicationToCaseAsync(
new AddCommunicationToCaseRequest()
{
CaseId = caseId,
CommunicationBody = body,
AttachmentSetId = attachmentSetId,
CcEmailAddresses = ccEmailAddresses
});
return response.Result;
}
///
/// Describe the communications for a case, optionally with a date filter.
///
/// The ID of the support case.
/// The optional start date for a filtered search.
/// The optional end date for a filtered search.
/// The list of communications for the case.
public async Task> DescribeCommunications(string caseId, DateTime? afterTime = null, DateTime? beforeTime = null)
{
var results = new List();
var paginateCommunications = _amazonSupport.Paginators.DescribeCommunications(
new DescribeCommunicationsRequest()
{
CaseId = caseId,
AfterTime = afterTime?.ToString("s"),
BeforeTime = beforeTime?.ToString("s")
});
// Get the entire list using the paginator.
await foreach (var communications in paginateCommunications.Communications)
{
results.Add(communications);
}
return results;
}
///
/// Get case details for a list of case ids, optionally with date filters.
///
/// The list of case IDs.
/// Optional display ID.
/// True to include communication. Defaults to true.
/// True to include resolved cases. Defaults to false.
/// The optional start date for a filtered search.
/// The optional end date for a filtered search.
/// Optional language support for your case.
/// Currently Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”) are supported.
/// A list of CaseDetails.
public async Task> DescribeCases(List caseIds, string? displayId = null, bool includeCommunication = true,
bool includeResolvedCases = false, DateTime? afterTime = null, DateTime? beforeTime = null,
string language = "en")
{
var results = new List();
var paginateCases = _amazonSupport.Paginators.DescribeCases(
new DescribeCasesRequest()
{
CaseIdList = caseIds,
DisplayId = displayId,
IncludeCommunications = includeCommunication,
IncludeResolvedCases = includeResolvedCases,
AfterTime = afterTime?.ToString("s"),
BeforeTime = beforeTime?.ToString("s"),
Language = language
});
// Get the entire list using the paginator.
await foreach (var cases in paginateCases.Cases)
{
results.Add(cases);
}
return results;
}
///
/// Resolve a support case by caseId.
///
/// Id for the support case.
/// The final status of the case after resolving.
public async Task ResolveCase(string caseId)
{
var response = await _amazonSupport.ResolveCaseAsync(
new ResolveCaseRequest()
{
CaseId = caseId
});
return response.FinalCaseStatus;
}
///
/// Verify the support level for AWS Support API access.
///
/// True if the subscription level supports API access.
public async Task VerifySubscription()
{
try
{
var response = await _amazonSupport.DescribeServicesAsync(
new DescribeServicesRequest()
{
Language = "en"
});
return response.HttpStatusCode == HttpStatusCode.OK;
}
catch (Amazon.AWSSupport.AmazonAWSSupportException ex)
{
if (ex.ErrorCode == "SubscriptionRequiredException")
{
return false;
}
else throw;
}
}
}
```
+ 有关 API 详细信息，请参阅《适用于 .NET 的 AWS SDK API Reference》**中的以下主题。
+ [AddAttachmentsToSet](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/AddAttachmentsToSet)
+ [AddCommunicationToCase](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/AddCommunicationToCase)
+ [CreateCase](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/CreateCase)
+ [DescribeAttachment](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeAttachment)
+ [DescribeCases](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeCases)
+ [DescribeCommunications](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeCommunications)
+ [DescribeServices](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeServices)
+ [DescribeSeverityLevels](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeSeverityLevels)
+ [ResolveCase](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/ResolveCase)
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
运行各种 支持 操作。
```
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.support.SupportClient;
import software.amazon.awssdk.services.support.model.AddAttachmentsToSetResponse;
import software.amazon.awssdk.services.support.model.AddCommunicationToCaseRequest;
import software.amazon.awssdk.services.support.model.AddCommunicationToCaseResponse;
import software.amazon.awssdk.services.support.model.Attachment;
import software.amazon.awssdk.services.support.model.AttachmentDetails;
import software.amazon.awssdk.services.support.model.CaseDetails;
import software.amazon.awssdk.services.support.model.Category;
import software.amazon.awssdk.services.support.model.Communication;
import software.amazon.awssdk.services.support.model.CreateCaseRequest;
import software.amazon.awssdk.services.support.model.CreateCaseResponse;
import software.amazon.awssdk.services.support.model.DescribeAttachmentRequest;
import software.amazon.awssdk.services.support.model.DescribeAttachmentResponse;
import software.amazon.awssdk.services.support.model.DescribeCasesRequest;
import software.amazon.awssdk.services.support.model.DescribeCasesResponse;
import software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest;
import software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse;
import software.amazon.awssdk.services.support.model.DescribeServicesRequest;
import software.amazon.awssdk.services.support.model.DescribeServicesResponse;
import software.amazon.awssdk.services.support.model.DescribeSeverityLevelsRequest;
import software.amazon.awssdk.services.support.model.DescribeSeverityLevelsResponse;
import software.amazon.awssdk.services.support.model.ResolveCaseRequest;
import software.amazon.awssdk.services.support.model.ResolveCaseResponse;
import software.amazon.awssdk.services.support.model.Service;
import software.amazon.awssdk.services.support.model.SeverityLevel;
import software.amazon.awssdk.services.support.model.SupportException;
import software.amazon.awssdk.services.support.model.AddAttachmentsToSetRequest;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.ArrayList;
import java.util.List;
/**
* Before running this Java (v2) code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*
* In addition, you must have the AWS Business Support Plan to use the AWS
* Support Java API. For more information, see:
*
* https://aws.amazon.com/premiumsupport/plans/
*
* This Java example performs the following tasks:
*
* 1. Gets and displays available services.
* 2. Gets and displays severity levels.
* 3. Creates a support case by using the selected service, category, and
* severity level.
* 4. Gets a list of open cases for the current day.
* 5. Creates an attachment set with a generated file.
* 6. Adds a communication with the attachment to the support case.
* 7. Lists the communications of the support case.
* 8. Describes the attachment set included with the communication.
* 9. Resolves the support case.
* 10. Gets a list of resolved cases for the current day.
*/
public class SupportScenario {
public static final String DASHES = new String(new char[80]).replace("\0", "-");
public static void main(String[] args) {
final String usage = """
Usage:
Where:
fileAttachment - The file can be a simple saved .txt file to use as an email attachment.\s
""";
// if (args.length != 1) {
// System.out.println(usage);
// System.exit(1);
// }
String fileAttachment = "C:\\AWS\\test.txt" ; //args[0];
Region region = Region.US_WEST_2;
SupportClient supportClient = SupportClient.builder()
.region(region)
.build();
System.out.println(DASHES);
System.out.println("***** Welcome to the AWS Support case example scenario.");
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("1. Get and display available services.");
List sevCatList = displayServices(supportClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("2. Get and display Support severity levels.");
String sevLevel = displaySevLevels(supportClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("3. Create a support case using the selected service, category, and severity level.");
String caseId = createSupportCase(supportClient, sevCatList, sevLevel);
if (caseId.compareTo("") == 0) {
System.out.println("A support case was not successfully created!");
System.exit(1);
} else
System.out.println("Support case " + caseId + " was successfully created!");
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("4. Get open support cases.");
getOpenCase(supportClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("5. Create an attachment set with a generated file to add to the case.");
String attachmentSetId = addAttachment(supportClient, fileAttachment);
System.out.println("The Attachment Set id value is" + attachmentSetId);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("6. Add communication with the attachment to the support case.");
addAttachSupportCase(supportClient, caseId, attachmentSetId);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("7. List the communications of the support case.");
String attachId = listCommunications(supportClient, caseId);
System.out.println("The Attachment id value is" + attachId);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("8. Describe the attachment set included with the communication.");
describeAttachment(supportClient, attachId);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("9. Resolve the support case.");
resolveSupportCase(supportClient, caseId);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("10. Get a list of resolved cases for the current day.");
getResolvedCase(supportClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("***** This Scenario has successfully completed");
System.out.println(DASHES);
}
public static void getResolvedCase(SupportClient supportClient) {
try {
// Specify the start and end time.
Instant now = Instant.now();
java.time.LocalDate.now();
Instant yesterday = now.minus(1, ChronoUnit.DAYS);
DescribeCasesRequest describeCasesRequest = DescribeCasesRequest.builder()
.maxResults(30)
.afterTime(yesterday.toString())
.beforeTime(now.toString())
.includeResolvedCases(true)
.build();
DescribeCasesResponse response = supportClient.describeCases(describeCasesRequest);
List cases = response.cases();
for (CaseDetails sinCase : cases) {
if (sinCase.status().compareTo("resolved") == 0)
System.out.println("The case status is " + sinCase.status());
}
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void resolveSupportCase(SupportClient supportClient, String caseId) {
try {
ResolveCaseRequest caseRequest = ResolveCaseRequest.builder()
.caseId(caseId)
.build();
ResolveCaseResponse response = supportClient.resolveCase(caseRequest);
System.out.println("The status of case " + caseId + " is " + response.finalCaseStatus());
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void describeAttachment(SupportClient supportClient, String attachId) {
try {
DescribeAttachmentRequest attachmentRequest = DescribeAttachmentRequest.builder()
.attachmentId(attachId)
.build();
DescribeAttachmentResponse response = supportClient.describeAttachment(attachmentRequest);
System.out.println("The name of the file is " + response.attachment().fileName());
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static String listCommunications(SupportClient supportClient, String caseId) {
try {
String attachId = null;
DescribeCommunicationsRequest communicationsRequest = DescribeCommunicationsRequest.builder()
.caseId(caseId)
.maxResults(10)
.build();
DescribeCommunicationsResponse response = supportClient.describeCommunications(communicationsRequest);
List communications = response.communications();
for (Communication comm : communications) {
System.out.println("the body is: " + comm.body());
// Get the attachment id value.
List attachments = comm.attachmentSet();
for (AttachmentDetails detail : attachments) {
attachId = detail.attachmentId();
}
}
return attachId;
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
public static void addAttachSupportCase(SupportClient supportClient, String caseId, String attachmentSetId) {
try {
AddCommunicationToCaseRequest caseRequest = AddCommunicationToCaseRequest.builder()
.caseId(caseId)
.attachmentSetId(attachmentSetId)
.communicationBody("Please refer to attachment for details.")
.build();
AddCommunicationToCaseResponse response = supportClient.addCommunicationToCase(caseRequest);
if (response.result())
System.out.println("You have successfully added a communication to an AWS Support case");
else
System.out.println("There was an error adding the communication to an AWS Support case");
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static String addAttachment(SupportClient supportClient, String fileAttachment) {
try {
File myFile = new File(fileAttachment);
InputStream sourceStream = new FileInputStream(myFile);
SdkBytes sourceBytes = SdkBytes.fromInputStream(sourceStream);
Attachment attachment = Attachment.builder()
.fileName(myFile.getName())
.data(sourceBytes)
.build();
AddAttachmentsToSetRequest setRequest = AddAttachmentsToSetRequest.builder()
.attachments(attachment)
.build();
AddAttachmentsToSetResponse response = supportClient.addAttachmentsToSet(setRequest);
return response.attachmentSetId();
} catch (SupportException | FileNotFoundException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
public static void getOpenCase(SupportClient supportClient) {
try {
// Specify the start and end time.
Instant now = Instant.now();
java.time.LocalDate.now();
Instant yesterday = now.minus(1, ChronoUnit.DAYS);
DescribeCasesRequest describeCasesRequest = DescribeCasesRequest.builder()
.maxResults(20)
.afterTime(yesterday.toString())
.beforeTime(now.toString())
.build();
DescribeCasesResponse response = supportClient.describeCases(describeCasesRequest);
List cases = response.cases();
for (CaseDetails sinCase : cases) {
System.out.println("The case status is " + sinCase.status());
System.out.println("The case Id is " + sinCase.caseId());
System.out.println("The case subject is " + sinCase.subject());
}
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static String createSupportCase(SupportClient supportClient, List sevCatList, String sevLevel) {
try {
String serviceCode = sevCatList.get(0);
String caseCat = sevCatList.get(1);
CreateCaseRequest caseRequest = CreateCaseRequest.builder()
.categoryCode(caseCat.toLowerCase())
.serviceCode(serviceCode.toLowerCase())
.severityCode(sevLevel.toLowerCase())
.communicationBody("Test issue with " + serviceCode.toLowerCase())
.subject("Test case, please ignore")
.language("en")
.issueType("technical")
.build();
CreateCaseResponse response = supportClient.createCase(caseRequest);
return response.caseId();
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
public static String displaySevLevels(SupportClient supportClient) {
try {
DescribeSeverityLevelsRequest severityLevelsRequest = DescribeSeverityLevelsRequest.builder()
.language("en")
.build();
DescribeSeverityLevelsResponse response = supportClient.describeSeverityLevels(severityLevelsRequest);
List severityLevels = response.severityLevels();
String levelName = null;
for (SeverityLevel sevLevel : severityLevels) {
System.out.println("The severity level name is: " + sevLevel.name());
if (sevLevel.name().compareTo("High") == 0)
levelName = sevLevel.name();
}
return levelName;
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
// Return a List that contains a Service name and Category name.
public static List displayServices(SupportClient supportClient) {
try {
DescribeServicesRequest servicesRequest = DescribeServicesRequest.builder()
.language("en")
.build();
DescribeServicesResponse response = supportClient.describeServices(servicesRequest);
String serviceCode = null;
String catName = null;
List sevCatList = new ArrayList<>();
List services = response.services();
System.out.println("Get the first 10 services");
int index = 1;
for (Service service : services) {
if (index == 11)
break;
System.out.println("The Service name is: " + service.name());
if (service.name().compareTo("Account") == 0)
serviceCode = service.code();
// Get the Categories for this service.
List categories = service.categories();
for (Category cat : categories) {
System.out.println("The category name is: " + cat.name());
if (cat.name().compareTo("Security") == 0)
catName = cat.name();
}
index++;
}
// Push the two values to the list.
sevCatList.add(serviceCode);
sevCatList.add(catName);
return sevCatList;
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return null;
}
}
```
+ 有关 API 详细信息，请参阅《AWS SDK for Java 2.x API Reference》**中的以下主题。
+ [AddAttachmentsToSet](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/AddAttachmentsToSet)
+ [AddCommunicationToCase](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/AddCommunicationToCase)
+ [CreateCase](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/CreateCase)
+ [DescribeAttachment](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeAttachment)
+ [DescribeCases](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeCases)
+ [DescribeCommunications](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeCommunications)
+ [DescribeServices](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeServices)
+ [DescribeSeverityLevels](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeSeverityLevels)
+ [ResolveCase](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/ResolveCase)
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
在终端中运行交互式场景。
```
import {
AddAttachmentsToSetCommand,
AddCommunicationToCaseCommand,
CreateCaseCommand,
DescribeAttachmentCommand,
DescribeCasesCommand,
DescribeCommunicationsCommand,
DescribeServicesCommand,
DescribeSeverityLevelsCommand,
ResolveCaseCommand,
SupportClient,
} from "@aws-sdk/client-support";
import * as inquirer from "@inquirer/prompts";
import { retry } from "@aws-doc-sdk-examples/lib/utils/util-timers.js";
const wrapText = (text, char = "=") => {
const rule = char.repeat(80);
return `${rule}\n ${text}\n${rule}\n`;
};
const client = new SupportClient({ region: "us-east-1" });
// Verify that the account has a Support plan.
export const verifyAccount = async () => {
const command = new DescribeServicesCommand({});
try {
await client.send(command);
} catch (err) {
if (err.name === "SubscriptionRequiredException") {
throw new Error(
"You must be subscribed to the AWS Support plan to use this feature.",
);
}
throw err;
}
};
/**
* Select a service from the list returned from DescribeServices.
*/
export const getService = async () => {
const { services } = await client.send(new DescribeServicesCommand({}));
const selectedService = await inquirer.select({
message:
"Select a service. Your support case will be created for this service. The list of services is truncated for readability.",
choices: services.slice(0, 10).map((s) => ({ name: s.name, value: s })),
});
return selectedService;
};
/**
* @param {{ categories: import('@aws-sdk/client-support').Category[]}} service
*/
export const getCategory = async (service) => {
const selectedCategory = await inquirer.select({
message: "Select a category.",
choices: service.categories.map((c) => ({ name: c.name, value: c })),
});
return selectedCategory;
};
// Get the available severity levels for the account.
export const getSeverityLevel = async () => {
const command = new DescribeSeverityLevelsCommand({});
const { severityLevels } = await client.send(command);
const selectedSeverityLevel = await inquirer.select({
message: "Select a severity level.",
choices: severityLevels.map((s) => ({ name: s.name, value: s })),
});
return selectedSeverityLevel;
};
/**
* Create a new support case
* @param {{
* selectedService: import('@aws-sdk/client-support').Service
* selectedCategory: import('@aws-sdk/client-support').Category
* selectedSeverityLevel: import('@aws-sdk/client-support').SeverityLevel
* }} selections
* @returns
*/
export const createCase = async ({
selectedService,
selectedCategory,
selectedSeverityLevel,
}) => {
const command = new CreateCaseCommand({
subject: "IGNORE: Test case",
communicationBody: "This is a test. Please ignore.",
serviceCode: selectedService.code,
categoryCode: selectedCategory.code,
severityCode: selectedSeverityLevel.code,
});
const { caseId } = await client.send(command);
return caseId;
};
// Get a list of open support cases created today.
export const getTodaysOpenCases = async () => {
const d = new Date();
const startOfToday = new Date(d.getFullYear(), d.getMonth(), d.getDate());
const command = new DescribeCasesCommand({
includeCommunications: false,
afterTime: startOfToday.toISOString(),
});
const { cases } = await client.send(command);
if (cases.length === 0) {
throw new Error(
"Unexpected number of cases. Expected more than 0 open cases.",
);
}
return cases;
};
// Create an attachment set.
export const createAttachmentSet = async () => {
const command = new AddAttachmentsToSetCommand({
attachments: [
{
fileName: "example.txt",
data: new TextEncoder().encode("some example text"),
},
],
});
const { attachmentSetId } = await client.send(command);
return attachmentSetId;
};
export const linkAttachmentSetToCase = async (attachmentSetId, caseId) => {
const command = new AddCommunicationToCaseCommand({
attachmentSetId,
caseId,
communicationBody: "Adding attachment set to case.",
});
await client.send(command);
};
// Get all communications for a support case.
export const getCommunications = async (caseId) => {
const command = new DescribeCommunicationsCommand({
caseId,
});
const { communications } = await client.send(command);
return communications;
};
/**
* @param {import('@aws-sdk/client-support').Communication[]} communications
*/
export const getFirstAttachment = (communications) => {
const firstCommWithAttachment = communications.find(
(c) => c.attachmentSet.length > 0,
);
return firstCommWithAttachment?.attachmentSet[0].attachmentId;
};
// Get an attachment.
export const getAttachment = async (attachmentId) => {
const command = new DescribeAttachmentCommand({
attachmentId,
});
const { attachment } = await client.send(command);
return attachment;
};
// Resolve the case matching the given case ID.
export const resolveCase = async (caseId) => {
const shouldResolve = await inquirer.confirm({
message: `Do you want to resolve ${caseId}?`,
});
if (shouldResolve) {
const command = new ResolveCaseCommand({
caseId: caseId,
});
await client.send(command);
return true;
}
return false;
};
/**
* Find a specific case in the list of provided cases by case ID.
* If the case is not found, and the results are paginated, continue
* paging through the results.
* @param {{
* caseId: string,
* cases: import('@aws-sdk/client-support').CaseDetails[]
* nextToken: string
* }} options
* @returns
*/
export const findCase = async ({ caseId, cases, nextToken }) => {
const foundCase = cases.find((c) => c.caseId === caseId);
if (foundCase) {
return foundCase;
}
if (nextToken) {
const response = await client.send(
new DescribeCasesCommand({
nextToken,
includeResolvedCases: true,
}),
);
return findCase({
caseId,
cases: response.cases,
nextToken: response.nextToken,
});
}
throw new Error(`${caseId} not found.`);
};
// Get all cases created today.
export const getTodaysResolvedCases = async (caseIdToWaitFor) => {
const d = new Date("2023-01-18");
const startOfToday = new Date(d.getFullYear(), d.getMonth(), d.getDate());
const command = new DescribeCasesCommand({
includeCommunications: false,
afterTime: startOfToday.toISOString(),
includeResolvedCases: true,
});
const { cases, nextToken } = await client.send(command);
await findCase({ cases, caseId: caseIdToWaitFor, nextToken });
return cases.filter((c) => c.status === "resolved");
};
const main = async () => {
let caseId;
try {
console.log(wrapText("Welcome to the AWS Support basic usage scenario."));
// Verify that the account is subscribed to support.
await verifyAccount();
// Provided a truncated list of services and prompt the user to select one.
const selectedService = await getService();
// Provided the categories for the selected service and prompt the user to select one.
const selectedCategory = await getCategory(selectedService);
// Provide the severity available severity levels for the account and prompt the user to select one.
const selectedSeverityLevel = await getSeverityLevel();
// Create a support case.
console.log("\nCreating a support case.");
caseId = await createCase({
selectedService,
selectedCategory,
selectedSeverityLevel,
});
console.log(`Support case created: ${caseId}`);
// Display a list of open support cases created today.
const todaysOpenCases = await retry(
{ intervalInMs: 1000, maxRetries: 15 },
getTodaysOpenCases,
);
console.log(
`\nOpen support cases created today: ${todaysOpenCases.length}`,
);
console.log(todaysOpenCases.map((c) => `${c.caseId}`).join("\n"));
// Create an attachment set.
console.log("\nCreating an attachment set.");
const attachmentSetId = await createAttachmentSet();
console.log(`Attachment set created: ${attachmentSetId}`);
// Add the attachment set to the support case.
console.log(`\nAdding attachment set to ${caseId}`);
await linkAttachmentSetToCase(attachmentSetId, caseId);
console.log(`Attachment set added to ${caseId}`);
// List the communications for a support case.
console.log(`\nListing communications for ${caseId}`);
const communications = await getCommunications(caseId);
console.log(
communications
.map(
(c) =>
`Communication created on ${c.timeCreated}. Has ${c.attachmentSet.length} attachments.`,
)
.join("\n"),
);
// Describe the first attachment.
console.log(`\nDescribing attachment ${attachmentSetId}`);
const attachmentId = getFirstAttachment(communications);
const attachment = await getAttachment(attachmentId);
console.log(
`Attachment is the file '${
attachment.fileName
}' with data: \n${new TextDecoder().decode(attachment.data)}`,
);
// Confirm that the support case should be resolved.
const isResolved = await resolveCase(caseId);
if (isResolved) {
// List the resolved cases and include the one previously created.
// Resolved cases can take a while to appear.
console.log(
"\nWaiting for case status to be marked as resolved. This can take some time.",
);
const resolvedCases = await retry(
{ intervalInMs: 20000, maxRetries: 15 },
() => getTodaysResolvedCases(caseId),
);
console.log("Resolved cases:");
console.log(resolvedCases.map((c) => c.caseId).join("\n"));
}
} catch (err) {
console.error(err);
}
};
```
+ 有关 API 详细信息，请参阅《适用于 JavaScript 的 AWS SDK API Reference》**中的以下主题。
+ [AddAttachmentsToSet](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/AddAttachmentsToSetCommand)
+ [AddCommunicationToCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/AddCommunicationToCaseCommand)
+ [CreateCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/CreateCaseCommand)
+ [DescribeAttachment](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeAttachmentCommand)
+ [DescribeCases](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeCasesCommand)
+ [DescribeCommunications](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeCommunicationsCommand)
+ [DescribeServices](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeServicesCommand)
+ [DescribeSeverityLevels](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeSeverityLevelsCommand)
+ [ResolveCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/ResolveCaseCommand)
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
Before running this Kotlin code example, set up your development environment,
including your credentials.
For more information, see the following documentation topic:
https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup.html
In addition, you must have the AWS Business Support Plan to use the AWS Support Java API. For more information, see:
https://aws.amazon.com/premiumsupport/plans/
This Kotlin example performs the following tasks:
1. Gets and displays available services.
2. Gets and displays severity levels.
3. Creates a support case by using the selected service, category, and severity level.
4. Gets a list of open cases for the current day.
5. Creates an attachment set with a generated file.
6. Adds a communication with the attachment to the support case.
7. Lists the communications of the support case.
8. Describes the attachment set included with the communication.
9. Resolves the support case.
10. Gets a list of resolved cases for the current day.
*/
suspend fun main(args: Array) {
val usage = """
Usage:
Where:
fileAttachment - The file can be a simple saved .txt file to use as an email attachment.
"""
if (args.size != 1) {
println(usage)
exitProcess(0)
}
val fileAttachment = args[0]
println("***** Welcome to the AWS Support case example scenario.")
println("***** Step 1. Get and display available services.")
val sevCatList = displayServices()
println("***** Step 2. Get and display Support severity levels.")
val sevLevel = displaySevLevels()
println("***** Step 3. Create a support case using the selected service, category, and severity level.")
val caseIdVal = createSupportCase(sevCatList, sevLevel)
if (caseIdVal != null) {
println("Support case $caseIdVal was successfully created!")
} else {
println("A support case was not successfully created!")
exitProcess(1)
}
println("***** Step 4. Get open support cases.")
getOpenCase()
println("***** Step 5. Create an attachment set with a generated file to add to the case.")
val attachmentSetId = addAttachment(fileAttachment)
println("The Attachment Set id value is $attachmentSetId")
println("***** Step 6. Add communication with the attachment to the support case.")
addAttachSupportCase(caseIdVal, attachmentSetId)
println("***** Step 7. List the communications of the support case.")
val attachId = listCommunications(caseIdVal)
println("The Attachment id value is $attachId")
println("***** Step 8. Describe the attachment set included with the communication.")
describeAttachment(attachId)
println("***** Step 9. Resolve the support case.")
resolveSupportCase(caseIdVal)
println("***** Step 10. Get a list of resolved cases for the current day.")
getResolvedCase()
println("***** This Scenario has successfully completed")
}
suspend fun getResolvedCase() {
// Specify the start and end time.
val now = Instant.now()
LocalDate.now()
val yesterday = now.minus(1, ChronoUnit.DAYS)
val describeCasesRequest =
DescribeCasesRequest {
maxResults = 30
afterTime = yesterday.toString()
beforeTime = now.toString()
includeResolvedCases = true
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeCases(describeCasesRequest)
response.cases?.forEach { sinCase ->
println("The case status is ${sinCase.status}")
println("The case Id is ${sinCase.caseId}")
println("The case subject is ${sinCase.subject}")
}
}
}
suspend fun resolveSupportCase(caseIdVal: String) {
val caseRequest =
ResolveCaseRequest {
caseId = caseIdVal
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.resolveCase(caseRequest)
println("The status of case $caseIdVal is ${response.finalCaseStatus}")
}
}
suspend fun describeAttachment(attachId: String?) {
val attachmentRequest =
DescribeAttachmentRequest {
attachmentId = attachId
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeAttachment(attachmentRequest)
println("The name of the file is ${response.attachment?.fileName}")
}
}
suspend fun listCommunications(caseIdVal: String?): String? {
val communicationsRequest =
DescribeCommunicationsRequest {
caseId = caseIdVal
maxResults = 10
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeCommunications(communicationsRequest)
response.communications?.forEach { comm ->
println("the body is: " + comm.body)
comm.attachmentSet?.forEach { detail ->
return detail.attachmentId
}
}
}
return ""
}
suspend fun addAttachSupportCase(
caseIdVal: String?,
attachmentSetIdVal: String?,
) {
val caseRequest =
AddCommunicationToCaseRequest {
caseId = caseIdVal
attachmentSetId = attachmentSetIdVal
communicationBody = "Please refer to attachment for details."
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.addCommunicationToCase(caseRequest)
if (response.result) {
println("You have successfully added a communication to an AWS Support case")
} else {
println("There was an error adding the communication to an AWS Support case")
}
}
}
suspend fun addAttachment(fileAttachment: String): String? {
val myFile = File(fileAttachment)
val sourceBytes = (File(fileAttachment).readBytes())
val attachmentVal =
Attachment {
fileName = myFile.name
data = sourceBytes
}
val setRequest =
AddAttachmentsToSetRequest {
attachments = listOf(attachmentVal)
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.addAttachmentsToSet(setRequest)
return response.attachmentSetId
}
}
suspend fun getOpenCase() {
// Specify the start and end time.
val now = Instant.now()
LocalDate.now()
val yesterday = now.minus(1, ChronoUnit.DAYS)
val describeCasesRequest =
DescribeCasesRequest {
maxResults = 20
afterTime = yesterday.toString()
beforeTime = now.toString()
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeCases(describeCasesRequest)
response.cases?.forEach { sinCase ->
println("The case status is ${sinCase.status}")
println("The case Id is ${sinCase.caseId}")
println("The case subject is ${sinCase.subject}")
}
}
}
suspend fun createSupportCase(
sevCatListVal: List,
sevLevelVal: String,
): String? {
val serCode = sevCatListVal[0]
val caseCategory = sevCatListVal[1]
val caseRequest =
CreateCaseRequest {
categoryCode = caseCategory.lowercase(Locale.getDefault())
serviceCode = serCode.lowercase(Locale.getDefault())
severityCode = sevLevelVal.lowercase(Locale.getDefault())
communicationBody = "Test issue with ${serCode.lowercase(Locale.getDefault())}"
subject = "Test case, please ignore"
language = "en"
issueType = "technical"
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.createCase(caseRequest)
return response.caseId
}
}
suspend fun displaySevLevels(): String {
var levelName = ""
val severityLevelsRequest =
DescribeSeverityLevelsRequest {
language = "en"
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeSeverityLevels(severityLevelsRequest)
response.severityLevels?.forEach { sevLevel ->
println("The severity level name is: ${sevLevel.name}")
if (sevLevel.name == "High") {
levelName = sevLevel.name!!
}
}
return levelName
}
}
// Return a List that contains a Service name and Category name.
suspend fun displayServices(): List {
var serviceCode = ""
var catName = ""
val sevCatList = mutableListOf()
val servicesRequest =
DescribeServicesRequest {
language = "en"
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeServices(servicesRequest)
println("Get the first 10 services")
var index = 1
response.services?.forEach { service ->
if (index == 11) {
return@forEach
}
println("The Service name is ${service.name}")
if (service.name == "Account") {
serviceCode = service.code.toString()
}
// Get the categories for this service.
service.categories?.forEach { cat ->
println("The category name is ${cat.name}")
if (cat.name == "Security") {
catName = cat.name!!
}
}
index++
}
}
// Push the two values to the list.
serviceCode.let { sevCatList.add(it) }
catName.let { sevCatList.add(it) }
return sevCatList
}
```
+ 有关 API 详细信息，请参阅《AWS SDK for Kotlin API Reference》**中的以下主题。
+ [AddAttachmentsToSet](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [AddCommunicationToCase](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CreateCase](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeAttachment](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeCases](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeCommunications](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeServices](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeSeverityLevels](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ResolveCase](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
在命令提示符中运行交互式场景。
```
class SupportCasesScenario:
"""Runs an interactive scenario that shows how to get started using AWS Support."""
def __init__(self, support_wrapper):
"""
:param support_wrapper: An object that wraps AWS Support actions.
"""
self.support_wrapper = support_wrapper
def display_and_select_service(self):
"""
Lists support services and prompts the user to select one.
:return: The support service selected by the user.
"""
print("-" * 88)
services_list = self.support_wrapper.describe_services("en")
print(f"AWS Support client returned {len(services_list)} services.")
print("Displaying first 10 services:")
service_choices = [svc["name"] for svc in services_list[:10]]
selected_index = q.choose(
"Select an example support service by entering a number from the preceding list:",
service_choices,
)
selected_service = services_list[selected_index]
print("-" * 88)
return selected_service
def display_and_select_category(self, service):
"""
Lists categories for a support service and prompts the user to select one.
:param service: The service of the categories.
:return: The selected category.
"""
print("-" * 88)
print(
f"Available support categories for Service {service['name']} {len(service['categories'])}:"
)
categories_choices = [category["name"] for category in service["categories"]]
selected_index = q.choose(
"Select an example support category by entering a number from the preceding list:",
categories_choices,
)
selected_category = service["categories"][selected_index]
print("-" * 88)
return selected_category
def display_and_select_severity(self):
"""
Lists available severity levels and prompts the user to select one.
:return: The selected severity level.
"""
print("-" * 88)
severity_levels_list = self.support_wrapper.describe_severity_levels("en")
print(f"Available severity levels:")
severity_choices = [level["name"] for level in severity_levels_list]
selected_index = q.choose(
"Select an example severity level by entering a number from the preceding list:",
severity_choices,
)
selected_severity = severity_levels_list[selected_index]
print("-" * 88)
return selected_severity
def create_example_case(self, service, category, severity_level):
"""
Creates an example support case with the user's selections.
:param service: The service for the new case.
:param category: The category for the new case.
:param severity_level: The severity level for the new case.
:return: The caseId of the new support case.
"""
print("-" * 88)
print(f"Creating new case for service {service['name']}.")
case_id = self.support_wrapper.create_case(service, category, severity_level)
print(f"\tNew case created with ID {case_id}.")
print("-" * 88)
return case_id
def list_open_cases(self):
"""
List the open cases for the current day.
"""
print("-" * 88)
print("Let's list the open cases for the current day.")
start_time = str(datetime.utcnow().date())
end_time = str(datetime.utcnow().date() + timedelta(days=1))
open_cases = self.support_wrapper.describe_cases(start_time, end_time, False)
for case in open_cases:
print(f"\tCase: {case['caseId']}: status {case['status']}.")
print("-" * 88)
def create_attachment_set(self):
"""
Create an attachment set with a sample file.
:return: The attachment set ID of the new attachment set.
"""
print("-" * 88)
print("Creating attachment set with a sample file.")
attachment_set_id = self.support_wrapper.add_attachment_to_set()
print(f"\tNew attachment set created with ID {attachment_set_id}.")
print("-" * 88)
return attachment_set_id
def add_communication(self, case_id, attachment_set_id):
"""
Add a communication with an attachment set to the case.
:param case_id: The ID of the case for the communication.
:param attachment_set_id: The ID of the attachment set to
add to the communication.
"""
print("-" * 88)
print(f"Adding a communication and attachment set to the case.")
self.support_wrapper.add_communication_to_case(attachment_set_id, case_id)
print(
f"Added a communication and attachment set {attachment_set_id} to the case {case_id}."
)
print("-" * 88)
def list_communications(self, case_id):
"""
List the communications associated with a case.
:param case_id: The ID of the case.
:return: The attachment ID of an attachment.
"""
print("-" * 88)
print("Let's list the communications for our case.")
attachment_id = ""
communications = self.support_wrapper.describe_all_case_communications(case_id)
for communication in communications:
print(
f"\tCommunication created on {communication['timeCreated']} "
f"has {len(communication['attachmentSet'])} attachments."
)
if len(communication["attachmentSet"]) > 0:
attachment_id = communication["attachmentSet"][0]["attachmentId"]
print("-" * 88)
return attachment_id
def describe_case_attachment(self, attachment_id):
"""
Describe an attachment associated with a case.
:param attachment_id: The ID of the attachment.
"""
print("-" * 88)
print("Let's list the communications for our case.")
attached_file = self.support_wrapper.describe_attachment(attachment_id)
print(f"\tAttachment includes file {attached_file}.")
print("-" * 88)
def resolve_case(self, case_id):
"""
Shows how to resolve an AWS Support case by its ID.
:param case_id: The ID of the case to resolve.
"""
print("-" * 88)
print(f"Resolving case with ID {case_id}.")
case_status = self.support_wrapper.resolve_case(case_id)
print(f"\tFinal case status is {case_status}.")
print("-" * 88)
def list_resolved_cases(self):
"""
List the resolved cases for the current day.
"""
print("-" * 88)
print("Let's list the resolved cases for the current day.")
start_time = str(datetime.utcnow().date())
end_time = str(datetime.utcnow().date() + timedelta(days=1))
resolved_cases = self.support_wrapper.describe_cases(start_time, end_time, True)
for case in resolved_cases:
print(f"\tCase: {case['caseId']}: status {case['status']}.")
print("-" * 88)
def run_scenario(self):
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
print("-" * 88)
print("Welcome to the AWS Support get started with support cases demo.")
print("-" * 88)
selected_service = self.display_and_select_service()
selected_category = self.display_and_select_category(selected_service)
selected_severity = self.display_and_select_severity()
new_case_id = self.create_example_case(
selected_service, selected_category, selected_severity
)
wait(10)
self.list_open_cases()
new_attachment_set_id = self.create_attachment_set()
self.add_communication(new_case_id, new_attachment_set_id)
new_attachment_id = self.list_communications(new_case_id)
self.describe_case_attachment(new_attachment_id)
self.resolve_case(new_case_id)
wait(10)
self.list_resolved_cases()
print("\nThanks for watching!")
print("-" * 88)
if __name__ == "__main__":
try:
scenario = SupportCasesScenario(SupportWrapper.from_client())
scenario.run_scenario()
except Exception:
logging.exception("Something went wrong with the demo.")
```
定义一个包装支持客户端操作的类。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def describe_services(self, language):
"""
Get the descriptions of AWS services available for support for a language.
:param language: The language for support services.
Currently, only "en" (English) and "ja" (Japanese) are supported.
:return: The list of AWS service descriptions.
"""
try:
response = self.support_client.describe_services(language=language)
services = response["services"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't get Support services for language %s. Here's why: %s: %s",
language,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return services
def describe_severity_levels(self, language):
"""
Get the descriptions of available severity levels for support cases for a language.
:param language: The language for support severity levels.
Currently, only "en" (English) and "ja" (Japanese) are supported.
:return: The list of severity levels.
"""
try:
response = self.support_client.describe_severity_levels(language=language)
severity_levels = response["severityLevels"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't get severity levels for language %s. Here's why: %s: %s",
language,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return severity_levels
def create_case(self, service, category, severity):
"""
Create a new support case.
:param service: The service to use for the new case.
:param category: The category to use for the new case.
:param severity: The severity to use for the new case.
:return: The caseId of the new case.
"""
try:
response = self.support_client.create_case(
subject="Example case for testing, ignore.",
serviceCode=service["code"],
severityCode=severity["code"],
categoryCode=category["code"],
communicationBody="Example support case body.",
language="en",
issueType="customer-service",
)
case_id = response["caseId"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't create case. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return case_id
def add_attachment_to_set(self):
"""
Add an attachment to a set, or create a new attachment set if one does not exist.
:return: The attachment set ID.
"""
try:
response = self.support_client.add_attachments_to_set(
attachments=[
{
"fileName": "attachment_file.txt",
"data": b"This is a sample file for attachment to a support case.",
}
]
)
new_set_id = response["attachmentSetId"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't add attachment. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return new_set_id
def add_communication_to_case(self, attachment_set_id, case_id):
"""
Add a communication and an attachment set to a case.
:param attachment_set_id: The ID of an existing attachment set.
:param case_id: The ID of the case.
"""
try:
self.support_client.add_communication_to_case(
caseId=case_id,
communicationBody="This is an example communication added to a support case.",
attachmentSetId=attachment_set_id,
)
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't add communication. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def describe_all_case_communications(self, case_id):
"""
Describe all the communications for a case using a paginator.
:param case_id: The ID of the case.
:return: The communications for the case.
"""
try:
communications = []
paginator = self.support_client.get_paginator("describe_communications")
for page in paginator.paginate(caseId=case_id):
communications += page["communications"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't describe communications. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return communications
def describe_attachment(self, attachment_id):
"""
Get information about an attachment by its attachmentID.
:param attachment_id: The ID of the attachment.
:return: The name of the attached file.
"""
try:
response = self.support_client.describe_attachment(
attachmentId=attachment_id
)
attached_file = response["attachment"]["fileName"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't get attachment description. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return attached_file
def resolve_case(self, case_id):
"""
Resolve a support case by its caseId.
:param case_id: The ID of the case to resolve.
:return: The final status of the case.
"""
try:
response = self.support_client.resolve_case(caseId=case_id)
final_status = response["finalCaseStatus"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't resolve case. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return final_status
def describe_cases(self, after_time, before_time, resolved):
"""
Describe support cases over a period of time, optionally filtering
by status.
:param after_time: The start time to include for cases.
:param before_time: The end time to include for cases.
:param resolved: True to include resolved cases in the results,
otherwise results are open cases.
:return: The final status of the case.
"""
try:
cases = []
paginator = self.support_client.get_paginator("describe_cases")
for page in paginator.paginate(
afterTime=after_time,
beforeTime=before_time,
includeResolvedCases=resolved,
language="en",
):
cases += page["cases"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't describe cases. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
if resolved:
cases = filter(lambda case: case["status"] == "resolved", cases)
return cases
```
+ 有关 API 详细信息，请参阅《AWS SDK for Python (Boto3) API Reference》**中的以下主题。
+ [AddAttachmentsToSet](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/AddAttachmentsToSet)
+ [AddCommunicationToCase](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/AddCommunicationToCase)
+ [CreateCase](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/CreateCase)
+ [DescribeAttachment](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeAttachment)
+ [DescribeCases](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeCases)
+ [DescribeCommunications](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeCommunications)
+ [DescribeServices](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeServices)
+ [DescribeSeverityLevels](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeSeverityLevels)
+ [ResolveCase](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/ResolveCase)
------
# 用于 支持 使用的操作 AWS SDKs
以下代码示例演示了如何使用执行单个 支持 操作 AWS SDKs。每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关设置和运行代码的说明。
以下示例仅包括最常用的操作。有关完整列表，请参阅 [AWS 支持 API 参考](https://docs.aws.amazon.com/awssupport/latest/APIReference/welcome.html)。
**Topics**
+ [`AddAttachmentsToSet`](support_example_support_AddAttachmentsToSet_section.md)
+ [`AddCommunicationToCase`](support_example_support_AddCommunicationToCase_section.md)
+ [`CreateCase`](support_example_support_CreateCase_section.md)
+ [`DescribeAttachment`](support_example_support_DescribeAttachment_section.md)
+ [`DescribeCases`](support_example_support_DescribeCases_section.md)
+ [`DescribeCommunications`](support_example_support_DescribeCommunications_section.md)
+ [`DescribeServices`](support_example_support_DescribeServices_section.md)
+ [`DescribeSeverityLevels`](support_example_support_DescribeSeverityLevels_section.md)
+ [`DescribeTrustedAdvisorCheckRefreshStatuses`](support_example_support_DescribeTrustedAdvisorCheckRefreshStatuses_section.md)
+ [`DescribeTrustedAdvisorCheckResult`](support_example_support_DescribeTrustedAdvisorCheckResult_section.md)
+ [`DescribeTrustedAdvisorCheckSummaries`](support_example_support_DescribeTrustedAdvisorCheckSummaries_section.md)
+ [`DescribeTrustedAdvisorChecks`](support_example_support_DescribeTrustedAdvisorChecks_section.md)
+ [`RefreshTrustedAdvisorCheck`](support_example_support_RefreshTrustedAdvisorCheck_section.md)
+ [`ResolveCase`](support_example_support_ResolveCase_section.md)
# `AddAttachmentsToSet`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `AddAttachmentsToSet`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Add an attachment to a set, or create a new attachment set if one does not exist.
///
/// The data for the attachment.
/// The file name for the attachment.
/// Optional setId for the attachment. Creates a new attachment set if empty.
/// The setId of the attachment.
public async Task AddAttachmentToSet(MemoryStream data, string fileName, string? attachmentSetId = null)
{
var response = await _amazonSupport.AddAttachmentsToSetAsync(
new AddAttachmentsToSetRequest
{
AttachmentSetId = attachmentSetId,
Attachments = new List
{
new Attachment
{
Data = data,
FileName = fileName
}
}
});
return response.AttachmentSetId;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[AddAttachmentsToSet](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/AddAttachmentsToSet)*中的。
------
#### [ CLI ]
**AWS CLI**
**向集合添加附件**
以下`add-attachments-to-set`示例向一组图片添加了一张图片，然后您可以为 AWS 账户中的支持案例指定该图片。
```
aws support add-attachments-to-set \
--attachment-set-id "as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE" \
--attachments fileName=troubleshoot-screenshot.png,data=base64-encoded-string
```
输出：
```
{
"attachmentSetId": "as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE",
"expiryTime": "2020-05-14T17:04:40.790+0000"
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的[案例管理](https://docs.aws.amazon.com/awssupport/latest/user/case-management.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[AddAttachmentsToSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/add-attachments-to-set.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static String addAttachment(SupportClient supportClient, String fileAttachment) {
try {
File myFile = new File(fileAttachment);
InputStream sourceStream = new FileInputStream(myFile);
SdkBytes sourceBytes = SdkBytes.fromInputStream(sourceStream);
Attachment attachment = Attachment.builder()
.fileName(myFile.getName())
.data(sourceBytes)
.build();
AddAttachmentsToSetRequest setRequest = AddAttachmentsToSetRequest.builder()
.attachments(attachment)
.build();
AddAttachmentsToSetResponse response = supportClient.addAttachmentsToSet(setRequest);
return response.attachmentSetId();
} catch (SupportException | FileNotFoundException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[AddAttachmentsToSet](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/AddAttachmentsToSet)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import { AddAttachmentsToSetCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Create a new attachment set or add attachments to an existing set.
// Provide an 'attachmentSetId' value to add attachments to an existing set.
// Use AddCommunicationToCase or CreateCase to associate an attachment set with a support case.
const response = await client.send(
new AddAttachmentsToSetCommand({
// You can add up to three attachments per set. The size limit is 5 MB per attachment.
attachments: [
{
fileName: "example.txt",
data: new TextEncoder().encode("some example text"),
},
],
}),
);
// Use this ID in AddCommunicationToCase or CreateCase.
console.log(response.attachmentSetId);
return response;
} catch (err) {
console.error(err);
}
};
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[AddAttachmentsToSet](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/AddAttachmentsToSetCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun addAttachment(fileAttachment: String): String? {
val myFile = File(fileAttachment)
val sourceBytes = (File(fileAttachment).readBytes())
val attachmentVal =
Attachment {
fileName = myFile.name
data = sourceBytes
}
val setRequest =
AddAttachmentsToSetRequest {
attachments = listOf(attachmentVal)
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.addAttachmentsToSet(setRequest)
return response.attachmentSetId
}
}
```
+ 有关 API 的详细信息，请参阅适用[AddAttachmentsToSet](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def add_attachment_to_set(self):
"""
Add an attachment to a set, or create a new attachment set if one does not exist.
:return: The attachment set ID.
"""
try:
response = self.support_client.add_attachments_to_set(
attachments=[
{
"fileName": "attachment_file.txt",
"data": b"This is a sample file for attachment to a support case.",
}
]
)
new_set_id = response["attachmentSetId"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't add attachment. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return new_set_id
```
+ 有关 API 的详细信息，请参阅适用[AddAttachmentsToSet](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/AddAttachmentsToSet)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `AddCommunicationToCase`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `AddCommunicationToCase`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Add communication to a case, including optional attachment set ID and CC email addresses.
///
/// Id for the support case.
/// Body text of the communication.
/// Optional Id for an attachment set.
/// Optional list of CC email addresses.
/// True if successful.
public async Task AddCommunicationToCase(string caseId, string body,
string? attachmentSetId = null, List? ccEmailAddresses = null)
{
var response = await _amazonSupport.AddCommunicationToCaseAsync(
new AddCommunicationToCaseRequest()
{
CaseId = caseId,
CommunicationBody = body,
AttachmentSetId = attachmentSetId,
CcEmailAddresses = ccEmailAddresses
});
return response.Result;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[AddCommunicationToCase](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/AddCommunicationToCase)*中的。
------
#### [ CLI ]
**AWS CLI**
**向案例添加通信**
以下`add-communication-to-case`示例将通信添加到您 AWS 账户中的支持案例中。
```
aws support add-communication-to-case \
--case-id "case-12345678910-2013-c4c1d2bf33c5cf47" \
--communication-body "I'm attaching a set of images to this case." \
--cc-email-addresses "myemail@example.com" \
--attachment-set-id "as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE"
```
输出：
```
{
"result": true
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的[案例管理](https://docs.aws.amazon.com/awssupport/latest/user/case-management.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[AddCommunicationToCase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/add-communication-to-case.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static void addAttachSupportCase(SupportClient supportClient, String caseId, String attachmentSetId) {
try {
AddCommunicationToCaseRequest caseRequest = AddCommunicationToCaseRequest.builder()
.caseId(caseId)
.attachmentSetId(attachmentSetId)
.communicationBody("Please refer to attachment for details.")
.build();
AddCommunicationToCaseResponse response = supportClient.addCommunicationToCase(caseRequest);
if (response.result())
System.out.println("You have successfully added a communication to an AWS Support case");
else
System.out.println("There was an error adding the communication to an AWS Support case");
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[AddCommunicationToCase](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/AddCommunicationToCase)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import { AddCommunicationToCaseCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
let attachmentSetId;
try {
// Add a communication to a case.
const response = await client.send(
new AddCommunicationToCaseCommand({
communicationBody: "Adding an attachment.",
// Set value to an existing support case id.
caseId: "CASE_ID",
// Optional. Set value to an existing attachment set id to add attachments to the case.
attachmentSetId,
}),
);
console.log(response);
return response;
} catch (err) {
console.error(err);
}
};
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[AddCommunicationToCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/AddCommunicationToCaseCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun addAttachSupportCase(
caseIdVal: String?,
attachmentSetIdVal: String?,
) {
val caseRequest =
AddCommunicationToCaseRequest {
caseId = caseIdVal
attachmentSetId = attachmentSetIdVal
communicationBody = "Please refer to attachment for details."
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.addCommunicationToCase(caseRequest)
if (response.result) {
println("You have successfully added a communication to an AWS Support case")
} else {
println("There was an error adding the communication to an AWS Support case")
}
}
}
```
+ 有关 API 的详细信息，请参阅适用[AddCommunicationToCase](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：将电子邮件通信的正文添加到指定案例中。**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CommunicationBody "Some text about the case"
```
**示例 2：将电子邮件通信的正文添加到指定案例中，另加上电子邮件抄送行中包含的一个或多个电子邮件地址。**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CcEmailAddress @("email1@address.com", "email2@address.com") -CommunicationBody "Some text about the case"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [AddCommunicationToCase](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：将电子邮件通信的正文添加到指定案例中。**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CommunicationBody "Some text about the case"
```
**示例 2：将电子邮件通信的正文添加到指定案例中，另加上电子邮件抄送行中包含的一个或多个电子邮件地址。**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CcEmailAddress @("email1@address.com", "email2@address.com") -CommunicationBody "Some text about the case"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [AddCommunicationToCase](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def add_communication_to_case(self, attachment_set_id, case_id):
"""
Add a communication and an attachment set to a case.
:param attachment_set_id: The ID of an existing attachment set.
:param case_id: The ID of the case.
"""
try:
self.support_client.add_communication_to_case(
caseId=case_id,
communicationBody="This is an example communication added to a support case.",
attachmentSetId=attachment_set_id,
)
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't add communication. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[AddCommunicationToCase](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/AddCommunicationToCase)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `CreateCase`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `CreateCase`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Create a new support case.
///
/// Service code for the new case.
/// Category for the new case.
/// Severity code for the new case.
/// Subject of the new case.
/// Body text of the new case.
/// Optional language support for your case.
/// Currently Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”) are supported.
/// Optional Id for an attachment set for the new case.
/// Optional issue type for the new case. Options are "customer-service" or "technical".
/// The caseId of the new support case.
public async Task CreateCase(string serviceCode, string categoryCode, string severityCode, string subject,
string body, string language = "en", string? attachmentSetId = null, string issueType = "customer-service")
{
var response = await _amazonSupport.CreateCaseAsync(
new CreateCaseRequest()
{
ServiceCode = serviceCode,
CategoryCode = categoryCode,
SeverityCode = severityCode,
Subject = subject,
Language = language,
AttachmentSetId = attachmentSetId,
IssueType = issueType,
CommunicationBody = body
});
return response.CaseId;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[CreateCase](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/CreateCase)*中的。
------
#### [ CLI ]
**AWS CLI**
**创建案例**
以下`create-case`示例为您的 AWS 账户创建了一个支持案例。
```
aws support create-case \
--category-code "using-aws" \
--cc-email-addresses "myemail@example.com" \
--communication-body "I want to learn more about an AWS service." \
--issue-type "technical" \
--language "en" \
--service-code "general-info" \
--severity-code "low" \
--subject "Question about my account"
```
输出：
```
{
"caseId": "case-12345678910-2013-c4c1d2bf33c5cf47"
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的[案例管理](https://docs.aws.amazon.com/awssupport/latest/user/case-management.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateCase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/create-case.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static String createSupportCase(SupportClient supportClient, List sevCatList, String sevLevel) {
try {
String serviceCode = sevCatList.get(0);
String caseCat = sevCatList.get(1);
CreateCaseRequest caseRequest = CreateCaseRequest.builder()
.categoryCode(caseCat.toLowerCase())
.serviceCode(serviceCode.toLowerCase())
.severityCode(sevLevel.toLowerCase())
.communicationBody("Test issue with " + serviceCode.toLowerCase())
.subject("Test case, please ignore")
.language("en")
.issueType("technical")
.build();
CreateCaseResponse response = supportClient.createCase(caseRequest);
return response.caseId();
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[CreateCase](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/CreateCase)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import { CreateCaseCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Create a new case and log the case id.
// Important: This creates a real support case in your account.
const response = await client.send(
new CreateCaseCommand({
// The subject line of the case.
subject: "IGNORE: Test case",
// Use DescribeServices to find available service codes for each service.
serviceCode: "service-quicksight-end-user",
// Use DescribeSecurityLevels to find available severity codes for your support plan.
severityCode: "low",
// Use DescribeServices to find available category codes for each service.
categoryCode: "end-user-support",
// The main description of the support case.
communicationBody: "This is a test. Please ignore.",
}),
);
console.log(response.caseId);
return response;
} catch (err) {
console.error(err);
}
};
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[CreateCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/CreateCaseCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun createSupportCase(
sevCatListVal: List,
sevLevelVal: String,
): String? {
val serCode = sevCatListVal[0]
val caseCategory = sevCatListVal[1]
val caseRequest =
CreateCaseRequest {
categoryCode = caseCategory.lowercase(Locale.getDefault())
serviceCode = serCode.lowercase(Locale.getDefault())
severityCode = sevLevelVal.lowercase(Locale.getDefault())
communicationBody = "Test issue with ${serCode.lowercase(Locale.getDefault())}"
subject = "Test case, please ignore"
language = "en"
issueType = "technical"
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.createCase(caseRequest)
return response.caseId
}
}
```
+ 有关 API 的详细信息，请参阅适用[CreateCase](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：在 Su AWS pport Center 中创建新案例。-ServiceCode 和-CategoryCode 参数的值可以使用 Get-ASAService cmdlet 获取。-SeverityCode 参数的值可以使用 Get-ASASeverityLevel cmdlet 获得。-IssueType 参数值可以是 “客户服务” 或 “技术”。如果成功，则 AWS 输出 Support 案例编号。默认情况下，案例将用英语处理，要使用日语，请添加 -Language“ja”参数。-ServiceCode、-CategoryCode、-主题和-CommunicationBody 参数是必需的。**
```
New-ASACase -ServiceCode "amazon-cloudfront" -CategoryCode "APIs" -SeverityCode "low" -Subject "subject text" -CommunicationBody "description of the case" -CcEmailAddress @("email1@domain.com", "email2@domain.com") -IssueType "technical"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [CreateCase](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：在 Su AWS pport Center 中创建新案例。-ServiceCode 和-CategoryCode 参数的值可以使用 Get-ASAService cmdlet 获取。-SeverityCode 参数的值可以使用 Get-ASASeverityLevel cmdlet 获得。-IssueType 参数值可以是 “客户服务” 或 “技术”。如果成功，则 AWS 输出 Support 案例编号。默认情况下，案例将用英语处理，要使用日语，请添加 -Language“ja”参数。-ServiceCode、-CategoryCode、-主题和-CommunicationBody 参数是必需的。**
```
New-ASACase -ServiceCode "amazon-cloudfront" -CategoryCode "APIs" -SeverityCode "low" -Subject "subject text" -CommunicationBody "description of the case" -CcEmailAddress @("email1@domain.com", "email2@domain.com") -IssueType "technical"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [CreateCase](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def create_case(self, service, category, severity):
"""
Create a new support case.
:param service: The service to use for the new case.
:param category: The category to use for the new case.
:param severity: The severity to use for the new case.
:return: The caseId of the new case.
"""
try:
response = self.support_client.create_case(
subject="Example case for testing, ignore.",
serviceCode=service["code"],
severityCode=severity["code"],
categoryCode=category["code"],
communicationBody="Example support case body.",
language="en",
issueType="customer-service",
)
case_id = response["caseId"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't create case. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return case_id
```
+ 有关 API 的详细信息，请参阅适用[CreateCase](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/CreateCase)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `DescribeAttachment`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DescribeAttachment`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Get description of a specific attachment.
///
/// Id of the attachment, usually fetched by describing the communications of a case.
/// The attachment object.
public async Task DescribeAttachment(string attachmentId)
{
var response = await _amazonSupport.DescribeAttachmentAsync(
new DescribeAttachmentRequest()
{
AttachmentId = attachmentId
});
return response.Attachment;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DescribeAttachment](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeAttachment)*中的。
------
#### [ CLI ]
**AWS CLI**
**描述附件**
以下 `describe-attachment` 示例返回有关带指定 ID 的附件的信息。
```
aws support describe-attachment \
--attachment-id "attachment-KBnjRNrePd9D6Jx0-Mm00xZuDEaL2JAj_0-gJv9qqDooTipsz3V1Nb19rCfkZneeQeDPgp8X1iVJyHH7UuhZDdNeqGoduZsPrAhyMakqlc60-iJjL5HqyYGiT1FG8EXAMPLE"
```
输出：
```
{
"attachment": {
"fileName": "troubleshoot-screenshot.png",
"data": "base64-blob"
}
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的[案例管理](https://docs.aws.amazon.com/awssupport/latest/user/case-management.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/describe-attachment.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static void describeAttachment(SupportClient supportClient, String attachId) {
try {
DescribeAttachmentRequest attachmentRequest = DescribeAttachmentRequest.builder()
.attachmentId(attachId)
.build();
DescribeAttachmentResponse response = supportClient.describeAttachment(attachmentRequest);
System.out.println("The name of the file is " + response.attachment().fileName());
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeAttachment](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeAttachment)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import { DescribeAttachmentCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Get the metadata and content of an attachment.
const response = await client.send(
new DescribeAttachmentCommand({
// Set value to an existing attachment id.
// Use DescribeCommunications or DescribeCases to find an attachment id.
attachmentId: "ATTACHMENT_ID",
}),
);
console.log(response.attachment?.fileName);
return response;
} catch (err) {
console.error(err);
}
};
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[DescribeAttachment](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeAttachmentCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun describeAttachment(attachId: String?) {
val attachmentRequest =
DescribeAttachmentRequest {
attachmentId = attachId
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeAttachment(attachmentRequest)
println("The name of the file is ${response.attachment?.fileName}")
}
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeAttachment](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def describe_attachment(self, attachment_id):
"""
Get information about an attachment by its attachmentID.
:param attachment_id: The ID of the attachment.
:return: The name of the attached file.
"""
try:
response = self.support_client.describe_attachment(
attachmentId=attachment_id
)
attached_file = response["attachment"]["fileName"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't get attachment description. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return attached_file
```
+ 有关 API 的详细信息，请参阅适用[DescribeAttachment](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeAttachment)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `DescribeCases`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DescribeCases`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Get case details for a list of case ids, optionally with date filters.
///
/// The list of case IDs.
/// Optional display ID.
/// True to include communication. Defaults to true.
/// True to include resolved cases. Defaults to false.
/// The optional start date for a filtered search.
/// The optional end date for a filtered search.
/// Optional language support for your case.
/// Currently Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”) are supported.
/// A list of CaseDetails.
public async Task> DescribeCases(List caseIds, string? displayId = null, bool includeCommunication = true,
bool includeResolvedCases = false, DateTime? afterTime = null, DateTime? beforeTime = null,
string language = "en")
{
var results = new List();
var paginateCases = _amazonSupport.Paginators.DescribeCases(
new DescribeCasesRequest()
{
CaseIdList = caseIds,
DisplayId = displayId,
IncludeCommunications = includeCommunication,
IncludeResolvedCases = includeResolvedCases,
AfterTime = afterTime?.ToString("s"),
BeforeTime = beforeTime?.ToString("s"),
Language = language
});
// Get the entire list using the paginator.
await foreach (var cases in paginateCases.Cases)
{
results.Add(cases);
}
return results;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DescribeCases](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeCases)*中的。
------
#### [ CLI ]
**AWS CLI**
**描述案例**
以下`describe-cases`示例返回有关您 AWS 账户中指定支持案例的信息。
```
aws support describe-cases \
--display-id "1234567890" \
--after-time "2020-03-23T21:31:47.774Z" \
--include-resolved-cases \
--language "en" \
--no-include-communications \
--max-item 1
```
输出：
```
{
"cases": [
{
"status": "resolved",
"ccEmailAddresses": [],
"timeCreated": "2020-03-23T21:31:47.774Z",
"caseId": "case-12345678910-2013-c4c1d2bf33c5cf47",
"severityCode": "low",
"language": "en",
"categoryCode": "using-aws",
"serviceCode": "general-info",
"submittedBy": "myemail@example.com",
"displayId": "1234567890",
"subject": "Question about my account"
}
]
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的[案例管理](https://docs.aws.amazon.com/awssupport/latest/user/case-management.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeCases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/describe-cases.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static void getOpenCase(SupportClient supportClient) {
try {
// Specify the start and end time.
Instant now = Instant.now();
java.time.LocalDate.now();
Instant yesterday = now.minus(1, ChronoUnit.DAYS);
DescribeCasesRequest describeCasesRequest = DescribeCasesRequest.builder()
.maxResults(20)
.afterTime(yesterday.toString())
.beforeTime(now.toString())
.build();
DescribeCasesResponse response = supportClient.describeCases(describeCasesRequest);
List cases = response.cases();
for (CaseDetails sinCase : cases) {
System.out.println("The case status is " + sinCase.status());
System.out.println("The case Id is " + sinCase.caseId());
System.out.println("The case subject is " + sinCase.subject());
}
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeCases](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeCases)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import { DescribeCasesCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Get all of the unresolved cases in your account.
// Filter or expand results by providing parameters to the DescribeCasesCommand. Refer
// to the TypeScript definition and the API doc for more information on possible parameters.
// https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-support/interfaces/describecasescommandinput.html
const response = await client.send(new DescribeCasesCommand({}));
const caseIds = response.cases.map((supportCase) => supportCase.caseId);
console.log(caseIds);
return response;
} catch (err) {
console.error(err);
}
};
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[DescribeCases](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeCasesCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun getOpenCase() {
// Specify the start and end time.
val now = Instant.now()
LocalDate.now()
val yesterday = now.minus(1, ChronoUnit.DAYS)
val describeCasesRequest =
DescribeCasesRequest {
maxResults = 20
afterTime = yesterday.toString()
beforeTime = now.toString()
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeCases(describeCasesRequest)
response.cases?.forEach { sinCase ->
println("The case status is ${sinCase.status}")
println("The case Id is ${sinCase.caseId}")
println("The case subject is ${sinCase.subject}")
}
}
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeCases](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：返回所有支持案例的详细信息。**
```
Get-ASACase
```
**示例 2：返回自指定日期和时间以来所有支持案例的详细信息。**
```
Get-ASACase -AfterTime "2013-09-10T03:06Z"
```
**示例 3：返回前 10 个支持案例的详细信息，包括已解决的支持案例。**
```
Get-ASACase -MaxResult 10 -IncludeResolvedCases $true
```
**示例 4：返回单个指定支持案例的详细信息。**
```
Get-ASACase -CaseIdList "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**示例 5：返回指定支持案例的详细信息。**
```
Get-ASACase -CaseIdList @("case-12345678910-2013-c4c1d2bf33c5cf47", "case-18929034710-2011-c4fdeabf33c5cf47")
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeCases](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：返回所有支持案例的详细信息。**
```
Get-ASACase
```
**示例 2：返回自指定日期和时间以来所有支持案例的详细信息。**
```
Get-ASACase -AfterTime "2013-09-10T03:06Z"
```
**示例 3：返回前 10 个支持案例的详细信息，包括已解决的支持案例。**
```
Get-ASACase -MaxResult 10 -IncludeResolvedCases $true
```
**示例 4：返回单个指定支持案例的详细信息。**
```
Get-ASACase -CaseIdList "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**示例 5：返回指定支持案例的详细信息。**
```
Get-ASACase -CaseIdList @("case-12345678910-2013-c4c1d2bf33c5cf47", "case-18929034710-2011-c4fdeabf33c5cf47")
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeCases](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def describe_cases(self, after_time, before_time, resolved):
"""
Describe support cases over a period of time, optionally filtering
by status.
:param after_time: The start time to include for cases.
:param before_time: The end time to include for cases.
:param resolved: True to include resolved cases in the results,
otherwise results are open cases.
:return: The final status of the case.
"""
try:
cases = []
paginator = self.support_client.get_paginator("describe_cases")
for page in paginator.paginate(
afterTime=after_time,
beforeTime=before_time,
includeResolvedCases=resolved,
language="en",
):
cases += page["cases"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't describe cases. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
if resolved:
cases = filter(lambda case: case["status"] == "resolved", cases)
return cases
```
+ 有关 API 的详细信息，请参阅适用[DescribeCases](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeCases)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `DescribeCommunications`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DescribeCommunications`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Describe the communications for a case, optionally with a date filter.
///
/// The ID of the support case.
/// The optional start date for a filtered search.
/// The optional end date for a filtered search.
/// The list of communications for the case.
public async Task> DescribeCommunications(string caseId, DateTime? afterTime = null, DateTime? beforeTime = null)
{
var results = new List();
var paginateCommunications = _amazonSupport.Paginators.DescribeCommunications(
new DescribeCommunicationsRequest()
{
CaseId = caseId,
AfterTime = afterTime?.ToString("s"),
BeforeTime = beforeTime?.ToString("s")
});
// Get the entire list using the paginator.
await foreach (var communications in paginateCommunications.Communications)
{
results.Add(communications);
}
return results;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DescribeCommunications](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeCommunications)*中的。
------
#### [ CLI ]
**AWS CLI**
**描述案例的最新通信**
以下`describe-communications`示例返回您 AWS 账户中指定支持案例的最新通信。
```
aws support describe-communications \
--case-id "case-12345678910-2013-c4c1d2bf33c5cf47" \
--after-time "2020-03-23T21:31:47.774Z" \
--max-item 1
```
输出：
```
{
"communications": [
{
"body": "I want to learn more about an AWS service.",
"attachmentSet": [],
"caseId": "case-12345678910-2013-c4c1d2bf33c5cf47",
"timeCreated": "2020-05-12T23:12:35.000Z",
"submittedBy": "Amazon Web Services"
}
],
"NextToken": "eyJuZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQEXAMPLE=="
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的[案例管理](https://docs.aws.amazon.com/awssupport/latest/user/case-management.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeCommunications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/describe-communications.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static String listCommunications(SupportClient supportClient, String caseId) {
try {
String attachId = null;
DescribeCommunicationsRequest communicationsRequest = DescribeCommunicationsRequest.builder()
.caseId(caseId)
.maxResults(10)
.build();
DescribeCommunicationsResponse response = supportClient.describeCommunications(communicationsRequest);
List communications = response.communications();
for (Communication comm : communications) {
System.out.println("the body is: " + comm.body());
// Get the attachment id value.
List attachments = comm.attachmentSet();
for (AttachmentDetails detail : attachments) {
attachId = detail.attachmentId();
}
}
return attachId;
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeCommunications](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeCommunications)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import { DescribeCommunicationsCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Get all communications for the support case.
// Filter results by providing parameters to the DescribeCommunicationsCommand. Refer
// to the TypeScript definition and the API doc for more information on possible parameters.
// https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-support/interfaces/describecommunicationscommandinput.html
const response = await client.send(
new DescribeCommunicationsCommand({
// Set value to an existing case id.
caseId: "CASE_ID",
}),
);
const text = response.communications.map((item) => item.body).join("\n");
console.log(text);
return response;
} catch (err) {
console.error(err);
}
};
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[DescribeCommunications](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeCommunicationsCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun listCommunications(caseIdVal: String?): String? {
val communicationsRequest =
DescribeCommunicationsRequest {
caseId = caseIdVal
maxResults = 10
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeCommunications(communicationsRequest)
response.communications?.forEach { comm ->
println("the body is: " + comm.body)
comm.attachmentSet?.forEach { detail ->
return detail.attachmentId
}
}
}
return ""
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeCommunications](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：返回指定案例的所有通信。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**示例 2：返回自协调世界时 2012 年 1 月 1 日午夜以来针对指定案例的所有通信。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -AfterTime "2012-01-10T00:00Z"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeCommunications](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：返回指定案例的所有通信。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**示例 2：返回自协调世界时 2012 年 1 月 1 日午夜以来针对指定案例的所有通信。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -AfterTime "2012-01-10T00:00Z"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeCommunications](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def describe_all_case_communications(self, case_id):
"""
Describe all the communications for a case using a paginator.
:param case_id: The ID of the case.
:return: The communications for the case.
"""
try:
communications = []
paginator = self.support_client.get_paginator("describe_communications")
for page in paginator.paginate(caseId=case_id):
communications += page["communications"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't describe communications. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return communications
```
+ 有关 API 的详细信息，请参阅适用[DescribeCommunications](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeCommunications)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `DescribeServices`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DescribeServices`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Get the descriptions of AWS services.
///
/// Optional language for services.
/// Currently Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”) are supported.
/// The list of AWS service descriptions.
public async Task> DescribeServices(string language = "en")
{
var response = await _amazonSupport.DescribeServicesAsync(
new DescribeServicesRequest()
{
Language = language
});
return response.Services;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DescribeServices](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeServices)*中的。
------
#### [ CLI ]
**AWS CLI**
**列出 AWS 服务和服务类别**
以下 `describe-services` 示例列出了用于请求一般信息的可用服务类别。
```
aws support describe-services \
--service-code-list "general-info"
```
输出：
```
{
"services": [
{
"code": "general-info",
"name": "General Info and Getting Started",
"categories": [
{
"code": "charges",
"name": "How Will I Be Charged?"
},
{
"code": "gdpr-queries",
"name": "Data Privacy Query"
},
{
"code": "reserved-instances",
"name": "Reserved Instances"
},
{
"code": "resource",
"name": "Where is my Resource?"
},
{
"code": "using-aws",
"name": "Using AWS & Services"
},
{
"code": "free-tier",
"name": "Free Tier"
},
{
"code": "security-and-compliance",
"name": "Security & Compliance"
},
{
"code": "account-structure",
"name": "Account Structure"
}
]
}
]
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的[案例管理](https://docs.aws.amazon.com/awssupport/latest/user/case-management.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/describe-services.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
// Return a List that contains a Service name and Category name.
public static List displayServices(SupportClient supportClient) {
try {
DescribeServicesRequest servicesRequest = DescribeServicesRequest.builder()
.language("en")
.build();
DescribeServicesResponse response = supportClient.describeServices(servicesRequest);
String serviceCode = null;
String catName = null;
List sevCatList = new ArrayList<>();
List services = response.services();
System.out.println("Get the first 10 services");
int index = 1;
for (Service service : services) {
if (index == 11)
break;
System.out.println("The Service name is: " + service.name());
if (service.name().compareTo("Account") == 0)
serviceCode = service.code();
// Get the Categories for this service.
List categories = service.categories();
for (Category cat : categories) {
System.out.println("The category name is: " + cat.name());
if (cat.name().compareTo("Security") == 0)
catName = cat.name();
}
index++;
}
// Push the two values to the list.
sevCatList.add(serviceCode);
sevCatList.add(catName);
return sevCatList;
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return null;
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeServices](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeServices)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
// Return a List that contains a Service name and Category name.
suspend fun displayServices(): List {
var serviceCode = ""
var catName = ""
val sevCatList = mutableListOf()
val servicesRequest =
DescribeServicesRequest {
language = "en"
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeServices(servicesRequest)
println("Get the first 10 services")
var index = 1
response.services?.forEach { service ->
if (index == 11) {
return@forEach
}
println("The Service name is ${service.name}")
if (service.name == "Account") {
serviceCode = service.code.toString()
}
// Get the categories for this service.
service.categories?.forEach { cat ->
println("The category name is ${cat.name}")
if (cat.name == "Security") {
catName = cat.name!!
}
}
index++
}
}
// Push the two values to the list.
serviceCode.let { sevCatList.add(it) }
catName.let { sevCatList.add(it) }
return sevCatList
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeServices](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：返回所有可用的服务代码、名称和类别。**
```
Get-ASAService
```
**示例 2：返回带有指定代码的服务的名称和类别。**
```
Get-ASAService -ServiceCodeList "amazon-cloudfront"
```
**示例 3：返回指定服务代码的名称和类别。**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch")
```
**示例 4：返回指定服务代码的名称和类别（日语）。目前支持英语（“en”）和日语（“ja”）语言代码。**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch") -Language "ja"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeServices](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：返回所有可用的服务代码、名称和类别。**
```
Get-ASAService
```
**示例 2：返回带有指定代码的服务的名称和类别。**
```
Get-ASAService -ServiceCodeList "amazon-cloudfront"
```
**示例 3：返回指定服务代码的名称和类别。**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch")
```
**示例 4：返回指定服务代码的名称和类别（日语）。目前支持英语（“en”）和日语（“ja”）语言代码。**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch") -Language "ja"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def describe_services(self, language):
"""
Get the descriptions of AWS services available for support for a language.
:param language: The language for support services.
Currently, only "en" (English) and "ja" (Japanese) are supported.
:return: The list of AWS service descriptions.
"""
try:
response = self.support_client.describe_services(language=language)
services = response["services"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't get Support services for language %s. Here's why: %s: %s",
language,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return services
```
+ 有关 API 的详细信息，请参阅适用[DescribeServices](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeServices)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `DescribeSeverityLevels`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DescribeSeverityLevels`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Get the descriptions of support severity levels.
///
/// Optional language for severity levels.
/// Currently Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”) are supported.
/// The list of support severity levels.
public async Task> DescribeSeverityLevels(string language = "en")
{
var response = await _amazonSupport.DescribeSeverityLevelsAsync(
new DescribeSeverityLevelsRequest()
{
Language = language
});
return response.SeverityLevels;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DescribeSeverityLevels](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/DescribeSeverityLevels)*中的。
------
#### [ CLI ]
**AWS CLI**
**列出可用的严重性级别**
以下 `describe-severity-levels` 示例列出了支持案例的可用严重性级别。
```
aws support describe-severity-levels
```
输出：
```
{
"severityLevels": [
{
"code": "low",
"name": "Low"
},
{
"code": "normal",
"name": "Normal"
},
{
"code": "high",
"name": "High"
},
{
"code": "urgent",
"name": "Urgent"
},
{
"code": "critical",
"name": "Critical"
}
]
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的[选择严重性](https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeSeverityLevels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/describe-severity-levels.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static String displaySevLevels(SupportClient supportClient) {
try {
DescribeSeverityLevelsRequest severityLevelsRequest = DescribeSeverityLevelsRequest.builder()
.language("en")
.build();
DescribeSeverityLevelsResponse response = supportClient.describeSeverityLevels(severityLevelsRequest);
List severityLevels = response.severityLevels();
String levelName = null;
for (SeverityLevel sevLevel : severityLevels) {
System.out.println("The severity level name is: " + sevLevel.name());
if (sevLevel.name().compareTo("High") == 0)
levelName = sevLevel.name();
}
return levelName;
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeSeverityLevels](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeSeverityLevels)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import { DescribeSeverityLevelsCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Get the list of severity levels.
// The available values depend on the support plan for the account.
const response = await client.send(new DescribeSeverityLevelsCommand({}));
console.log(response.severityLevels);
return response;
} catch (err) {
console.error(err);
}
};
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[DescribeSeverityLevels](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeSeverityLevelsCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun displaySevLevels(): String {
var levelName = ""
val severityLevelsRequest =
DescribeSeverityLevelsRequest {
language = "en"
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.describeSeverityLevels(severityLevelsRequest)
response.severityLevels?.forEach { sevLevel ->
println("The severity level name is: ${sevLevel.name}")
if (sevLevel.name == "High") {
levelName = sevLevel.name!!
}
}
return levelName
}
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeSeverityLevels](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：返回可分配给 Support 案例的 AWS 严重性级别列表。**
```
Get-ASASeverityLevel
```
**示例 2：返回可以分配给 Support 案例的 AWS 严重性级别列表。级别名称以日语返回。**
```
Get-ASASeverityLevel -Language "ja"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeSeverityLevels](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：返回可分配给 Support 案例的 AWS 严重性级别列表。**
```
Get-ASASeverityLevel
```
**示例 2：返回可以分配给 Support 案例的 AWS 严重性级别列表。级别名称以日语返回。**
```
Get-ASASeverityLevel -Language "ja"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeSeverityLevels](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def describe_severity_levels(self, language):
"""
Get the descriptions of available severity levels for support cases for a language.
:param language: The language for support severity levels.
Currently, only "en" (English) and "ja" (Japanese) are supported.
:return: The list of severity levels.
"""
try:
response = self.support_client.describe_severity_levels(language=language)
severity_levels = response["severityLevels"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't get severity levels for language %s. Here's why: %s: %s",
language,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return severity_levels
```
+ 有关 API 的详细信息，请参阅适用[DescribeSeverityLevels](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeSeverityLevels)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# 将 `DescribeTrustedAdvisorCheckRefreshStatuses` 与 CLI 配合使用
以下代码示例演示如何使用 `DescribeTrustedAdvisorCheckRefreshStatuses`。
------
#### [ CLI ]
**AWS CLI**
**列出 Truste AWS d Advisor 检查的刷新状态**
以下 `describe-trusted-advisor-check-refresh-statuses` 示例列出两个 Trusted Advisor 检查的刷新状态：Amazon S3 存储桶权限和 IAM 使用。
```
aws support describe-trusted-advisor-check-refresh-statuses \
--check-id "Pfx0RwqBli" "zXCkfM1nI3"
```
输出：
```
{
"statuses": [
{
"checkId": "Pfx0RwqBli",
"status": "none",
"millisUntilNextRefreshable": 0
},
{
"checkId": "zXCkfM1nI3",
"status": "none",
"millisUntilNextRefreshable": 0
}
]
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的 [AWS Trusted Advisor](https://docs.aws.amazon.com/awssupport/latest/user/trusted-advisor.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeTrustedAdvisorCheckRefreshStatuses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/describe-trusted-advisor-check-refresh-statuses.html)*中的。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：返回指定检查的刷新请求的当前状态。Request-ASATrusted AdvisorCheckRefresh 可用于请求刷新支票的状态信息。**
```
Get-ASATrustedAdvisorCheckRefreshStatus -CheckId @("checkid1", "checkid2")
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeTrustedAdvisorCheckRefreshStatuses](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：返回指定检查的刷新请求的当前状态。Request-ASATrusted AdvisorCheckRefresh 可用于请求刷新支票的状态信息。**
```
Get-ASATrustedAdvisorCheckRefreshStatus -CheckId @("checkid1", "checkid2")
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeTrustedAdvisorCheckRefreshStatuses](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# 将 `DescribeTrustedAdvisorCheckResult` 与 CLI 配合使用
以下代码示例演示如何使用 `DescribeTrustedAdvisorCheckResult`。
------
#### [ CLI ]
**AWS CLI**
**列出 Tru AWS sted Advisor 检查的结果**
以下 `describe-trusted-advisor-check-result` 示例列出 IAM 使用检查的结果。
```
aws support describe-trusted-advisor-check-result \
--check-id "zXCkfM1nI3"
```
输出：
```
{
"result": {
"checkId": "zXCkfM1nI3",
"timestamp": "2020-05-13T21:38:05Z",
"status": "ok",
"resourcesSummary": {
"resourcesProcessed": 1,
"resourcesFlagged": 0,
"resourcesIgnored": 0,
"resourcesSuppressed": 0
},
"categorySpecificSummary": {
"costOptimizing": {
"estimatedMonthlySavings": 0.0,
"estimatedPercentMonthlySavings": 0.0
}
},
"flaggedResources": [
{
"status": "ok",
"resourceId": "47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZEXAMPLE",
"isSuppressed": false
}
]
}
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的 [AWS Trusted Advisor](https://docs.aws.amazon.com/awssupport/latest/user/trusted-advisor.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeTrustedAdvisorCheckResult](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/describe-trusted-advisor-check-result.html)*中的。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：返回 Trusted Advisor 检查的结果。可用 Trusted Advisor 支票列表可以使用 Get-获取ASATrustedAdvisorChecks。输出是检查的总体状态、上次运行检查的时间戳以及特定检查的唯一 checkid。要以日语输出结果，请添加 -Language“ja”参数。**
```
Get-ASATrustedAdvisorCheckResult -CheckId "checkid1"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeTrustedAdvisorCheckResult](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：返回 Trusted Advisor 检查的结果。可用 Trusted Advisor 支票列表可以使用 Get-获取ASATrustedAdvisorChecks。输出是检查的总体状态、上次运行检查的时间戳以及特定检查的唯一 checkid。要以日语输出结果，请添加 -Language“ja”参数。**
```
Get-ASATrustedAdvisorCheckResult -CheckId "checkid1"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeTrustedAdvisorCheckResult](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# 将 `DescribeTrustedAdvisorCheckSummaries` 与 CLI 配合使用
以下代码示例演示如何使用 `DescribeTrustedAdvisorCheckSummaries`。
------
#### [ CLI ]
**AWS CLI**
**列出 Tru AWS sted Advisor 支票摘要**
以下 `describe-trusted-advisor-check-summaries` 示例列出两个 Trusted Advisor 检查的结果：Amazon S3 存储桶权限和 IAM 使用。
```
aws support describe-trusted-advisor-check-summaries \
--check-ids "Pfx0RwqBli" "zXCkfM1nI3"
```
输出：
```
{
"summaries": [
{
"checkId": "Pfx0RwqBli",
"timestamp": "2020-05-13T21:38:12Z",
"status": "ok",
"hasFlaggedResources": true,
"resourcesSummary": {
"resourcesProcessed": 44,
"resourcesFlagged": 0,
"resourcesIgnored": 0,
"resourcesSuppressed": 0
},
"categorySpecificSummary": {
"costOptimizing": {
"estimatedMonthlySavings": 0.0,
"estimatedPercentMonthlySavings": 0.0
}
}
},
{
"checkId": "zXCkfM1nI3",
"timestamp": "2020-05-13T21:38:05Z",
"status": "ok",
"hasFlaggedResources": true,
"resourcesSummary": {
"resourcesProcessed": 1,
"resourcesFlagged": 0,
"resourcesIgnored": 0,
"resourcesSuppressed": 0
},
"categorySpecificSummary": {
"costOptimizing": {
"estimatedMonthlySavings": 0.0,
"estimatedPercentMonthlySavings": 0.0
}
}
}
]
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的 [AWS Trusted Advisor](https://docs.aws.amazon.com/awssupport/latest/user/trusted-advisor.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeTrustedAdvisorCheckSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/describe-trusted-advisor-check-summaries.html)*中的。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：返回指定 Trusted Advisor 检查的最新摘要。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId "checkid1"
```
**示例 2：返回指定 Trusted Advisor 检查的最新摘要。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId @("checkid1", "checkid2")
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeTrustedAdvisorCheckSummaries](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：返回指定 Trusted Advisor 检查的最新摘要。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId "checkid1"
```
**示例 2：返回指定 Trusted Advisor 检查的最新摘要。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId @("checkid1", "checkid2")
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeTrustedAdvisorCheckSummaries](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# 将 `DescribeTrustedAdvisorChecks` 与 CLI 配合使用
以下代码示例演示如何使用 `DescribeTrustedAdvisorChecks`。
------
#### [ CLI ]
**AWS CLI**
**列出可用的 T AWS rusted Advisor 支票**
以下`describe-trusted-advisor-checks`示例列出了您 AWS 账户中可用的 Trusted Advisor 支票。这些信息包括检查名称、ID、描述、类别和元数据。请注意，为便于阅读，输出已缩短。
```
aws support describe-trusted-advisor-checks \
--language "en"
```
输出：
```
{
"checks": [
{
"id": "zXCkfM1nI3",
"name": "IAM Use",
"description": "Checks for your use of AWS Identity and Access Management (IAM). You can use IAM to create users, groups, and roles in AWS, and you can use permissions to control access to AWS resources. \n
\n
\nAlert Criteria
\nYellow: No IAM users have been created for this account.\n
\n
\nRecommended Action
\nCreate one or more IAM users and groups in your account. You can then create additional users whose permissions are limited to perform specific tasks in your AWS environment. For more information, see Getting Started. \n
\nAdditional Resources
\nWhat Is IAM?",
"category": "security",
"metadata": []
}
]
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的 [AWS Trusted Advisor](https://docs.aws.amazon.com/awssupport/latest/user/trusted-advisor.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeTrustedAdvisorChecks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/describe-trusted-advisor-checks.html)*中的。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：返回 Trusted Advisor 检查的集合。必须指定 Language 参数，该参数可以接受“en”（表示英语输出），也可以接受“ja”（表示日语输出）。**
```
Get-ASATrustedAdvisorCheck -Language "en"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeTrustedAdvisorChecks](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：返回 Trusted Advisor 检查的集合。必须指定 Language 参数，该参数可以接受“en”（表示英语输出），也可以接受“ja”（表示日语输出）。**
```
Get-ASATrustedAdvisorCheck -Language "en"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeTrustedAdvisorChecks](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# 将 `RefreshTrustedAdvisorCheck` 与 CLI 配合使用
以下代码示例演示如何使用 `RefreshTrustedAdvisorCheck`。
------
#### [ CLI ]
**AWS CLI**
**刷新 Tru AWS sted Advisor 支票**
以下`refresh-trusted-advisor-check`示例刷新了您 AWS 账户中的 Amazon S3 存储桶权限 Trusted Advisor 支票。
```
aws support refresh-trusted-advisor-check \
--check-id "Pfx0RwqBli"
```
输出：
```
{
"status": {
"checkId": "Pfx0RwqBli",
"status": "enqueued",
"millisUntilNextRefreshable": 3599992
}
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的 [AWS Trusted Advisor](https://docs.aws.amazon.com/awssupport/latest/user/trusted-advisor.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[RefreshTrustedAdvisorCheck](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/refresh-trusted-advisor-check.html)*中的。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：请求刷新指定的 Trusted Advisor 检查。**
```
Request-ASATrustedAdvisorCheckRefresh -CheckId "checkid1"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [RefreshTrustedAdvisorCheck](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：请求刷新指定的 Trusted Advisor 检查。**
```
Request-ASATrustedAdvisorCheckRefresh -CheckId "checkid1"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [RefreshTrustedAdvisorCheck](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# `ResolveCase`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `ResolveCase`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](support_example_support_Scenario_GetStartedSupportCases_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Resolve a support case by caseId.
///
/// Id for the support case.
/// The final status of the case after resolving.
public async Task ResolveCase(string caseId)
{
var response = await _amazonSupport.ResolveCaseAsync(
new ResolveCaseRequest()
{
CaseId = caseId
});
return response.FinalCaseStatus;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[ResolveCase](https://docs.aws.amazon.com/goto/DotNetSDKV3/support-2013-04-15/ResolveCase)*中的。
------
#### [ CLI ]
**AWS CLI**
**处理支持案例**
以下`resolve-case`示例解决了您 AWS 账户中的一个支持案例。
```
aws support resolve-case \
--case-id "case-12345678910-2013-c4c1d2bf33c5cf47"
```
输出：
```
{
"finalCaseStatus": "resolved",
"initialCaseStatus": "work-in-progress"
}
```
有关更多信息，请参阅《AWS Support 用户指南》**中的[案例管理](https://docs.aws.amazon.com/awssupport/latest/user/case-management.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ResolveCase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/support/resolve-case.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static void resolveSupportCase(SupportClient supportClient, String caseId) {
try {
ResolveCaseRequest caseRequest = ResolveCaseRequest.builder()
.caseId(caseId)
.build();
ResolveCaseResponse response = supportClient.resolveCase(caseRequest);
System.out.println("The status of case " + caseId + " is " + response.finalCaseStatus());
} catch (SupportException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[ResolveCase](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/ResolveCase)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import { ResolveCaseCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
const main = async () => {
try {
const response = await client.send(
new ResolveCaseCommand({
caseId: "CASE_ID",
}),
);
console.log(response.finalCaseStatus);
return response;
} catch (err) {
console.error(err);
}
};
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[ResolveCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/ResolveCaseCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun resolveSupportCase(caseIdVal: String) {
val caseRequest =
ResolveCaseRequest {
caseId = caseIdVal
}
SupportClient.fromEnvironment { region = "us-west-2" }.use { supportClient ->
val response = supportClient.resolveCase(caseRequest)
println("The status of case $caseIdVal is ${response.finalCaseStatus}")
}
}
```
+ 有关 API 的详细信息，请参阅适用[ResolveCase](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：返回指定案例的初始状态和完成用于解决该案例的调用后的当前状态。**
```
Resolve-ASACase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [ResolveCase](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：返回指定案例的初始状态和完成用于解决该案例的调用后的当前状态。**
```
Resolve-ASACase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [ResolveCase](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/support#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class SupportWrapper:
"""Encapsulates Support actions."""
def __init__(self, support_client):
"""
:param support_client: A Boto3 Support client.
"""
self.support_client = support_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
support_client = boto3.client("support")
return cls(support_client)
def resolve_case(self, case_id):
"""
Resolve a support case by its caseId.
:param case_id: The ID of the case to resolve.
:return: The final status of the case.
"""
try:
response = self.support_client.resolve_case(caseId=case_id)
final_status = response["finalCaseStatus"]
except ClientError as err:
if err.response["Error"]["Code"] == "SubscriptionRequiredException":
logger.info(
"You must have a Business, Enterprise On-Ramp, or Enterprise Support "
"plan to use the AWS Support API. \n\tPlease upgrade your subscription to run these "
"examples."
)
else:
logger.error(
"Couldn't resolve case. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return final_status
```
+ 有关 API 的详细信息，请参阅适用[ResolveCase](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/ResolveCase)于 *Python 的AWS SDK (Boto3) API 参考*。
------