add_attachments_to_set ¶

def add_attachments_to_set(
    self,
    attachments: "capo_support.types.attachments.Attachments",
    *,
    config_overrides: Optional[SupportClientConfig] = None,
    attachment_set_id: Optional[
        "capo_support.types.attachment_set_id.AttachmentSetId"
    ] = None,
    dry_run: Optional[
        "capo_support.types.nullable_boolean_type.NullableBooleanType"
    ] = None,
) -> (
    "capo_support.types.add_attachments_to_set_response.AddAttachmentsToSetResponse"
):
    """<p>Adds one or more attachments to an attachment set. </p> <p>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 <code>expiryTime</code> returned in the response is when the set expires. </p> <note> <ul> <li> <p>You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.</p> </li> <li> <p>If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the <code>SubscriptionRequiredException</code> error message appears. For information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p> </li> </ul> </note>

    Args:
        attachment_set_id: <p>The ID of the attachment set. If an <code>attachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>attachmentSetId</code> is specified, the attachments are added to the specified set, if it exists.</p>
        attachments: <p>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.</p> <p>In the <code>Attachment</code> object, use the <code>data</code> parameter to specify the contents of the attachment file. In the previous request syntax, the value for <code>data</code> appear as <code>blob</code>, which is represented as a base64-encoded string. The value for <code>fileName</code> is the name of the attachment, such as <code>troubleshoot-screenshot.png</code>.</p>
        dry_run: <p>Specifies whether to validate the request without actually adding the attachments. When set to <code>true</code>, the request is validated but no attachments are stored, and the operation returns a <code>DryRunOperationException</code>. When omitted or set to <code>false</code>, the request runs normally.</p>

    Raises:
        capo_support.errors.attachment_limit_exceeded.AttachmentLimitExceeded: <p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>
        capo_support.errors.attachment_set_expired.AttachmentSetExpired: <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>
        capo_support.errors.attachment_set_id_not_found.AttachmentSetIdNotFound: <p>An attachment set with the specified ID could not be found.</p>
        capo_support.errors.attachment_set_size_limit_exceeded.AttachmentSetSizeLimitExceeded: <p>A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.</p>
        capo_support.errors.dry_run_operation_exception.DryRunOperationException: <p>The request was valid, but the operation wasn't performed because <code>dryRun</code> was set to <code>true</code>.</p>
        capo_support.errors.internal_server_error.InternalServerError: <p>An internal server error occurred.</p>
        capo_support.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_support.types.add_attachments_to_set_request.AddAttachmentsToSetRequest]",
    ) -> OperationResponse[
        "capo_support.types.add_attachments_to_set_response.AddAttachmentsToSetResponse"
    ]:
        import capo_support._operations.aws_support_20130415.add_attachments_to_set

        output, http_response = (
            capo_support._operations.aws_support_20130415.add_attachments_to_set.add_attachments_to_set(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AddAttachmentsToSet")
    )
    input_: capo_support.types.add_attachments_to_set_request.AddAttachmentsToSetRequest = {
        "attachments": attachments
    }
    if attachment_set_id is not None:
        input_["attachment_set_id"] = attachment_set_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output