amazonka-support-2.0: Amazon Support SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Support.AddAttachmentsToSet

Description

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, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
Synopsis

Creating a Request

data AddAttachmentsToSet Source #

See: newAddAttachmentsToSet smart constructor.

Constructors

AddAttachmentsToSet' 

Fields

  • attachmentSetId :: Maybe Text

    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.

  • attachments :: [Attachment]

    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.

Instances

Instances details
ToJSON AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

ToHeaders AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

ToPath AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

ToQuery AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

AWSRequest AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

Associated Types

type AWSResponse AddAttachmentsToSet #

Generic AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

Associated Types

type Rep AddAttachmentsToSet :: Type -> Type #

Read AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

Show AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

NFData AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

Methods

rnf :: AddAttachmentsToSet -> () #

Eq AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

Hashable AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

type AWSResponse AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

type Rep AddAttachmentsToSet Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

type Rep AddAttachmentsToSet = D1 ('MetaData "AddAttachmentsToSet" "Amazonka.Support.AddAttachmentsToSet" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "AddAttachmentsToSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Attachment])))

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:

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.

Constructors

AddAttachmentsToSetResponse' 

Fields

  • attachmentSetId :: Maybe Text

    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.

  • expiryTime :: Maybe Text

    The time and date when the attachment set expires.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic AddAttachmentsToSetResponse Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

Associated Types

type Rep AddAttachmentsToSetResponse :: Type -> Type #

Read AddAttachmentsToSetResponse Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

Show AddAttachmentsToSetResponse Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

NFData AddAttachmentsToSetResponse Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

Eq AddAttachmentsToSetResponse Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

type Rep AddAttachmentsToSetResponse Source # 
Instance details

Defined in Amazonka.Support.AddAttachmentsToSet

type Rep AddAttachmentsToSetResponse = D1 ('MetaData "AddAttachmentsToSetResponse" "Amazonka.Support.AddAttachmentsToSet" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "AddAttachmentsToSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "expiryTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

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:expiryTime:AddAttachmentsToSetResponse', addAttachmentsToSetResponse_expiryTime - The time and date when the attachment set expires.

$sel:httpStatus:AddAttachmentsToSetResponse', addAttachmentsToSetResponse_httpStatus - The response's http status code.

Response Lenses

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_expiryTime :: Lens' AddAttachmentsToSetResponse (Maybe Text) Source #

The time and date when the attachment set expires.