SDK for PHP 3.x

AWS Backup Storage 2018-04-10

Client: Aws\BackupStorage\BackupStorageClient
Service ID: backupstorage
Version: 2018-04-10

This page describes the parameters and results for the operations of the AWS Backup Storage (2018-04-10), and shows how to use the Aws\BackupStorage\BackupStorageClient object to call the described operations. This documentation is specific to the 2018-04-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DeleteObject ( array $params = [] )
Delete Object from the incremental base Backup.
GetChunk ( array $params = [] )
Gets the specified object's chunk.
GetObjectMetadata ( array $params = [] )
Get metadata associated with an Object.
ListChunks ( array $params = [] )
List chunks in a given Object
ListObjects ( array $params = [] )
List all Objects in a given Backup.
NotifyObjectComplete ( array $params = [] )
Complete upload
PutChunk ( array $params = [] )
Upload chunk.
PutObject ( array $params = [] )
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
StartObject ( array $params = [] )
Start upload containing one or many chunks.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListChunks
ListObjects

Operations

DeleteObject 

$result = $client->deleteObject([/* ... */]);
$promise = $client->deleteObjectAsync([/* ... */]);

Delete Object from the incremental base Backup.

Parameter Syntax

$result = $client->deleteObject([
    'BackupJobId' => '<string>', // REQUIRED
    'ObjectName' => '<string>', // REQUIRED
]);

Parameter Details

Members
BackupJobId
Required: Yes
Type: string
Backup job Id for the in-progress backup.
ObjectName
Required: Yes
Type: string
The name of the Object.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:

Retryable exception, indicates internal server error.

ServiceInternalException:

Deprecated. To be removed from the model.

RetryableException:

Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException:

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ResourceNotFoundException:

Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

ThrottlingException:

Increased rate over throttling limits. Can be retried with exponential backoff.

AccessDeniedException:

This error does not currently have a description.

GetChunk 

$result = $client->getChunk([/* ... */]);
$promise = $client->getChunkAsync([/* ... */]);

Gets the specified object's chunk.

Parameter Syntax

$result = $client->getChunk([
    'ChunkToken' => '<string>', // REQUIRED
    'StorageJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChunkToken
Required: Yes
Type: string
Chunk token
StorageJobId
Required: Yes
Type: string
Storage job id

Result Syntax

[
    'Checksum' => '<string>',
    'ChecksumAlgorithm' => 'SHA256',
    'Data' => <string || resource || Psr\Http\Message\StreamInterface>,
    'Length' => <integer>,
]

Result Details

Members
Checksum
Required: Yes
Type: string
Data checksum
ChecksumAlgorithm
Required: Yes
Type: string
Checksum algorithm
Data
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Chunk data
Length
Required: Yes
Type: long (int|float)
Data length

Errors

IllegalArgumentException:

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

RetryableException:

Retryable exception. In general indicates internal failure that can be fixed by retry.

ResourceNotFoundException:

Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

ServiceInternalException:

Deprecated. To be removed from the model.

ThrottlingException:

Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException:

Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException:

This error does not currently have a description.

GetObjectMetadata 

$result = $client->getObjectMetadata([/* ... */]);
$promise = $client->getObjectMetadataAsync([/* ... */]);

Get metadata associated with an Object.

Parameter Syntax

$result = $client->getObjectMetadata([
    'ObjectToken' => '<string>', // REQUIRED
    'StorageJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ObjectToken
Required: Yes
Type: string
Object token.
StorageJobId
Required: Yes
Type: string
Backup job id for the in-progress backup.

Result Syntax

[
    'MetadataBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'MetadataBlobChecksum' => '<string>',
    'MetadataBlobChecksumAlgorithm' => 'SHA256',
    'MetadataBlobLength' => <integer>,
    'MetadataString' => '<string>',
]

Result Details

Members
MetadataBlob
Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Metadata blob.
MetadataBlobChecksum
Type: string
MetadataBlob checksum.
MetadataBlobChecksumAlgorithm
Type: string
Checksum algorithm.
MetadataBlobLength
Type: long (int|float)
The size of MetadataBlob.
MetadataString
Type: string
Metadata string.

Errors

ServiceUnavailableException:

Retryable exception, indicates internal server error.

ServiceInternalException:

Deprecated. To be removed from the model.

ResourceNotFoundException:

Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

RetryableException:

Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException:

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException:

Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException:

Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException:

This error does not currently have a description.

ListChunks 

$result = $client->listChunks([/* ... */]);
$promise = $client->listChunksAsync([/* ... */]);

List chunks in a given Object

Parameter Syntax

$result = $client->listChunks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectToken' => '<string>', // REQUIRED
    'StorageJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int
Maximum number of chunks
NextToken
Type: string
Pagination token
ObjectToken
Required: Yes
Type: string
Object token
StorageJobId
Required: Yes
Type: string
Storage job id

Result Syntax

[
    'ChunkList' => [
        [
            'Checksum' => '<string>',
            'ChecksumAlgorithm' => 'SHA256',
            'ChunkToken' => '<string>',
            'Index' => <integer>,
            'Length' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ChunkList
Required: Yes
Type: Array of Chunk structures
List of chunks
NextToken
Type: string
Pagination token

Errors

ServiceUnavailableException:

Retryable exception, indicates internal server error.

ResourceNotFoundException:

Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

ServiceInternalException:

Deprecated. To be removed from the model.

RetryableException:

Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException:

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

AccessDeniedException:

This error does not currently have a description.

ListObjects 

$result = $client->listObjects([/* ... */]);
$promise = $client->listObjectsAsync([/* ... */]);

List all Objects in a given Backup.

Parameter Syntax

$result = $client->listObjects([
    'CreatedAfter' => <integer || string || DateTime>,
    'CreatedBefore' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartingObjectName' => '<string>',
    'StartingObjectPrefix' => '<string>',
    'StorageJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
CreatedAfter
Type: timestamp (string|DateTime or anything parsable by strtotime)
(Optional) Created after filter
CreatedBefore
Type: timestamp (string|DateTime or anything parsable by strtotime)
(Optional) Created before filter
MaxResults
Type: int
Maximum objects count
NextToken
Type: string
Pagination token
StartingObjectName
Type: string
Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL
StartingObjectPrefix
Type: string
Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL
StorageJobId
Required: Yes
Type: string
Storage job id

Result Syntax

[
    'NextToken' => '<string>',
    'ObjectList' => [
        [
            'ChunksCount' => <integer>,
            'MetadataString' => '<string>',
            'Name' => '<string>',
            'ObjectChecksum' => '<string>',
            'ObjectChecksumAlgorithm' => 'SUMMARY',
            'ObjectToken' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string
Pagination token
ObjectList
Required: Yes
Type: Array of BackupObject structures
Object list

Errors

ServiceUnavailableException:

Retryable exception, indicates internal server error.

ServiceInternalException:

Deprecated. To be removed from the model.

RetryableException:

Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException:

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException:

Increased rate over throttling limits. Can be retried with exponential backoff.

ResourceNotFoundException:

Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

KMSInvalidKeyUsageException:

Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException:

This error does not currently have a description.

NotifyObjectComplete 

$result = $client->notifyObjectComplete([/* ... */]);
$promise = $client->notifyObjectCompleteAsync([/* ... */]);

Complete upload

Parameter Syntax

$result = $client->notifyObjectComplete([
    'BackupJobId' => '<string>', // REQUIRED
    'MetadataBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'MetadataBlobChecksum' => '<string>',
    'MetadataBlobChecksumAlgorithm' => 'SHA256',
    'MetadataBlobLength' => <integer>,
    'MetadataString' => '<string>',
    'ObjectChecksum' => '<string>', // REQUIRED
    'ObjectChecksumAlgorithm' => 'SUMMARY', // REQUIRED
    'UploadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
BackupJobId
Required: Yes
Type: string
Backup job Id for the in-progress backup
MetadataBlob
Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Optional metadata associated with an Object. Maximum length is 4MB.
MetadataBlobChecksum
Type: string
Checksum of MetadataBlob.
MetadataBlobChecksumAlgorithm
Type: string
Checksum algorithm.
MetadataBlobLength
Type: long (int|float)
The size of MetadataBlob.
MetadataString
Type: string
Optional metadata associated with an Object. Maximum string length is 256 bytes.
ObjectChecksum
Required: Yes
Type: string
Object checksum
ObjectChecksumAlgorithm
Required: Yes
Type: string
Checksum algorithm
UploadId
Required: Yes
Type: string
Upload Id for the in-progress upload

Result Syntax

[
    'ObjectChecksum' => '<string>',
    'ObjectChecksumAlgorithm' => 'SUMMARY',
]

Result Details

Members
ObjectChecksum
Required: Yes
Type: string
Object checksum
ObjectChecksumAlgorithm
Required: Yes
Type: string
Checksum algorithm

Errors

ServiceUnavailableException:

Retryable exception, indicates internal server error.

ServiceInternalException:

Deprecated. To be removed from the model.

NotReadableInputStreamException:

Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

RetryableException:

Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException:

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException:

Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException:

Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException:

This error does not currently have a description.

PutChunk 

$result = $client->putChunk([/* ... */]);
$promise = $client->putChunkAsync([/* ... */]);

Upload chunk.

Parameter Syntax

$result = $client->putChunk([
    'BackupJobId' => '<string>', // REQUIRED
    'Checksum' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'SHA256', // REQUIRED
    'ChunkIndex' => <integer>, // REQUIRED
    'Data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'Length' => <integer>, // REQUIRED
    'UploadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
BackupJobId
Required: Yes
Type: string
Backup job Id for the in-progress backup.
Checksum
Required: Yes
Type: string
Data checksum
ChecksumAlgorithm
Required: Yes
Type: string
Checksum algorithm
ChunkIndex
Required: Yes
Type: long (int|float)
Describes this chunk's position relative to the other chunks
Data
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Data to be uploaded
Length
Required: Yes
Type: long (int|float)
Data length
UploadId
Required: Yes
Type: string
Upload Id for the in-progress upload.

Result Syntax

[
    'ChunkChecksum' => '<string>',
    'ChunkChecksumAlgorithm' => 'SHA256',
]

Result Details

Members
ChunkChecksum
Required: Yes
Type: string
Chunk checksum
ChunkChecksumAlgorithm
Required: Yes
Type: string
Checksum algorithm

Errors

ServiceUnavailableException:

Retryable exception, indicates internal server error.

ServiceInternalException:

Deprecated. To be removed from the model.

NotReadableInputStreamException:

Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

RetryableException:

Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException:

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException:

Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException:

Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException:

This error does not currently have a description.

PutObject 

$result = $client->putObject([/* ... */]);
$promise = $client->putObjectAsync([/* ... */]);

Upload object that can store object metadata String and data blob in single API call using inline chunk field.

Parameter Syntax

$result = $client->putObject([
    'BackupJobId' => '<string>', // REQUIRED
    'InlineChunk' => <string || resource || Psr\Http\Message\StreamInterface>,
    'InlineChunkChecksum' => '<string>',
    'InlineChunkChecksumAlgorithm' => '<string>',
    'InlineChunkLength' => <integer>,
    'MetadataString' => '<string>',
    'ObjectChecksum' => '<string>',
    'ObjectChecksumAlgorithm' => 'SUMMARY',
    'ObjectName' => '<string>', // REQUIRED
    'ThrowOnDuplicate' => true || false,
]);

Parameter Details

Members
BackupJobId
Required: Yes
Type: string
Backup job Id for the in-progress backup.
InlineChunk
Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Inline chunk data to be uploaded.
InlineChunkChecksum
Type: string
Inline chunk checksum
InlineChunkChecksumAlgorithm
Type: string
Inline chunk checksum algorithm
InlineChunkLength
Type: long (int|float)
Length of the inline chunk data.
MetadataString
Type: string
Store user defined metadata like backup checksum, disk ids, restore metadata etc.
ObjectChecksum
Type: string
object checksum
ObjectChecksumAlgorithm
Type: string
object checksum algorithm
ObjectName
Required: Yes
Type: string
The name of the Object to be uploaded.
ThrowOnDuplicate
Type: boolean
Throw an exception if Object name is already exist.

Result Syntax

[
    'InlineChunkChecksum' => '<string>',
    'InlineChunkChecksumAlgorithm' => 'SHA256',
    'ObjectChecksum' => '<string>',
    'ObjectChecksumAlgorithm' => 'SUMMARY',
]

Result Details

Members
InlineChunkChecksum
Required: Yes
Type: string
Inline chunk checksum
InlineChunkChecksumAlgorithm
Required: Yes
Type: string
Inline chunk checksum algorithm
ObjectChecksum
Required: Yes
Type: string
object checksum
ObjectChecksumAlgorithm
Required: Yes
Type: string
object checksum algorithm

Errors

ServiceUnavailableException:

Retryable exception, indicates internal server error.

ServiceInternalException:

Deprecated. To be removed from the model.

NotReadableInputStreamException:

Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

RetryableException:

Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException:

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException:

Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException:

Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException:

This error does not currently have a description.

StartObject 

$result = $client->startObject([/* ... */]);
$promise = $client->startObjectAsync([/* ... */]);

Start upload containing one or many chunks.

Parameter Syntax

$result = $client->startObject([
    'BackupJobId' => '<string>', // REQUIRED
    'ObjectName' => '<string>', // REQUIRED
    'ThrowOnDuplicate' => true || false,
]);

Parameter Details

Members
BackupJobId
Required: Yes
Type: string
Backup job Id for the in-progress backup
ObjectName
Required: Yes
Type: string
Name for the object.
ThrowOnDuplicate
Type: boolean
Throw an exception if Object name is already exist.

Result Syntax

[
    'UploadId' => '<string>',
]

Result Details

Members
UploadId
Required: Yes
Type: string
Upload Id for a given upload.

Errors

ServiceUnavailableException:

Retryable exception, indicates internal server error.

ServiceInternalException:

Deprecated. To be removed from the model.

RetryableException:

Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException:

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ResourceNotFoundException:

Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

DataAlreadyExistsException:

Non-retryable exception. Attempted to create already existing object or chunk. This message contains a checksum of already presented data.

ThrottlingException:

Increased rate over throttling limits. Can be retried with exponential backoff.

AccessDeniedException:

This error does not currently have a description.

Shapes

AccessDeniedException

Members
Message
Type: string

BackupObject

Description
Object
Members
ChunksCount
Type: long (int|float)
Number of chunks in object
MetadataString
Type: string
Metadata string associated with the Object
Name
Required: Yes
Type: string
Object name
ObjectChecksum
Required: Yes
Type: string
Object checksum
ObjectChecksumAlgorithm
Required: Yes
Type: string
Checksum algorithm
ObjectToken
Required: Yes
Type: string
Object token

Chunk

Description
Chunk
Members
Checksum
Required: Yes
Type: string
Chunk checksum
ChecksumAlgorithm
Required: Yes
Type: string
Checksum algorithm
ChunkToken
Required: Yes
Type: string
Chunk token
Index
Required: Yes
Type: long (int|float)
Chunk index
Length
Required: Yes
Type: long (int|float)
Chunk length

DataAlreadyExistsException

Description
Non-retryable exception. Attempted to create already existing object or chunk. This message contains a checksum of already presented data.
Members
Checksum
Type: string
Data checksum used
ChecksumAlgorithm
Type: string
Checksum algorithm used
Message
Type: string

IllegalArgumentException

Description
Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
Members
Message
Type: string

KMSInvalidKeyUsageException

Description
Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
Members
Message
Type: string

NotReadableInputStreamException

Description
Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
Members
Message
Type: string

ResourceNotFoundException

Description
Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
Members
Message
Type: string

RetryableException

Description
Retryable exception. In general indicates internal failure that can be fixed by retry.
Members
Message
Type: string

ServiceInternalException

Description
Deprecated. To be removed from the model.
Members
Message
Type: string

ServiceUnavailableException

Description
Retryable exception, indicates internal server error.
Members
Message
Type: string

ThrottlingException

Description
Increased rate over throttling limits. Can be retried with exponential backoff.
Members
Message
Type: string