com.amazonaws.services.ec2.model

Class DescribeImageAttributeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeImageAttributeRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeImageAttributeRequest>, java.io.Serializable, java.lang.Cloneable

public class DescribeImageAttributeRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeImageAttributeRequest>

Container for the parameters to the DescribeImageAttribute operation.

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

See Also:

AmazonEC2.describeImageAttribute(DescribeImageAttributeRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeImageAttributeRequest() Default constructor for a new DescribeImageAttributeRequest object.
DescribeImageAttributeRequest(java.lang.String imageId, ImageAttributeName attribute) Constructs a new DescribeImageAttributeRequest object.
DescribeImageAttributeRequest(java.lang.String imageId, java.lang.String attribute) Constructs a new DescribeImageAttributeRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAttribute() The AMI attribute.
Request<DescribeImageAttributeRequest>	getDryRunRequest() This method is intended for internal use only.
java.lang.String	getImageId() The ID of the AMI.
int	hashCode()
void	setAttribute(ImageAttributeName attribute) The AMI attribute.
void	setAttribute(java.lang.String attribute) The AMI attribute.
void	setImageId(java.lang.String imageId) The ID of the AMI.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeImageAttributeRequest	withAttribute(ImageAttributeName attribute) The AMI attribute.
DescribeImageAttributeRequest	withAttribute(java.lang.String attribute) The AMI attribute.
DescribeImageAttributeRequest	withImageId(java.lang.String imageId) The ID of the AMI.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeImageAttributeRequest

public DescribeImageAttributeRequest()

Default constructor for a new DescribeImageAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DescribeImageAttributeRequest

public DescribeImageAttributeRequest(java.lang.String imageId,
                                     java.lang.String attribute)

Constructs a new DescribeImageAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

imageId - The ID of the AMI.

attribute - The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

DescribeImageAttributeRequest

public DescribeImageAttributeRequest(java.lang.String imageId,
                                     ImageAttributeName attribute)

Constructs a new DescribeImageAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

imageId - The ID of the AMI.

attribute - The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Method Detail

getImageId

public java.lang.String getImageId()

The ID of the AMI.

Returns:

The ID of the AMI.

setImageId

public void setImageId(java.lang.String imageId)

The ID of the AMI.

Parameters:

imageId - The ID of the AMI.

withImageId

public DescribeImageAttributeRequest withImageId(java.lang.String imageId)

The ID of the AMI.

Returns a reference to this object so that method calls can be chained together.

Parameters:

imageId - The ID of the AMI.

Returns:

A reference to this updated object so that method calls can be chained together.

getAttribute

public java.lang.String getAttribute()

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport

Returns:

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

See Also:

ImageAttributeName

setAttribute

public void setAttribute(java.lang.String attribute)

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport

Parameters:

attribute - The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

See Also:

ImageAttributeName

withAttribute

public DescribeImageAttributeRequest withAttribute(java.lang.String attribute)

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport

Parameters:

attribute - The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ImageAttributeName

setAttribute

public void setAttribute(ImageAttributeName attribute)

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport

Parameters:

attribute - The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

See Also:

ImageAttributeName

withAttribute

public DescribeImageAttributeRequest withAttribute(ImageAttributeName attribute)

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport

Parameters:

attribute - The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ImageAttributeName

getDryRunRequest

public Request<DescribeImageAttributeRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeImageAttributeRequest>

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object