[ aws . ec2 ]

modify-fpga-image-attribute

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  modify-fpga-image-attribute
[--dry-run | --no-dry-run]
--fpga-image-id <value>
[--attribute <value>]
[--operation-type <value>]
[--user-ids <value>]
[--user-groups <value>]
[--product-codes <value>]
[--load-permission <value>]
[--description <value>]
[--name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--dry-run | --no-dry-run (boolean)

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 (string)

The ID of the AFI.

--attribute (string)

The name of the attribute.

Possible values:

• description

• name

• loadPermission

• productCodes

--operation-type (string)

The operation type.

Possible values:

• add

• remove

--user-ids (list)

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

(string)

Syntax:

"string" "string" ...

--user-groups (list)

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

(string)

Syntax:

"string" "string" ...

--product-codes (list)

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.

(string)

Syntax:

"string" "string" ...

--load-permission (structure)

The load permission for the AFI.

Add -> (list)

The load permissions to add.

(structure)

Describes a load permission.

Group -> (string)

The name of the group.

UserId -> (string)

The AWS account ID.

Remove -> (list)

The load permissions to remove.

(structure)

Describes a load permission.

Group -> (string)

The name of the group.

UserId -> (string)

The AWS account ID.

Shorthand Syntax:

Add=[{Group=string,UserId=string},{Group=string,UserId=string}],Remove=[{Group=string,UserId=string},{Group=string,UserId=string}]

JSON Syntax:

{
  "Add": [
    {
      "Group": "all",
      "UserId": "string"
    }
    ...
  ],
  "Remove": [
    {
      "Group": "all",
      "UserId": "string"
    }
    ...
  ]
}

--description (string)

A description for the AFI.

--name (string)

A name for the AFI.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To modify the attributes of an Amazon FPGA image

This example adds load permissions for account ID 123456789012 for the specified AFI.

Command:

aws ec2 modify-fpga-image-attribute --attribute loadPermission --fpga-image-id afi-0d123e123bfc85abc --load-permission Add=[{UserId=123456789012}]

Output:

{
  "FpgaImageAttribute": {
      "FpgaImageId": "afi-0d123e123bfc85abc",
      "LoadPermissions": [
          {
              "UserId": "123456789012"
          }
      ]
  }
}

Output

FpgaImageAttribute -> (structure)

Information about the attribute.

FpgaImageId -> (string)

The ID of the AFI.

Name -> (string)

The name of the AFI.

Description -> (string)

The description of the AFI.

LoadPermissions -> (list)

The load permissions.

(structure)

Describes a load permission.

UserId -> (string)

The AWS account ID.

Group -> (string)

The name of the group.

ProductCodes -> (list)

The product codes.

(structure)

Describes a product code.

ProductCodeId -> (string)

The product code.

ProductCodeType -> (string)

The type of product code.