Request Parameters Response Elements Errors Examples See Also

ModifyFpgaImageAttribute

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

Attribute

The name of the attribute.

Type: String

Valid Values: description | name | loadPermission | productCodes

Required: No

Description

A description for the AFI.

Type: String

Required: No

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.

Type: Boolean

Required: No

FpgaImageId

The ID of the AFI.

Type: String

Required: Yes

LoadPermission

The load permission for the AFI.

Type: LoadPermissionModifications object

Required: No

Name

A name for the AFI.

Type: String

Required: No

OperationType

The operation type.

Type: String

Valid Values: add | remove

Required: No

ProductCode.N

The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute.

Type: Array of strings

Required: No

UserGroup.N

The user groups. This parameter is valid only when modifying the loadPermission attribute.

Type: Array of strings

Required: No

UserId.N

The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

fpgaImageAttribute

Information about the attribute.

Type: FpgaImageAttribute object

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example

This example adds load permissions for account ID 123456789012.

Sample Request


https://ec2.amazonaws.com/?Action=ModifyFpgaImageAttribute
&FpgaImageId=afi-0d123e21abcc85abc
&Attribute=loadPermission
&LoadPermission.Add.1.UserId=123456789012
&AUTHPARAMS

Sample Response


<ModifyFpgaImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>75837959-edf9-4183-ad01-6cb1example</requestId>
    <fpgaImageAttribute>
        <fpgaImageId>afi-0d123e21abcc85abc</fpgaImageId>
        <loadPermissions>
            <item>
                <userId>123456789012</userId>
            </item>
        </loadPermissions>
    </fpgaImageAttribute>
</ModifyFpgaImageAttributeResponse>