Serialized Form (AWS Java SDK for Amazon Elastic Block Store 1.11.939 API)

Package com.amazonaws.services.ebs.model
- Class com.amazonaws.services.ebs.model.AccessDeniedException extends AmazonEBSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - reason
```
String reason
```
      The reason for the exception.
- Class com.amazonaws.services.ebs.model.AmazonEBSException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ebs.model.Block extends Object implements Serializable
  - Serialized Fields
    - blockIndex
```
Integer blockIndex
```
      The block index.
    - blockToken
```
String blockToken
```
      The block token for the block index.
- Class com.amazonaws.services.ebs.model.ChangedBlock extends Object implements Serializable
  - Serialized Fields
    - blockIndex
```
Integer blockIndex
```
      The block index.
    - firstBlockToken
```
String firstBlockToken
```
      The block token for the block index of the FirstSnapshotId specified in the ListChangedBlocks operation. This value is absent if the first snapshot does not have the changed block that is on the second snapshot.
    - secondBlockToken
```
String secondBlockToken
```
      The block token for the block index of the SecondSnapshotId specified in the ListChangedBlocks operation.
- Class com.amazonaws.services.ebs.model.CompleteSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot.
    - changedBlocksCount
```
Integer changedBlocksCount
```
      The number of blocks that were written to the snapshot.
    - checksum
```
String checksum
```
      An aggregated Base-64 SHA256 checksum based on the checksums of each written block.
      
      To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.
    - checksumAlgorithm
```
String checksumAlgorithm
```
      The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.
    - checksumAggregationMethod
```
String checksumAggregationMethod
```
      The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.
- Class com.amazonaws.services.ebs.model.CompleteSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the snapshot.
- Class com.amazonaws.services.ebs.model.ConcurrentLimitExceededException extends AmazonEBSException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ebs.model.ConflictException extends AmazonEBSException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ebs.model.GetSnapshotBlockRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot containing the block from which to get data.
    - blockIndex
```
Integer blockIndex
```
      The block index of the block from which to get data.
      
      Obtain the BlockIndex by running the ListChangedBlocks or ListSnapshotBlocks operations.
    - blockToken
```
String blockToken
```
      The block token of the block from which to get data.
      
      Obtain the BlockToken by running the ListChangedBlocks or ListSnapshotBlocks operations.
- Class com.amazonaws.services.ebs.model.GetSnapshotBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - dataLength
```
Integer dataLength
```
      The size of the data in the block.
    - blockData
```
InputStream blockData
```
      The data content of the block.
    - checksum
```
String checksum
```
      The checksum generated for the block, which is Base64 encoded.
    - checksumAlgorithm
```
String checksumAlgorithm
```
      The algorithm used to generate the checksum for the block, such as SHA256.
- Class com.amazonaws.services.ebs.model.InternalServerException extends AmazonEBSException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ebs.model.ListChangedBlocksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - firstSnapshotId
```
String firstSnapshotId
```
      The ID of the first snapshot to use for the comparison.
      
      The FirstSnapshotID parameter must be specified with a SecondSnapshotId parameter; otherwise, an error occurs.
    - secondSnapshotId
```
String secondSnapshotId
```
      The ID of the second snapshot to use for the comparison.
      
      The SecondSnapshotId parameter must be specified with a FirstSnapshotID parameter; otherwise, an error occurs.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
    - maxResults
```
Integer maxResults
```
      The number of results to return.
    - startingBlockIndex
```
Integer startingBlockIndex
```
      The block index from which the comparison should start.
      
      The list in the response will start from this block index or the next valid block index in the snapshots.
- Class com.amazonaws.services.ebs.model.ListChangedBlocksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - changedBlocks
```
List<E> changedBlocks
```
      An array of objects containing information about the changed blocks.
    - expiryTime
```
Date expiryTime
```
      The time when the BlockToken expires.
    - volumeSize
```
Long volumeSize
```
      The size of the volume in GB.
    - blockSize
```
Integer blockSize
```
      The size of the block.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ebs.model.ListSnapshotBlocksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot from which to get block indexes and block tokens.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
    - maxResults
```
Integer maxResults
```
      The number of results to return.
    - startingBlockIndex
```
Integer startingBlockIndex
```
      The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.
- Class com.amazonaws.services.ebs.model.ListSnapshotBlocksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - blocks
```
List<E> blocks
```
      An array of objects containing information about the blocks.
    - expiryTime
```
Date expiryTime
```
      The time when the BlockToken expires.
    - volumeSize
```
Long volumeSize
```
      The size of the volume in GB.
    - blockSize
```
Integer blockSize
```
      The size of the block.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ebs.model.PutSnapshotBlockRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot.
    - blockIndex
```
Integer blockIndex
```
      The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.
    - blockData
```
InputStream blockData
```
      The data to write to the block.
      
      The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.
    - dataLength
```
Integer dataLength
```
      The size of the data to write to the block, in bytes. Currently, the only supported size is 524288.
      
      Valid values: 524288
    - progress
```
Integer progress
```
      The progress of the write process, as a percentage.
    - checksum
```
String checksum
```
      A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.
    - checksumAlgorithm
```
String checksumAlgorithm
```
      The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.
- Class com.amazonaws.services.ebs.model.PutSnapshotBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - checksum
```
String checksum
```
      The SHA256 checksum generated for the block data by Amazon EBS.
    - checksumAlgorithm
```
String checksumAlgorithm
```
      The algorithm used by Amazon EBS to generate the checksum.
- Class com.amazonaws.services.ebs.model.RequestThrottledException extends AmazonEBSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - reason
```
String reason
```
      The reason for the exception.
- Class com.amazonaws.services.ebs.model.ResourceNotFoundException extends AmazonEBSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - reason
```
String reason
```
      The reason for the exception.
- Class com.amazonaws.services.ebs.model.ServiceQuotaExceededException extends AmazonEBSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - reason
```
String reason
```
      The reason for the exception.
- Class com.amazonaws.services.ebs.model.StartSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeSize
```
Long volumeSize
```
      The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).
    - parentSnapshotId
```
String parentSnapshotId
```
      The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.
      
      If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.
    - tags
```
List<E> tags
```
      The tags to apply to the snapshot.
    - description
```
String description
```
      A description for the snapshot.
    - clientToken
```
String clientToken
```
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
      
      If you do not specify a client token, one is automatically generated by the AWS SDK.
      
      For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.
    - encrypted
```
Boolean encrypted
```
      Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true. To create an unencrypted snapshot, omit this parameter.
      
      If you specify a value for ParentSnapshotId, omit this parameter.
      
      If you specify true, the snapshot is encrypted using the CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use ModifyEbsDefaultKmsKeyId.
      
      If your account is enabled for encryption by default, you cannot set this parameter to false. In this case, you can omit this parameter.
      
      For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.
    - kmsKeyArn
```
String kmsKeyArn
```
      The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.
      
      If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.
      
      If Encrypted is set to true, you must specify a CMK ARN.
    - timeout
```
Integer timeout
```
      The amount of time (in minutes) after which the snapshot is automatically cancelled if:
      
      No blocks are written to the snapshot.
      
      The snapshot is not completed after writing the last block of data.
      
      If no value is specified, the timeout defaults to 60 minutes.
- Class com.amazonaws.services.ebs.model.StartSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - description
```
String description
```
      The description of the snapshot.
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot.
    - ownerId
```
String ownerId
```
      The AWS account ID of the snapshot owner.
    - status
```
String status
```
      The status of the snapshot.
    - startTime
```
Date startTime
```
      The timestamp when the snapshot was created.
    - volumeSize
```
Long volumeSize
```
      The size of the volume, in GiB.
    - blockSize
```
Integer blockSize
```
      The size of the blocks in the snapshot, in bytes.
    - tags
```
List<E> tags
```
      The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
    - parentSnapshotId
```
String parentSnapshotId
```
      The ID of the parent snapshot.
    - kmsKeyArn
```
String kmsKeyArn
```
      The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the snapshot.
- Class com.amazonaws.services.ebs.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key of the tag.
    - value
```
String value
```
      The value of the tag.
- Class com.amazonaws.services.ebs.model.ValidationException extends AmazonEBSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - reason
```
String reason
```
      The reason for the validation exception.

Serialized Form

Package com.amazonaws.services.ebs.model

Class com.amazonaws.services.ebs.model.AccessDeniedException extends AmazonEBSException implements Serializable

Serialized Fields

reason

Class com.amazonaws.services.ebs.model.AmazonEBSException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.ebs.model.Block extends Object implements Serializable

Serialized Fields

blockIndex

blockToken

Class com.amazonaws.services.ebs.model.ChangedBlock extends Object implements Serializable

Serialized Fields

blockIndex

firstBlockToken

secondBlockToken

Class com.amazonaws.services.ebs.model.CompleteSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

changedBlocksCount

checksum

checksumAlgorithm

checksumAggregationMethod

Class com.amazonaws.services.ebs.model.CompleteSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

status

Class com.amazonaws.services.ebs.model.ConcurrentLimitExceededException extends AmazonEBSException implements Serializable

Class com.amazonaws.services.ebs.model.ConflictException extends AmazonEBSException implements Serializable

Class com.amazonaws.services.ebs.model.GetSnapshotBlockRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

blockIndex

blockToken

Class com.amazonaws.services.ebs.model.GetSnapshotBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

dataLength

blockData

checksum

checksumAlgorithm

Class com.amazonaws.services.ebs.model.InternalServerException extends AmazonEBSException implements Serializable

Class com.amazonaws.services.ebs.model.ListChangedBlocksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

firstSnapshotId

secondSnapshotId

nextToken

maxResults

startingBlockIndex

Class com.amazonaws.services.ebs.model.ListChangedBlocksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

changedBlocks

expiryTime

volumeSize

blockSize

nextToken

Class com.amazonaws.services.ebs.model.ListSnapshotBlocksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

nextToken

maxResults

startingBlockIndex

Class com.amazonaws.services.ebs.model.ListSnapshotBlocksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

blocks

expiryTime

volumeSize

blockSize

nextToken

Class com.amazonaws.services.ebs.model.PutSnapshotBlockRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

blockIndex

blockData

dataLength

progress

checksum

checksumAlgorithm

Class com.amazonaws.services.ebs.model.PutSnapshotBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

checksum

checksumAlgorithm

Class com.amazonaws.services.ebs.model.RequestThrottledException extends AmazonEBSException implements Serializable