Exemples d’utilisation de l’AWS CLI avec Support

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec Support.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

Actions

L’exemple de code suivant montre comment utiliser add-attachments-to-set.

AWS CLI

Pour ajouter une pièce jointe à un ensemble

L’exemple add-attachments-to-set suivant ajoute une image à un ensemble que vous pouvez ensuite spécifier pour une demande de support dans votre compte AWS.


aws support add-attachments-to-set \
    --attachment-set-id "as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE" \
    --attachments fileName=troubleshoot-screenshot.png,data=base64-encoded-string

Sortie :


{
    "attachmentSetId": "as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE",
    "expiryTime": "2020-05-14T17:04:40.790+0000"
}

Pour plus d’informations, consultez Gestion des demandes dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez AddAttachmentsToSet dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser add-communication-to-case.

AWS CLI

Pour ajouter une communication à une demande

L’exemple add-communication-to-case suivant ajoute des communications à une demande de support dans votre compte AWS.


aws support add-communication-to-case \
    --case-id "case-12345678910-2013-c4c1d2bf33c5cf47" \
    --communication-body "I'm attaching a set of images to this case." \
    --cc-email-addresses "myemail@example.com" \
    --attachment-set-id "as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE"

Sortie :


{
    "result": true
}

Pour plus d’informations, consultez Gestion des demandes dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez AddCommunicationToCase dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-case.

AWS CLI

Pour créer une demande

L’exemple create-case suivant crée une demande de support pour votre compte AWS.


aws support create-case \
    --category-code "using-aws" \
    --cc-email-addresses "myemail@example.com" \
    --communication-body "I want to learn more about an AWS service." \
    --issue-type "technical" \
    --language "en" \
    --service-code "general-info" \
    --severity-code "low" \
    --subject "Question about my account"

Sortie :


{
    "caseId": "case-12345678910-2013-c4c1d2bf33c5cf47"
}

Pour plus d’informations, consultez Gestion des demandes dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez CreateCase dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-attachment.

AWS CLI

Pour décrire une pièce jointe

L’exemple describe-attachment suivant renvoie les informations sur la pièce jointe possédant l’ID spécifié.


aws support describe-attachment \
    --attachment-id "attachment-KBnjRNrePd9D6Jx0-Mm00xZuDEaL2JAj_0-gJv9qqDooTipsz3V1Nb19rCfkZneeQeDPgp8X1iVJyHH7UuhZDdNeqGoduZsPrAhyMakqlc60-iJjL5HqyYGiT1FG8EXAMPLE"

Sortie :


{
    "attachment": {
        "fileName": "troubleshoot-screenshot.png",
        "data": "base64-blob"
    }
}

Pour plus d’informations, consultez Gestion des demandes dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez DescribeAttachment dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-cases.

AWS CLI

Pour décrire une demande

L’exemple describe-cases suivant renvoie les informations sur la demande de support spécifiée dans votre compte AWS.


aws support describe-cases \
    --display-id "1234567890" \
    --after-time "2020-03-23T21:31:47.774Z" \
    --include-resolved-cases \
    --language "en" \
    --no-include-communications \
    --max-item 1

Sortie :


{
    "cases": [
        {
            "status": "resolved",
            "ccEmailAddresses": [],
            "timeCreated": "2020-03-23T21:31:47.774Z",
            "caseId": "case-12345678910-2013-c4c1d2bf33c5cf47",
            "severityCode": "low",
            "language": "en",
            "categoryCode": "using-aws",
            "serviceCode": "general-info",
            "submittedBy": "myemail@example.com",
            "displayId": "1234567890",
            "subject": "Question about my account"
        }
    ]
}

Pour plus d’informations, consultez Gestion des demandes dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez DescribeCases dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-communications.

AWS CLI

Pour décrire la dernière communication concernant une demande

L’exemple describe-communications suivant renvoie la dernière communication concernant la demande de support spécifiée dans votre compte AWS.


aws support describe-communications \
    --case-id "case-12345678910-2013-c4c1d2bf33c5cf47" \
    --after-time "2020-03-23T21:31:47.774Z" \
    --max-item 1

Sortie :


{
    "communications": [
        {
            "body": "I want to learn more about an AWS service.",
            "attachmentSet": [],
            "caseId": "case-12345678910-2013-c4c1d2bf33c5cf47",
            "timeCreated": "2020-05-12T23:12:35.000Z",
            "submittedBy": "Amazon Web Services"
        }
    ],
    "NextToken": "eyJuZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQEXAMPLE=="
}

Pour plus d’informations, consultez Gestion des demandes dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez DescribeCommunications dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-services.

AWS CLI

Pour répertorier les services et les catégories de services AWS

L’exemple describe-services suivant répertorie les catégories de services disponibles pour demander des informations générales.


aws support describe-services \
    --service-code-list "general-info"

Sortie :


{
    "services": [
        {
            "code": "general-info",
            "name": "General Info and Getting Started",
            "categories": [
                {
                    "code": "charges",
                    "name": "How Will I Be Charged?"
                },
                {
                    "code": "gdpr-queries",
                    "name": "Data Privacy Query"
                },
                {
                    "code": "reserved-instances",
                    "name": "Reserved Instances"
                },
                {
                    "code": "resource",
                    "name": "Where is my Resource?"
                },
                {
                    "code": "using-aws",
                    "name": "Using AWS & Services"
                },
                {
                    "code": "free-tier",
                    "name": "Free Tier"
                },
                {
                    "code": "security-and-compliance",
                    "name": "Security & Compliance"
                },
                {
                    "code": "account-structure",
                    "name": "Account Structure"
                }
            ]
        }
    ]
}

Pour plus d’informations, consultez Gestion des demandes dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez DescribeServices dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-severity-levels.

AWS CLI

Pour répertorier les niveaux de gravité disponibles

L’exemple describe-severity-levels suivant répertorie les niveaux de gravité disponibles pour une demande de support.


aws support describe-severity-levels

Sortie :


{
    "severityLevels": [
        {
            "code": "low",
            "name": "Low"
        },
        {
            "code": "normal",
            "name": "Normal"
        },
        {
            "code": "high",
            "name": "High"
        },
        {
            "code": "urgent",
            "name": "Urgent"
        },
        {
            "code": "critical",
            "name": "Critical"
        }
    ]
}

Pour plus d’informations, consultez Choix du niveau de gravité dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez DescribeSeverityLevels dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-trusted-advisor-check-refresh-statuses.

AWS CLI

Pour répertorier les statuts d’actualisation des vérifications d’AWS Trusted Advisor

L’exemple describe-trusted-advisor-check-refresh-statuses suivant répertorie les statuts d’actualisation des deux vérifications de Trusted Advisor : Autorisations pour le compartiment Amazon S3 et Utilisation d’IAM.


aws support describe-trusted-advisor-check-refresh-statuses \
    --check-id "Pfx0RwqBli" "zXCkfM1nI3"

Sortie :


{
    "statuses": [
        {
            "checkId": "Pfx0RwqBli",
            "status": "none",
            "millisUntilNextRefreshable": 0
        },
        {
            "checkId": "zXCkfM1nI3",
            "status": "none",
            "millisUntilNextRefreshable": 0
        }
    ]
}

Pour plus d’informations, consultez AWS Trusted Advisor dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez DescribeTrustedAdvisorCheckRefreshStatuses dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-trusted-advisor-check-result.

AWS CLI

Pour répertorier les résultats d’une vérification AWS Trusted Advisor

L’exemple describe-trusted-advisor-check-result suivant répertorie les résultats de la vérification Utilisation d’IAM.


aws support describe-trusted-advisor-check-result \
    --check-id "zXCkfM1nI3"

Sortie :


{
    "result": {
        "checkId": "zXCkfM1nI3",
        "timestamp": "2020-05-13T21:38:05Z",
        "status": "ok",
        "resourcesSummary": {
            "resourcesProcessed": 1,
            "resourcesFlagged": 0,
            "resourcesIgnored": 0,
            "resourcesSuppressed": 0
        },
        "categorySpecificSummary": {
            "costOptimizing": {
                "estimatedMonthlySavings": 0.0,
                "estimatedPercentMonthlySavings": 0.0
            }
        },
        "flaggedResources": [
            {
                "status": "ok",
                "resourceId": "47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZEXAMPLE",
                "isSuppressed": false
            }
        ]
    }
}

Pour plus d’informations, consultez AWS Trusted Advisor dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez DescribeTrustedAdvisorCheckResult dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-trusted-advisor-check-summaries.

AWS CLI

Pour répertorier les résumés des vérifications d’AWS Trusted Advisor

L’exemple describe-trusted-advisor-check-summaries suivant répertorie les résultats des deux vérifications de Trusted Advisor : Autorisations pour le compartiment Amazon S3 et Utilisation d’IAM.


aws support describe-trusted-advisor-check-summaries \
    --check-ids "Pfx0RwqBli" "zXCkfM1nI3"

Sortie :


{
    "summaries": [
        {
            "checkId": "Pfx0RwqBli",
            "timestamp": "2020-05-13T21:38:12Z",
            "status": "ok",
            "hasFlaggedResources": true,
            "resourcesSummary": {
                "resourcesProcessed": 44,
                "resourcesFlagged": 0,
                "resourcesIgnored": 0,
                "resourcesSuppressed": 0
            },
            "categorySpecificSummary": {
                "costOptimizing": {
                    "estimatedMonthlySavings": 0.0,
                    "estimatedPercentMonthlySavings": 0.0
                }
            }
        },
        {
            "checkId": "zXCkfM1nI3",
            "timestamp": "2020-05-13T21:38:05Z",
            "status": "ok",
            "hasFlaggedResources": true,
            "resourcesSummary": {
                "resourcesProcessed": 1,
                "resourcesFlagged": 0,
                "resourcesIgnored": 0,
                "resourcesSuppressed": 0
            },
            "categorySpecificSummary": {
                "costOptimizing": {
                    "estimatedMonthlySavings": 0.0,
                    "estimatedPercentMonthlySavings": 0.0
                }
            }
        }
    ]
}

Pour plus d’informations, consultez AWS Trusted Advisor dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez DescribeTrustedAdvisorCheckSummaries dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-trusted-advisor-checks.

AWS CLI

Pour répertorier les vérifications d’AWS Trusted Advisor disponibles

L’exemple describe-trusted-advisor-checks suivant répertorie les vérifications de Trusted Advisor disponibles dans votre compte AWS. Ces informations incluent le nom, l’ID, la description, la catégorie et les métadonnées de la vérification. Veuillez noter que la sortie est raccourcie à des fins de lisibilité.


aws support describe-trusted-advisor-checks \
    --language "en"

Sortie :


{
    "checks": [
        {
            "id": "zXCkfM1nI3",
            "name": "IAM Use",
            "description": "Checks for your use of AWS Identity and Access Management (IAM). You can use IAM to create users, groups, and roles in AWS, and you can use permissions to control access to AWS resources. \n<br>\n<br>\n<b>Alert Criteria</b><br>\nYellow: No IAM users have been created for this account.\n<br>\n<br>\n<b>Recommended Action</b><br>\nCreate one or more IAM users and groups in your account. You can then create additional users whose permissions are limited to perform specific tasks in your AWS environment. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/IAMGettingStarted.html\" target=\"_blank\">Getting Started</a>. \n<br><br>\n<b>Additional Resources</b><br>\n<a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_Introduction.html\" target=\"_blank\">What Is IAM?</a>",
            "category": "security",
            "metadata": []
        }
    ]
}

Pour plus d’informations, consultez AWS Trusted Advisor dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez DescribeTrustedAdvisorChecks dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser refresh-trusted-advisor-check.

AWS CLI

Pour actualiser une vérification AWS Trusted Advisor

L’exemple refresh-trusted-advisor-check suivant actualise la vérification Autorisations pour le compartiment Amazon S3 de Trusted Advisor dans votre compte AWS.


aws support refresh-trusted-advisor-check \
    --check-id "Pfx0RwqBli"

Sortie :


{
    "status": {
        "checkId": "Pfx0RwqBli",
        "status": "enqueued",
        "millisUntilNextRefreshable": 3599992
    }
}

Pour plus d’informations, consultez AWS Trusted Advisor dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez RefreshTrustedAdvisorCheck dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser resolve-case.

AWS CLI

Pour résoudre une demande de support

L’exemple resolve-case suivant résout une demande de support dans votre compte AWS.


aws support resolve-case \
    --case-id "case-12345678910-2013-c4c1d2bf33c5cf47"

Sortie :


{
    "finalCaseStatus": "resolved",
    "initialCaseStatus": "work-in-progress"
}

Pour plus d’informations, consultez Gestion des demandes dans le Guide de l’utilisateur AWS Support.

Pour plus de détails sur l’API, consultez ResolveCase dans la Référence des commandes de l’AWS CLI.

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

AWS STS

Amazon SWF