Prev		Next

AddGrant (SOAP)

The AddGrant operation gives the specified user permission to access the queue specified.

Validation

AddGrant requests are validated on the following:

The specified queue must exist.

Returns

Returns Success if the action succeeded or an error response if unsuccessful.

Request Parameters

Name	Description	Type	Value
`QueueName`	Specifies the queue the grant is applied to.	Required. The name of the queue, as specified when the queue was created.	MyQueue
`Grantee.EmailAddress`	The email address of the user receiving the grant.	Required. String.	email_alias@server_domain.com
`Permission`	The grant, or permission, to add for the grantee. See Access Control Overview for a list of available grants.	String.	`ReceiveMessage`

Sample AddGrant Request (SOAP)

The following sample demonstrates adding a ReceiveMessage grant for the specified queue.

Sample Request

<soapenv:Body>
  <ac:AddGrant xmlns:ac="http://access.amazonaws.com/doc/2006-01-01/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ac:Request>
      <ac:Grantee xsi:type="ac:AmazonCustomerByEmail">
        <ac:EmailAddress>chriscustomer@email.com</ac:EmailAddress>
      </ac:Grantee>
      <ac:Permission>ReceiveMessage</ac:Permission>
    </ac:Request>
  </ac:AddGrant>
</soapenv:Body>

Sample Response

<soapenv:Body>
  <ac:AddGrantResponse xmlns:ac="http://queue.amazonaws.com/doc/2006-04-01/">
    <ac:Response>
      <ac:ResponseStatus>
        <ac:StatusCode>SUCCESS</ac:StatusCode>
        <ac:StatusMessage/>
      </ac:ResponseStatus>
    </ac:Response>
  </ac:AddGrantResponse>
</soapenv:Body>