AWS.Tools.QLDB.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.QLDB</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet"> <summary> Adds one or more tags to a specified Amazon QLDB resource. <para> A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) to which you want to add the tags. For example:</para><para><code>arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet.Tag"> <summary> <para> <para>The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet"> <summary> Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format. <para> If the ledger with the given <code>Name</code> doesn't exist, then throws <code>ResourceNotFoundException</code>. </para><para> If the ledger with the given <code>Name</code> is in <code>CREATING</code> status, then throws <code>ResourcePreconditionNotMetException</code>. </para><para> You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw <code>LimitExceededException</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.S3ExportConfiguration_Bucket"> <summary> <para> <para>The Amazon S3 bucket name in which a journal export job writes the journal contents.</para><para>The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html">Bucket Restrictions and Limitations</a> in the <i>Amazon S3 Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.ExclusiveEndTime"> <summary> <para> <para>The exclusive end date and time for the range of journal contents that you want to export.</para><para>The <code>ExclusiveEndTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code></para><para>The <code>ExclusiveEndTime</code> must be less than or equal to the current UTC date and time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.InclusiveStartTime"> <summary> <para> <para>The inclusive start date and time for the range of journal contents that you want to export.</para><para>The <code>InclusiveStartTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code></para><para>The <code>InclusiveStartTime</code> must be before <code>ExclusiveEndTime</code>.</para><para>If you provide an <code>InclusiveStartTime</code> that is before the ledger's <code>CreationDateTime</code>, Amazon QLDB defaults it to the ledger's <code>CreationDateTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.EncryptionConfiguration_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for a customer master key (CMK) in AWS Key Management Service (AWS KMS).</para><para>You must provide a <code>KmsKeyArn</code> if you specify <code>SSE_KMS</code> as the <code>ObjectEncryptionType</code>.</para><para><code>KmsKeyArn</code> is not required if you specify <code>SSE_S3</code> as the <code>ObjectEncryptionType</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.EncryptionConfiguration_ObjectEncryptionType"> <summary> <para> <para>The Amazon S3 object encryption type.</para><para>To learn more about server-side encryption options in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon S3 Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.S3ExportConfiguration_Prefix"> <summary> <para> <para>The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.</para><para>The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html">Object Key and Metadata</a> in the <i>Amazon S3 Developer Guide</i>.</para><para>The following are examples of valid <code>Prefix</code> values:</para><ul><li><para><code>JournalExports-ForMyLedger/Testing/</code></para></li><li><para><code>JournalExports</code></para></li><li><para><code>My:Tests/</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:</para><ul><li><para>Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.</para></li><li><para>(Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet"> <summary> Returns a journal block object at a specified address in a ledger. Also returns a proof of the specified block for verification if <code>DigestTipAddress</code> is provided. <para> If the specified ledger doesn't exist or is in <code>DELETING</code> status, then throws <code>ResourceNotFoundException</code>. </para><para> If the specified ledger is in <code>CREATING</code> status, then throws <code>ResourcePreconditionNotMetException</code>. </para><para> If no block exists with the specified address, then throws <code>InvalidParameterException</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet.BlockAddress_IonText"> <summary> <para> <para>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet.DigestTipAddress_IonText"> <summary> <para> <para>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.GetBlockResponse). Specifying the name of a property of type Amazon.QLDB.Model.GetBlockResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBDigestCmdlet"> <summary> Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBDigestCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBDigestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.GetDigestResponse). Specifying the name of a property of type Amazon.QLDB.Model.GetDigestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBDigestCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportCmdlet"> <summary> Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters. <para> If the export job with the given <code>ExportId</code> doesn't exist, then throws <code>ResourceNotFoundException</code>. </para><para> If the ledger with the given <code>Name</code> doesn't exist, then throws <code>ResourceNotFoundException</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportCmdlet.ExportId"> <summary> <para> <para>The unique ID of the journal export job that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportCmdlet.Select"> <summary> 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.QLDB.Model.DescribeJournalS3ExportResponse). Specifying the name of a property of type Amazon.QLDB.Model.DescribeJournalS3ExportResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExportId parameter. The -PassThru parameter is deprecated, use -Select '^ExportId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportListCmdlet"> <summary> Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region. <para> This action returns a maximum of <code>MaxResults</code> items, and is paginated so that you can retrieve all the items by calling <code>ListJournalS3Exports</code> multiple times. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single <code>ListJournalS3Exports</code> request. (The actual number of results returned might be fewer.)</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportListCmdlet.NextToken"> <summary> <para> <para>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListJournalS3Exports</code> call, then you should use that value as input here.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JournalS3Exports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ListJournalS3ExportsResponse). Specifying the name of a property of type Amazon.QLDB.Model.ListJournalS3ExportsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet"> <summary> Returns an array of journal export job descriptions for a specified ledger. <para> This action returns a maximum of <code>MaxResults</code> items, and is paginated so that you can retrieve all the items by calling <code>ListJournalS3ExportsForLedger</code> multiple times. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single <code>ListJournalS3ExportsForLedger</code> request. (The actual number of results returned might be fewer.)</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.NextToken"> <summary> <para> <para>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListJournalS3ExportsForLedger</code> call, then you should use that value as input here.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JournalS3Exports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ListJournalS3ExportsForLedgerResponse). Specifying the name of a property of type Amazon.QLDB.Model.ListJournalS3ExportsForLedgerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerCmdlet"> <summary> Returns information about a ledger, including its state and when it was created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerCmdlet.Name"> <summary> <para> <para>The name of the ledger that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.DescribeLedgerResponse). Specifying the name of a property of type Amazon.QLDB.Model.DescribeLedgerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerListCmdlet"> <summary> Returns an array of ledger summaries that are associated with the current AWS account and Region. <para> This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling <code>ListLedgers</code> multiple times. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single <code>ListLedgers</code> request. (The actual number of results returned might be fewer.)</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerListCmdlet.NextToken"> <summary> <para> <para>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListLedgers</code> call, then you should use that value as input here.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Ledgers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ListLedgersResponse). Specifying the name of a property of type Amazon.QLDB.Model.ListLedgersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBResourceTagCmdlet"> <summary> Returns all tags for a specified Amazon QLDB resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for which you want to list the tags. For example:</para><para><code>arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.QLDB.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet"> <summary> Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if <code>DigestTipAddress</code> is provided. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.DocumentId"> <summary> <para> <para>The unique ID of the document to be verified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.BlockAddress_IonText"> <summary> <para> <para>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.DigestTipAddress_IonText"> <summary> <para> <para>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.GetRevisionResponse). Specifying the name of a property of type Amazon.QLDB.Model.GetRevisionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentId parameter. The -PassThru parameter is deprecated, use -Select '^DocumentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet"> <summary> Creates a new ledger in your AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.DeletionProtection"> <summary> <para> <para>The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (<code>true</code>) by default.</para><para>If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>. The QLDB console disables deletion protection for you when you use it to delete a ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.Name"> <summary> <para> <para>The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.PermissionsMode"> <summary> <para> <para>The permissions mode to assign to the ledger that you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.Tag"> <summary> <para> <para>The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.CreateLedgerResponse). Specifying the name of a property of type Amazon.QLDB.Model.CreateLedgerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBLedgerCmdlet"> <summary> Deletes a ledger and all of its contents. This action is irreversible. <para> If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>. The QLDB console disables deletion protection for you when you use it to delete a ledger. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBLedgerCmdlet.Name"> <summary> <para> <para>The name of the ledger that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBLedgerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.DeleteLedgerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBLedgerCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBLedgerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet"> <summary> Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) from which you want to remove the tags. For example:</para><para><code>arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys that you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet"> <summary> Updates properties on a ledger. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.DeletionProtection"> <summary> <para> <para>The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (<code>true</code>) by default.</para><para>If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>. The QLDB console disables deletion protection for you when you use it to delete a ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.UpdateLedgerResponse). Specifying the name of a property of type Amazon.QLDB.Model.UpdateLedgerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |