create_image_usage_report ¶

def create_image_usage_report(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    image_id: Optional["capo_ec2.types.image_id.ImageId"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    resource_types: Optional[
        "capo_ec2.types.image_usage_resource_type_request_list.ImageUsageResourceTypeRequestList"
    ] = None,
    account_ids: Optional[
        "capo_ec2.types.image_usage_report_user_id_string_list.ImageUsageReportUserIdStringList"
    ] = None,
    client_token: Optional[
        "capo_ec2.types.create_image_usage_report_client_token.CreateImageUsageReportClientToken"
    ] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
) -> "capo_ec2.types.create_image_usage_report_result.CreateImageUsageReportResult":
    """<p>Creates a report that shows how your image is used across other Amazon Web Services accounts. The report provides visibility into which accounts are using the specified image, and how many resources (EC2 instances or launch templates) are referencing it.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/your-ec2-ami-usage.html">View your AMI usage</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        image_id: <p>The ID of the image to report on.</p>
        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>
        resource_types: <p>The resource types to include in the report.</p>
        account_ids: <p>The Amazon Web Services account IDs to include in the report. To include all accounts, omit this parameter.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure idempotency of the request.</p>
        tag_specifications: <p>The tags to apply to the report on creation. The <code>ResourceType</code> must be set to <code>image-usage-report</code>; any other value will cause the report creation to fail.</p> <p>To tag a report after it has been created, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html">CreateTags</a>.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_image_usage_report_request.CreateImageUsageReportRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_image_usage_report_result.CreateImageUsageReportResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_image_usage_report

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateImageUsageReport")
    )
    input_: capo_ec2.types.create_image_usage_report_request.CreateImageUsageReportRequest = {}
    if image_id is not None:
        input_["image_id"] = image_id
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if resource_types is not None:
        input_["resource_types"] = resource_types
    if account_ids is not None:
        input_["account_ids"] = account_ids
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications

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