文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 支援 使用 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 ]
**SDK for Java 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) 的 SDK**
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 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [AddAttachmentsToSet](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 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 詳細資訊，請參閱《*適用於 Python (Boto3) 的AWS SDK API 參考*》中的 [AddAttachmentsToSet](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/AddAttachmentsToSet)。
------
# `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 ]
**SDK for Java 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) 的 SDK**
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 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [AddCommunicationToCase](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for 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 參考 (V4)》**中的 [AddCommunicationToCase](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for 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 參考 (V5)》**中的 [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 詳細資訊，請參閱《*適用於 Python (Boto3) 的AWS SDK API 參考*》中的 [AddCommunicationToCase](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/AddCommunicationToCase)。
------
# `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 ]
**SDK for Java 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) 的 SDK**
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 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [CreateCase](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：在 AWS 支援中心建立新案例。可使用 Get-ASAService cmdlet 取得 -ServiceCode 和 -CategoryCode 參數的值。可使用 Get-ASASeverityLevel cmdlet 取得 -SeverityCode 參數的值。-IssueType 參數值可以是 "customer-service" 或 "technical"。如果成功，則會輸出 AWS 支援案例編號。預設以英文處理案例，若要使用日文，則需新增 -Language "ja" 參數。-ServiceCode、-CategoryCode、-Subject 和 -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 參考 (V4)》**中的 [CreateCase](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：在 AWS 支援中心建立新案例。可使用 Get-ASAService cmdlet 取得 -ServiceCode 和 -CategoryCode 參數的值。可使用 Get-ASASeverityLevel cmdlet 取得 -SeverityCode 參數的值。-IssueType 參數值可以是 "customer-service" 或 "technical"。如果成功，則會輸出 AWS 支援案例編號。預設以英文處理案例，若要使用日文，則需新增 -Language "ja" 參數。-ServiceCode、-CategoryCode、-Subject 和 -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 參考 (V5)》**中的 [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 詳細資訊，請參閱《*AWS SDK for Python (Boto3) API 參考*》中的 [CreateCase](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/CreateCase)。
------
# `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 ]
**SDK for Java 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) 的 SDK**
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 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [DescribeAttachment](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 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 詳細資訊，請參閱《適用於 Python (Boto3) 的 AWS SDK API 參考》**中的 [DescribeAttachment](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeAttachment)。
------
# `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 ]
**SDK for Java 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) 的 SDK**
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 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [DescribeCases](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for 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 參考 (V4)》**中的 [DescribeCases](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for 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 參考 (V5)》**中的 [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 的詳細資訊，請參閱《*適用於 Python (Boto3) 的AWS SDK API 參考*》中的 [DescribeCases](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeCases)。
------
# `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 ]
**SDK for Java 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) 的 SDK**
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 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [DescribeCommunications](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：傳回指定案例的所有通訊。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**範例 2：針對指定的案例，傳回自 2012 年 1 月 1 日 UTC 午夜以來的所有通訊。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -AfterTime "2012-01-10T00:00Z"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeCommunications](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：傳回指定案例的所有通訊。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**範例 2：針對指定的案例，傳回自 2012 年 1 月 1 日 UTC 午夜以來的所有通訊。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -AfterTime "2012-01-10T00:00Z"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [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 詳細資訊，請參閱《*適用於 Python (Boto3) 的AWS SDK API 參考*》中的 [DescribeCommunications](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeCommunications)。
------
# `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 ]
**SDK for Java 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 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [DescribeServices](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for 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 參考 (V4)》**中的 [DescribeServices](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for 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 參考 (V5)》**中的 [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 詳細資訊，請參閱《*適用於 Python (Boto3) 的AWS SDK API 參考*》中的 [DescribeServices](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeServices)。
------
# `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 ]
**SDK for Java 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) 的 SDK**
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 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [DescribeSeverityLevels](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：傳回可指派給 AWS 支援案例的嚴重性等級清單。**
```
Get-ASASeverityLevel
```
**範例 2：傳回可指派給 AWS 支援案例的嚴重性等級清單。層級名稱以日文傳回。**
```
Get-ASASeverityLevel -Language "ja"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeSeverityLevels](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：傳回可指派給 AWS 支援案例的嚴重性等級清單。**
```
Get-ASASeverityLevel
```
**範例 2：傳回可指派給 AWS 支援案例的嚴重性等級清單。層級名稱以日文傳回。**
```
Get-ASASeverityLevel -Language "ja"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [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 詳細資訊，請參閱《*適用於 Python (Boto3) 的AWS SDK API 參考*》中的 [DescribeSeverityLevels](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeSeverityLevels)。
------
# 搭配使用 `DescribeTrustedAdvisorCheckRefreshStatuses` 與 CLI
下列程式碼範例示範如何使用 `DescribeTrustedAdvisorCheckRefreshStatuses`。
------
#### [ CLI ]
**AWS CLI**
**列出 AWS Trusted 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 ]
**Tools for PowerShell V4**
**範例 1：傳回指定之檢查的重新整理請求的目前狀態。Request-ASATrustedAdvisorCheckRefresh 可用來請求重新整理檢查的狀態資訊。**
```
Get-ASATrustedAdvisorCheckRefreshStatus -CheckId @("checkid1", "checkid2")
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeTrustedAdvisorCheckRefreshStatuses](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：傳回指定之檢查的重新整理請求的目前狀態。Request-ASATrustedAdvisorCheckRefresh 可用來請求重新整理檢查的狀態資訊。**
```
Get-ASATrustedAdvisorCheckRefreshStatus -CheckId @("checkid1", "checkid2")
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeTrustedAdvisorCheckRefreshStatuses](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeTrustedAdvisorCheckResult` 與 CLI
下列程式碼範例示範如何使用 `DescribeTrustedAdvisorCheckResult`。
------
#### [ CLI ]
**AWS CLI**
**列出 an AWS Trusted 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 ]
**Tools for PowerShell V4**
**範例 1：傳回 Trusted Advisor 檢查的結果。可使用 Get-ASATrustedAdvisorChecks 取得可用的 Trusted Advisor 檢查清單。輸出是檢查的整體狀態、上次執行檢查的時間戳記，以及特定檢查的唯一 checkid。若要以日文顯示輸出結果，可新增 -Language "ja" 參數。**
```
Get-ASATrustedAdvisorCheckResult -CheckId "checkid1"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeTrustedAdvisorCheckResult](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：傳回 Trusted Advisor 檢查的結果。可使用 Get-ASATrustedAdvisorChecks 取得可用的 Trusted Advisor 檢查清單。輸出是檢查的整體狀態、上次執行檢查的時間戳記，以及特定檢查的唯一 checkid。若要以日文顯示輸出結果，可新增 -Language "ja" 參數。**
```
Get-ASATrustedAdvisorCheckResult -CheckId "checkid1"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeTrustedAdvisorCheckResult](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeTrustedAdvisorCheckSummaries` 與 CLI
下列程式碼範例示範如何使用 `DescribeTrustedAdvisorCheckSummaries`。
------
#### [ CLI ]
**AWS CLI**
**列出 AWS Trusted 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 ]
**Tools for PowerShell V4**
**範例 1：傳回指定之 Trusted Advisor 檢查的最新摘要。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId "checkid1"
```
**範例 2：傳回指定之 Trusted Advisor 檢查的最新摘要。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId @("checkid1", "checkid2")
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeTrustedAdvisorCheckSummaries](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：傳回指定之 Trusted Advisor 檢查的最新摘要。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId "checkid1"
```
**範例 2：傳回指定之 Trusted Advisor 檢查的最新摘要。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId @("checkid1", "checkid2")
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeTrustedAdvisorCheckSummaries](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeTrustedAdvisorChecks` 與 CLI
下列程式碼範例示範如何使用 `DescribeTrustedAdvisorChecks`。
------
#### [ CLI ]
**AWS CLI**
**列出可用的 AWS Trusted 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 ]
**Tools for PowerShell V4**
**範例 1：傳回 Trusted Advisor 檢查的集合。您必須指定語言參數，其可接受英文輸出 "en"，或日文輸出 "ja"。**
```
Get-ASATrustedAdvisorCheck -Language "en"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeTrustedAdvisorChecks](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：傳回 Trusted Advisor 檢查的集合。您必須指定語言參數，其可接受英文輸出 "en"，或日文輸出 "ja"。**
```
Get-ASATrustedAdvisorCheck -Language "en"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeTrustedAdvisorChecks](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `RefreshTrustedAdvisorCheck` 與 CLI
下列程式碼範例示範如何使用 `RefreshTrustedAdvisorCheck`。
------
#### [ CLI ]
**AWS CLI**
**重新整理 an AWS Trusted 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 ]
**Tools for PowerShell V4**
**範例 1：請求重新整理指定的 Trusted Advisor 檢查。**
```
Request-ASATrustedAdvisorCheckRefresh -CheckId "checkid1"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [RefreshTrustedAdvisorCheck](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：請求重新整理指定的 Trusted Advisor 檢查。**
```
Request-ASATrustedAdvisorCheckRefresh -CheckId "checkid1"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [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 ]
**SDK for Java 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) 的 SDK**
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 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [ResolveCase](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：傳回指定案例的初始狀態，以及呼叫解決案例完成後的目前狀態。**
```
Resolve-ASACase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ResolveCase](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：傳回指定案例的初始狀態，以及呼叫解決案例完成後的目前狀態。**
```
Resolve-ASACase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [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 詳細資訊，請參閱《*適用於 Python (Boto3) 的AWS SDK API 參考*》中的 [ResolveCase](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/ResolveCase)。
------