create_restore_image_task ¶

def create_restore_image_task(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    bucket: Optional["capo_ec2.types.string.String"] = None,
    object_key: Optional["capo_ec2.types.string.String"] = None,
    name: Optional["capo_ec2.types.image_name_request.ImageNameRequest"] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.create_restore_image_task_result.CreateRestoreImageTaskResult":
    """<p>Starts a task that restores an AMI from an Amazon S3 object that was previously created by using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p> <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using S3</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using S3</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        bucket: <p>The name of the Amazon S3 bucket that contains the stored AMI object.</p>
        object_key: <p>The name of the stored AMI object in the bucket.</p>
        name: <p>The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.</p>
        tag_specifications: <p>The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.</p> <ul> <li> <p>To tag the AMI, the value for <code>ResourceType</code> must be <code>image</code>.</p> </li> <li> <p>To tag the snapshots, the value for <code>ResourceType</code> must be <code>snapshot</code>. The same tag is applied to all of the snapshots that are created.</p> </li> </ul>
        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>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_restore_image_task_request.CreateRestoreImageTaskRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_restore_image_task_result.CreateRestoreImageTaskResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_restore_image_task

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRestoreImageTask")
    )
    input_: capo_ec2.types.create_restore_image_task_request.CreateRestoreImageTaskRequest = {}
    if bucket is not None:
        input_["bucket"] = bucket
    if object_key is not None:
        input_["object_key"] = object_key
    if name is not None:
        input_["name"] = name
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if dry_run is not None:
        input_["dry_run"] = dry_run

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