@Generated(value="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 AWS service that hosts the resource that the ARN key represents.
The following are common error codes that you might receive from other AWS services:
InternalServiceException – This can mean that the Resource Groups Tagging API didn't receive a response from another AWS service. It can also mean the 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 calling tagging operations in the AWS
service that contains the resource. For example, to use the Resource Groups Tagging API to tag a CloudWatch alarm
resource, you need permission to call
TagResources
and TagResource
in the CloudWatch API.
For more information on errors that are generated from other AWS services, see the documentation for that service.
Modifier and Type | Class and Description |
---|---|
static interface |
FailureInfo.Builder |
Modifier and Type | Method and Description |
---|---|
static FailureInfo.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
ErrorCode |
errorCode()
The code of the common error.
|
String |
errorCodeAsString()
The code of the common error.
|
String |
errorMessage()
The message of the common error.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends FailureInfo.Builder> |
serializableBuilderClass() |
Integer |
statusCode()
The HTTP status code of the common error.
|
FailureInfo.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final Integer statusCode()
The HTTP status code of the common error.
public final ErrorCode errorCode()
The code of the common error. Valid values include InternalServiceException
,
InvalidParameterException
, and any valid error code returned by the AWS 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()
.
InternalServiceException
,
InvalidParameterException
, and any valid error code returned by the AWS service that hosts
the resource that you want to tag.ErrorCode
public final String errorCodeAsString()
The code of the common error. Valid values include InternalServiceException
,
InvalidParameterException
, and any valid error code returned by the AWS 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()
.
InternalServiceException
,
InvalidParameterException
, and any valid error code returned by the AWS service that hosts
the resource that you want to tag.ErrorCode
public final String errorMessage()
The message of the common error.
public FailureInfo.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<FailureInfo.Builder,FailureInfo>
public static FailureInfo.Builder builder()
public static Class<? extends FailureInfo.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.