create_storedi_scsi_volume async ¶

async def create_storedi_scsi_volume(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    disk_id: "capo_storage_gateway.types.disk_id.DiskId",
    preserve_existing_data: "capo_storage_gateway.types.boolean2.Boolean2",
    target_name: "capo_storage_gateway.types.target_name.TargetName",
    network_interface_id: "capo_storage_gateway.types.network_interface_id.NetworkInterfaceId",
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
    snapshot_id: Optional[
        "capo_storage_gateway.types.snapshot_id.SnapshotId"
    ] = None,
    kms_encrypted: Optional["capo_storage_gateway.types.boolean.Boolean"] = None,
    kms_key: Optional["capo_storage_gateway.types.kms_key.KMSKey"] = None,
    tags: Optional["capo_storage_gateway.types.tags.Tags"] = None,
) -> "capo_storage_gateway.types.create_storedi_scsi_volume_output.CreateStorediSCSIVolumeOutput":
    """<p>Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.</p> <p>The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.</p> <p>In the request, you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.</p>

    Args:
        disk_id: <p>The unique identifier for the gateway local disk that is configured as a stored volume. Use <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html">ListLocalDisks</a> to list disk IDs for a gateway.</p>
        snapshot_id: <p>The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>.</p>
        preserve_existing_data: <p>Set to <code>true</code> if you want to preserve the data on the local disk. Otherwise, set to <code>false</code> to create an empty volume.</p> <p>Valid Values: <code>true</code> | <code>false</code> </p>
        target_name: <p>The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume</code>. The target name must be unique across all volumes on a gateway.</p> <p>If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.</p>
        network_interface_id: <p>The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway.</p> <p>Valid Values: A valid IP address.</p>
        kms_encrypted: <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own KMS key, or <code>false</code> to use a key managed by Amazon S3. Optional.</p> <p>Valid Values: <code>true</code> | <code>false</code> </p>
        kms_key: <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
        tags: <p>A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</p> </note>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To create a stored iSCSI volume
        Creates a stored volume on a specified stored gateway.

        >>> await client.create_storedi_scsi_volume(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B', disk_id='pci-0000:03:00.0-scsi-0:0:0:0', snapshot_id='snap-f47b7b94', preserve_existing_data=True, target_name='my-volume', network_interface_id='10.1.1.1')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.create_storedi_scsi_volume_input.CreateStorediSCSIVolumeInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.create_storedi_scsi_volume_output.CreateStorediSCSIVolumeOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.create_storedi_scsi_volume

        (
            output,
            http_response,
        ) = await capo_storage_gateway._operations.storage_gateway_20130630.create_storedi_scsi_volume.async_create_storedi_scsi_volume(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateStorediSCSIVolume")
    )
    input_: capo_storage_gateway.types.create_storedi_scsi_volume_input.CreateStorediSCSIVolumeInput = {
        "gateway_arn": gateway_arn,
        "disk_id": disk_id,
        "preserve_existing_data": preserve_existing_data,
        "target_name": target_name,
        "network_interface_id": network_interface_id,
    }
    if snapshot_id is not None:
        input_["snapshot_id"] = snapshot_id
    if kms_encrypted is not None:
        input_["kms_encrypted"] = kms_encrypted
    if kms_key is not None:
        input_["kms_key"] = kms_key
    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