第 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 範例 下列程式碼範例示範如何使用 AWS Tools for PowerShell V5 搭配 Amazon SQS 來執行動作和實作常見案例。 *Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。 每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。 **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 Cmdlet 參考 (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 Cmdlet 參考 (V5)》**中的 [PurgeQueue](https://docs.aws.amazon.com/powershell/v5/reference)。 ### `Edit-SQSMessageVisibility` 以下程式碼範例顯示如何使用 `Edit-SQSMessageVisibility`。 **Tools for PowerShell V5** **範例 1：此範例會將指定佇列中具有指定接收控點的訊息可見性逾時，變更為 10 小時 (10 小時 \$1 60 分鐘 \$1 60 秒 = 36000 秒)。** ``` Edit-SQSMessageVisibility -QueueUrl https://sqs.us-east-1.amazonaws.com/8039EXAMPLE/MyQueue -ReceiptHandle AQEBgGDh...J/Iqww== -VisibilityTimeout 36000 ``` + 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ChangeMessageVisibility](https://docs.aws.amazon.com/powershell/v5/reference)。 ### `Edit-SQSMessageVisibilityBatch` 以下程式碼範例顯示如何使用 `Edit-SQSMessageVisibilityBatch`。 **Tools for PowerShell V5** **範例 1：此範例會變更在指定佇列中，具有指定接收控點的 2 則訊息的可見性逾時。第一則訊息的可見性逾時變更為 10 小時 (10 小時 \$1 60 分鐘 \$1 60 秒 = 36000 秒)。第二則訊息的可見性逾時變更為 5 小時 (5 小時 \$1 60 分鐘 \$1 60 秒 = 18000 秒)。** ``` $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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (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 Cmdlet 參考 (V5)》**中的 [SendMessage](https://docs.aws.amazon.com/powershell/v5/reference)。 ### `Send-SQSMessageBatch` 以下程式碼範例顯示如何使用 `Send-SQSMessageBatch`。 **Tools for PowerShell V5** **範例 1：此範例會將 2 則具有指定屬性和訊息內文的訊息，傳送至指定的佇列。第一則訊息的傳遞延遲 15 秒，第二則訊息延遲 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 Cmdlet 參考 (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 Cmdlet 參考 (V5)》**中的 [SetQueueAttributes](https://docs.aws.amazon.com/powershell/v5/reference)。