QueueItem

pydantic model openapi_client.models.queue_item.QueueItem

QueueItem

Fields:
field name: Optional[StrictStr] = None (alias 'Name')

SQS queue name from SSM.

field type: Optional[StrictStr] = None (alias 'Type')

FIFO when Name ends with .fifo, otherwise Standard.

field display_name: Optional[StrictStr] = None (alias 'DisplayName')

Configured display label, else Name.

field description: Optional[StrictStr] = None (alias 'Description')

Configured description, else empty.

field can_purge: Optional[StrictBool] = None (alias 'CanPurge')

Whether PUT purge is allowed for this queue.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of QueueItem from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of QueueItem from a dict

Return type:

Optional[Self]