Skip to content

EC2  >  Operations  >  modify_fpga_image_attribute

modify_fpga_image_attribute

Operation

modify_fpga_image_attribute async

modify_fpga_image_attribute(request: ModifyFpgaImageAttributeInput | ModifyFpgaImageAttributeInputDict, /, *, plugins: list[Plugin] | None = None) -> ModifyFpgaImageAttributeOutput
modify_fpga_image_attribute(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyFpgaImageAttributeInputDict]) -> ModifyFpgaImageAttributeOutput

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

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ModifyFpgaImageAttributeOutput

An instance of ModifyFpgaImageAttributeOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ModifyFpgaImageAttributeInput dataclass

Bases: _SerdeShape

Dataclass for ModifyFpgaImageAttributeInput structure.

Attributes
attribute class-attribute instance-attribute
attribute: str | None = ...

The name of the attribute.

description class-attribute instance-attribute
description: str | None = ...

A description for the AFI.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

fpga_image_id class-attribute instance-attribute
fpga_image_id: str | None = ...

The ID of the AFI.

load_permission class-attribute instance-attribute
load_permission: LoadPermissionModifications | None = ...

The load permission for the AFI.

name class-attribute instance-attribute
name: str | None = ...

A name for the AFI.

operation_type class-attribute instance-attribute
operation_type: str | None = ...

The operation type.

product_codes class-attribute instance-attribute
product_codes: list[str] | None = ...

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.

user_groups class-attribute instance-attribute
user_groups: list[str] | None = ...

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

user_ids class-attribute instance-attribute
user_ids: list[str] | None = ...

The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.

Dictionaries

ModifyFpgaImageAttributeInputDict

Bases: TypedDict

Dictionary form of ModifyFpgaImageAttributeInput.

Attributes
attribute instance-attribute
attribute: str | None

The name of the attribute.

description instance-attribute
description: str | None

A description for the AFI.

dry_run instance-attribute
dry_run: bool | None

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.

fpga_image_id instance-attribute
fpga_image_id: Required[str]

The ID of the AFI.

load_permission instance-attribute

The load permission for the AFI.

name instance-attribute
name: str | None

A name for the AFI.

operation_type instance-attribute
operation_type: str | None

The operation type.

product_codes instance-attribute
product_codes: Sequence[str] | None

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.

user_groups instance-attribute
user_groups: Sequence[str] | None

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

user_ids instance-attribute
user_ids: Sequence[str] | None

The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.

Output

ModifyFpgaImageAttributeOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyFpgaImageAttributeOutput structure.

Attributes

fpga_image_attribute class-attribute instance-attribute
fpga_image_attribute: FpgaImageAttribute | None = ...

Information about the attribute.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.