Obtenez un tableau de bord avec AWS CLI Répertoriez les tableaux de bord avec AWS CLI Associez une politique basée sur les ressources à un magasin de données d'événements ou à un tableau de bord avec le AWS CLI Actualisez manuellement un tableau de bord à l'aide du AWS CLI Mettez à jour un tableau de bord avec AWS CLI

Gérez les tableaux de bord avec AWS CLI

Cette section décrit plusieurs autres commandes que vous pouvez exécuter pour gérer vos tableaux de bord, notamment obtenir un tableau de bord, répertorier vos tableaux de bord, actualiser un tableau de bord et mettre à jour un tableau de bord.

Lorsque vous utilisez le AWS CLI, n'oubliez pas que vos commandes s'exécutent dans la Région AWS configuration adaptée à votre profil. Si vous souhaitez exécuter les commandes dans une autre région, modifiez la région par défaut pour votre profil, ou utilisez le paramètre --region avec la commande.

Exemples :

Obtenez un tableau de bord avec AWS CLI
Répertoriez les tableaux de bord avec AWS CLI
Associez une politique basée sur les ressources à un magasin de données d'événements ou à un tableau de bord avec le AWS CLI
Actualisez manuellement un tableau de bord à l'aide du AWS CLI
Mettez à jour un tableau de bord avec AWS CLI

Obtenez un tableau de bord avec AWS CLI

Exécutez la get-dashboard commande pour renvoyer un tableau de bord. Spécifiez le --dashboard-id en fournissant l'ARN du tableau de bord ou le nom du tableau de bord.


aws cloudtrail get-dashboard --dashboard-id arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

Répertoriez les tableaux de bord avec AWS CLI

Exécutez la list-dashboards commande pour répertorier les tableaux de bord de votre compte.

Incluez le --type paramètre, pour afficher uniquement les MANAGED tableaux de bord CUSTOM ou.
Incluez le --max-results paramètre pour limiter le nombre de résultats. Les valeurs valides sont comprises entre 1 et 100.
Incluez les tableaux de bord --name-prefix à renvoyer correspondant au préfixe spécifié.

L'exemple suivant répertorie tous les tableaux de bord.


aws cloudtrail list-dashboards

Cet exemple répertorie uniquement les CUSTOM tableaux de bord.


aws cloudtrail list-dashboards --type CUSTOM

L'exemple suivant répertorie uniquement les MANAGED tableaux de bord.


aws cloudtrail list-dashboards --type MANAGED

Le dernier exemple répertorie les tableaux de bord correspondant au préfixe spécifié.


aws cloudtrail list-dashboards --name-prefix ExamplePrefix

Associez une politique basée sur les ressources à un magasin de données d'événements ou à un tableau de bord avec le AWS CLI

Exécutez la put-resource-policy commande pour appliquer une politique basée sur les ressources à un magasin de données d'événements ou à un tableau de bord.

Associer une politique basée sur les ressources à une banque de données d'événements

Pour exécuter des requêtes sur un tableau de bord lors d'une actualisation manuelle ou planifiée, vous devez associer une politique basée sur les ressources à chaque magasin de données d'événements associé à un widget sur le tableau de bord. Cela permet à CloudTrail Lake d'exécuter les requêtes en votre nom. Pour plus d'informations sur la politique basée sur les ressources, consultez. Exemple : CloudTrail Autoriser l'exécution de requêtes pour actualiser un tableau de bord

L'exemple suivant associe une politique basée sur les ressources à un magasin de données d'événements. Remplacez-le account-id par votre identifiant de compte, eds-arn par l'ARN du magasin de données d'événements pour lequel les requêtes CloudTrail seront exécutées et dashboard-arn par l'ARN du tableau de bord.


aws cloudtrail put-resource-policy \
--resource-arn eds-arn \
--resource-policy '{"Version": "2012-10-17",		 	 	  "Statement": [{"Sid": "EDSPolicy", "Effect": "Allow", "Principal": { "Service": "cloudtrail.amazonaws.com" }, "Action": "cloudtrail:StartQuery", "Condition": { "StringEquals": { "AWS:SourceArn": "dashboard-arn", "AWS:SourceAccount": "account-id"}}} ]}'

Associer une politique basée sur les ressources à un tableau de bord

Pour définir un calendrier d'actualisation pour un tableau de bord, vous devez associer une politique basée sur les ressources au tableau de bord afin de permettre à CloudTrail Lake d'actualiser le tableau de bord en votre nom. Pour plus d'informations sur la politique basée sur les ressources, consultez. Exemple de politique basée sur les ressources pour un tableau de bord

L'exemple suivant associe une politique basée sur les ressources à un tableau de bord. account-idRemplacez-le par votre identifiant de compte et dashboard-arn par l'ARN du tableau de bord.


aws cloudtrail put-resource-policy \
--resource-arn dashboard-arn \
--resource-policy '{"Version": "2012-10-17",		 	 	  "Statement": [{"Sid": "DashboardPolicy", "Effect": "Allow", "Principal": { "Service": "cloudtrail.amazonaws.com" }, "Action": "cloudtrail:StartDashboardRefresh", "Condition": { "StringEquals": { "AWS:SourceArn": "dashboard-arn", "AWS:SourceAccount": "account-id"}}}]}'

Actualisez manuellement un tableau de bord à l'aide du AWS CLI

Exécutez la start-dashboard-refresh commande pour actualiser manuellement le tableau de bord. Avant de pouvoir exécuter cette commande, vous devez associer une politique basée sur les ressources à chaque magasin de données d'événements associé à un widget de tableau de bord.

L'exemple suivant montre comment actualiser manuellement un tableau de bord personnalisé.


aws cloudtrail start-dashboard-refresh \ 
--dashboard-id  dashboard-id \ 
--query-parameter-values '{"$StartTime$": "2024-11-05T10:45:24.00Z"}'

L'exemple suivant montre comment actualiser manuellement un tableau de bord géré. Les tableaux de bord gérés étant configurés par CloudTrail, la demande d'actualisation doit inclure l'ID du magasin de données d'événements sur lequel les requêtes seront exécutées.


aws cloudtrail start-dashboard-refresh \
--dashboard-id dashboard-id  \
--query-parameter-values '{"$StartTime$": "2024-11-05T10:45:24.00Z", "$EventDataStoreId$": "eds-id"}'

Mettez à jour un tableau de bord avec AWS CLI

Exécutez la update-dashboard commande pour mettre à jour un tableau de bord. Vous pouvez mettre à jour le tableau de bord pour définir un calendrier d'actualisation, activer ou désactiver un calendrier d'actualisation, modifier les widgets et activer ou désactiver la protection contre la résiliation.

Mettez à jour le calendrier d'actualisation avec le AWS CLI

L'exemple suivant met à jour le calendrier d'actualisation d'un tableau de bord personnalisé nomméAccountActivityDashboard.


aws cloudtrail update-dashboard --dashboard-id AccountActivityDashboard \
--refresh-schedule '{"Frequency": {"Unit": "HOURS", "Value": 6}, "Status": "ENABLED"}'

Désactivez la protection contre le licenciement et le calendrier d'actualisation sur un tableau de bord personnalisé à l'aide du AWS CLI

L'exemple suivant désactive la protection contre la résiliation pour un tableau de bord personnalisé nommé AccountActivityDashboard pour autoriser la suppression du tableau de bord. Il désactive également le programme d'actualisation.


aws cloudtrail update-dashboard --dashboard-id AccountActivityDashboard \
--refresh-schedule '{ "Status": "DISABLED"}' \
--no-termination-protection-enabled

L'exemple suivant ajoute un nouveau widget nommé TopServices au tableau de bord personnalisé nomméAccountActivityDashboard. Le tableau de widgets inclut les deux widgets déjà créés pour le tableau de bord et le nouveau widget.

Note

Dans cet exemple, il ? est entouré de guillemets simples car il est utilisé aveceventTime. Selon le système d'exploitation que vous utilisez, vous devrez peut-être entourer les guillemets simples de guillemets d'échappement. Pour plus d'informations, consultez la section Utilisation de guillemets et de littéraux avec des chaînes dans le AWS CLI.


aws cloudtrail update-dashboard --dashboard-id AccountActivityDashboard \
--widgets '[
    {
      "ViewProperties": {
        "Height": "2",
        "Width": "4",
        "Title": "TopErrors",
        "View": "Table"
      },
      "QueryStatement": "SELECT errorCode, COUNT(*) AS eventCount FROM eds WHERE eventTime > '?' AND eventTime < '?' AND (errorCode is not null) GROUP BY errorCode ORDER BY eventCount DESC LIMIT 100",
      "QueryParameters": ["$StartTime$", "$EndTime$"]
    },
    {
      "ViewProperties": {
        "Height": "2",
        "Width": "4",
        "Title": "MostActiveRegions",
        "View": "PieChart",
        "LabelColumn": "awsRegion",
        "ValueColumn": "eventCount",
        "FilterColumn": "awsRegion"
      },
      "QueryStatement": "SELECT awsRegion, COUNT(*) AS eventCount FROM eds where eventTime > '?' and eventTime < '?' GROUP BY awsRegion ORDER BY eventCount LIMIT 100",
      "QueryParameters": ["$StartTime$", "$EndTime$"]
    },
    {
      "ViewProperties": {
        "Height": "2",
        "Width": "4",
        "Title": "TopServices",
        "View": "BarChart",
        "LabelColumn": "service",
        "ValueColumn": "eventCount",
        "FilterColumn": "service",
        "Orientation": "Vertical"
      },
      "QueryStatement": "SELECT replace(eventSource, '.amazonaws.com') AS service, COUNT(*) as eventCount FROM eds WHERE eventTime > '?' AND eventTime < '?' GROUP BY eventSource ORDER BY eventCount DESC LIMIT 100",
      "QueryParameters": ["$StartTime$", "$EndTime$"]
    }
  ]'

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Afficher les propriétés des widgets

Supprimer un tableau de bord à l'aide du AWS CLI