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 QLDB ExportJournalToS3 API operation.

Syntax

Export-QLDBJournalToS3
-Name <String>
-S3ExportConfiguration_Bucket <String>
-ExclusiveEndTime <DateTime>
-InclusiveStartTime <DateTime>
-EncryptionConfiguration_KmsKeyArn <String>
-EncryptionConfiguration_ObjectEncryptionType <S3ObjectEncryptionType>
-OutputFormat <OutputFormat>
-S3ExportConfiguration_Prefix <String>
-RoleArn <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format. In JSON Lines format, each journal block in the exported data object is a valid JSON object that is delimited by a newline. You can use this format to easily integrate JSON exports with analytics tools such as Glue and Amazon Athena because these services can parse newline-delimited JSON automatically. For more information about the format, see JSON Lines. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException. You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.

Parameters

-EncryptionConfiguration_KmsKeyArn <String>
The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesS3ExportConfiguration_EncryptionConfiguration_KmsKeyArn
-EncryptionConfiguration_ObjectEncryptionType <S3ObjectEncryptionType>
The Amazon S3 object encryption type.To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesS3ExportConfiguration_EncryptionConfiguration_ObjectEncryptionType
-ExclusiveEndTime <DateTime>
The exclusive end date and time for the range of journal contents to export.The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.The ExclusiveEndTime must be less than or equal to the current UTC date and time.
Required?True
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)
-InclusiveStartTime <DateTime>
The inclusive start date and time for the range of journal contents to export.The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.The InclusiveStartTime must be before ExclusiveEndTime.If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the ledger.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-OutputFormat <OutputFormat>
The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:
  • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
  • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.
To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3ExportConfiguration_Bucket <String>
The Amazon S3 bucket name in which a journal export job writes the journal contents.The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3ExportConfiguration_Prefix <String>
The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.The following are examples of valid Prefix values:
  • JournalExports-ForMyLedger/Testing/
  • JournalExports
  • My:Tests/
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ExportId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ExportJournalToS3Response). Specifying the name of a property of type Amazon.QLDB.Model.ExportJournalToS3Response 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)

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

System.String or Amazon.QLDB.Model.ExportJournalToS3Response
This cmdlet returns a System.String object. The service call response (type Amazon.QLDB.Model.ExportJournalToS3Response) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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