このセクションでは、Network Flow Monitor のオペレーションで、AWS Command Line Interface を使用する例を示します。
開始する前に、必ずログインして、ネットワークフローのモニタリングに使用するスコープを提供する AWS アカウントで AWS CLI を使用してください。Network Flow Monitor での API アクションの使用については、「Network Flow Monitor API リファレンスガイド」を参照してください。
トピック
モニターを作成する
AWS CLI を使用してモニターを作成するには、create-monitor コマンドを使用します。次の例では、指定したアカウントに demo という名前のモニターを作成します。
aws networkflowmonitor create-monitor \ --monitor-name demo \ --local-resources type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889" \ --scope-arn arn:aws:networkflowmonitor:us-east-1:111122223333:scope/sample-aaaa-bbbb-cccc-44556677889
出力:
{
"monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/demo",
"monitorName": "demo",
"monitorStatus": "ACTIVE",
"tags": {}
}詳細については、「Network Flow Monitor でモニターを作成する」を参照してください。
モニターの詳細の表示
AWS CLI を使用してモニターに関する情報を表示するには、get-monitor コマンドを使用します。
aws networkflowmonitor get-monitor --monitor-name "TestMonitor"
{
"ClientLocationType": "city",
"CreatedAt": "2022-09-22T19:27:47Z",
"ModifiedAt": "2022-09-22T19:28:30Z",
"MonitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/TestMonitor",
"MonitorName": "TestMonitor",
"ProcessingStatus": "OK",
"ProcessingStatusInfo": "The monitor is actively processing data",
"Resources": [
"arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889"
],
"MaxCityNetworksToMonitor": 10000,
"Status": "ACTIVE"
}スコープを作成する
次の create-scope の例では、Network Flow Monitor によってネットワークトラフィックメトリクスが生成される対象となるリソースのセットであるスコープを作成します。
aws networkflowmonitor create-scope \ --targets '[{"targetIdentifier":{"targetId":{"accountId":"111122223333"},"targetType":"ACCOUNT"},"region":"us-east-1"}]'
出力:
{
"scopeId": "sample-aaaa-bbbb-cccc-11112222333",
"status": "IN_PROGRESS",
"tags": {}
}
詳細については、「Network Flow Monitor のコンポーネントと機能」を参照してください。
モニタの削除
次の delete-monitor の例では、アカウントから Demo という名前のモニターを削除します。
aws networkflowmonitor delete-monitor \ --monitor-name Demo
このコマンドでは何も出力されません。
詳細については、「Network Flow Monitor でモニターを削除する」を参照してください。
スコープを削除する
次の delete-scope の例では、指定したスコープを削除します。
aws networkflowmonitor delete-scope \ --scope-id sample-aaaa-bbbb-cccc-44556677889
このコマンドでは何も出力されません。
詳細については、「Network Flow Monitor のコンポーネントと機能」を参照してください。
モニターに関する情報を取得する
次の get-monitor の例では、指定されたアカウントの demo という名前のモニターに関する情報が表示されます。
aws networkflowmonitor get-monitor \ --monitor-name Demo
出力:
{ "monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE", "localResources": [ { "type": "AWS::EC2::VPC", "identifier": "arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889" } ], "remoteResources": [], "createdAt": "2024-12-09T12:21:51.616000-06:00", "modifiedAt": "2024-12-09T12:21:55.412000-06:00", "tags": {} }
詳細については、「Network Flow Monitor のコンポーネントと機能」を参照してください。
特定のクエリのデータを取得する
以下のセクションでは、クエリステータスを取得するための CLI コマンドの例を示します。
get-query-results-workload-insights-top-contributors-data
get-query-results-workload-insights-top-contributors-data の例では、指定したクエリのデータを返します。
aws networkflowmonitor get-query-results-workload-insights-top-contributors-data \ --scope-id sample-aaaa-bbbb-cccc-11112222333 \ --query-id sample-dddd-eeee-ffff-44556677889
出力:
{ "datapoints": [ { "timestamps": [ "2024-12-09T19:00:00+00:00", "2024-12-09T19:05:00+00:00", "2024-12-09T19:10:00+00:00" ], "values": [ 259943.0, 194856.0, 216432.0 ], "label": "use1-az6" } ], "unit": "Bytes" }
get-query-results-workload-insights-top-contributors
次の get-query-results-workload-insights-top-contributors の例では、指定したクエリのデータを返します。
aws networkflowmonitor get-query-results-workload-insights-top-contributors \ --scope-id sample-aaaa-bbbb-cccc-11112222333 \ --query-id sample-dddd-eeee-ffff-44556677889
出力:
{ "topContributors": [ { "accountId": "111122223333", "localSubnetId": "subnet-SAMPLE1111", "localAz": "use1-az6", "localVpcId": "vpc-SAMPLE2222", "localRegion": "us-east-1", "remoteIdentifier": "", "value": 333333, "localSubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-2222444455556666", "localVpcArn": "arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889" } ] }
get-query-status-monitor-top-contributors
次の get-query-status-monitor-top-contributors の例では、指定したアカウントのクエリの現在のステータスを表示します。
aws networkflowmonitor get-query-status-monitor-top-contributors \ --monitor-name Demo \ --query-id sample-dddd-eeee-ffff-44556677889
出力:
{ "status": "SUCCEEDED" }
get-query-status-workload-insights-top-contributors-data
次の get-query-status-workload-insights-top-contributors-data の例では、指定したアカウントのクエリの現在のステータスを表示します。
aws networkflowmonitor get-query-status-workload-insights-top-contributors-data \ --scope-id sample-aaaa-bbbb-cccc-11112222333 \ --query-id sample-dddd-eeee-ffff-44556677889
出力:
{ "status": "SUCCEEDED" }
get-query-results-workload-insights-top-contributors
次の get-query-results-workload-insights-top-contributors の例では、指定したアカウントのクエリの現在のステータスを表示します。
aws networkflowmonitor get-query-status-workload-insights-top-contributors \ --scope-id sample-aaaa-bbbb-cccc-11112222333 \ --query-id sample-dddd-eeee-ffff-44556677889
出力:
{ "status": "SUCCEEDED" }
詳細については、「ワークロードインサイトを使用してネットワークフローを評価する」を参照してください。
スコープ情報を参照する
次の get-scope の例では、ステータス、タグ、名前、ターゲットの詳細など、スコープに関する情報を表示します。
aws networkflowmonitor get-scope \ --scope-id sample-aaaa-bbbb-cccc-11112222333
出力:
{ "scopeId": "sample-aaaa-bbbb-cccc-11112222333", "status": "SUCCEEDED", "scopeArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:scope/sample-aaaa-bbbb-cccc-11112222333", "targets": [ { "targetIdentifier": { "targetId": { "accountId": "111122223333" }, "targetType": "ACCOUNT" }, "region": "us-east-1" } ], "tags": {} }
詳細については、「Network Flow Monitor のコンポーネントと機能」を参照してください。
アカウントのモニターのリストを参照する
次の list-monitors の例では、指定したアカウントのすべてのモニターを返します。
aws networkflowmonitor list-monitors
出力:
{ "monitors": [ { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE" } ] }
詳細については、「Network Flow Monitor のコンポーネントと機能」を参照してください。
アカウントのスコープのリストを参照する
次の list-scopes の例では、指定したアカウントのすべてのスコープを一覧表示します。
aws networkflowmonitor list-scopes
出力:
{ "scopes": [ { "scopeId": "sample-aaaa-bbbb-cccc-11112222333", "status": "SUCCEEDED", "scopeArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:scope/sample-aaaa-bbbb-cccc-11112222333" } ] }
詳細については、「Network Flow Monitor のコンポーネントと機能」を参照してください。
モニターのタグのリストを表示する
次の list-tags-for-resource の例では、指定したリソースに関連付けられているすべてのタグを返します。
aws networkflowmonitor list-tags-for-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo
出力:
{ "tags": { "Value": "Production", "Key": "stack" } }
詳細については、「Amazon CloudWatch リソースにタグを付ける」を参照してください。
クエリの開始と停止
以下のセクションでは、Network Flow Monitor でクエリを開始および停止するための CLI コマンドの例を示します。
start-query-monitor-top-contributors
次の start-query-monitor-top-contributors の例では、上位寄与要因を取得するための queryId を返すクエリを開始します。
aws networkflowmonitor start-query-monitor-top-contributors \ --monitor-name Demo \ --start-time 2024-12-09T19:00:00Z \ --end-time 2024-12-09T19:15:00Z \ --metric-name DATA_TRANSFERRED \ --destination-category UNCLASSIFIED
出力:
{ "queryId": "sample-dddd-eeee-ffff-44556677889" }
詳細については、「ワークロードインサイトを使用してネットワークフローを評価する」を参照してください。
start-query-workload-insights-top-contributors-data
次の start-query-workload-insights-top-contributors-data の例では、上位寄与要因を取得するための queryId を返すクエリを開始します。
aws networkflowmonitor start-query-workload-insights-top-contributors-data \ --scope-id sample-aaaa-bbbb-cccc-11112222333 \ --start-time 2024-12-09T19:00:00Z \ --end-time 2024-12-09T19:15:00Z \ --metric-name DATA_TRANSFERRED \ --destination-category UNCLASSIFIED
出力:
{ "queryId": "sample-dddd-eeee-ffff-44556677889" }
詳細については、「ワークロードインサイトを使用してネットワークフローを評価する」を参照してください。
start-query-workload-insights-top-contributors
次の start-query-workload-insights-top-contributors の例では、上位寄与要因を取得するための queryId を返すクエリを開始します。
aws networkflowmonitor start-query-workload-insights-top-contributors \ --scope-id sample-aaaa-bbbb-cccc-11112222333 \ --start-time 2024-12-09T19:00:00Z \ --end-time 2024-12-09T19:15:00Z \ --metric-name DATA_TRANSFERRED \ --destination-category UNCLASSIFIED
出力:
{ "queryId": "sample-dddd-eeee-ffff-44556677889" }
詳細については、「ワークロードインサイトを使用してネットワークフローを評価する」を参照してください。
stop-query-monitor-top-contributors
次の stop-query-monitor-top-contributors の例では、指定したアカウントのクエリを停止します。
aws networkflowmonitor stop-query-monitor-top-contributors \ --monitor-name Demo \ --query-id sample-dddd-eeee-ffff-44556677889
このコマンドでは何も出力されません。
詳細については、「ワークロードインサイトを使用してネットワークフローを評価する」を参照してください。
stop-query-workload-insights-top-contributors-data
次の stop-query-workload-insights-top-contributors-data では、指定したアカウントのクエリを停止します。
aws networkflowmonitor stop-query-workload-insights-top-contributors-data \ --scope-id sample-aaaa-bbbb-cccc-11112222333 \ --query-id sample-dddd-eeee-ffff-44556677889
このコマンドでは何も出力されません。
詳細については、「ワークロードインサイトを使用してネットワークフローを評価する」を参照してください。
stop-query-workload-insights-top-contributors
次の stop-query-workload-insights-top-contributors の例では、指定したアカウントのクエリを停止します。
aws networkflowmonitor stop-query-workload-insights-top-contributors \ --scope-id sample-aaaa-bbbb-cccc-11112222333 \ --query-id sample-dddd-eeee-ffff-44556677889
このコマンドでは何も出力されません。
詳細については、「ワークロードインサイトを使用してネットワークフローを評価する」を参照してください。
モニターにタグを付ける
次の tag-resource では、指定したアカウントのモニターにタグを追加します。
aws networkflowmonitor tag-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo \ --tags Key=stack,Value=Production
このコマンドでは何も出力されません。
詳細については、「Amazon CloudWatch リソースにタグを付ける」を参照してください。
モニターからタグを削除する
次の untag-resource の例では、指定したアカウントのモニターへのタグを削除します。
aws networkflowmonitor untag-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo \ --tag-keys stack
このコマンドでは何も出力されません。
詳細については、「Amazon CloudWatch リソースにタグを付ける」を参照してください。
既存のモニターを更新する
次の update-monitor の例では、指定したアカウントの「Demo」という名前のモニターを更新します。
aws networkflowmonitor update-monitor \ --monitor-name Demo \ --local-resources-to-add type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889"
出力:
{ "monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE", "tags": { "Value": "Production", "Key": "stack" } }
詳細については、「Network Flow Monitor のコンポーネントと機能」を参照してください。
