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 |
Adds one or more attachments to an attachment set.
An attachment set is a temporary container for attachments that you add
to a case or case communication. The set is available for 1 hour after
it's created. The expiryTime
returned in the response is when the set
expires.
- You must have a Business or Enterprise Support plan to use the AWS Support API.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise Support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
Synopsis
- data AddAttachmentsToSet = AddAttachmentsToSet' {}
- newAddAttachmentsToSet :: AddAttachmentsToSet
- addAttachmentsToSet_attachmentSetId :: Lens' AddAttachmentsToSet (Maybe Text)
- addAttachmentsToSet_attachments :: Lens' AddAttachmentsToSet [Attachment]
- data AddAttachmentsToSetResponse = AddAttachmentsToSetResponse' {
- expiryTime :: Maybe Text
- attachmentSetId :: Maybe Text
- httpStatus :: Int
- newAddAttachmentsToSetResponse :: Int -> AddAttachmentsToSetResponse
- addAttachmentsToSetResponse_expiryTime :: Lens' AddAttachmentsToSetResponse (Maybe Text)
- addAttachmentsToSetResponse_attachmentSetId :: Lens' AddAttachmentsToSetResponse (Maybe Text)
- addAttachmentsToSetResponse_httpStatus :: Lens' AddAttachmentsToSetResponse Int
Creating a Request
data AddAttachmentsToSet Source #
See: newAddAttachmentsToSet
smart constructor.
AddAttachmentsToSet' | |
|
Instances
newAddAttachmentsToSet :: AddAttachmentsToSet Source #
Create a value of AddAttachmentsToSet
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:attachmentSetId:AddAttachmentsToSet'
, addAttachmentsToSet_attachmentSetId
- The ID of the attachment set. If an attachmentSetId
is not specified,
a new attachment set is created, and the ID of the set is returned in
the response. If an attachmentSetId
is specified, the attachments are
added to the specified set, if it exists.
$sel:attachments:AddAttachmentsToSet'
, addAttachmentsToSet_attachments
- One or more attachments to add to the set. You can add up to three
attachments per set. The size limit is 5 MB per attachment.
In the Attachment
object, use the data
parameter to specify the
contents of the attachment file. In the previous request syntax, the
value for data
appear as blob
, which is represented as a
base64-encoded string. The value for fileName
is the name of the
attachment, such as troubleshoot-screenshot.png
.
Request Lenses
addAttachmentsToSet_attachmentSetId :: Lens' AddAttachmentsToSet (Maybe Text) Source #
The ID of the attachment set. If an attachmentSetId
is not specified,
a new attachment set is created, and the ID of the set is returned in
the response. If an attachmentSetId
is specified, the attachments are
added to the specified set, if it exists.
addAttachmentsToSet_attachments :: Lens' AddAttachmentsToSet [Attachment] Source #
One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment.
In the Attachment
object, use the data
parameter to specify the
contents of the attachment file. In the previous request syntax, the
value for data
appear as blob
, which is represented as a
base64-encoded string. The value for fileName
is the name of the
attachment, such as troubleshoot-screenshot.png
.
Destructuring the Response
data AddAttachmentsToSetResponse Source #
The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
See: newAddAttachmentsToSetResponse
smart constructor.
AddAttachmentsToSetResponse' | |
|
Instances
newAddAttachmentsToSetResponse Source #
Create a value of AddAttachmentsToSetResponse
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:expiryTime:AddAttachmentsToSetResponse'
, addAttachmentsToSetResponse_expiryTime
- The time and date when the attachment set expires.
$sel:attachmentSetId:AddAttachmentsToSet'
, addAttachmentsToSetResponse_attachmentSetId
- The ID of the attachment set. If an attachmentSetId
was not specified,
a new attachment set is created, and the ID of the set is returned in
the response. If an attachmentSetId
was specified, the attachments are
added to the specified set, if it exists.
$sel:httpStatus:AddAttachmentsToSetResponse'
, addAttachmentsToSetResponse_httpStatus
- The response's http status code.
Response Lenses
addAttachmentsToSetResponse_expiryTime :: Lens' AddAttachmentsToSetResponse (Maybe Text) Source #
The time and date when the attachment set expires.
addAttachmentsToSetResponse_attachmentSetId :: Lens' AddAttachmentsToSetResponse (Maybe Text) Source #
The ID of the attachment set. If an attachmentSetId
was not specified,
a new attachment set is created, and the ID of the set is returned in
the response. If an attachmentSetId
was specified, the attachments are
added to the specified set, if it exists.
addAttachmentsToSetResponse_httpStatus :: Lens' AddAttachmentsToSetResponse Int Source #
The response's http status code.