Class: Aws::ResourceGroupsTaggingAPI::Types::FailureInfo

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-resourcegroupstaggingapi/types.rb

Overview

Information about the errors that are returned for each failed resource. This information can include ‘InternalServiceException` and `InvalidParameterException` errors. It can also include any valid error code returned by the Amazon Web Services service that hosts the resource that the ARN key represents.

The following are common error codes that you might receive from other Amazon Web Services services:

  • InternalServiceException – This can mean that the Resource Groups Tagging API didn’t receive a response from another Amazon Web Services service. It can also mean that the resource type in the request is not supported by the Resource Groups Tagging API. In these cases, it’s safe to retry the request and then call

    GetResources][1

    to verify the changes.

  • AccessDeniedException – This can mean that you need permission to call the tagging operations in the Amazon Web Services service that contains the resource. For example, to use the Resource Groups Tagging API to tag a Amazon CloudWatch alarm resource, you need permission to call both [ ‘TagResources` ][2] and [ `TagResource` ][3] in the CloudWatch API.

For more information on errors that are generated from other Amazon Web Services services, see the documentation for that service.

[1]: docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html [2]: docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html [3]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error_code ⇒ String

The code of the common error. Valid values include ‘InternalServiceException`, `InvalidParameterException`, and any valid error code returned by the Amazon Web Services service that hosts the resource that you want to tag.

Returns:

  • (String) 


179
180
181
182
183
184
185
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 179

class FailureInfo < Struct.new(
  :status_code,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

The message of the common error.

Returns:

  • (String) 


179
180
181
182
183
184
185
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 179

class FailureInfo < Struct.new(
  :status_code,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#status_code ⇒ Integer

The HTTP status code of the common error.

Returns:

  • (Integer) 


179
180
181
182
183
184
185
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 179

class FailureInfo < Struct.new(
  :status_code,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end