AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Exception: Aws::Errors::ServiceError

Inherits:
RuntimeError
  • Object
show all
Defined in:
gems/aws-sdk-core/lib/aws-sdk-core/errors.rb

Overview

The base class for all errors returned by an Amazon Web Service. All ~400 level client errors and ~500 level server errors are raised as service errors. This indicates it was an error returned from the service and not one generated by the client.

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(context, message, data = Aws::EmptyStructure.new) ⇒ ServiceError

Returns a new instance of ServiceError

Parameters:



17
18
19
20
21
22
23
# File 'gems/aws-sdk-core/lib/aws-sdk-core/errors.rb', line 17

def initialize(context, message, data = Aws::EmptyStructure.new)
  @code = self.class.code
  @message = message if message && !message.empty?
  @context = context
  @data = data
  super(message)
end

Class Attribute Details

.codeString

Returns:

  • (String)


38
39
40
# File 'gems/aws-sdk-core/lib/aws-sdk-core/errors.rb', line 38

def code
  @code
end

Instance Attribute Details

#codeString (readonly)

Returns:

  • (String)


26
27
28
# File 'gems/aws-sdk-core/lib/aws-sdk-core/errors.rb', line 26

def code
  @code
end

#contextSeahorse::Client::RequestContext (readonly)

Returns The context of the request that triggered the remote service to return this error.

Returns:



30
31
32
# File 'gems/aws-sdk-core/lib/aws-sdk-core/errors.rb', line 30

def context
  @context
end

#dataAws::Structure (readonly)

Returns:

  • (Aws::Structure)


33
34
35
# File 'gems/aws-sdk-core/lib/aws-sdk-core/errors.rb', line 33

def data
  @data
end