Doc AWS SDK ExamplesWord リポジトリには、さらに多くの GitHub の例があります。 AWS SDK
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Tools forSQS を使用した Amazon PowerShell の例
次のコード例は、Amazon SQS AWS Tools for PowerShell で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。
トピック
アクション
次の例は、Add-SQSPermission を使用する方法を説明しています。
- ツール for PowerShell
-
例 1: この例では AWS アカウント 、指定された が指定されたキューからメッセージを送信することを許可します。
Add-SQSPermission -Action SendMessage -AWSAccountId 80398EXAMPLE -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue-
APIの詳細については、「コマンドレットリファレンス」のAddPermission」を参照してください。 AWS Tools for PowerShell
-
次の例は、Clear-SQSQueue を使用する方法を説明しています。
- ツール for PowerShell
-
例 1: この例では、指定されたキューからすべてのメッセージを削除します。
Clear-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue-
APIの詳細については、「コマンドレットリファレンス」のPurgeQueue」を参照してください。 AWS Tools for PowerShell
-
次の例は、Edit-SQSMessageVisibility を使用する方法を説明しています。
- ツール for PowerShell
-
例 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 「コマンドレットリファレンス」のChangeMessageVisibility」を参照してください。
-
次のコード例は、Edit-SQSMessageVisibilityBatch を使用する方法を示しています。
- ツール for PowerShell
-
例 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 「コマンドレットリファレンス」のChangeMessageVisibilityBatch」を参照してください。
-
次のコード例は、Get-SQSDeadLetterSourceQueue を使用する方法を示しています。
- ツール for PowerShell
-
例 1: この例では、指定されたキューに依存するキューの URLs をデッドレターキューとして一覧表示します。
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 「コマンドレットリファレンス」のListDeadLetterSourceQueues」を参照してください。
-
次のコード例は、Get-SQSQueue を使用する方法を示しています。
- ツール for PowerShell
-
例 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 の詳細については、「コマンドレットリファレンス」のListQueues」を参照してください。 AWS Tools for PowerShell
-
次の例は、Get-SQSQueueAttribute を使用する方法を説明しています。
- ツール for PowerShell
-
例 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":"2008-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":"2008-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の詳細については、「コマンドレットリファレンス」のGetQueueAttributes」を参照してください。 AWS Tools for PowerShell
-
次の例は、Get-SQSQueueUrl を使用する方法を説明しています。
- ツール for PowerShell
-
例 1: この例では、指定された名前のキューの URL を一覧表示します。
Get-SQSQueueUrl -QueueName MyQueue出力:
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue-
APIの詳細については、「コマンドレットリファレンス」のGetQueueUrl」を参照してください。 AWS Tools for PowerShell
-
次のコード例は、New-SQSQueue を使用する方法を示しています。
- ツール for PowerShell
-
例 1: この例では、指定された名前のキューを作成します。
New-SQSQueue -QueueName MyQueue出力:
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue-
API の詳細については、「コマンドレットリファレンス」のCreateQueue」を参照してください。 AWS Tools for PowerShell
-
次のコード例は、Receive-SQSMessage を使用する方法を示しています。
- ツール for PowerShell
-
例 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 の詳細については、「コマンドレットリファレンス」のReceiveMessage」を参照してください。 AWS Tools for PowerShell
-
次のコード例は、Remove-SQSMessage を使用する方法を示しています。
- ツール for PowerShell
-
例 1: この例では、指定された受信ハンドルを持つメッセージを指定されたキューから削除します。
Remove-SQSMessage -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -ReceiptHandle AQEBd329...v6gl8Q==-
APIの詳細については、「コマンドレットリファレンス」のDeleteMessage」を参照してください。 AWS Tools for PowerShell
-
次の例は、Remove-SQSMessageBatch を使用する方法を説明しています。
- ツール for PowerShell
-
例 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の詳細については、「コマンドレットリファレンス」のDeleteMessageBatch」を参照してください。 AWS Tools for PowerShell
-
次の例は、Remove-SQSPermission を使用する方法を説明しています。
- ツール for PowerShell
-
例 1: この例では、指定したラベルを持つアクセス許可設定を指定したキューから削除します。
Remove-SQSPermission -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue-
API の詳細については、「コマンドレットリファレンス」のRemovePermission」を参照してください。 AWS Tools for PowerShell
-
次の例は、Remove-SQSQueue を使用する方法を説明しています。
- ツール for PowerShell
-
例 1: この例では、指定されたキューを削除します。
Remove-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue-
API の詳細については、「コマンドレットリファレンス」のDeleteQueue」を参照してください。 AWS Tools for PowerShell
-
次のコード例は、Send-SQSMessage を使用する方法を示しています。
- ツール for PowerShell
-
例 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 の詳細については、「コマンドレットリファレンス」のSendMessage」を参照してください。 AWS Tools for PowerShell
-
次の例は、Send-SQSMessageBatch を使用する方法を説明しています。
- ツール for PowerShell
-
例 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 の詳細については、「コマンドレットリファレンス」のSendMessageBatch」を参照してください。 AWS Tools for PowerShell
-
次のコード例は、Set-SQSQueueAttribute を使用する方法を示しています。
- ツール for PowerShell
-
例 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": "2008-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 の詳細については、「コマンドレットリファレンス」のSetQueueAttributes」を参照してください。 AWS Tools for PowerShell
-
