aws-sdk-sqs 1.5.0 → 1.80.0

data/sig/queue.rbs

@@ -0,0 +1,164 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module SQS
+    # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html
+    class Queue
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#initialize-instance_method
+      def initialize: (String url, Hash[Symbol, untyped] options) -> void
+                    | (url: String, ?client: Client) -> void
+                    | (Hash[Symbol, untyped] args) -> void
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#url-instance_method
+      def url: () -> String
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#attributes-instance_method
+      def attributes: () -> ::Hash[("All" | "Policy" | "VisibilityTimeout" | "MaximumMessageSize" | "MessageRetentionPeriod" | "ApproximateNumberOfMessages" | "ApproximateNumberOfMessagesNotVisible" | "CreatedTimestamp" | "LastModifiedTimestamp" | "QueueArn" | "ApproximateNumberOfMessagesDelayed" | "DelaySeconds" | "ReceiveMessageWaitTimeSeconds" | "RedrivePolicy" | "FifoQueue" | "ContentBasedDeduplication" | "KmsMasterKeyId" | "KmsDataKeyReusePeriodSeconds" | "DeduplicationScope" | "FifoThroughputLimit" | "RedriveAllowPolicy" | "SqsManagedSseEnabled"), ::String]
+
+      def client: () -> Client
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#load-instance_method
+      def load: () -> self
+      alias reload load
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#data-instance_method
+      def data: () -> Types::GetQueueAttributesResult
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#data_loaded?-instance_method
+      def data_loaded?: () -> bool
+
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#add_permission-instance_method
+      def add_permission: (
+                            label: ::String,
+                            aws_account_ids: Array[::String],
+                            actions: Array[::String]
+                          ) -> ::Aws::EmptyStructure
+                        | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#change_message_visibility_batch-instance_method
+      def change_message_visibility_batch: (
+                                             entries: Array[
+                                               {
+                                                 id: ::String,
+                                                 receipt_handle: ::String,
+                                                 visibility_timeout: ::Integer?
+                                               },
+                                             ]
+                                           ) -> Types::ChangeMessageVisibilityBatchResult
+                                         | (?Hash[Symbol, untyped]) -> Types::ChangeMessageVisibilityBatchResult
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#delete-instance_method
+      def delete: (
+                  ) -> ::Aws::EmptyStructure
+                | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#delete_messages-instance_method
+      def delete_messages: (
+                             entries: Array[
+                               {
+                                 id: ::String,
+                                 receipt_handle: ::String
+                               },
+                             ]
+                           ) -> Types::DeleteMessageBatchResult
+                         | (?Hash[Symbol, untyped]) -> Types::DeleteMessageBatchResult
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#purge-instance_method
+      def purge: (
+                 ) -> ::Aws::EmptyStructure
+               | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#receive_messages-instance_method
+      def receive_messages: (
+                              ?attribute_names: Array[("All" | "Policy" | "VisibilityTimeout" | "MaximumMessageSize" | "MessageRetentionPeriod" | "ApproximateNumberOfMessages" | "ApproximateNumberOfMessagesNotVisible" | "CreatedTimestamp" | "LastModifiedTimestamp" | "QueueArn" | "ApproximateNumberOfMessagesDelayed" | "DelaySeconds" | "ReceiveMessageWaitTimeSeconds" | "RedrivePolicy" | "FifoQueue" | "ContentBasedDeduplication" | "KmsMasterKeyId" | "KmsDataKeyReusePeriodSeconds" | "DeduplicationScope" | "FifoThroughputLimit" | "RedriveAllowPolicy" | "SqsManagedSseEnabled")],
+                              ?message_system_attribute_names: Array[("All" | "SenderId" | "SentTimestamp" | "ApproximateReceiveCount" | "ApproximateFirstReceiveTimestamp" | "SequenceNumber" | "MessageDeduplicationId" | "MessageGroupId" | "AWSTraceHeader" | "DeadLetterQueueSourceArn")],
+                              ?message_attribute_names: Array[::String],
+                              ?max_number_of_messages: ::Integer,
+                              ?visibility_timeout: ::Integer,
+                              ?wait_time_seconds: ::Integer,
+                              ?receive_request_attempt_id: ::String
+                            ) -> Message::Collection
+                          | (?Hash[Symbol, untyped]) -> Message::Collection
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#remove_permission-instance_method
+      def remove_permission: (
+                               label: ::String
+                             ) -> ::Aws::EmptyStructure
+                           | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#send_message-instance_method
+      def send_message: (
+                          message_body: ::String,
+                          ?delay_seconds: ::Integer,
+                          ?message_attributes: Hash[::String, {
+                              string_value: ::String?,
+                              binary_value: ::String?,
+                              string_list_values: Array[::String]?,
+                              binary_list_values: Array[::String]?,
+                              data_type: ::String
+                            }],
+                          ?message_system_attributes: Hash[("AWSTraceHeader"), {
+                              string_value: ::String?,
+                              binary_value: ::String?,
+                              string_list_values: Array[::String]?,
+                              binary_list_values: Array[::String]?,
+                              data_type: ::String
+                            }],
+                          ?message_deduplication_id: ::String,
+                          ?message_group_id: ::String
+                        ) -> Types::SendMessageResult
+                      | (?Hash[Symbol, untyped]) -> Types::SendMessageResult
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#send_messages-instance_method
+      def send_messages: (
+                           entries: Array[
+                             {
+                               id: ::String,
+                               message_body: ::String,
+                               delay_seconds: ::Integer?,
+                               message_attributes: Hash[::String, {
+                                   string_value: ::String?,
+                                   binary_value: ::String?,
+                                   string_list_values: Array[::String]?,
+                                   binary_list_values: Array[::String]?,
+                                   data_type: ::String
+                                 }]?,
+                               message_system_attributes: Hash[("AWSTraceHeader"), {
+                                   string_value: ::String?,
+                                   binary_value: ::String?,
+                                   string_list_values: Array[::String]?,
+                                   binary_list_values: Array[::String]?,
+                                   data_type: ::String
+                                 }]?,
+                               message_deduplication_id: ::String?,
+                               message_group_id: ::String?
+                             },
+                           ]
+                         ) -> Types::SendMessageBatchResult
+                       | (?Hash[Symbol, untyped]) -> Types::SendMessageBatchResult
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#set_attributes-instance_method
+      def set_attributes: (
+                            attributes: Hash[("All" | "Policy" | "VisibilityTimeout" | "MaximumMessageSize" | "MessageRetentionPeriod" | "ApproximateNumberOfMessages" | "ApproximateNumberOfMessagesNotVisible" | "CreatedTimestamp" | "LastModifiedTimestamp" | "QueueArn" | "ApproximateNumberOfMessagesDelayed" | "DelaySeconds" | "ReceiveMessageWaitTimeSeconds" | "RedrivePolicy" | "FifoQueue" | "ContentBasedDeduplication" | "KmsMasterKeyId" | "KmsDataKeyReusePeriodSeconds" | "DeduplicationScope" | "FifoThroughputLimit" | "RedriveAllowPolicy" | "SqsManagedSseEnabled"), ::String]
+                          ) -> ::Aws::EmptyStructure
+                        | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#dead_letter_source_queues-instance_method
+      def dead_letter_source_queues: (
+                                     ) -> Queue::Collection
+                                   | (?Hash[Symbol, untyped]) -> Queue::Collection
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#message-instance_method
+      def message: (String receipt_handle) -> Message
+
+      class Collection < ::Aws::Resources::Collection[Queue]
+      end
+    end
+  end
+end

data/sig/resource.rbs

@@ -0,0 +1,106 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module SQS
+    # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html
+    class Resource
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#initialize-instance_method
+      def initialize: (
+                        ?client: Client,
+                        ?credentials: untyped,
+                        ?region: String,
+                        ?access_key_id: String,
+                        ?active_endpoint_cache: bool,
+                        ?adaptive_retry_wait_to_fill: bool,
+                        ?client_side_monitoring: bool,
+                        ?client_side_monitoring_client_id: String,
+                        ?client_side_monitoring_host: String,
+                        ?client_side_monitoring_port: Integer,
+                        ?client_side_monitoring_publisher: untyped,
+                        ?convert_params: bool,
+                        ?correct_clock_skew: bool,
+                        ?defaults_mode: String,
+                        ?disable_host_prefix_injection: bool,
+                        ?disable_request_compression: bool,
+                        ?endpoint: String,
+                        ?endpoint_cache_max_entries: Integer,
+                        ?endpoint_cache_max_threads: Integer,
+                        ?endpoint_cache_poll_interval: Integer,
+                        ?endpoint_discovery: bool,
+                        ?ignore_configured_endpoint_urls: bool,
+                        ?log_formatter: untyped,
+                        ?log_level: Symbol,
+                        ?logger: untyped,
+                        ?max_attempts: Integer,
+                        ?profile: String,
+                        ?request_min_compression_size_bytes: Integer,
+                        ?retry_backoff: Proc,
+                        ?retry_base_delay: Float,
+                        ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
+                        ?retry_limit: Integer,
+                        ?retry_max_delay: Integer,
+                        ?retry_mode: ("legacy" | "standard" | "adaptive"),
+                        ?sdk_ua_app_id: String,
+                        ?secret_access_key: String,
+                        ?session_token: String,
+                        ?sigv4a_signing_region_set: Array[String],
+                        ?simple_json: bool,
+                        ?stub_responses: untyped,
+                        ?token_provider: untyped,
+                        ?use_dualstack_endpoint: bool,
+                        ?use_fips_endpoint: bool,
+                        ?validate_params: bool,
+                        ?verify_checksums: bool,
+                        ?endpoint_provider: untyped,
+                        ?http_proxy: String,
+                        ?http_open_timeout: (Float | Integer),
+                        ?http_read_timeout: (Float | Integer),
+                        ?http_idle_timeout: (Float | Integer),
+                        ?http_continue_timeout: (Float | Integer),
+                        ?ssl_timeout: (Float | Integer | nil),
+                        ?http_wire_trace: bool,
+                        ?ssl_verify_peer: bool,
+                        ?ssl_ca_bundle: String,
+                        ?ssl_ca_directory: String,
+                        ?ssl_ca_store: String,
+                        ?on_chunk_received: Proc,
+                        ?on_chunk_sent: Proc,
+                        ?raise_response_errors: bool
+                      ) -> void
+                    | (?Hash[Symbol, untyped]) -> void
+
+      def client: () -> Client
+
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#create_queue-instance_method
+      def create_queue: (
+                          queue_name: ::String,
+                          ?attributes: Hash[("All" | "Policy" | "VisibilityTimeout" | "MaximumMessageSize" | "MessageRetentionPeriod" | "ApproximateNumberOfMessages" | "ApproximateNumberOfMessagesNotVisible" | "CreatedTimestamp" | "LastModifiedTimestamp" | "QueueArn" | "ApproximateNumberOfMessagesDelayed" | "DelaySeconds" | "ReceiveMessageWaitTimeSeconds" | "RedrivePolicy" | "FifoQueue" | "ContentBasedDeduplication" | "KmsMasterKeyId" | "KmsDataKeyReusePeriodSeconds" | "DeduplicationScope" | "FifoThroughputLimit" | "RedriveAllowPolicy" | "SqsManagedSseEnabled"), ::String],
+                          ?tags: Hash[::String, ::String]
+                        ) -> Queue
+                      | (?Hash[Symbol, untyped]) -> Queue
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#get_queue_by_name-instance_method
+      def get_queue_by_name: (
+                               queue_name: ::String,
+                               ?queue_owner_aws_account_id: ::String
+                             ) -> Queue
+                           | (?Hash[Symbol, untyped]) -> Queue
+
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#queue-instance_method
+      def queue: (String url) -> Queue
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#queues-instance_method
+      def queues: (
+                    ?queue_name_prefix: ::String
+                  ) -> Queue::Collection
+                | (?Hash[Symbol, untyped]) -> Queue::Collection
+    end
+  end
+end