aws-sdk-sqs 1.63.0 → 1.70.0

Sign up to get free protection for your applications and to get access to all the features.
data/sig/queue.rbs ADDED
@@ -0,0 +1,163 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module SQS
10
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html
11
+ class Queue
12
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#initialize-instance_method
13
+ def initialize: (String url, Hash[Symbol, untyped] options) -> void
14
+ | (url: String, ?client: Client) -> void
15
+ | (Hash[Symbol, untyped] args) -> void
16
+
17
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#url-instance_method
18
+ def url: () -> String
19
+
20
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#attributes-instance_method
21
+ 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]
22
+
23
+ def client: () -> Client
24
+
25
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#load-instance_method
26
+ def load: () -> self
27
+ alias reload load
28
+
29
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#data-instance_method
30
+ def data: () -> Types::GetQueueAttributesResult
31
+
32
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#data_loaded?-instance_method
33
+ def data_loaded?: () -> bool
34
+
35
+
36
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#add_permission-instance_method
37
+ def add_permission: (
38
+ label: ::String,
39
+ aws_account_ids: Array[::String],
40
+ actions: Array[::String]
41
+ ) -> ::Aws::EmptyStructure
42
+ | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
43
+
44
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#change_message_visibility_batch-instance_method
45
+ def change_message_visibility_batch: (
46
+ entries: Array[
47
+ {
48
+ id: ::String,
49
+ receipt_handle: ::String,
50
+ visibility_timeout: ::Integer?
51
+ },
52
+ ]
53
+ ) -> Types::ChangeMessageVisibilityBatchResult
54
+ | (?Hash[Symbol, untyped]) -> Types::ChangeMessageVisibilityBatchResult
55
+
56
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#delete-instance_method
57
+ def delete: (
58
+ ) -> ::Aws::EmptyStructure
59
+ | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
60
+
61
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#delete_messages-instance_method
62
+ def delete_messages: (
63
+ entries: Array[
64
+ {
65
+ id: ::String,
66
+ receipt_handle: ::String
67
+ },
68
+ ]
69
+ ) -> Types::DeleteMessageBatchResult
70
+ | (?Hash[Symbol, untyped]) -> Types::DeleteMessageBatchResult
71
+
72
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#purge-instance_method
73
+ def purge: (
74
+ ) -> ::Aws::EmptyStructure
75
+ | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
76
+
77
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#receive_messages-instance_method
78
+ def receive_messages: (
79
+ ?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")],
80
+ ?message_attribute_names: Array[::String],
81
+ ?max_number_of_messages: ::Integer,
82
+ ?visibility_timeout: ::Integer,
83
+ ?wait_time_seconds: ::Integer,
84
+ ?receive_request_attempt_id: ::String
85
+ ) -> Message::Collection
86
+ | (?Hash[Symbol, untyped]) -> Message::Collection
87
+
88
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#remove_permission-instance_method
89
+ def remove_permission: (
90
+ label: ::String
91
+ ) -> ::Aws::EmptyStructure
92
+ | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
93
+
94
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#send_message-instance_method
95
+ def send_message: (
96
+ message_body: ::String,
97
+ ?delay_seconds: ::Integer,
98
+ ?message_attributes: Hash[::String, {
99
+ string_value: ::String?,
100
+ binary_value: ::String?,
101
+ string_list_values: Array[::String]?,
102
+ binary_list_values: Array[::String]?,
103
+ data_type: ::String
104
+ }],
105
+ ?message_system_attributes: Hash[("AWSTraceHeader"), {
106
+ string_value: ::String?,
107
+ binary_value: ::String?,
108
+ string_list_values: Array[::String]?,
109
+ binary_list_values: Array[::String]?,
110
+ data_type: ::String
111
+ }],
112
+ ?message_deduplication_id: ::String,
113
+ ?message_group_id: ::String
114
+ ) -> Types::SendMessageResult
115
+ | (?Hash[Symbol, untyped]) -> Types::SendMessageResult
116
+
117
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#send_messages-instance_method
118
+ def send_messages: (
119
+ entries: Array[
120
+ {
121
+ id: ::String,
122
+ message_body: ::String,
123
+ delay_seconds: ::Integer?,
124
+ message_attributes: Hash[::String, {
125
+ string_value: ::String?,
126
+ binary_value: ::String?,
127
+ string_list_values: Array[::String]?,
128
+ binary_list_values: Array[::String]?,
129
+ data_type: ::String
130
+ }]?,
131
+ message_system_attributes: Hash[("AWSTraceHeader"), {
132
+ string_value: ::String?,
133
+ binary_value: ::String?,
134
+ string_list_values: Array[::String]?,
135
+ binary_list_values: Array[::String]?,
136
+ data_type: ::String
137
+ }]?,
138
+ message_deduplication_id: ::String?,
139
+ message_group_id: ::String?
140
+ },
141
+ ]
142
+ ) -> Types::SendMessageBatchResult
143
+ | (?Hash[Symbol, untyped]) -> Types::SendMessageBatchResult
144
+
145
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#set_attributes-instance_method
146
+ def set_attributes: (
147
+ 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]
148
+ ) -> ::Aws::EmptyStructure
149
+ | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure
150
+
151
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#dead_letter_source_queues-instance_method
152
+ def dead_letter_source_queues: (
153
+ ) -> Queue::Collection
154
+ | (?Hash[Symbol, untyped]) -> Queue::Collection
155
+
156
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#message-instance_method
157
+ def message: (String receipt_handle) -> Message
158
+
159
+ class Collection < ::Aws::Resources::Collection[Queue]
160
+ end
161
+ end
162
+ end
163
+ end
data/sig/resource.rbs ADDED
@@ -0,0 +1,105 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module SQS
10
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html
11
+ class Resource
12
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#initialize-instance_method
13
+ def initialize: (
14
+ ?client: Client,
15
+ ?credentials: untyped,
16
+ ?region: String,
17
+ ?access_key_id: String,
18
+ ?active_endpoint_cache: bool,
19
+ ?adaptive_retry_wait_to_fill: bool,
20
+ ?client_side_monitoring: bool,
21
+ ?client_side_monitoring_client_id: String,
22
+ ?client_side_monitoring_host: String,
23
+ ?client_side_monitoring_port: Integer,
24
+ ?client_side_monitoring_publisher: untyped,
25
+ ?convert_params: bool,
26
+ ?correct_clock_skew: bool,
27
+ ?defaults_mode: String,
28
+ ?disable_host_prefix_injection: bool,
29
+ ?disable_request_compression: bool,
30
+ ?endpoint: String,
31
+ ?endpoint_cache_max_entries: Integer,
32
+ ?endpoint_cache_max_threads: Integer,
33
+ ?endpoint_cache_poll_interval: Integer,
34
+ ?endpoint_discovery: bool,
35
+ ?ignore_configured_endpoint_urls: bool,
36
+ ?log_formatter: untyped,
37
+ ?log_level: Symbol,
38
+ ?logger: untyped,
39
+ ?max_attempts: Integer,
40
+ ?profile: String,
41
+ ?request_min_compression_size_bytes: Integer,
42
+ ?retry_backoff: Proc,
43
+ ?retry_base_delay: Float,
44
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
45
+ ?retry_limit: Integer,
46
+ ?retry_max_delay: Integer,
47
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
48
+ ?sdk_ua_app_id: String,
49
+ ?secret_access_key: String,
50
+ ?session_token: String,
51
+ ?simple_json: bool,
52
+ ?stub_responses: untyped,
53
+ ?token_provider: untyped,
54
+ ?use_dualstack_endpoint: bool,
55
+ ?use_fips_endpoint: bool,
56
+ ?validate_params: bool,
57
+ ?verify_checksums: bool,
58
+ ?endpoint_provider: untyped,
59
+ ?http_proxy: String,
60
+ ?http_open_timeout: (Float | Integer),
61
+ ?http_read_timeout: (Float | Integer),
62
+ ?http_idle_timeout: (Float | Integer),
63
+ ?http_continue_timeout: (Float | Integer),
64
+ ?ssl_timeout: (Float | Integer | nil),
65
+ ?http_wire_trace: bool,
66
+ ?ssl_verify_peer: bool,
67
+ ?ssl_ca_bundle: String,
68
+ ?ssl_ca_directory: String,
69
+ ?ssl_ca_store: String,
70
+ ?on_chunk_received: Proc,
71
+ ?on_chunk_sent: Proc,
72
+ ?raise_response_errors: bool
73
+ ) -> void
74
+ | (?Hash[Symbol, untyped]) -> void
75
+
76
+ def client: () -> Client
77
+
78
+
79
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#create_queue-instance_method
80
+ def create_queue: (
81
+ queue_name: ::String,
82
+ ?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],
83
+ ?tags: Hash[::String, ::String]
84
+ ) -> Queue
85
+ | (?Hash[Symbol, untyped]) -> Queue
86
+
87
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#get_queue_by_name-instance_method
88
+ def get_queue_by_name: (
89
+ queue_name: ::String,
90
+ ?queue_owner_aws_account_id: ::String
91
+ ) -> Queue
92
+ | (?Hash[Symbol, untyped]) -> Queue
93
+
94
+
95
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#queue-instance_method
96
+ def queue: (String url) -> Queue
97
+
98
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Resource.html#queues-instance_method
99
+ def queues: (
100
+ ?queue_name_prefix: ::String
101
+ ) -> Queue::Collection
102
+ | (?Hash[Symbol, untyped]) -> Queue::Collection
103
+ end
104
+ end
105
+ end