Beispiele für die Verwendung von der AWS CLI mit Network Flow Monitor - AWS Command Line Interface
Aktionen

Beispiele für die Verwendung von der AWS CLI mit Network Flow Monitor

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit Network Flow Monitor nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie eine Anleitung zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie create-monitor verwendet wird.

AWS CLI

So erstellen Sie einen Monitor

Im folgenden Beispiel für create-monitor wird ein Monitor mit dem Namen demo im angegebenen Konto erstellt.

aws networkflowmonitor create-monitor \
    --monitor-name demo \
    --local-resources type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0"  \
    --scope-arn arn:aws:networkflowmonitor:us-east-1:123456789012:scope/e21cda79-30a0-4c12-9299-d8629d76d8cf

Ausgabe:

{
    "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/demo",
    "monitorName": "demo",
    "monitorStatus": "ACTIVE",
    "tags": {}
}

Weitere Informationen finden Sie unter Erstellen eines Monitors in Network Flow Monitor im Benutzerhandbuch zu Amazon CloudWatch.

  • Weitere Details zur API finden Sie unter CreateMonitor in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-scope verwendet wird.

AWS CLI

So erstellen Sie einen Bereich

Im folgenden Beispiel für create-scope wird ein Bereich mit einer Reihe von Ressourcen erstellt, für die Network Flow Monitor Metriken zum Netzwerkverkehr generiert.

aws networkflowmonitor create-scope \
    --targets '[{"targetIdentifier":{"targetId":{"accountId":"123456789012"},"targetType":"ACCOUNT"},"region":"us-east-1"}]'

Ausgabe:

{
    "scopeId": "97626f8d-8a21-4b5d-813a-1a0962dd4615",
    "status": "IN_PROGRESS",
    "tags": {}
}

Weitere Informationen finden Sie unter Komponenten und Features von Network Flow Monitor im Benutzerhandbuch zu Amazon CloudWatch.

  • Weitere Details zur API finden Sie unter CreateScope in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-monitor verwendet wird.

AWS CLI

So löschen Sie einen Monitor

Im folgenden Beispiel für delete-monitor wird ein Monitor mit dem Namen demo im angegebenen Konto gelöscht.

aws networkflowmonitor delete-monitor \
    --monitor-name demo

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Löschen eines Monitors in Network Flow Monitor im Benutzerhandbuch zu Amazon CloudWatch.

  • Weitere Details zur API finden Sie unter DeleteMonitor in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-scope verwendet wird.

AWS CLI

So löschen Sie einen Bereich

Im folgenden Beispiel für delete-scope wird der angegebene Bereich gelöscht.

aws networkflowmonitor delete-scope \
    --scope-id fdc20616-6bb4-4242-a24e-a748e65ca7ac

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Komponenten und Features von Network Flow Monitor im Benutzerhandbuch zu Amazon CloudWatch.

  • Weitere Details zur API finden Sie unter DeleteScope in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-monitor verwendet wird.

AWS CLI

So rufen Sie Informationen zu einem Monitor ab

Im folgenden Beispiel für get-monitor werden Informationen zum Monitor demo im angegebenen Konto angezeigt.

aws networkflowmonitor get-monitor \
    --monitor-name Demo

Ausgabe:

{
    "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo",
    "monitorName": "Demo",
    "monitorStatus": "ACTIVE",
    "localResources": [
        {
            "type": "AWS::EC2::VPC",
            "identifier": "arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0"
        }
    ],
    "remoteResources": [],
    "createdAt": "2024-12-09T12:21:51.616000-06:00",
    "modifiedAt": "2024-12-09T12:21:55.412000-06:00",
    "tags": {}
}

Weitere Informationen finden Sie unter Komponenten und Features von Network Flow Monitor im Benutzerhandbuch zu Amazon CloudWatch.

  • Weitere Details zur API finden Sie unter GetMonitor in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-query-results-workload-insights-top-contributors-data verwendet wird.

AWS CLI

So rufen Sie die wichtigsten Contributor-Daten für Workload-Einblicke ab

Im folgenden Beispiel für get-query-results-workload-insights-top-contributors-data werden die Daten für die angegebene Abfrage zurückgegeben.

aws networkflowmonitor get-query-results-workload-insights-top-contributors-data \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id cc4f4ab3-3103-33b8-80ff-d6597a0c6cea

Ausgabe:

{
    "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"
}

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie get-query-results-workload-insights-top-contributors verwendet wird.

AWS CLI

So rufen Sie die wichtigsten Contributors für Workload-Einblicke ab

Im folgenden Beispiel für get-query-results-workload-insights-top-contributors werden die Daten für die angegebene Abfrage zurückgegeben.

aws networkflowmonitor get-query-results-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id 1fc423d3-b144-37a6-80e6-e2c7d26eea0c

Ausgabe:

{
    "topContributors": [
        {
            "accountId": "123456789012",
            "localSubnetId": "subnet-0a5b30fb95dca2c14",
            "localAz": "use1-az6",
            "localVpcId": "vpc-03ea55eeda25adbb0",
            "localRegion": "us-east-1",
            "remoteIdentifier": "",
            "value": 908443,
            "localSubnetArn": "arn:aws:ec2:us-east-1:123456789012:subnet/subnet-0a5b30fb95dca2c14",
            "localVpcArn": "arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0"
        }
    ]
}

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie get-query-status-monitor-top-contributors verwendet wird.

AWS CLI

So rufen Sie den Status der Abfrage ab

Im folgenden Beispiel für get-query-status-monitor-top-contributors wird der aktuelle Status der Abfrage im angegebenen Konto angezeigt.

aws networkflowmonitor get-query-status-monitor-top-contributors \
    --monitor-name Demo \
    --query-id 5398eabd-bc40-3f5f-aba3-bcb639d3c7ca

Ausgabe:

{
    "status": "SUCCEEDED"
}

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie get-query-status-workload-insights-top-contributors-data verwendet wird.

AWS CLI

So rufen Sie den Status der Abfrage ab

Im folgenden Beispiel für get-query-status-workload-insights-top-contributors-data wird der aktuelle Status der Abfrage im angegebenen Konto angezeigt.

aws networkflowmonitor get-query-status-workload-insights-top-contributors-data \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id 4333754d-8ae1-3f29-b6b7-c36db2e7f8ac

Ausgabe:

{
    "status": "SUCCEEDED"
}

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie get-query-status-workload-insights-top-contributors verwendet wird.

AWS CLI

So rufen Sie den Status der Abfrage ab

Im folgenden Beispiel für get-query-status-workload-insights-top-contributors wird der aktuelle Status der Abfrage im angegebenen Konto angezeigt.

aws networkflowmonitor get-query-status-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id f2a87c70-3e5a-362e-8beb-4747d13d8419

Ausgabe:

{
    "status": "SUCCEEDED"
}

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie get-scope verwendet wird.

AWS CLI

So rufen Sie Informationen zu einem Auftrag ab

Im folgenden Beispiel für get-scope werden Informationen zu einem Bereich angezeigt, z. B. Status, Tags, Name und Zieldetails.

aws networkflowmonitor get-scope \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf

Ausgabe:

{
    "scopeId": "e21cda79-30a0-4c12-9299-d8629d76d8cf",
    "status": "SUCCEEDED",
    "scopeArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:scope/e21cda79-30a0-4c12-9299-d8629d76d8cf",
    "targets": [
        {
            "targetIdentifier": {
                "targetId": {
                    "accountId": "123456789012"
                },
                "targetType": "ACCOUNT"
            },
            "region": "us-east-1"
        }
    ],
    "tags": {}
}

Weitere Informationen finden Sie unter Komponenten und Features von Network Flow Monitor im Benutzerhandbuch zu Amazon CloudWatch.

  • Weitere Details zur API finden Sie unter GetScope in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-monitors verwendet wird.

AWS CLI

So rufen Sie eine Liste von Monitoren ab

Im folgenden Beispiel für list-monitors werden alle Monitore im angegebenen Konto zurückgegeben.

aws networkflowmonitor list-monitors

Ausgabe:

{
    "monitors": [
        {
            "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo",
            "monitorName": "Demo",
            "monitorStatus": "ACTIVE"
        }
    ]
}

Weitere Informationen finden Sie unter Komponenten und Features von Network Flow Monitor im Benutzerhandbuch zu Amazon CloudWatch.

  • Weitere Details zur API finden Sie unter ListMonitors in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-scopes verwendet wird.

AWS CLI

So rufen Sie eine Liste von Bereichen ab

Im folgenden Beispiel für list-scopes werden alle Dashboards im angegebenen Konto aufgelistet.

aws networkflowmonitor list-scopes

Ausgabe:

{
    "scopes": [
        {
            "scopeId": "fdc20616-6bb4-4242-a24e-a748e65ca7ac",
            "status": "SUCCEEDED",
            "scopeArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:scope/fdc20616-6bb4-4242-a24e-a748e65ca7ac"
        }
    ]
}

Weitere Informationen finden Sie unter Komponenten und Features von Network Flow Monitor im Benutzerhandbuch zu Amazon CloudWatch.

  • Weitere Details zur API finden Sie unter ListScopes in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-tags-for-resource verwendet wird.

AWS CLI

So listen Sie die Tags auf

Im folgenden Beispiel für list-tags-for-resource werden alle Tags abgerufen, die der angegebenen Ressource zugeordnet sind.

aws networkflowmonitor list-tags-for-resource \
    --resource-arn arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo

Ausgabe:

{
    "tags": {
        "Value": "Production",
        "Key": "stack"
    }
}

Weitere Informationen finden Sie unter Markieren von Ressourcen von Amazon CloudWatch Events im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie start-query-monitor-top-contributors verwendet wird.

AWS CLI

So starten Sie eine Abfrage

Im folgenden Beispiel für start-query-monitor-top-contributors wird die Abfrage gestartet, die eine Abfrage-ID zurückgibt, um die wichtigsten Mitwirkenden abzurufen.

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

Ausgabe:

{
    "queryId": "aecd3a88-0283-35b0-a17d-6e944dc8531d"
}

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie start-query-workload-insights-top-contributors-data verwendet wird.

AWS CLI

So starten Sie eine Abfrage

Im folgenden Beispiel für start-query-workload-insights-top-contributors-data wird die Abfrage gestartet, die eine Abfrage-ID zurückgibt, um die wichtigsten Mitwirkenden abzurufen.

aws networkflowmonitor start-query-workload-insights-top-contributors-data \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --start-time 2024-12-09T19:00:00Z \
    --end-time 2024-12-09T19:15:00Z \
    --metric-name DATA_TRANSFERRED \
    --destination-category UNCLASSIFIED

Ausgabe:

{
    "queryId": "cc4f4ab3-3103-33b8-80ff-d6597a0c6cea"
}

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie start-query-workload-insights-top-contributors verwendet wird.

AWS CLI

So starten Sie eine Abfrage

Im folgenden Beispiel für start-query-workload-insights-top-contributors wird die Abfrage gestartet, die eine Abfrage-ID zurückgibt, um die wichtigsten Mitwirkenden abzurufen.

aws networkflowmonitor start-query-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --start-time 2024-12-09T19:00:00Z \
    --end-time 2024-12-09T19:15:00Z \
    --metric-name DATA_TRANSFERRED \
    --destination-category UNCLASSIFIED

Ausgabe:

{
    "queryId": "1fc423d3-b144-37a6-80e6-e2c7d26eea0c"
}

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie stop-query-monitor-top-contributors verwendet wird.

AWS CLI

So beenden Sie eine Abfrage

Im folgenden Beispiel für stop-query-monitor-top-contributors wird die Abfrage im angegebenen Konto angehalten.

aws networkflowmonitor stop-query-monitor-top-contributors \
    --monitor-name Demo \
    --query-id aecd3a88-0283-35b0-a17d-6e944dc8531d

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie stop-query-workload-insights-top-contributors-data verwendet wird.

AWS CLI

So beenden Sie eine Abfrage

Im folgenden Beispiel für stop-query-workload-insights-top-contributors-data wird die Abfrage im angegebenen Konto angehalten.

aws networkflowmonitor stop-query-workload-insights-top-contributors-data \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id cc4f4ab3-3103-33b8-80ff-d6597a0c6cea

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie stop-query-workload-insights-top-contributors verwendet wird.

AWS CLI

So beenden Sie eine Abfrage

Im folgenden Beispiel für stop-query-workload-insights-top-contributors wird die Abfrage im angegebenen Konto angehalten.

aws networkflowmonitor stop-query-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id 1fc423d3-b144-37a6-80e6-e2c7d26eea0c

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Bewerten von Netzwerk-Flows mit Workload-Einblicken im Benutzerhandbuch zu Amazon CloudWatch.

Das folgende Codebeispiel zeigt, wie tag-resource verwendet wird.

AWS CLI

So fügen Sie der angegebenen Ressource ein Tag hinzu

Im folgenden Beispiel für tag-resource wird ein Monitor im angegebenen Konto mit einem Tag versehen.

aws networkflowmonitor tag-resource \
    --resource-arn arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo \
    --tags Key=stack,Value=Production

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Markieren von Ressourcen von Amazon CloudWatch Events im Benutzerhandbuch zu Amazon CloudWatch.

  • API-Details finden Sie unter TagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie untag-resource verwendet wird.

AWS CLI

So entfernen Sie alle Tags aus der angegebenen Ressource

Im folgenden Beispiel für untag-resource wird ein Tag aus einem Monitor im angegebenen Konto entfernt.

aws networkflowmonitor untag-resource \
    --resource-arn arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo \
    --tag-keys stack

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Markieren von Ressourcen von Amazon CloudWatch Events im Benutzerhandbuch zu Amazon CloudWatch.

  • API-Details finden Sie unter UntagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-monitor verwendet wird.

AWS CLI

So aktualisieren sie einen vorhandenen Monitor

Im folgenden Beispiel für update-monitor wird ein Monitor mit dem Namen Demo im angegebenen Konto aktualisiert.

aws networkflowmonitor update-monitor \
    --monitor-name Demo \
    --local-resources-to-add type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:123456789012:vpc/vpc-048d08dfbec623f94"

Ausgabe:

{
    "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo",
    "monitorName": "Demo",
    "monitorStatus": "ACTIVE",
    "tags": {
        "Value": "Production",
        "Key": "stack"
    }
}

Weitere Informationen finden Sie unter Komponenten und Features von Network Flow Monitor im Benutzerhandbuch zu Amazon CloudWatch.

  • Weitere Details zur API finden Sie unter UpdateMonitor in der AWS CLI-Befehlsreferenz.