mon-set-alarm-state

説明

指定したアラームのアラーム状態を一時的に変更します。次の期間では、アラームは本来の状態に設定されます。

構文

mon-set-alarm-state AlarmName --state-reason value --state-value value [--state-reason-data value] [Common Options]

オプション

名前	説明
AlarmName	アラームの名前。この値は --alarm-name を使用して設定することもできます。 タイプ: 引数 有効値: UTF-8 文字列。 デフォルト: N/A 必須: はい
--state-reason VALUE	アラームがこの状態に設定された理由 (人間が判読可能な形式)。 型: 文字列 有効値: 1 から 1023 文字の UTF-8 文字列 デフォルト: N/A 必須: はい
--state-reason-data VALUE	アラームがこの状態に設定された理由。このデータはマシンで読み取り可能な JSON 用です。 型: 文字列 有効値: マシンで読み取り可能な 1 から 4000 文字の有効な JSON 文字列 デフォルト: N/A 必須：いいえ
--state-value VALUE	アラームを設定する状態。 タイプ: 列挙法 有効値: ALARM、OK、または INSUFFICIENT_DATA デフォルト: N/A 必須: はい

一般的なオプション

名前	説明
--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 で指定した値を使用します。

出力

このコマンドでは、アラームの状態を一時的に変更し、リクエストが正常に行われた場合は OK-Set alarm state value を表示します。

Amazon CloudWatch CLI は、stderr でエラーを表示します。

例

リクエストの例

この例では、my-alarm というアラームの状態を OK に設定しています。

mon-set-alarm-state --alarm-name my-alarm --state OK

関連トピック

ダウンロード

• コマンドラインインターフェイスをセットアップする

関連アクション

• SetAlarmState

関連コマンド

• mon-describe-alarms