Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.SQS.Types.MessageAttributeValue
Description
Synopsis
- data MessageAttributeValue = MessageAttributeValue' {
- binaryValue :: Maybe Base64
- stringListValues :: Maybe [Text]
- stringValue :: Maybe Text
- binaryListValues :: Maybe [Base64]
- dataType :: Text
- newMessageAttributeValue :: Text -> MessageAttributeValue
- messageAttributeValue_binaryValue :: Lens' MessageAttributeValue (Maybe ByteString)
- messageAttributeValue_stringListValues :: Lens' MessageAttributeValue (Maybe [Text])
- messageAttributeValue_stringValue :: Lens' MessageAttributeValue (Maybe Text)
- messageAttributeValue_binaryListValues :: Lens' MessageAttributeValue (Maybe [ByteString])
- messageAttributeValue_dataType :: Lens' MessageAttributeValue Text
Documentation
data MessageAttributeValue Source #
The user-specified message attribute value. For string data types, the
Value
attribute has the same restrictions on the content as the
message body. For more information, see SendMessage.
Name
, type
, value
and the message body must not be empty or null.
All parts of the message attribute, including Name
, Type
, and
Value
, are part of the message size restriction (256 KB or 262,144
bytes).
See: newMessageAttributeValue
smart constructor.
Constructors
MessageAttributeValue' | |
Fields
|
Instances
newMessageAttributeValue Source #
Create a value of MessageAttributeValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:binaryValue:MessageAttributeValue'
, messageAttributeValue_binaryValue
- Binary type attributes can store any binary data, such as compressed
data, encrypted data, or images.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:stringListValues:MessageAttributeValue'
, messageAttributeValue_stringListValues
- Not implemented. Reserved for future use.
$sel:stringValue:MessageAttributeValue'
, messageAttributeValue_stringValue
- Strings are Unicode with UTF-8 binary encoding. For a list of code
values, see
ASCII Printable Characters.
$sel:binaryListValues:MessageAttributeValue'
, messageAttributeValue_binaryListValues
- Not implemented. Reserved for future use.
$sel:dataType:MessageAttributeValue'
, messageAttributeValue_dataType
- Amazon SQS supports the following logical data types: String
,
Number
, and Binary
. For the Number
data type, you must use
StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
messageAttributeValue_binaryValue :: Lens' MessageAttributeValue (Maybe ByteString) Source #
Binary type attributes can store any binary data, such as compressed
data, encrypted data, or images.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
messageAttributeValue_stringListValues :: Lens' MessageAttributeValue (Maybe [Text]) Source #
Not implemented. Reserved for future use.
messageAttributeValue_stringValue :: Lens' MessageAttributeValue (Maybe Text) Source #
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
messageAttributeValue_binaryListValues :: Lens' MessageAttributeValue (Maybe [ByteString]) Source #
Not implemented. Reserved for future use.
messageAttributeValue_dataType :: Lens' MessageAttributeValue Text Source #
Amazon SQS supports the following logical data types: String
,
Number
, and Binary
. For the Number
data type, you must use
StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.