create_instance_snapshot `async` ¶

create_instance_snapshot(
    instance_snapshot_name: ResourceName,
    instance_name: ResourceName,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    tags: Optional[TagList] = None,
) -> CreateInstanceSnapshotResult

Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.

The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

Parameters:

instance_snapshot_name (ResourceName) –

The name for your new snapshot.
instance_name (ResourceName) –

The Lightsail instance on which to base your snapshot.
tags (Optional[TagList], default: None ) –

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Raises:

AccessDeniedException –

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
AccountSetupInProgressException –

Lightsail throws this exception when an account is still in the setup in progress state.
InvalidInputException –

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException –

Lightsail throws this exception when it cannot find a resource.
OperationFailureException –

Lightsail throws this exception when an operation fails to execute.
RegionSetupInProgressException –

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
ServiceException –

A general service exception.
UnauthenticatedException –

Lightsail throws this exception when the user has not been authenticated.
UnknownServiceError –

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

Source code in docs_src/capo_lightsail/_services/async_lightsail.py

async def create_instance_snapshot(
    self,
    instance_snapshot_name: "capo_lightsail.types.resource_name.ResourceName",
    instance_name: "capo_lightsail.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    tags: Optional["capo_lightsail.types.tag_list.TagList"] = None,
) -> "capo_lightsail.types.create_instance_snapshot_result.CreateInstanceSnapshotResult":
    """<p>Creates a snapshot of a specific virtual private server, or <i>instance</i>. You can use a snapshot to create a new instance that is based on that snapshot.</p> <p>The <code>create instance snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags">Amazon Lightsail Developer Guide</a>.</p>

    Args:
        instance_snapshot_name: <p>The name for your new snapshot.</p>
        instance_name: <p>The Lightsail instance on which to base your snapshot.</p>
        tags: <p>The tag keys and optional values to add to the resource during create.</p> <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.account_setup_in_progress_exception.AccountSetupInProgressException: <p>Lightsail throws this exception when an account is still in the setup in progress state.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.operation_failure_exception.OperationFailureException: <p>Lightsail throws this exception when an operation fails to execute.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lightsail.types.create_instance_snapshot_request.CreateInstanceSnapshotRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.create_instance_snapshot_result.CreateInstanceSnapshotResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.create_instance_snapshot

        (
            output,
            http_response,
        ) = await capo_lightsail._operations.lightsail_20161128.create_instance_snapshot.async_create_instance_snapshot(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateInstanceSnapshot")
    )
    input_: capo_lightsail.types.create_instance_snapshot_request.CreateInstanceSnapshotRequest = {
        "instance_snapshot_name": instance_snapshot_name,
        "instance_name": instance_name,
    }
    if tags is not None:
        input_["tags"] = tags

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

create_instance_snapshot async ¶

create_instance_snapshot `async` ¶