This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1: Acl
2: AclRequest
3: AclResponse
4: CheckDuplicationResponse
5: ConfigSetRequest
6: DescriptionSetRequest
7: DescriptionSetResponse
8: Encryption
9: Queue
10: QueueCreateRequest
11: QueueCreateResponse
12: QueueListResponse
13: QueueShowResponse
14: Tag

1 - Acl

Name	Description	Schema	Default
ip_address required	IP address Example : `192.168.0.0`	string

2 - AclRequest

Name	Description	Schema	Default
ip_address required	Access Allowed IP List Example : `['0.0.0.0', '192.168.0.0']`	array[string]

3 - AclResponse

Name	Description	Schema	Default
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string

4 - CheckDuplicationResponse

Name	Description	Schema	Default
result required	Result Example : `True`	boolean

5 - ConfigSetRequest

Name	Description	Schema	Default
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
encryption optional	Encryption	any of [Encryption, null]
message_retention_period required	Message retention period Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256` Minimum : `1` Maximum : `256`	integer

6 - DescriptionSetRequest

Name	Description	Schema	Default
description required	Description Example : `Queue description` Maximum length : `100`	string

7 - DescriptionSetResponse

Name	Description	Schema	Default
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string

8 - Encryption

Name	Description	Schema	Default
id required	KMS ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	any of [string, null]
name required	KMS name Example : `test-kms`	any of [string, null]

9 - Queue

Name	Description	Schema	Default
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
encryption optional	Encryption	any of [Encryption, null]
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue name Example : `test-queue.fifo`	string
number_wait_messages required	Number of waiting messages Example : `10`	integer
state required	Queue state Example : `ACTIVE`	string
type required	Queue Type Example : `FIFO`	string

10 - QueueCreateRequest

Name	Description	Schema	Default
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
description optional	Description Example : `Queue description`	any of [string, null]
encryption optional	Encryption	any of [Encryption, null]
message_retention_period required	Message retention period Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256` Minimum : `1` Maximum : `256`	integer
name required	Queue name Example : `test-queue.fifo` Pattern : `^[a-z][a-z0-9-]$\|^[a-z][a-z0-9-]\.fifo$` Minimum length : `3` Maximum length : `64`	string
tags optional	Tag List	any of [array[Tag], null]

11 - QueueCreateResponse

Name	Description	Schema	Default
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
messages required	Description Example : `Create Queue`	string
state required	Queue state Example : `ACTIVE`	string

12 - QueueListResponse

Name	Description	Schema	Default
count required	count Example : `20`	integer
page required	page Example : `0`	integer
queues required	Queue List	array[Queue]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

13 - QueueShowResponse

Name	Description	Schema	Default
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
allow_ip_access optional	Access Allowed IP List Example : `['0.0.0.0', '192.168.0.0']`	any of [array[Acl], null]
console_polling_count required	Polling count Example : `10`	integer
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
description optional	Description Example : `Queue description`	any of [string, null]
encryption optional	Encryption	any of [Encryption, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
message_retention_period required	Message retention period Example : `40`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue name Example : `test-queue.fifo`	string
number_wait_messages required	Number of waiting messages Example : `10`	integer
state required	Queue state Example : `ACTIVE`	string
type required	Queue Type Example : `FIFO`	string

14 - Tag

Name	Description	Schema	Default
key required	Tag Key Example : `key1`	string
value required	Tag Value Example : `value1`	any of [string, null]