NAME

Paws::EBS - Perl Interface to AWS Amazon Elastic Block Store

SYNOPSIS

  use Paws;
  my $obj = Paws->service('EBS');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

You can create incremental snapshots directly from data on-premises into EBS volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an EBS snapshot during a disaster. Then after recovery, you can restore it back to AWS or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an EBS Snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html) in the Amazon Elastic Compute Cloud User Guide. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/ebs-service.html) in the AWS General Reference.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02>

METHODS

CompleteSnapshot

ChangedBlocksCount => Int
SnapshotId => Str
[Checksum => Str]
[ChecksumAggregationMethod => Str]
[ChecksumAlgorithm => Str]

Each argument is described in detail in: Paws::EBS::CompleteSnapshot

Returns: a Paws::EBS::CompleteSnapshotResponse instance

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to "completed". You cannot write new blocks to a snapshot after it has been completed.

Each argument is described in detail in: Paws::EBS::GetSnapshotBlock

Returns: a Paws::EBS::GetSnapshotBlockResponse instance

Returns the data in a block in an Amazon Elastic Block Store snapshot.

ListChangedBlocks

SecondSnapshotId => Str
[FirstSnapshotId => Str]
[MaxResults => Int]
[NextToken => Str]
[StartingBlockIndex => Int]

Each argument is described in detail in: Paws::EBS::ListChangedBlocks

Returns: a Paws::EBS::ListChangedBlocksResponse instance

Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

ListSnapshotBlocks

SnapshotId => Str
[MaxResults => Int]
[NextToken => Str]
[StartingBlockIndex => Int]

Each argument is described in detail in: Paws::EBS::ListSnapshotBlocks

Returns: a Paws::EBS::ListSnapshotBlocksResponse instance

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

PutSnapshotBlock

BlockData => Str
BlockIndex => Int
Checksum => Str
ChecksumAlgorithm => Str
DataLength => Int
SnapshotId => Str
[Progress => Int]

Each argument is described in detail in: Paws::EBS::PutSnapshotBlock

Returns: a Paws::EBS::PutSnapshotBlockResponse instance

Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the "pending" state.

Data written to a snapshot must be aligned with 512-byte sectors.

StartSnapshot

VolumeSize => Int
[ClientToken => Str]
[Description => Str]
[Encrypted => Bool]
[KmsKeyArn => Str]
[ParentSnapshotId => Str]
[Tags => ArrayRef[Paws::EBS::Tag]]
[Timeout => Int]

Each argument is described in detail in: Paws::EBS::StartSnapshot

Returns: a Paws::EBS::StartSnapshotResponse instance

Creates a new Amazon EBS snapshot. The new snapshot enters the "pending" state after the request completes.

After creating the snapshot, use PutSnapshotBlock (https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html) to write blocks of data to the snapshot.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>