describe_attachment_upload_status ¶

def describe_attachment_upload_status(
    self,
    upload_id: "capo_support.types.upload_id.UploadId",
    *,
    config_overrides: Optional[SupportClientConfig] = None,
    dry_run: Optional[
        "capo_support.types.nullable_boolean_type.NullableBooleanType"
    ] = None,
) -> "capo_support.types.describe_attachment_upload_status_response.DescribeAttachmentUploadStatusResponse":
    """<p>Returns the current status, file name, and progress of a multipart attachment upload that was started with <a>GetAttachmentUploadLinks</a>. Use this operation to track where an upload is in the workflow. While parts are still being uploaded and reported through <a>CompleteAttachmentUpload</a>, the <code>uploadStatus</code> is <code>attachment-not-ready</code> and <code>uploadProgress</code> reports the total number of parts and how many have been completed so far. After every part has been reported and the service finishes processing the upload asynchronously, the <code>uploadStatus</code> becomes <code>attachment-ready</code> and the <code>uploadId</code> can be attached to a case through <a>CreateCase</a> or <a>AddCommunicationToCase</a>.</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:
        upload_id: <p>The unique identifier for the upload. The <code>uploadId</code> is returned by <a>GetAttachmentUploadLinks</a> when you initiate the upload.</p>
        dry_run: <p>Specifies whether to validate the request without actually returning upload status. When set to <code>true</code>, the request is validated but no status is returned, 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.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.upload_id_not_found.UploadIdNotFound: <p>The specified <code>uploadId</code> couldn't be located.</p>
        capo_support.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_support.types.describe_attachment_upload_status_request.DescribeAttachmentUploadStatusRequest]",
    ) -> OperationResponse[
        "capo_support.types.describe_attachment_upload_status_response.DescribeAttachmentUploadStatusResponse"
    ]:
        import capo_support._operations.aws_support_20130415.describe_attachment_upload_status

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAttachmentUploadStatus")
    )
    input_: capo_support.types.describe_attachment_upload_status_request.DescribeAttachmentUploadStatusRequest = {
        "upload_id": upload_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