AWS Support Tools for を使用した の例 PowerShell - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS Support Tools for を使用した の例 PowerShell

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

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

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

次の例は、Add-ASACommunicationToCase を使用する方法を説明しています。

のツール PowerShell

例 1: 指定したケースに E メール通信の本文を追加します。

Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CommunicationBody "Some text about the case"

例 2: 指定したケースに E メール通信の本文と、E メールの CC 行に含まれる 1 つ以上の E メールアドレスを追加します。

Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CcEmailAddress @("email1@address.com", "email2@address.com") -CommunicationBody "Some text about the case"
  • API の詳細については、「 コマンドレットリファレンスAddCommunicationToCase」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Get-ASACase を使用する方法を説明しています。

のツール PowerShell

例 1: すべてのサポートケースの詳細を返します。

Get-ASACase

例 2: 指定した日時以降のすべてのサポートケースの詳細を返します。

Get-ASACase -AfterTime "2013-09-10T03:06Z"

例 3: 解決されたサポートケースを含め、最初の 10 件のサポートケースの詳細を返します。

Get-ASACase -MaxResult 10 -IncludeResolvedCases $true

例 4: 指定された単一のサポートケースの詳細を返します。

Get-ASACase -CaseIdList "case-12345678910-2013-c4c1d2bf33c5cf47"

例 5: 指定されたサポートケースの詳細を返します。

Get-ASACase -CaseIdList @("case-12345678910-2013-c4c1d2bf33c5cf47", "case-18929034710-2011-c4fdeabf33c5cf47")

例 6: 手動ページングを使用してすべてのサポートケースを返します。ケースは 20 個のバッチで取得されます。

$nextToken = $null do { Get-ASACase -NextToken $nextToken -MaxResult 20 $nextToken = $AWSHistory.LastServiceResponse.NextToken } while ($nextToken -ne $null)
  • API の詳細については、「 コマンドレットリファレンスDescribeCases」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Get-ASACommunication を使用する方法を説明しています。

のツール PowerShell

例 1: 指定したケースのすべての通信を返します。

Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"

例 2: 指定されたケースについて、2012 年 1 月 1 日の午前 0 時 UTC 以降のすべての通信を返します。

Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -AfterTime "2012-01-10T00:00Z"

例 3: 手動ページングを使用して、指定したケースについて、2012 年 1 月 1 日の午前 0 時 UTC 以降のすべての通信を返します。通信は 20 個のバッチで取得されます。

$nextToken = $null do { Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -NextToken $nextToken -MaxResult 20 $nextToken = $AWSHistory.LastServiceResponse.NextToken } while ($nextToken -ne $null)
  • API の詳細については、「 コマンドレットリファレンスDescribeCommunications」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Get-ASAService を使用する方法を説明しています。

のツール PowerShell

例 1: 使用可能なすべてのサービスコード、名前、カテゴリを返します。

Get-ASAService

例 2: 指定されたコードを持つサービスの名前とカテゴリを返します。

Get-ASAService -ServiceCodeList "amazon-cloudfront"

例 3: 指定されたサービスコードの名前とカテゴリを返します。

Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch")

例 4: 指定されたサービスコードの名前とカテゴリ (日本語) を返します。現在、英語 (「en」) および日本語 (「ja」) 言語コードがサポートされています。

Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch") -Language "ja"
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeServices」の「」を参照してください。

次の例は、Get-ASASeverityLevel を使用する方法を説明しています。

のツール PowerShell

例 1: AWS サポートケースに割り当てることができる重要度レベルのリストを返します。

Get-ASASeverityLevel

例 2: AWS サポートケースに割り当てることができる重要度レベルのリストを返します。レベルの名前は日本語で返されます。

Get-ASASeverityLevel -Language "ja"
  • API の詳細については、「 コマンドレットリファレンスDescribeSeverityLevels」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Get-ASATrustedAdvisorCheck を使用する方法を説明しています。

のツール PowerShell

例 1: Trusted Advisor チェックのコレクションを返します。英語出力の場合は「en」、日本語出力の場合は「ja」のいずれかを受け入れることができる Language パラメータを指定する必要があります。

Get-ASATrustedAdvisorCheck -Language "en"
  • API の詳細については、「 コマンドレットリファレンスDescribeTrustedAdvisorChecks」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Get-ASATrustedAdvisorCheckRefreshStatus を使用する方法を説明しています。

のツール PowerShell

例 1: 指定したチェックの更新リクエストの現在のステータスを返します。Request-ASA を使用して、チェックのステータス情報の更新をリクエストTrustedAdvisorCheckRefresh できます。

Get-ASATrustedAdvisorCheckRefreshStatus -CheckId @("checkid1", "checkid2")

次の例は、Get-ASATrustedAdvisorCheckResult を使用する方法を説明しています。

のツール PowerShell

例 1: Trusted Advisor チェックの結果を返します。利用可能な Trusted Advisor チェックのリストは、Get-ASA を使用して取得できますTrustedAdvisorChecks。出力は、チェックの全体的なステータス、チェックが最後に実行されたタイムスタンプ、および特定のチェックの一意のチェック ID です。結果を日本語で出力するには、-Language "ja" パラメータを追加します。

Get-ASATrustedAdvisorCheckResult -CheckId "checkid1"
  • API の詳細については、「 コマンドレットリファレンスDescribeTrustedAdvisorCheckResult」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Get-ASATrustedAdvisorCheckSummary を使用する方法を説明しています。

のツール PowerShell

例 1: 指定された Trusted Advisor チェックの最新の概要を返します。

Get-ASATrustedAdvisorCheckSummary -CheckId "checkid1"

例 2: 指定された Trusted Advisor チェックの最新の概要を返します。

Get-ASATrustedAdvisorCheckSummary -CheckId @("checkid1", "checkid2")

次の例は、New-ASACase を使用する方法を説明しています。

のツール PowerShell

例 1: AWS サポートセンターで新しいケースを作成します。- ServiceCode パラメータと - CategoryCode パラメータの値は、Get-ASAService コマンドレットを使用して取得できます。-SeverityCode parameter の値は、Get-ASA SeverityLevel コマンドレットを使用して取得できます。IssueType パラメータ値は、「customer-service」または「technical」のいずれかです。成功すると、 AWS サポートケース番号が出力されます。デフォルトでは、ケースは英語で処理され、日本語を使用するには -Language "ja" パラメータを追加します。-ServiceCode、-CategoryCode、-Subject、-CommunicationBody parameters は必須です。

New-ASACase -ServiceCode "amazon-cloudfront" -CategoryCode "APIs" -SeverityCode "low" -Subject "subject text" -CommunicationBody "description of the case" -CcEmailAddress @("email1@domain.com", "email2@domain.com") -IssueType "technical"
  • API の詳細については、「 コマンドレットリファレンスCreateCase」の「」を参照してください。 AWS Tools for PowerShell

次の例は、Request-ASATrustedAdvisorCheckRefresh を使用する方法を説明しています。

のツール PowerShell

例 1: 指定された Trusted Advisor チェックの更新をリクエストします。

Request-ASATrustedAdvisorCheckRefresh -CheckId "checkid1"
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスRefreshTrustedAdvisorCheck」の「」を参照してください。

次の例は、Resolve-ASACase を使用する方法を説明しています。

のツール PowerShell

例 1: 指定されたケースの初期状態と、解決の呼び出しが完了した後の現在の状態を返します。

Resolve-ASACase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
  • API の詳細については、「 コマンドレットリファレンスResolveCase」の「」を参照してください。 AWS Tools for PowerShell