create_store_image_task `async` ¶

create_store_image_task(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    image_id: Optional[ImageId] = None,
    bucket: Optional[String] = None,
    s3_object_tags: Optional[S3ObjectTagList] = None,
    dry_run: Optional[Boolean] = None,
) -> CreateStoreImageTaskResult

Stores an AMI as a single object in an Amazon S3 bucket.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using S3 in the Amazon EC2 User Guide.

For more information, see Store and restore an AMI using S3 in the Amazon EC2 User Guide.

Parameters:

image_id (Optional[ImageId], default: None ) –

The ID of the AMI.
bucket (Optional[String], default: None ) –

The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed.
s3_object_tags (Optional[S3ObjectTagList], default: None ) –

The tags to apply to the AMI object that will be stored in the Amazon S3 bucket.
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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def create_store_image_task(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    image_id: Optional["capo_ec2.types.image_id.ImageId"] = None,
    bucket: Optional["capo_ec2.types.string.String"] = None,
    s3_object_tags: Optional[
        "capo_ec2.types.s3_object_tag_list.S3ObjectTagList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.create_store_image_task_result.CreateStoreImageTaskResult":
    """<p>Stores an AMI as a single object in an Amazon S3 bucket.</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:
        image_id: <p>The ID of the AMI.</p>
        bucket: <p>The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed. </p>
        s3_object_tags: <p>The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. </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>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.create_store_image_task_request.CreateStoreImageTaskRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.create_store_image_task_result.CreateStoreImageTaskResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_store_image_task

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.create_store_image_task.async_create_store_image_task(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateStoreImageTask")
    )
    input_: capo_ec2.types.create_store_image_task_request.CreateStoreImageTaskRequest = {}
    if image_id is not None:
        input_["image_id"] = image_id
    if bucket is not None:
        input_["bucket"] = bucket
    if s3_object_tags is not None:
        input_["s3_object_tags"] = s3_object_tags
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

create_store_image_task async ¶

create_store_image_task `async` ¶