commonMain.aws.sdk.kotlin.runtime.http.ProtocolErrors.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-http Show documentation

HTTP core for AWS service clients

There is a newer version: 1.3.84

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package aws.sdk.kotlin.runtime.http

import aws.sdk.kotlin.runtime.AwsErrorMetadata
import aws.sdk.kotlin.runtime.AwsServiceException
import aws.sdk.kotlin.runtime.InternalSdkApi
import aws.smithy.kotlin.runtime.ServiceErrorMetadata
import aws.smithy.kotlin.runtime.http.response.HttpResponse
import aws.smithy.kotlin.runtime.util.setIfValueNotNull

/**
 * Common error response details
 */
public interface AwsErrorDetails {
    /**
     * The error code that identifies the error
     */
    public val code: String?

    /**
     * A description of the error
     */
    public val message: String?

    /**
     * The unique request ID returned by the service
     */
    public val requestId: String?
}

@InternalSdkApi
public data class ErrorDetails(
    override val code: String?,
    override val message: String?,
    override val requestId: String?,
) : AwsErrorDetails

/**
 * Pull specific details from the response / error and set [AwsServiceException] metadata
 */
@InternalSdkApi
public fun setAseErrorMetadata(exception: Any, response: HttpResponse, errorDetails: AwsErrorDetails?) {
    if (exception is AwsServiceException) {
        exception.sdkErrorMetadata.attributes.setIfValueNotNull(ServiceErrorMetadata.ErrorCode, errorDetails?.code)
        exception.sdkErrorMetadata.attributes.setIfValueNotNull(AwsErrorMetadata.ErrorMessage, errorDetails?.message)
        exception.sdkErrorMetadata.attributes.setIfValueNotNull(ServiceErrorMetadata.RequestId, response.headers[X_AMZN_REQUEST_ID_HEADER])
        exception.sdkErrorMetadata.attributes[ServiceErrorMetadata.ProtocolResponse] = response
    }
}