Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetSnapshot

Returns information about a specific snapshot.

Request Syntax


{
   "ownerAccount": "string",
   "snapshotArn": "string",
   "snapshotName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ownerAccount

The owner AWS account of a snapshot shared with another user.

Type: String

Required: No

snapshotArn

The Amazon Resource Name (ARN) of the snapshot to return.

Type: String

Required: No

snapshotName

The name of the snapshot to return.

Type: String

Required: No

Response Syntax


{
   "snapshot": { 
      "accountsWithProvisionedRestoreAccess": [ "string" ],
      "accountsWithRestoreAccess": [ "string" ],
      "actualIncrementalBackupSizeInMegaBytes": number,
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "backupProgressInMegaBytes": number,
      "currentBackupRateInMegaBytesPerSecond": number,
      "elapsedTimeInSeconds": number,
      "estimatedSecondsToCompletion": number,
      "kmsKeyId": "string",
      "namespaceArn": "string",
      "namespaceName": "string",
      "ownerAccount": "string",
      "snapshotArn": "string",
      "snapshotCreateTime": "string",
      "snapshotName": "string",
      "snapshotRemainingDays": number,
      "snapshotRetentionPeriod": number,
      "snapshotRetentionStartTime": "string",
      "status": "string",
      "totalBackupSizeInMegaBytes": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

snapshot

The returned snapshot object.

Type: Snapshot object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400