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

Syntax

Start-DDBBulkPutItem
-TableName <String>
-InputS3Configuration_InputCompressionType <InputCompressionType>
-InputS3Configuration_InputFormat <BulkOperationInputFormat>
-MaxWriteRequestUnit <Int64>
-OutputS3Configuration_OutputType <String[]>
-PerformanceTier <BulkOperationPerformanceTier>
-InputS3Configuration_S3Bucket <String>
-OutputS3Configuration_S3Bucket <String>
-InputS3Configuration_S3BucketOwner <String>
-OutputS3Configuration_S3BucketOwner <String>
-InputS3Configuration_S3KeyPrefix <String>
-OutputS3Configuration_S3KeyPrefix <String>
-OutputS3Configuration_S3SseAlgorithm <S3SseAlgorithm>
-OutputS3Configuration_S3SseKmsKeyId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDynamoDBConfig>

Description

Starts an asynchronous bulk operation that reads items from Amazon S3 and writes them to an existing DynamoDB table, so you can efficiently load or migrate large datasets.

Parameters

-ClientConfig <AmazonDynamoDBConfig>
Amazon.PowerShell.Cmdlets.DDB.AmazonDynamoDBClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that ensures the bulk operation starts no more than one time. During the 8 hours after the initial request, repeated requests that use the same token and parameters return the same bulk operation. If a request reuses the token with different parameters, DynamoDB returns an IdempotentParameterMismatchException. If you omit the token, an Amazon Web Services SDK automatically generates one.
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)
-InputS3Configuration_InputCompressionType <InputCompressionType>
The compression type of the input objects. Valid values are GZIP, ZSTD, and NONE. If you don't specify a value, DynamoDB uses NONE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputS3Configuration_InputFormat <BulkOperationInputFormat>
The format of the input objects. DYNAMODB_JSON uses JSON Lines, with one JSON record per line. ION uses a sequence of Ion structs.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputS3Configuration_S3Bucket <String>
The name of the Amazon S3 bucket that contains the input objects.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputS3Configuration_S3BucketOwner <String>
The Amazon Web Services account ID of the input bucket owner. If you omit this value, DynamoDB uses the Amazon Web Services account ID of the requester.S3BucketOwner is required when the bucket is owned by another Amazon Web Services account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputS3Configuration_S3KeyPrefix <String>
An optional key prefix that limits the input to matching objects in the Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxWriteRequestUnit <Int64>
The maximum rate, in write request units per second, at which the bulk operation attempts to write. The value must be at least 1,024. With this setting, you limit only the bulk operation; the table's provisioned or on-demand capacity settings don't change. The actual write rate can be lower.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxWriteRequestUnits
-OutputS3Configuration_OutputType <String[]>
The following values describe the types of output that DynamoDB writes for individual input items. Include one or both values.
ERROR
Reports input records or input objects that DynamoDB couldn't process. This includes malformed input and item validation failures, such as a missing or incorrectly typed primary key attribute or an item that exceeds a DynamoDB limit.
CONDITION_CHECK_FAILURE
Reports the attempted item and, when present, the existing item for a write whose condition expression evaluates to false.
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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputS3Configuration_S3Bucket <String>
The name of the Amazon S3 bucket where DynamoDB writes output records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputS3Configuration_S3BucketOwner <String>
The Amazon Web Services account ID of the output bucket owner. If you omit this value, DynamoDB uses the Amazon Web Services account ID of the requester.S3BucketOwner is required when the bucket is owned by another Amazon Web Services account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputS3Configuration_S3KeyPrefix <String>
An optional key prefix under which DynamoDB writes the output records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputS3Configuration_S3SseAlgorithm <S3SseAlgorithm>
The server-side encryption algorithm for the output objects. Valid values are AES256 and KMS. If you don't specify a value, Amazon S3 applies the destination bucket's default encryption settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputS3Configuration_S3SseKmsKeyId <String>
The identifier of the KMS key that encrypts the output objects. Specify this value when S3SseAlgorithm is KMS. Don't specify it when the algorithm is AES256.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformanceTier <BulkOperationPerformanceTier>
The performance tier for the bulk operation. Valid values are STANDARD and ACCELERATED. If you don't specify a value, the operation uses STANDARD.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'BulkOperationDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DynamoDBv2.Model.StartBulkPutItemsResponse). Specifying the name of a property of type Amazon.DynamoDBv2.Model.StartBulkPutItemsResponse 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)
-TableName <String>
The name or ARN of the existing DynamoDB table that receives the items.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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.BulkOperationDescription or Amazon.DynamoDBv2.Model.StartBulkPutItemsResponse
This cmdlet returns an Amazon.DynamoDBv2.Model.BulkOperationDescription object. The service call response (type Amazon.DynamoDBv2.Model.StartBulkPutItemsResponse) 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