EC2 / Client / modify_fpga_image_attribute

modify_fpga_image_attribute

EC2.Client.modify_fpga_image_attribute(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.modify_fpga_image_attribute(
    DryRun=True|False,
    FpgaImageId='string',
    Attribute='description'|'name'|'loadPermission'|'productCodes',
    OperationType='add'|'remove',
    UserIds=[
        'string',
    ],
    UserGroups=[
        'string',
    ],
    ProductCodes=[
        'string',
    ],
    LoadPermission={
        'Add': [
            {
                'Group': 'all',
                'UserId': 'string'
            },
        ],
        'Remove': [
            {
                'Group': 'all',
                'UserId': 'string'
            },
        ]
    },
    Description='string',
    Name='string'
)

Parameters:

• DryRun (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.

• FpgaImageId (string) –

  [REQUIRED]

  The ID of the AFI.

• Attribute (string) – The name of the attribute.

• OperationType (string) – The operation type.

• UserIds (list) –

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

  • (string) –

• UserGroups (list) –

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

  • (string) –

• ProductCodes (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) –

• LoadPermission (dict) –

  The load permission for the AFI.

  • Add (list) –

    The load permissions to add.

    • (dict) –

      Describes a load permission.

      • Group (string) –

        The name of the group.

      • UserId (string) –

        The Amazon Web Services account ID.

  • Remove (list) –

    The load permissions to remove.

    • (dict) –

      Describes a load permission.

      • Group (string) –

        The name of the group.

      • UserId (string) –

        The Amazon Web Services account ID.

• Description (string) – A description for the AFI.

• Name (string) – A name for the AFI.

Return type:

dict

Returns:

Response Syntax

{
    'FpgaImageAttribute': {
        'FpgaImageId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LoadPermissions': [
            {
                'UserId': 'string',
                'Group': 'all'
            },
        ],
        'ProductCodes': [
            {
                'ProductCodeId': 'string',
                'ProductCodeType': 'devpay'|'marketplace'
            },
        ]
    }
}

Response Structure

• (dict) –

  • FpgaImageAttribute (dict) –

    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.

      • (dict) –

        Describes a load permission.

        • UserId (string) –

          The Amazon Web Services account ID.

        • Group (string) –

          The name of the group.

    • ProductCodes (list) –

      The product codes.

      • (dict) –

        Describes a product code.

        • ProductCodeId (string) –

          The product code.

        • ProductCodeType (string) –

          The type of product code.