AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon DynamoDB ExportTableToPointInTime API operation.

Syntax

Export-DDBTableToPointInTime
-ExportFormat <ExportFormat>
-IncrementalExportSpecification_ExportFromTime <DateTime>
-ExportTime <DateTime>
-IncrementalExportSpecification_ExportToTime <DateTime>
-ExportType <ExportType>
-IncrementalExportSpecification_ExportViewType <ExportViewType>
-FilterSpecification_ExpressionAttributeName <Hashtable>
-FilterSpecification_ExpressionAttributeValue <Hashtable>
-FilterSpecification_FilterExpression <String>
-FilterSpecification_KeyConditionExpression <String>
-FilterSpecification_ProjectionExpression <String>
-S3Bucket <String>
-S3BucketOwner <String>
-S3Prefix <String>
-S3SseAlgorithm <S3SseAlgorithm>
-S3SseKmsKeyId <String>
-TableArn <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDynamoDBConfig>

Description

Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.

Parameters

-ClientConfig <AmazonDynamoDBConfig>
Amazon.PowerShell.Cmdlets.DDB.AmazonDynamoDBClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Providing a ClientToken makes the call to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an ExportConflictException.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExportFormat <ExportFormat>
The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExportTime <DateTime>
Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExportType <ExportType>
Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterSpecification_ExpressionAttributeName <Hashtable>
One or more substitution tokens for attribute names in an expression. For more information, see Expression Attribute Names in the Amazon DynamoDB Developer Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilterSpecification_ExpressionAttributeNames
-FilterSpecification_ExpressionAttributeValue <Hashtable>
One or more values that can be substituted in an expression. For more information, see Expression Attribute Values in the Amazon DynamoDB Developer Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilterSpecification_ExpressionAttributeValues
-FilterSpecification_FilterExpression <String>
A condition that filters which items are included in the export. This parameter uses the same syntax as FilterExpression in Query and Scan. If you don't provide KeyConditionExpression, this expression can also reference key attributes. If you don't specify this parameter, all items are included in the export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterSpecification_KeyConditionExpression <String>
A condition expression that filters items by key values. The expression must test equality on a single partition key value and can optionally compare a sort key value. This parameter uses the same syntax as KeyConditionExpression in Query. When you provide this parameter, FilterExpression can only reference non-key attributes. If you don't specify this parameter, all items are eligible for export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterSpecification_ProjectionExpression <String>
The attributes you want to retrieve for items included in the export. Separate attribute names in the expression with commas. If you don't specify this parameter, all attributes are returned.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncrementalExportSpecification_ExportFromTime <DateTime>
Time in the past which provides the inclusive start range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state including and after this point in time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncrementalExportSpecification_ExportToTime <DateTime>
Time in the past which provides the exclusive end range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state just prior to this point in time. If this is not provided, the latest time with data available will be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncrementalExportSpecification_ExportViewType <ExportViewType>
The view type that was chosen for the export. Valid values are NEW_AND_OLD_IMAGES and NEW_IMAGES. The default value is NEW_AND_OLD_IMAGES.NEW_AND_OLD_IMAGES exports both the new and old images of each changed item, while NEW_IMAGES exports only the new (latest) image. The view type you choose determines the structure of each item in the output for insert, update, and delete operations. For details and examples of how each view type shapes the export output, see DynamoDB table export output format in the Amazon DynamoDB Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Bucket <String>
The name of the Amazon S3 bucket to export the snapshot to.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3BucketOwner <String>
The ID of the Amazon Web Services account that owns the bucket the export will be stored in.S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Prefix <String>
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3SseAlgorithm <S3SseAlgorithm>
Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:
  • AES256 - server-side encryption with Amazon S3 managed keys
  • KMS - server-side encryption with KMS managed keys
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3SseKmsKeyId <String>
The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ExportDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DynamoDBv2.Model.ExportTableToPointInTimeResponse). Specifying the name of a property of type Amazon.DynamoDBv2.Model.ExportTableToPointInTimeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableArn <String>
The Amazon Resource Name (ARN) associated with the table to export.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.DynamoDBv2.Model.ExportDescription or Amazon.DynamoDBv2.Model.ExportTableToPointInTimeResponse
This cmdlet returns an Amazon.DynamoDBv2.Model.ExportDescription object. The service call response (type Amazon.DynamoDBv2.Model.ExportTableToPointInTimeResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z