Open 3D Engine AWSCore Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
AWSCore::Error Struct Reference

Encapsulates the data produced when a service API call fails. More...

#include <Error.h>

Public Member Functions

bool OnJsonKey (const char *key, JsonReader &reader)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *reflection)
 

Public Attributes

AZStd::string type
 
AZStd::string message
 Describes the error. Intended for use by humans.
 

Static Public Attributes

static const AZStd::string TYPE_NETWORK_ERROR
 
static const AZStd::string TYPE_CLIENT_ERROR
 
static const AZStd::string TYPE_SERVICE_ERROR
 
static const AZStd::string TYPE_CONTENT_ERROR
 

Detailed Description

Encapsulates the data produced when a service API call fails.

Member Data Documentation

◆ type

AZStd::string AWSCore::Error::type

Identifies the type of error. Intended for use by programs.

NetworkError - if there was a problem sending the request or receiving the response. e.g. due to timeouts or proxy issues.

ClientError - if the service determines that the client request was invalid in some way.

ServiceError - if the service had trouble executing the request.

ContentError - if an error occurs when producing or consuming JSON format content.

Services may return other error types.

The documentation for this struct was generated from the following file: