Skip to content

describe_fpga_image_attribute

describe_fpga_image_attribute(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    fpga_image_id: Optional[FpgaImageId] = None,
    attribute: Optional[FpgaImageAttributeName] = None,
) -> DescribeFpgaImageAttributeResult

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

Parameters:

  • dry_run (Optional[Boolean], default: 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 (Optional[FpgaImageId], default: None ) –

    The ID of the AFI.

  • attribute (Optional[FpgaImageAttributeName], default: None ) –

    The AFI attribute.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_fpga_image_attribute(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    fpga_image_id: Optional["capo_ec2.types.fpga_image_id.FpgaImageId"] = None,
    attribute: Optional[
        "capo_ec2.types.fpga_image_attribute_name.FpgaImageAttributeName"
    ] = None,
) -> "capo_ec2.types.describe_fpga_image_attribute_result.DescribeFpgaImageAttributeResult":
    """<p>Describes the specified attribute of the specified Amazon FPGA Image (AFI).</p>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        fpga_image_id: <p>The ID of the AFI.</p>
        attribute: <p>The AFI attribute.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_fpga_image_attribute_request.DescribeFpgaImageAttributeRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_fpga_image_attribute_result.DescribeFpgaImageAttributeResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_fpga_image_attribute

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_fpga_image_attribute.describe_fpga_image_attribute(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFpgaImageAttribute")
    )
    input_: capo_ec2.types.describe_fpga_image_attribute_request.DescribeFpgaImageAttributeRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if fpga_image_id is not None:
        input_["fpga_image_id"] = fpga_image_id
    if attribute is not None:
        input_["attribute"] = attribute

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output