Package software.amazon.awssdk.services.resourcegroupstaggingapi.model

Class FailureInfo

java.lang.Object
software.amazon.awssdk.services.resourcegroupstaggingapi.model.FailureInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FailureInfo.Builder,FailureInfo>
@Generated("software.amazon.awssdk:codegen") public final class FailureInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FailureInfo.Builder,FailureInfo>

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 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 and TagResource in the CloudWatch API.

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

See Also:

  • Method Details

    • statusCode

      public final Integer statusCode()

      The HTTP status code of the common error.

      Returns:
      The HTTP status code of the common error.

    • errorCode

      public final ErrorCode errorCode()

      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.

      If the service returns an enum value that is not available in the current SDK version, errorCode will return ErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

      Returns:
      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.
      See Also:

    • errorCodeAsString

      public final String errorCodeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, errorCode will return ErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

      Returns:
      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.
      See Also:

    • errorMessage

      public final String errorMessage()

      The message of the common error.

      Returns:
      The message of the common error.

    • toBuilder

      public FailureInfo.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FailureInfo.Builder,FailureInfo>
      Returns:
      a builder for type T

    • builder

      public static FailureInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FailureInfo.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.