# mon-describe-alarms
## 説明
指定したアラームに関する情報を取得します。アラーム名を指定しないと、すべてのアラームの情報が返されます。アラーム名のプレフィックス、アラームの状態、またはアクションのプレフィックスだけでも、アラームを特定することができます。
## 構文
****mon-describe-alarms** [AlarmNames [*AlarmNames* ...]] [--action-prefix *value*] [--alarm-name-prefix *value*] [--state-value *value*] [Common Options]**
## オプション
| 名前 | 説明 |
| --- | --- |
| `AlarmNames` `AlarmNames` | アラームの名前。この値は `--alarm-name` を使用して設定することもできます。このオプションは複数回指定できます。 タイプ: 引数 有効値: 既存のアラーム名。それ以外では応答は返されません。 デフォルト: N/A。デフォルトではすべてのアラームが表示されます。 必須: いいえ |
| `--action-prefix` `VALUE` | アクション名のプレフィックス。 タイプ: 引数 有効値: 既存のアクション名のプレフィックス (ARN 形式)。 デフォルト: N/A。デフォルトでは最初のアクションが表示されます。 必須: いいえ |
| `--alarm-name-prefix` `VALUE` | アラーム名のプレフィックス。 タイプ: 引数 有効値: 既存のアラーム名のプレフィックス。 デフォルト: N/A 必須: いいえ |
| `--state-value` `VALUE` | アラームの状態。 タイプ: 列挙法 有効値: OK、ALARM、または INSUFFICIENT\$1DATA デフォルト: すべてのアラーム状態 必須: いいえ |
## 一般的なオプション
| 名前 | 説明 |
| --- | --- |
| `--aws-credential-file` `VALUE` | AWS 認証情報を含むファイルの場所。環境変数 `AWS_CREDENTIAL_FILE` を使用して、この値を設定できます。環境変数またはパスで指定する認証情報ファイルの場所は、実在のものでなければなりません。存在しない場合、リクエストは失敗します。すべての CloudWatch リクエストに、アクセスキー ID とシークレットアクセスキーを使用して署名する必要があります。 タイプ: 文字列 有効な値: アクセスキー ID とシークレットアクセスキーを含むファイルへの有効なパス。 デフォルト: 設定されている場合は、環境変数 `AWS_CREDENTIAL_FILE` を使用します。 |
| `-C, --ec2-cert-file-path` `VALUE` | リクエストに署名するための EC2 証明書ファイルの場所。環境変数 `EC2_CERT` を使用して、この値を指定できます。 タイプ: 文字列 有効な値: Amazon EC2 または AWS Identity and Access Management によって提供される PEM ファイルへの有効なファイルパス。 デフォルト: 設定されている場合は、環境変数 `EC2_CERT` を使用します。 |
| `--connection-timeout` `VALUE` | 接続タイムアウト値 (秒)。 タイプ: 整数 有効な値: 任意の正の整数。 デフォルト: 30 |
| `--delimiter` `VALUE` | 長い結果を区切って表示する際に使用する区切り記号。 タイプ: 文字列 有効な値: 任意の文字列。 デフォルト: コンマ（,） |
| `--headers` `` | 表形式の結果または区切られた結果を表示する場合に、列ヘッダーを含めます。XML 形式の結果を表示する場合に、サービスリクエストから HTTP ヘッダーを返します (該当する場合)。 タイプ: フラグ 有効な値: 存在する場合は、ヘッダーを表示します。 デフォルト: `--headers` オプションは、デフォルトでオフになっています。 |
| `-I, --access-key-id` `VALUE` | リクエストの署名で、シークレットキーと組み合わせて使用するアクセスキー ID。これは、––secret-key と組み合わせて使用する必要があります。単独で使用すると、このオプションは無視されます。CloudWatch へのすべてのリクエストには署名が必要です。署名がないと、リクエストは拒否されます。 タイプ: 文字列 有効な値: 有効なアクセスキー ID。 デフォルト: なし |
| `-K, --ec2-private-key-file-path` `VALUE` | リクエストに署名するために使用されるプライベートキー。パブリック/プライベートキーを使用すると、CLI が SOAP を使用します。リクエストは、パブリック証明書とプライベートキーを使用して署名されます。このパラメータは、`EC2_CERT` と組み合わせて使用する必要があります。単独で使用すると、この値は無視されます。設定されている場合は、環境変数の値 `EC2_PRIVATE_KEY` が使用され、このオプションは指定されません。環境変数 `AWS_CREDENTIAL_FILE` が設定されている場合、このオプションは無視されます。設定されていない場合は、`--aws-credentials-file` が使用されます。CloudWatch へのすべてのリクエストには署名が必要です。署名がないと、リクエストは拒否されます。 タイプ: 文字列 有効な値: 有効な ASN.1 プライベートキーへのパス。 デフォルト: なし |
| `--region` `VALUE` | リクエストの送信先のリージョン。環境変数 `EC2_REGION` を使用して、この値を指定できます。このリージョンは、CloudWatch の呼び出しに使用する URL の作成で使用され、Amazon Web Services (AWS) の有効なリージョンである必要があります。 タイプ: 文字列 有効な値: 任意の AWS リージョン (例: us-east-1) デフォルト: 環境変数 `EC2_REGION` が設定されている場合を除き、us-east-1 |
| `S, --secret-key` `VALUE` | リクエストの署名で、アクセスキー ID と組み合わせて使用するシークレットアクセスキー。このパラメータは、`--access-key-id` と組み合わせて使用する必要があります。単独で使用すると、このオプションは無視されます。 タイプ: 文字列 有効な値: アクセスキー ID デフォルト: なし |
| `--show-empty-fields` `` | プレースホルダーとして (nil) を使用して空のフィールドを表示し、このデータがリクエストされなかったことを示します。 タイプ: フラグ 有効な値: なし デフォルト: デフォルトでは、空のフィールドは表示されません。 |
| `--show-request` `` | CLI が AWS の呼び出しに使用する URL を表示します。 タイプ: フラグ 有効な値: なし デフォルト: false |
| `--show-table, --show-long, --show-xml, --quiet` `` | 結果の表示形式として、表形式、区切り形式 (長い)、XML 形式、または出力なし (非表示) を指定します。`--show-table` は、固定列幅のフォームにデータのサブネットを表示します。`--show-long` は、返されたすべての値を文字で区切って表示します。`--show-xml` は、サービスから返されたデータをそのままの状態で表示します。`--quiet` は、すべての標準出力を非表示にします。すべてのオプションは相互に排他的で、優先度は、`--show-table`、`--show-long`、`--show-xml`、`--quiet` の順になります。 タイプ: フラグ 有効な値: なし デフォルト: `--show-table` |
| `-U, --url` `VALUE` | CloudWatch への接続に使用する URL。環境変数 `AWS_CLOUDWATCH_URL` を使用して、この値を設定できます。この値は有効な URL を作成するために `--region` と組み合わせて使用されます。このオプションは、サービス呼び出しの URL をオーバーライドします。 タイプ: 文字列 有効な値:有効な HTTP または HTTPS URL。 デフォルト: 設定されている場合は、`AWS_CLOUDWATCH_URL` で指定した値を使用します。 |
## Output
このコマンドで、以下の値を含む表が返されます。
+ ALARM – アラーム名。
+ DESCRIPTION – アラームの説明。この列は ––show-long ビューにのみ表示されます。
+ STATE – アラームの状態。
+ STATE\$1REASON – 状態の理由 (人が読み取り可能な記述)。この列は ––show-long ビューにのみ表示されます。
+ STATE\$1REASON\$1DATA – 状態の理由 (コンピュータ向けの JSON 形式の記述)。この列は ––show-long ビューにのみ表示されます。
+ ENABLED – アクションを有効または無効にします。この列は ––show-long ビューにのみ表示されます。
+ OK\$1ACTIONS – OK のステータスで実行するアクション。この列は ––show-long ビューにのみ表示されます。
+ ALARM\$1ACTIONS – ALARM のステータスで実行するアクション。
+ INSUFFICIENT\$1DATA\$1ACTIONS – INSUFFICIENT\$1DATA のステータスで実行するアクション。この列は ––show-long ビューにのみ表示されます。
+ NAMESPACE – メトリクスの名前空間。
+ METRIC\$1NAME – メトリクスの名前。
+ DIMENSIONS – メトリクスディメンション。この列は ––show-long ビューにのみ表示されます。
+ PERIOD – 期間。
+ STATISTIC – 統計 (Average、Minimum、Maximum、Sum、SampleCount)。
+ EXTENDEDSTATISTIC – パーセンタイル統計。
+ UNIT – 単位。この列は ––show-long ビューにのみ表示されます。
+ EVAL\$1PERIODS – メトリクスを評価する期間の数。
+ COMPARISON – 比較演算子。
+ THRESHOLD – しきい値。
Amazon CloudWatch CLI は、stderr でエラーを表示します。
## 例
### リクエスト例
この例では、名前が my-alarm で始まるアラームをすべて記述しています。
```
mon-describe-alarms --alarm-name-prefix my-alarm --headers
```
このコマンドの出力例は次のとおりです。
```
ALARM STATE ALARM_ACTIONS NAMESPACE METRIC_NAME PERIOD STATISTIC EVAL_PERIODS COMPARISON THRESHOLD
my-alarm1 OK arn:aws:sns:.. AWS/EC2 CPUUtilization 60 Average 3 GreaterThanThreshold 100.0
my-alarm2 OK arn:aws:sns:.. AWS/EC2 CPUUtilization 60 Average 5
GreaterThanThreshold 80o.0
```
## 関連トピック
### ダウンロード
+ [コマンドラインインターフェイスをセットアップする](SetupCLI.md)
### 関連アクション
+ [DescribeAlarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html)
### 関連コマンド
+ [mon-describe-alarm-history](cli-mon-describe-alarm-history.md)
+ [mon-describe-alarms-for-metric](cli-mon-describe-alarms-for-metric.md)