EC2 / Client / describe_fpga_image_attribute

describe_fpga_image_attribute

EC2.Client.describe_fpga_image_attribute(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_fpga_image_attribute(
    DryRun=True|False,
    FpgaImageId='string',
    Attribute='description'|'name'|'loadPermission'|'productCodes'
)

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) –

  [REQUIRED]

  The AFI attribute.

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.