Exemplos do Network Flow Monitor usando a AWS CLI - AWS Command Line Interface
Ações

Exemplos do Network Flow Monitor usando a AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Network Flow Monitor.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar create-monitor.

AWS CLI

Como criar um monitor

O exemplo de create-monitor a seguir cria um monitor chamado demo na conta especificada.

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

Saída:

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

Consulte mais informações em Criar um monitor no Network Flow Monitor no Guia do usuário do Amazon CloudWatch.

  • Para ver detalhes da API, consulte CreateMonitor na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-scope.

AWS CLI

Como criar um escopo

O exemplo de create-scope a seguir cria um escopo que inclui um conjunto de recursos para os quais o Network Flow Monitor gerará métricas de tráfego de rede.

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

Saída:

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

Consulte mais informações em Componentes e recursos do Network Flow Monitor no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em CreateScope na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-monitor.

AWS CLI

Para excluir um monitor

O exemplo de delete-monitor a seguir exclui um monitor chamado demo na conta especificada.

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

Este comando não produz saída.

Consulte mais informações em Excluir um monitor no Network Flow Monitor no Guia do usuário do Amazon CloudWatch.

  • Para ver detalhes da API, consulte DeleteMonitor na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-scope.

AWS CLI

Como excluir um escopo

O exemplo de delete-scope a seguir exclui um escopo especificado.

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

Este comando não produz saída.

Consulte mais informações em Componentes e recursos do Network Flow Monitor no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em DeleteScope na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-monitor.

AWS CLI

Como recuperar informações sobre um monitor

O exemplo de get-monitor a seguir exibe as informações sobre o painel chamado demo na conta especificada.

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

Saída:

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

Consulte mais informações em Componentes e recursos do Network Flow Monitor no Guia do usuário do Amazon CloudWatch.

  • Para ver detalhes da API, consulte GetMonitor na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-query-results-workload-insights-top-contributors-data.

AWS CLI

Como recuperar os dados dos principais colaboradores nos insights de workloads

O exemplo de get-query-results-workload-insights-top-contributors-data a seguir retorna os dados da consulta especificada.

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

Saída:

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

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar get-query-results-workload-insights-top-contributors.

AWS CLI

Como recuperar os principais colaboradores nos insights de workloads

O exemplo de get-query-results-workload-insights-top-contributors a seguir retorna os dados da consulta especificada.

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

Saída:

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

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar get-query-status-monitor-top-contributors.

AWS CLI

Como recuperar o status da consulta

O exemplo de get-query-status-monitor-top-contributors a seguir exibe o status atual da consulta na conta especificada.

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

Saída:

{
    "status": "SUCCEEDED"
}

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar get-query-status-workload-insights-top-contributors-data.

AWS CLI

Como recuperar o status da consulta

O exemplo de get-query-status-workload-insights-top-contributors-data a seguir exibe o status atual da consulta na conta especificada.

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

Saída:

{
    "status": "SUCCEEDED"
}

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar get-query-status-workload-insights-top-contributors.

AWS CLI

Como recuperar o status da consulta

O exemplo de get-query-status-workload-insights-top-contributors a seguir exibe o status atual da consulta na conta especificada.

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

Saída:

{
    "status": "SUCCEEDED"
}

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar get-scope.

AWS CLI

Como recuperar informações sobre um escopo

O exemplo de get-scope a seguir exibe informações sobre um escopo, como status, tags, nome e detalhes do destino.

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

Saída:

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

Consulte mais informações em Componentes e recursos do Network Flow Monitor no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em GetScope na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-monitors.

AWS CLI

Como recuperar uma lista de monitores

O exemplo de list-monitors a seguir retorna todos os monitores na conta especificada.

aws networkflowmonitor list-monitors

Saída:

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

Consulte mais informações em Componentes e recursos do Network Flow Monitor no Guia do usuário do Amazon CloudWatch.

  • Para ver detalhes da API, consulte ListMonitors na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-scopes.

AWS CLI

Como recuperar uma lista de escopos

O exemplo de list-scopes a seguir lista todos os escopos na conta especificada.

aws networkflowmonitor list-scopes

Saída:

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

Consulte mais informações em Componentes e recursos do Network Flow Monitor no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em ListScopes na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Como listar as tags

O exemplo de list-tags-for-resource a seguir retorna as tags associadas ao recurso especificado.

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

Saída:

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

Consulte mais informações em Etiquetar recursos do Amazon CloudWatch no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar start-query-monitor-top-contributors.

AWS CLI

Como iniciar uma consulta

O exemplo de start-query-monitor-top-contributors a seguir inicia a consulta que retorna um ID de consulta para recuperar os principais colaboradores.

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

Saída:

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

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar start-query-workload-insights-top-contributors-data.

AWS CLI

Como iniciar uma consulta

O exemplo de start-query-workload-insights-top-contributors-data a seguir inicia a consulta que retorna um ID de consulta para recuperar os principais colaboradores.

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

Saída:

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

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar start-query-workload-insights-top-contributors.

AWS CLI

Como iniciar uma consulta

O exemplo de start-query-workload-insights-top-contributors a seguir inicia a consulta que retorna um ID de consulta para recuperar os principais colaboradores.

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

Saída:

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

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar stop-query-monitor-top-contributors.

AWS CLI

Como interromper uma consulta

O exemplo de stop-query-monitor-top-contributors a seguir interrompe a consulta na conta especificada.

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

Este comando não produz saída.

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar stop-query-workload-insights-top-contributors-data.

AWS CLI

Como interromper uma consulta

O exemplo de stop-query-workload-insights-top-contributors-data a seguir interrompe a consulta na conta especificada.

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

Este comando não produz saída.

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar stop-query-workload-insights-top-contributors.

AWS CLI

Como interromper uma consulta

O exemplo de stop-query-workload-insights-top-contributors a seguir interrompe a consulta na conta especificada.

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

Este comando não produz saída.

Consulte mais informações em Avaliar fluxos de rede com insights de workloads no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para adicionar uma tag ao recurso especificado

O exemplo de tag-resource a seguir adiciona uma tag ao monitor na conta especificada.

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

Este comando não produz saída.

Consulte mais informações em Etiquetar recursos do Amazon CloudWatch no Guia do usuário do Amazon CloudWatch.

  • Para obter detalhes da API, consulte TagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Como remover uma tag do recurso especificado

O exemplo de untag-resource a seguir remove uma tag do monitor na conta especificada.

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

Este comando não produz saída.

Consulte mais informações em Etiquetar recursos do Amazon CloudWatch no Guia do usuário do Amazon CloudWatch.

  • Para obter detalhes sobre a API, consulte UntagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-monitor.

AWS CLI

Como atualizar um monitor existente

O exemplo de update-monitor a seguir atualiza o monitor chamado Demo na conta especificada.

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"

Saída:

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

Consulte mais informações em Componentes e recursos do Network Flow Monitor no Guia do usuário do Amazon CloudWatch.

  • Para ver detalhes da API, consulte UpdateMonitor na Referência de comandos da AWS CLI.