Struct aws_sdk_sqs::client::fluent_builders::AddPermission

pub struct AddPermission { /* private fields */ }

Fluent builder constructing a request to AddPermission.

Adds a permission to a queue for a specific principal. This allows sharing access to the queue.

When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.

• AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon SQS Developer Guide.

• An Amazon SQS policy can have a maximum of 7 actions.

• To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&AttributeName.1=first

&AttributeName.2=second

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Implementations

impl AddPermission

pub async fn customize(
    self
) -> Result<CustomizableOperation<AddPermission, AwsResponseRetryClassifier>, SdkError<AddPermissionError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<AddPermissionOutput, SdkError<AddPermissionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn queue_url(self, input: impl Into<String>) -> Self

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

pub fn set_queue_url(self, input: Option<String>) -> Self

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

pub fn label(self, input: impl Into<String>) -> Self

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

pub fn set_label(self, input: Option<String>) -> Self

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

pub fn aws_account_ids(self, input: impl Into<String>) -> Self

Appends an item to AWSAccountIds.

To override the contents of this collection use set_aws_account_ids.

The Amazon Web Services account numbers of the principals who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

pub fn set_aws_account_ids(self, input: Option<Vec<String>>) -> Self

The Amazon Web Services account numbers of the principals who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

pub fn actions(self, input: impl Into<String>) -> Self

Appends an item to Actions.

To override the contents of this collection use set_actions.

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

pub fn set_actions(self, input: Option<Vec<String>>) -> Self

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Trait Implementations

impl Clone for AddPermission

fn clone(&self) -> AddPermission

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AddPermission

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.