のバージョン 5 (V5) AWS Tools for PowerShell がリリースされました。 重要な変更とアプリケーションの移行については、[「移行トピック](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html)」を参照してください。 [https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html) 翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # Tools for PowerShell V5 を使用した Amazon SQS の例 次のコード例は、Amazon SQS で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `Add-SQSPermission` 次のコード例は、`Add-SQSPermission` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定された が指定されたキューからメッセージを送信 AWS アカウント することを許可します。** ``` Add-SQSPermission -Action SendMessage -AWSAccountId 80398EXAMPLE -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AddPermission](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Clear-SQSQueue` 次のコード例は、`Clear-SQSQueue` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定したキューからすべてのメッセージを削除します。** ``` Clear-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PurgeQueue](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Edit-SQSMessageVisibility` 次のコード例は、`Edit-SQSMessageVisibility` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定したキュー内の指定した受信ハンドルを持つメッセージの可視性タイムアウトを 10 時間 (10 時間 × 60 分 × 60 秒 = 36,000 秒) に変更します。** ``` Edit-SQSMessageVisibility -QueueUrl https://sqs.us-east-1.amazonaws.com/8039EXAMPLE/MyQueue -ReceiptHandle AQEBgGDh...J/Iqww== -VisibilityTimeout 36000 ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ChangeMessageVisibility](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Edit-SQSMessageVisibilityBatch` 次のコード例は、`Edit-SQSMessageVisibilityBatch` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定したキュー内の指定した受信ハンドルを持つ 2 つのメッセージの可視性タイムアウトを変更します。最初のメッセージの可視性タイムアウトを 10 時間 (10 時間 × 60 分 × 60 秒 = 36,000 秒) に変更します。2 番目のメッセージの可視性タイムアウトを 5 時間 (5 時間 × 60 分 × 60 秒 = 18,000 秒) に変更します。** ``` $changeVisibilityRequest1 = New-Object Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry $changeVisibilityRequest1.Id = "Request1" $changeVisibilityRequest1.ReceiptHandle = "AQEBd329...v6gl8Q==" $changeVisibilityRequest1.VisibilityTimeout = 36000 $changeVisibilityRequest2 = New-Object Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry $changeVisibilityRequest2.Id = "Request2" $changeVisibilityRequest2.ReceiptHandle = "AQEBgGDh...J/Iqww==" $changeVisibilityRequest2.VisibilityTimeout = 18000 Edit-SQSMessageVisibilityBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $changeVisibilityRequest1, $changeVisibilityRequest2 ``` **出力:** ``` Failed Successful ------ ---------- {} {Request2, Request1} ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ChangeMessageVisibilityBatch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Get-SQSDeadLetterSourceQueue` 次のコード例は、`Get-SQSDeadLetterSourceQueue` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、デッドレターキューとして指定したキューに依存するすべてのキューの URL を一覧表示します。** ``` Get-SQSDeadLetterSourceQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue ``` **出力:** ``` https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListDeadLetterSourceQueues](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Get-SQSQueue` 次のコード例は、`Get-SQSQueue` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、すべてのキューを一覧表示します。** ``` Get-SQSQueue ``` **出力:** ``` https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/AnotherQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/DeadLetterQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue ``` **例 2: この例では、指定した名前で始まるすべてのキューを一覧表示します。** ``` Get-SQSQueue -QueueNamePrefix My ``` **出力:** ``` https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListQueues](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Get-SQSQueueAttribute` 次のコード例は、`Get-SQSQueueAttribute` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定したキューのすべての属性を一覧表示します。** ``` Get-SQSQueueAttribute -AttributeName All -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` **出力:** ``` VisibilityTimeout : 30 DelaySeconds : 0 MaximumMessageSize : 262144 MessageRetentionPeriod : 345600 ApproximateNumberOfMessages : 0 ApproximateNumberOfMessagesNotVisible : 0 ApproximateNumberOfMessagesDelayed : 0 CreatedTimestamp : 2/11/2015 5:53:35 PM LastModifiedTimestamp : 12/29/2015 2:23:17 PM QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue Policy : {"Version":"2012-10-17", "Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14 495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80 398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid": "SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":" arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]} Attributes : {[QueueArn, arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue], [ApproximateNumberOfMessages, 0], [ApproximateNumberOfMessagesNotVisible, 0], [ApproximateNumberOfMessagesDelayed, 0]...} ``` **例 2: この例では、指定したキューの指定した属性のみを別個に一覧表示します。** ``` Get-SQSQueueAttribute -AttributeName MaximumMessageSize, VisibilityTimeout -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` **出力:** ``` VisibilityTimeout : 30 DelaySeconds : 0 MaximumMessageSize : 262144 MessageRetentionPeriod : 345600 ApproximateNumberOfMessages : 0 ApproximateNumberOfMessagesNotVisible : 0 ApproximateNumberOfMessagesDelayed : 0 CreatedTimestamp : 2/11/2015 5:53:35 PM LastModifiedTimestamp : 12/29/2015 2:23:17 PM QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue Policy : {"Version":"2012-10-17", "Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14 495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80 398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid": "SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":" arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]} Attributes : {[MaximumMessageSize, 262144], [VisibilityTimeout, 30]} ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetQueueAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Get-SQSQueueUrl` 次のコード例は、`Get-SQSQueueUrl` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定した名前のキューの URL を表示します。** ``` Get-SQSQueueUrl -QueueName MyQueue ``` **出力:** ``` https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetQueueUrl](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `New-SQSQueue` 次のコード例は、`New-SQSQueue` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定した名前でキューを作成します。** ``` New-SQSQueue -QueueName MyQueue ``` **出力:** ``` https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateQueue](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Receive-SQSMessage` 次のコード例は、`Receive-SQSMessage` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定したキューで次に受信する 10 件までのメッセージに関する情報を表示します。情報には、指定したメッセージ属性 (存在する場合) の値が含まれます。** ``` Receive-SQSMessage -AttributeName SenderId, SentTimestamp -MessageAttributeName StudentName, StudentGrade -MessageCount 10 -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` **出力:** ``` Attributes : {[SenderId, AIDAIAZKMSNQ7TEXAMPLE], [SentTimestamp, 1451495923744]} Body : Information about John Doe's grade. MD5OfBody : ea572796e3c231f974fe75d89EXAMPLE MD5OfMessageAttributes : 48c1ee811f0fe7c4e88fbe0f5EXAMPLE MessageAttributes : {[StudentGrade, Amazon.SQS.Model.MessageAttributeValue], [StudentName, Amazon.SQS.Model.MessageAttributeValue]} MessageId : 53828c4b-631b-469b-8833-c093cEXAMPLE ReceiptHandle : AQEBpfGp...20Q5cg== ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ReceiveMessage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Remove-SQSMessage` 次のコード例は、`Remove-SQSMessage` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定した受信ハンドルを持つメッセージを指定したキューから削除します。** ``` Remove-SQSMessage -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -ReceiptHandle AQEBd329...v6gl8Q== ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteMessage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Remove-SQSMessageBatch` 次のコード例は、`Remove-SQSMessageBatch` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定した受信ハンドルを持つ 2 つのメッセージを指定したキューから削除します。** ``` $deleteMessageRequest1 = New-Object Amazon.SQS.Model.DeleteMessageBatchRequestEntry $deleteMessageRequest1.Id = "Request1" $deleteMessageRequest1.ReceiptHandle = "AQEBX2g4...wtJSQg==" $deleteMessageRequest2 = New-Object Amazon.SQS.Model.DeleteMessageBatchRequestEntry $deleteMessageRequest2.Id = "Request2" $deleteMessageRequest2.ReceiptHandle = "AQEBqOVY...KTsLYg==" Remove-SQSMessageBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $deleteMessageRequest1, $deleteMessageRequest2 ``` **出力:** ``` Failed Successful ------ ---------- {} {Request1, Request2} ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteMessageBatch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Remove-SQSPermission` 次のコード例は、`Remove-SQSPermission` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定したラベルを持つアクセス許可設定を、指定したキューから削除します。** ``` Remove-SQSPermission -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RemovePermission](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Remove-SQSQueue` 次のコード例は、`Remove-SQSQueue` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: こので例は、指定したキューを削除します。** ``` Remove-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteQueue](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Send-SQSMessage` 次のコード例は、`Send-SQSMessage` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定した属性とメッセージ本文を持つメッセージを指定したキューに送信し、メッセージの配信を 10 秒遅延させます。** ``` $cityAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $cityAttributeValue.DataType = "String" $cityAttributeValue.StringValue = "AnyCity" $populationAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $populationAttributeValue.DataType = "Number" $populationAttributeValue.StringValue = "1250800" $messageAttributes = New-Object System.Collections.Hashtable $messageAttributes.Add("City", $cityAttributeValue) $messageAttributes.Add("Population", $populationAttributeValue) Send-SQSMessage -DelayInSeconds 10 -MessageAttributes $messageAttributes -MessageBody "Information about the largest city in Any Region." -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` **出力:** ``` MD5OfMessageAttributes MD5OfMessageBody MessageId ---------------------- ---------------- --------- 1d3e51347bc042efbdf6dda31EXAMPLE 51b0a3256d59467f973009b73EXAMPLE c35fed8f-c739-4d0c-818b-1820eEXAMPLE ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SendMessage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。** ### `Send-SQSMessageBatch` 次のコード例は、`Send-SQSMessageBatch` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、指定した属性とメッセージ本文を持つ 2 つのメッセージを指定したキューに送信します。最初のメッセージでは配信を 15 秒遅延させ、2 番目のメッセージでは配信を 10 秒遅延させます。** ``` $student1NameAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $student1NameAttributeValue.DataType = "String" $student1NameAttributeValue.StringValue = "John Doe" $student1GradeAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $student1GradeAttributeValue.DataType = "Number" $student1GradeAttributeValue.StringValue = "89" $student2NameAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $student2NameAttributeValue.DataType = "String" $student2NameAttributeValue.StringValue = "Jane Doe" $student2GradeAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $student2GradeAttributeValue.DataType = "Number" $student2GradeAttributeValue.StringValue = "93" $message1 = New-Object Amazon.SQS.Model.SendMessageBatchRequestEntry $message1.DelaySeconds = 15 $message1.Id = "FirstMessage" $message1.MessageAttributes.Add("StudentName", $student1NameAttributeValue) $message1.MessageAttributes.Add("StudentGrade", $student1GradeAttributeValue) $message1.MessageBody = "Information about John Doe's grade." $message2 = New-Object Amazon.SQS.Model.SendMessageBatchRequestEntry $message2.DelaySeconds = 10 $message2.Id = "SecondMessage" $message2.MessageAttributes.Add("StudentName", $student2NameAttributeValue) $message2.MessageAttributes.Add("StudentGrade", $student2GradeAttributeValue) $message2.MessageBody = "Information about Jane Doe's grade." Send-SQSMessageBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $message1, $message2 ``` **出力:** ``` Failed Successful ------ ---------- {} {FirstMessage, SecondMessage} ``` + API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SendMessageBatch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Set-SQSQueueAttribute` 次のコード例は、`Set-SQSQueueAttribute` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: この例では、キューを SNS トピックにサブスクライブするポリシーを設定する方法を示します。メッセージをトピックに発行すると、メッセージはサブスクライブしたキューに送信されます。** ``` # create the queue and topic to be associated $qurl = New-SQSQueue -QueueName "myQueue" $topicarn = New-SNSTopic -Name "myTopic" # get the queue ARN to inject into the policy; it will be returned # in the output's QueueARN member but we need to put it into a variable # so text expansion in the policy string takes effect $qarn = (Get-SQSQueueAttribute -QueueUrl $qurl -AttributeName "QueueArn").QueueARN # construct the policy and inject arns $policy = @" { "Version":"2012-10-17", "Id": "$qarn/SQSPOLICY", "Statement": [ { "Sid": "1", "Effect": "Allow", "Principal": "*", "Action": "SQS:SendMessage", "Resource": "$qarn", "Condition": { "ArnEquals": { "aws:SourceArn": "$topicarn" } } } ] } "@ # set the policy Set-SQSQueueAttribute -QueueUrl $qurl -Attribute @{ Policy=$policy } ``` **例 2: この例では、指定したキューに指定した属性を設定します。** ``` Set-SQSQueueAttribute -Attribute @{"DelaySeconds" = "10"; "MaximumMessageSize" = "131072"} -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ``` + API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[SetQueueAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。