Support / Client / add_attachments_to_set

add_attachments_to_set#

Support.Client.add_attachments_to_set(**kwargs)#

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.

Note

  • 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.

See also: AWS API Documentation

Request Syntax

response = client.add_attachments_to_set(
    attachmentSetId='string',
    attachments=[
        {
            'fileName': 'string',
            'data': b'bytes'
        },
    ]
)
Parameters:

  • attachmentSetId (string) – 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 (list) –

    [REQUIRED]

    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.

    • (dict) –

      An attachment to a case communication. The attachment consists of the file name and the content of the file. Each attachment file size should not exceed 5 MB. File types that are supported include the following: pdf, jpeg,.doc, .log, .text

      • fileName (string) –

        The name of the attachment file.

      • data (bytes) –

        The content of the attachment file.

Return type:

dict

Returns:

Response Syntax

{
    'attachmentSetId': 'string',
    'expiryTime': 'string'
}

Response Structure

  • (dict) –

    The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

    • attachmentSetId (string) –

      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 (string) –

      The time and date when the attachment set expires.

Exceptions

  • Support.Client.exceptions.InternalServerError

  • Support.Client.exceptions.AttachmentSetIdNotFound

  • Support.Client.exceptions.AttachmentSetExpired

  • Support.Client.exceptions.AttachmentSetSizeLimitExceeded

  • Support.Client.exceptions.AttachmentLimitExceeded