Class: Aws::SQS::Queue

Inherits:
Object
  • Object
show all
Defined in:
aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb

Queue Attributes collapse

Instance Method Details

#approximate_number_of_messagesInteger

Returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

Returns:


59
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 59

queue_int_attr :approximate_number_of_messages

#approximate_number_of_messages_delayedInteger

Returns the approximate number of messages that are pending to be added to the queue.

Returns:

  • (Integer)

    returns the approximate number of messages that are pending to be added to the queue.


82
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 82

queue_int_attr :approximate_number_of_messages_delayed

#approximate_number_of_messages_not_visibleInteger

Returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

Returns:

  • (Integer)

    returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.


63
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 63

queue_int_attr :approximate_number_of_messages_not_visible

#arnString Also known as: queue_arn

Returns the queue's Amazon resource name (ARN).

Returns:

  • (String)

    the queue's Amazon resource name (ARN).


75
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 75

queue_str_attr :arn, name: 'QueueArn'

#created_timestampTime

Returns the time when the queue was created.

Returns:

  • (Time)

    the time when the queue was created.


67
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 67

queue_time_attr :created_timestamp

#delay_secondsInteger

Returns the default delay on the queue in seconds.

Returns:

  • (Integer)

    the default delay on the queue in seconds.


86
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 86

queue_int_attr :delay_seconds

#last_modified_timestampTime

Returns the time when the queue was last changed.

Returns:

  • (Time)

    the time when the queue was last changed.


71
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 71

queue_time_attr :last_modified_timestamp

#maximum_message_sizeInteger

Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

Returns:

  • (Integer)

    the limit of how many bytes a message can contain before Amazon SQS rejects it.


50
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 50

queue_int_attr :maximum_message_size

#message_retention_periodInteger

Returns the number of seconds Amazon SQS retains a message.

Returns:

  • (Integer)

    the number of seconds Amazon SQS retains a message.


54
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 54

queue_int_attr :message_retention_period

#policyString

Returns the queue's policy.

Returns:

  • (String)

    the queue's policy.


41
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 41

queue_str_attr :policy

#receive_message_wait_time_secondsInteger

Returns the time for which a Client#receive_message call will wait for a message to arrive.

Returns:

  • (Integer)

    the time for which a Client#receive_message call will wait for a message to arrive.


91
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 91

queue_int_attr :receive_message_wait_time_seconds

#redrive_policyString

Returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

Returns:

  • (String)

    the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.


98
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 98

queue_str_attr :redrive_policy

#visibility_timeoutInteger

Returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

Returns:

  • (Integer)

    the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.


45
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/sqs/queue.rb', line 45

queue_int_attr :visibility_timeout