AWS Tools for PowerShell バージョン 3.3 からバージョン 4 への移行

AWS Tools for PowerShell バージョン 4 は、AWS Tools for PowerShell バージョン 3.3 への下位互換性のあるアップデートです。既存のコマンドレットの動作を維持しながら、大幅な機能強化を追加します。

既存のスクリプトは、新しいバージョンにアップグレードした後も引き続き動作しますが、本番環境をアップグレードする前に十分にテストすることをお勧めします。

このセクションでは、変更点を示し、これらがスクリプトに与える影響について説明します。

完全モジュール化された新しい AWS.Tools バージョン

AWSPowerShell.NetCore and AWSPowerShell パッケージは「モノリシック」でした。つまり、AWS のすべてのサービスが同一のモジュールでサポートされるため、モジュールサイズが非常に大きく、AWS の新しいサービスや機能が追加されるたびにさらに肥大化します。新しい AWS.Tools パッケージは複数の小さいモジュールに分割されているため、使用する AWS のサービスに必要なモジュールだけをダウンロードしてインストールできます。パッケージには、他のすべてのモジュールと共有される必須の AWS.Tools.Common モジュールと、必要に応じてモジュールのインストール、更新、および削除を簡素化するための AWS.Tools.Installer モジュールが含まれています。

これにより、最初に Import-module を呼び出すことなく、最初の呼び出しでコマンドレットを自動的にインポートできます。ただし、コマンドレットを呼び出す前に、関連付けられた .NET オブジェクトを操作するには、 Import-Moduleを呼び出して、関連する .NET タイプについて PowerShell に通知する必要があります。

たとえば、次のコマンドには Amazon.EC2.Model.Filter への参照があります。このタイプの参照は自動インポートをトリガーできないため、Import-Module を最初に呼び出さないと、コマンドは失敗します。

PS > $filter = [Amazon.EC2.Model.Filter]@{Name="vpc-id";Values="vpc-1234abcd"}
  InvalidOperation: Unable to find type [Amazon.EC2.Model.Filter].

PS > Import-Module AWS.Tools.EC2
PS > $filter = [Amazon.EC2.Model.Filter]@{Name="vpc-id";Values="vpc-1234abcd"}
PS > Get-EC2Instance -Filter $filter -Select Reservations.Instances.InstanceId
  i-0123456789abcdefg
  i-0123456789hijklmn

新しい Get-AWSService コマンドレット

モジュールの AWS.Tools コレクションで AWS のサービス別のモジュールの名前を確認するには、Get-AWSService コマンドレットを使用します。

PS > Get-AWSService
  Service : ACMPCA
  CmdletNounPrefix : PCA
  ModuleName : AWS.Tools.ACMPCA
  SDKAssemblyVersion : 3.3.101.56
  ServiceName : Certificate Manager Private Certificate Authority

  Service : AlexaForBusiness
  CmdletNounPrefix : ALXB
  ModuleName : AWS.Tools.AlexaForBusiness
  SDKAssemblyVersion : 3.3.106.26
  ServiceName : Alexa For Business
  ...

コマンドレットから返されるオブジェクトを制御するための新しい -Select パラメータ

バージョン 4 のほとんどのコマンドレットは、新しい -Select パラメータをサポートしています。各コマンドレットは、AWS SDK for .NET を使用してユーザーに代わって AWS のサービス API を呼び出します。次に、AWS Tools for PowerShellクライアントはレスポンスを PowerShell スクリプトで使用できるオブジェクトに変換し、他のコマンドにパイプします。最終 PowerShell オブジェクトには、元のレスポンスに必要な数よりも多くのフィールドまたはプロパティが含まれていることがあり、また、他の場合は、デフォルトでは含まれていないレスポンスのフィールドまたはプロパティをオブジェクトに含める必要があります。-Select パラメータを使用すると、コマンドレットから返される .NET オブジェクトに含める内容を指定できます。

例えば、Get-S3Object コマンドレットは Amazon S3 SDK オペレーション を呼び出しますListObjects。このオペレーションは ListObjectsResponse オブジェクトを返します。ただし、デフォルトでは、 コマンドレットは SDK Get-S3Object レスポンスの S3Objects要素のみを PowerShell ユーザーに返します。次の例では、そのオブジェクトは 2 つの要素を持つ配列です。

PS > Get-S3Object -BucketName mybucket

ETag : "01234567890123456789012345678901111"
BucketName : mybucket
Key : file1.txt
LastModified : 9/30/2019 1:31:40 PM
Owner : Amazon.S3.Model.Owner
Size : 568
StorageClass : STANDARD

ETag : "01234567890123456789012345678902222"
BucketName : mybucket
Key : file2.txt
LastModified : 7/15/2019 9:36:54 AM
Owner : Amazon.S3.Model.Owner
Size : 392
StorageClass : STANDARD

AWS Tools for PowerShell バージョン 4 では、SDK API コールから返された完全な .NET レスポンスオブジェクトを返すように -Select * を指定できます。

PS > Get-S3Object -BucketName mybucket -Select *
  IsTruncated    : False
  NextMarker     :
  S3Objects      : {file1.txt, file2.txt}
  Name           : mybucket
  Prefix         :
  MaxKeys        : 1000
  CommonPrefixes : {}
  Delimiter      :

特定のネストされたプロパティへのパスを指定することもできます。次の例では、S3Objects 配列内の各要素の Key プロパティのみを返します。

PS > Get-S3Object -BucketName mybucket -Select S3Objects.Key
file1.txt
file2.txt

状況によっては、コマンドレットパラメータを返すと便利です。そのためには、-Select ^ParameterName を使用します。この機能は、-PassThru パラメータに代わるものです。このパラメータはまだ使用可能ですが、非推奨です。

PS > Get-S3Object -BucketName mybucket -Select S3Objects.Key |
>> Write-S3ObjectTagSet -Select ^Key -BucketName mybucket -Tagging_TagSet @{ Key='key'; Value='value'}
  file1.txt
  file2.txt

各コマンドレットの参照トピックは、-Select パラメータをサポートしているかどうかを示します。

より一貫した方法による出力内の項目数の制限

以前のバージョンの AWS Tools for PowerShell では、-MaxItems パラメータを使用して、最終出力で返すオブジェクトの最大数を指定しました。

この動作は AWS.Tools から削除されています。

この動作は AWSPowerShell. NetCore および で廃止され AWSPowerShell、将来のリリースでこれらのバージョンから削除されます。

基になるサービス API が MaxItems パラメータをサポートしている場合は、依然として使用可能であり、API が指定するとおりに機能します。ただし、コマンドレットの出力で返される項目の数を制限する追加動作はなくなりました。

最終出力で返される項目の数を制限するには、出力を Select-Object コマンドレットにパイプし、-First n パラメータを指定します。n は最終出力に含める項目の最大数です。

PS > Get-S3ObjectV2 -BucketName BUCKET_NAME -Select S3Objects.Key | select -first 2
file1.txt
file2.txt

AWS のすべてのサービスで -MaxItems のサポート方法が統一されていたわけではないため、これにより、不整合や予期しない結果が発生しなくなります。また、-MaxItems と新しい -Select パラメータと組み合わせて使用すると、混乱する結果が生じることがあります。

ストリームパラメータの使用の容易化

Stream タイプまたは string タイプのパラメータが、string[]、FileInfo、byte[] の各値を受け入れるようになりました。

次のいずれかの例を使用できます。

PS > Invoke-LMFunction -FunctionName MyTestFunction -PayloadStream '{
>> "some": "json"
>> }'

PS > Invoke-LMFunction -FunctionName MyTestFunction -PayloadStream (ls .\some.json)

PS > Invoke-LMFunction -FunctionName MyTestFunction -PayloadStream @('{', '"some": "json"', '}')

AWS Tools for PowerShell は、UTF-8 エンコーディングを使用してすべての文字列を byte[] に変換します。

プロパティ名によるパイプの拡張

ユーザーエクスペリエンスをより一貫させるために、任意のパラメータにプロパティ名を指定して、パイプライン入力を渡すことができるようになりました。

次の例では、ターゲットコマンドレットのパラメータ名と一致する名前を持つプロパティを持つカスタムオブジェクトを作成します。コマンドレットを実行すると、これらのプロパティが自動的にパラメータとして使用されます。

PS > [pscustomobject] @{ BucketName='myBucket'; Key='file1.txt'; PartNumber=1 } | Get-S3ObjectMetadata

注記

一部のプロパティは、以前のバージョンの AWS Tools for PowerShell でこれをサポートしていました。バージョン 4 では、これをすべてのパラメータで有効にすることで、より一貫させています。

一般的な静的パラメータ

バージョン 4.0 の AWS Tools for PowerShell で整合性を向上させるために、すべてのパラメータは静的になっています。

以前のバージョンの AWS Tools for PowerShell では、AccessKey、SecretKey、ProfileName、Region などの一般的なパラメータの一部は動的であり、その他すべてのパラメータは静的でした。は静的パラメータを動的パラメータの前に PowerShell バインドするため、これにより問題が発生する可能性があります。たとえば、次のコマンドを実行したとします。

PS > Get-EC2Region -Region us-west-2

の以前のバージョンでは、動的パラメータではなく-RegionName静的-Regionパラメータus-west-2に値が PowerShell バインドされています。これも、ユーザーの混乱につながる可能性があります。

AWS.Tools による必須パラメータの宣言と適用

AWS.Tools.* モジュールは、必須のコマンドレットパラメータを宣言して適用するようになりました。AWS サービスが API のパラメータが必要であることを宣言すると、 は、それを指定しなかった場合、対応する コマンドレットパラメータの入力 PowerShell を求めます。これは AWS.Tools にのみ適用されます。下位互換性を確保するために、これは AWSPowerShell.NetCore or には適用されません AWSPowerShell。

すべてのパラメータが NULL を使用可能

値タイプパラメータ (数値と日付) に $null に割り当てることができるようになりました。この変更は、既存のスクリプトには影響しません。これにより、必須パラメータを要求するプロンプトをバイパスできます。必須パラメータは、AWS.Tools でのみ要求されます。

バージョン 4 を使用して次の例を実行すると、各必須パラメータに「値」を指定するため、クライアント側の検証は効果的にバイパスされます。ただし、Amazon EC2 API サービスの呼び出しは失敗します。この AWS のサービスでは、当該情報がまだ必要とされるためです。

PS > Get-EC2InstanceAttribute -InstanceId $null -Attribute $null
WARNING: You are passing $null as a value for parameter Attribute which is marked as required.
In case you believe this parameter was incorrectly marked as required, report this by opening 
an issue at https://github.com/aws/aws-tools-for-powershell/issues.
WARNING: You are passing $null as a value for parameter InstanceId which is marked as required.
In case you believe this parameter was incorrectly marked as required, report this by opening
an issue at https://github.com/aws/aws-tools-for-powershell/issues.

Get-EC2InstanceAttribute : The request must contain the parameter instanceId

以前の非推奨機能の削除

以下は、以前のリリースの AWS Tools for PowerShell で非推奨であった機能であり、バージョン 4 では削除されています。

• Stop-EC2Instance コマンドレットから -Terminate パラメータを削除しました。代わりに Remove-EC2Instance を使用します。

• Clear-AWSCredential cmdlet から -ProfileNameパラメータを削除しました。代わりに Remove-AWSCredentialProfile を使用します。

• Import-EC2Instance コマンドレットと Import-EC2Volume コマンドレットを削除しました。