Data.Cloud.AmazonAPI.TAmazonQueueService

• Up to Parent: Data.Cloud.AmazonAPI
• Methods
• Properties
• Fields
• Types

[–] Properties Type: class Visibility: public Source:

Data.Cloud.AmazonAPI.pas

Data.Cloud.AmazonAPI.hpp

Unit: Data.Cloud.AmazonAPI Parent: Data.Cloud.AmazonAPI

Delphi

TAmazonQueueService = class(TAmazonBasicService)

C++

class PASCALIMPLEMENTATION TAmazonQueueService : public TAmazonBasicService

Description

Allows you to connect to the Amazon Simple Queue Service (SQS).

This class provides methods that you can use to:

• Manage queues:
  • Create or delete a queue.
  • List existing queues.
  • Add or remove queue permissions.
  • Get or set the properties of a queue.
• Manage messages:
  • Add a message to a queue.
  • Delete a single message from a queue or delete all messages in a queue.
  • Modify the visibility of a message.
  • Get or peek at messages.
  • Find out the maximum number of messages that you can retrieve from a queue.

Additionally, TAmazonQueueService provides some methods that return the response in an XML-parsed format:

• ListQueuesXML
• GetMessagesXML
• GetQueuePropertiesXML

For more information about the Amazon Simple Queue Service (SQS) API, see the official Amazon Simple Queue Service Documentation.

The following code snippet demonstrates how to create a new queue using the TAmazonQueueService class:

Delphi:

var
  ResponseInfo: TCloudResponseInfo;
  QueueURL: String;
  QueueService: TAmazonQueueService;
begin
  QueueService := TAmazonQueueService.Create(AmazonConnectionInfo1);
  ResponseInfo := TCloudResponseInfo.Create;
  try 
    if QueueService.CreateQueue('QueueName', QueueURL, -1, ResponseInfo) then
      Memo1.Lines.Append('Success! QueueURL: ' + QueueURL);
    else
      Memo1.Lines.Append(Format('Failure! %s', [ResponseInfo.StatusMessage]));
  finally
    QueueService.Free;
    ResponseInfo.Free;
  end;
end;

C++:

TCloudResponseInfo *ResponseInfo;
String QueueURL;
TAmazonQueueService *QueueService;
QueueService = new TAmazonQueueService(AmazonConnectionInfo1);
ResponseInfo = new TCloudResponseInfo;
try
{
    if (QueueService->CreateQueue("testqueue", QueueURL, -1, ResponseInfo))
    {
        Memo1->Lines->Append("Success! QueueURL: " + QueueURL);
    }
    else
    {
        TVarRec args[1] = {ResponseInfo->StatusMessage};
        Memo1->Lines->Append(Format("Failure! %s", args, 0));
    }
}
__finally
{
    delete QueueService;
    delete ResponseInfo;
}

See Also

• Connecting to a Non-Default Region

• Data.Cloud.AmazonAPI.TAmazonStorageService
• Data.Cloud.AmazonAPI.TAmazonTableService

• Data.Cloud.AmazonAPI.TAmazonConnectionInfo

• Amazon Simple Queue Service Documentation