AWS CLI を使用した AWS Support の例

次のコード例は、AWS Support で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれており、そこからコンテキストにおけるコードの設定方法と実行方法についての手順を確認できます。

トピック

アクション

アクション

次のコード例は、add-attachments-to-set を使用する方法を示しています。

AWS CLI

セットに添付ファイルを追加するには

次の add-attachments-to-set の例では、AWS アカウントでサポートケースに指定できるイメージをセットに追加します。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「ケース管理」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「AddAttachmentsToSet」を参照してください。

次のコード例は、add-communication-to-case を使用する方法を示しています。

AWS CLI

ケースに通信を追加するには

次の add-communication-to-case の例では、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"

出力:


{
    "result": true
}

詳細については、「AWS サポートユーザーガイド」の「ケース管理」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「AddCommunicationToCase」を参照してください。

次のコード例は、create-case を使用する方法を示しています。

AWS CLI

ケースを作成する

次の create-case の例では、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"

出力:


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

詳細については、「AWS サポートユーザーガイド」の「ケース管理」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「create-case」を参照してください。

次のコード例は、describe-attachment を使用する方法を示しています。

AWS CLI

添付ファイルについて説明する

次の describe-attachment の例では、指定された ID の添付ファイルに関する情報を返します。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「ケース管理」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeAttachment」を参照してください。

次のコード例は、describe-cases を使用する方法を示しています。

AWS CLI

ケースについて説明する

次の describe-cases の例では、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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「ケース管理」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeCases」を参照してください。

次のコード例は、describe-communications を使用する方法を示しています。

AWS CLI

ケースの最新のコミュニケーションについて説明する

次の describe-communications の例では、AWS アカウント内の指定されたサポートケースの最新のコミュニケーションを返します。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「ケース管理」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeCommunications」を参照してください。

次のコード例は、describe-services を使用する方法を示しています。

AWS CLI

AWS のサービスとサービスカテゴリを一覧表示する

次の describe-services の例では、一般的な情報をリクエストするためのサービスカテゴリを一覧表示します。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「ケース管理」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeServices」を参照してください。

次のコード例は、describe-severity-levels を使用する方法を示しています。

AWS CLI

利用可能な重要度レベルを一覧表示する

次の describe-severity-levels の例では、サポートケースの重要度レベルを一覧表示します。


aws support describe-severity-levels

出力:


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

詳細については、「AWS サポートユーザーガイド」の「緊急度の選択」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeSeverityLevels」を参照してください。

次のコード例は、describe-trusted-advisor-check-refresh-statuses を使用する方法を示しています。

AWS CLI

AWS Trusted Advisor チェックの更新ステータスを一覧表示するには

次の describe-trusted-advisor-check-refresh-statuses の例では、Amazon S3 バケットのアクセス許可と IAM の使用という 2 つの Trusted Advisor チェックの更新ステータスを一覧表示します。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「AWS Trusted Advisor」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeTrustedAdvisorCheckRefreshStatuses」を参照してください。

次のコード例は、describe-trusted-advisor-check-result を使用する方法を示しています。

AWS CLI

AWS Trusted Advisor チェックの結果を一覧表示するには

次の describe-trusted-advisor-check-result の例では、IAM 使用チェックの結果を一覧表示します。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「AWS Trusted Advisor」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeTrustedAdvisorCheckResult」を参照してください。

次のコード例は、describe-trusted-advisor-check-summaries を使用する方法を示しています。

AWS CLI

AWS Trusted Advisor チェックの概要を一覧表示するには

次の describe-trusted-advisor-check-summaries の例では、Amazon S3 バケットのアクセス許可と IAM の使用という 2 つの Trusted Advisor チェックの結果を一覧表示します。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「AWS Trusted Advisor」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeTrustedAdvisorCheckSummaries」を参照してください。

次のコード例は、describe-trusted-advisor-checks を使用する方法を示しています。

AWS CLI

使用可能な AWS Trusted Advisor チェックを一覧表示するには

次の describe-trusted-advisor-checks の例では、AWS アカウントで使用可能な Trusted Advisor チェックを一覧表示します。この情報には、チェック名、ID、説明、カテゴリ、メタデータが含まれます。読みやすくするために、出力が短縮されることに注意してください。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「AWS Trusted Advisor」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeTrustedAdvisorChecks」を参照してください。

次のコード例は、refresh-trusted-advisor-check を使用する方法を示しています。

AWS CLI

AWS Trusted Advisor チェックを更新するには

次の refresh-trusted-advisor-check の例では、AWS アカウントの Amazon S3 バケットのアクセス許可の Trusted Advisor チェックを更新します。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「AWS Trusted Advisor」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「RefreshTrustedAdvisorCheck」を参照してください。

次のコード例は、resolve-case を使用する方法を示しています。

AWS CLI

サポートケースを解決する

次の resolve-case の例では、AWS アカウントのサポートケースを解決します。


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

出力:


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

詳細については、「AWS サポートユーザーガイド」の「ケース管理」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ResolveCase」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

AWS STS

Amazon SWF