• 2026 年 4 月 30 日之後， AWS Systems Manager CloudWatch Dashboard 將不再可用。客戶可以繼續使用 Amazon CloudWatch 主控台來檢視、建立和管理其 Amazon CloudWatch 儀表板，就像現在一樣。如需詳細資訊，請參閱 [Amazon CloudWatch Dashboard 文件](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# `DescribeParameters` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DescribeParameters`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：列出所有參數**
下列`describe-parameters`範例列出目前 AWS 帳戶和區域中的所有參數。
```
aws ssm describe-parameters
```
輸出：
```
{
"Parameters": [
{
"Name": "MySecureStringParameter",
"Type": "SecureString",
"KeyId": "alias/aws/ssm",
"LastModifiedDate": 1582155479.205,
"LastModifiedUser": "arn:aws:sts::111222333444:assumed-role/Admin/Richard-Roe-Managed",
"Description": "This is a SecureString parameter",
"Version": 2,
"Tier": "Advanced",
"Policies": [
{
"PolicyText": "{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-07-07T22:30:00Z\"}}",
"PolicyType": "Expiration",
"PolicyStatus": "Pending"
},
{
"PolicyText": "{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"12\",\"Unit\":\"Hours\"}}",
"PolicyType": "ExpirationNotification",
"PolicyStatus": "Pending"
}
]
},
{
"Name": "MyStringListParameter",
"Type": "StringList",
"LastModifiedDate": 1582154764.222,
"LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major",
"Description": "This is a StringList parameter",
"Version": 1,
"Tier": "Standard",
"Policies": []
},
{
"Name": "MyStringParameter",
"Type": "String",
"LastModifiedDate": 1582154711.976,
"LastModifiedUser": "arn:aws:iam::111222333444:user/Alejandro-Rosalez",
"Description": "This is a String parameter",
"Version": 1,
"Tier": "Standard",
"Policies": []
},
{
"Name": "latestAmi",
"Type": "String",
"LastModifiedDate": 1580862415.521,
"LastModifiedUser": "arn:aws:sts::111222333444:assumed-role/lambda-ssm-role/Automation-UpdateSSM-Param",
"Version": 3,
"Tier": "Standard",
"Policies": []
}
]
}
```
**範例 2：列出符合特定中繼資料的所有參數**
此 `describe-parameters` 範例列出了符合篩選條件的所有參數。
aws ssm describe-parameters --filters "Key=Type,Values=StringList"
輸出：
```
{
"Parameters": [
{
"Name": "MyStringListParameter",
"Type": "StringList",
"LastModifiedDate": 1582154764.222,
"LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major",
"Description": "This is a StringList parameter",
"Version": 1,
"Tier": "Standard",
"Policies": []
}
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Searching for Systems Manager Parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeParameter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-parameters.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.ssm.SsmClient;
import software.amazon.awssdk.services.ssm.model.GetParameterRequest;
import software.amazon.awssdk.services.ssm.model.GetParameterResponse;
import software.amazon.awssdk.services.ssm.model.SsmException;
/**
* 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
*/
public class GetParameter {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
paraName - The name of the parameter.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String paraName = args[0];
Region region = Region.US_EAST_1;
SsmClient ssmClient = SsmClient.builder()
.region(region)
.build();
getParaValue(ssmClient, paraName);
ssmClient.close();
}
public static void getParaValue(SsmClient ssmClient, String paraName) {
try {
GetParameterRequest parameterRequest = GetParameterRequest.builder()
.name(paraName)
.build();
GetParameterResponse parameterResponse = ssmClient.getParameter(parameterRequest);
System.out.println("The parameter value is " + parameterResponse.parameter().value());
} catch (SsmException e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeParameters](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeParameters)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了所有參數。**
```
Get-SSMParameterList
```
**輸出：**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:58:23 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeParameters](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了所有參數。**
```
Get-SSMParameterList
```
**輸出：**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:58:23 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeParameters](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/ssm#code-examples)中設定和執行。
```
async fn show_parameters(client: &Client) -> Result<(), Error> {
let resp = client.describe_parameters().send().await?;
for param in resp.parameters() {
println!(" {}", param.name().unwrap_or_default());
}
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Rust 的AWS SDK API 參考》**中的 [DescribeParameters](https://docs.rs/aws-sdk-ssm/latest/aws_sdk_ssm/client/struct.Client.html#method.describe_parameters)。
------
如需 AWS SDK 開發人員指南和程式碼範例的完整清單，請參閱 [搭配 AWS SDK 使用此服務](sdk-general-information-section.md)。此主題也包含有關入門的資訊和舊版 SDK 的詳細資訊。