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 ImportTable API operation.

Syntax

Import-DDBTable
-InputFormat <InputFormat>
-TableCreationParameters_AttributeDefinition <AttributeDefinition[]>
-TableCreationParameters_BillingMode <BillingMode>
-Csv_Delimiter <String>
-SSESpecification_Enabled <Boolean>
-TableCreationParameters_GlobalSecondaryIndex <GlobalSecondaryIndex[]>
-Csv_HeaderList <String[]>
-InputCompressionType <InputCompressionType>
-TableCreationParameters_KeySchema <KeySchemaElement[]>
-SSESpecification_KMSMasterKeyId <String>
-ProvisionedThroughput_ReadCapacityUnit <Int64>
-S3BucketSource_S3Bucket <String>
-S3BucketSource_S3BucketOwner <String>
-S3BucketSource_S3KeyPrefix <String>
-SSESpecification_SSEType <SSEType>
-TableCreationParameters_TableName <String>
-ProvisionedThroughput_WriteCapacityUnit <Int64>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDynamoDBConfig>

Description

Imports table data from an S3 bucket.

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 ImportTableInput 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 IdempotentParameterMismatch exception.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Csv_Delimiter <String>
The delimiter used for separating items in the CSV file being imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputFormatOptions_Csv_Delimiter
-Csv_HeaderList <String[]>
List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputFormatOptions_Csv_HeaderList
-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)
-InputCompressionType <InputCompressionType>
Type of compression to be used on the input coming from the imported table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputFormat <InputFormat>
The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the InputFormat parameter. The -PassThru parameter is deprecated, use -Select '^InputFormat' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisionedThroughput_ReadCapacityUnit <Int64>
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableCreationParameters_ProvisionedThroughput_ReadCapacityUnits
-ProvisionedThroughput_WriteCapacityUnit <Int64>
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableCreationParameters_ProvisionedThroughput_WriteCapacityUnits
-S3BucketSource_S3Bucket <String>
The S3 bucket that is being imported from.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3BucketSource_S3BucketOwner <String>
The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3BucketSource_S3KeyPrefix <String>
The key prefix shared by all S3 Objects that are being imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ImportTableDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DynamoDBv2.Model.ImportTableResponse). Specifying the name of a property of type Amazon.DynamoDBv2.Model.ImportTableResponse 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)
-SSESpecification_Enabled <Boolean>
Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableCreationParameters_SSESpecification_Enabled
-SSESpecification_KMSMasterKeyId <String>
The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableCreationParameters_SSESpecification_KMSMasterKeyId
-SSESpecification_SSEType <SSEType>
Server-side encryption type. The only supported value is:
  • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableCreationParameters_SSESpecification_SSEType
-TableCreationParameters_AttributeDefinition <AttributeDefinition[]>
The attributes of the table created as part of the import operation.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableCreationParameters_AttributeDefinitions
-TableCreationParameters_BillingMode <BillingMode>
The billing mode for provisioning the table created as part of the import operation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableCreationParameters_GlobalSecondaryIndex <GlobalSecondaryIndex[]>
The Global Secondary Indexes (GSI) of the table to be created as part of the import operation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableCreationParameters_GlobalSecondaryIndexes
-TableCreationParameters_KeySchema <KeySchemaElement[]>
The primary key and option sort key of the table created as part of the import operation.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableCreationParameters_TableName <String>
The name of the table created as part of the import operation.
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.ImportTableDescription or Amazon.DynamoDBv2.Model.ImportTableResponse
This cmdlet returns an Amazon.DynamoDBv2.Model.ImportTableDescription object. The service call response (type Amazon.DynamoDBv2.Model.ImportTableResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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