Package software.amazon.awssdk.services.ec2.model

Class DescribeImageAttributeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DescribeImageAttributeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeImageAttributeRequest.Builder,DescribeImageAttributeRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeImageAttributeRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeImageAttributeRequest.Builder,DescribeImageAttributeRequest>

Contains the parameters for DescribeImageAttribute.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeImageAttributeRequest.Builder

Method Summary

Modifier and Type	Method	Description
ImageAttributeName	attribute()	The AMI attribute.
String	attributeAsString()	The AMI attribute.
static DescribeImageAttributeRequest.Builder	builder()
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	imageId()	The ID of the AMI.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeImageAttributeRequest.Builder>	serializableBuilderClass()
DescribeImageAttributeRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

attribute

public final ImageAttributeName attribute()

The AMI attribute.

Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.

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

Returns:

The AMI attribute.

Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.

See Also:

ImageAttributeName

attributeAsString

public final String attributeAsString()

The AMI attribute.

Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.

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

Returns:

The AMI attribute.

Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.

See Also:

ImageAttributeName

imageId

public final String imageId()

The ID of the AMI.

Returns:

The ID of the AMI.

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

toBuilder

public DescribeImageAttributeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeImageAttributeRequest.Builder,DescribeImageAttributeRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeImageAttributeRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo