AWS.Tools.SimpleDBv2.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SimpleDBv2</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SDBV2.GetSDBV2ExportCmdlet"> <summary> Returns information for an existing domain export. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.GetSDBV2ExportCmdlet.ExportArn"> <summary> <para> <para>Unique ARN identifier of the export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.GetSDBV2ExportCmdlet.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.SimpleDBv2.Model.GetExportResponse). Specifying the name of a property of type Amazon.SimpleDBv2.Model.GetExportResponse 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.SDBV2.GetSDBV2ExportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExportArn parameter. The -PassThru parameter is deprecated, use -Select '^ExportArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SDBV2.GetSDBV2ExportListCmdlet"> <summary> Lists all exports that were created. The results are paginated and can be filtered by domain name.<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.SDBV2.GetSDBV2ExportListCmdlet.DomainName"> <summary> <para> <para>The name of the domain to filter exports. If not provided, exports for all the domains will be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.GetSDBV2ExportListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of exports to return in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.GetSDBV2ExportListCmdlet.NextToken"> <summary> <para> <para>A pagination token used to retrieve the next page of results. This token is obtained from the nextToken field in the previous ListExportsResponse. Leave empty for the first request.</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.GetSDBV2ExportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleDBv2.Model.ListExportsResponse). Specifying the name of a property of type Amazon.SimpleDBv2.Model.ListExportsResponse 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.SDBV2.GetSDBV2ExportListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.GetSDBV2ExportListCmdlet.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.SDBV2.StartSDBV2DomainExportCmdlet"> <summary> Initiates the export of a SimpleDB domain to an S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.StartSDBV2DomainExportCmdlet.DomainName"> <summary> <para> <para>The name of the domain to export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.StartSDBV2DomainExportCmdlet.S3Bucket"> <summary> <para> <para>The name of the S3 bucket where the domain data will be exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.StartSDBV2DomainExportCmdlet.S3BucketOwner"> <summary> <para> <para>The ID of the AWS account that owns the bucket the export will be stored in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.StartSDBV2DomainExportCmdlet.S3KeyPrefix"> <summary> <para> <para>The prefix string to be used to generate the S3 object keys for export artifacts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.StartSDBV2DomainExportCmdlet.S3SseAlgorithm"> <summary> <para> <para>The server-side encryption algorithm to use for the exported data in S3. Valid values are: AES256 (SSE-S3) and KMS (SSE-KMS). If not specified, bucket's default encryption will apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.StartSDBV2DomainExportCmdlet.S3SseKmsKeyId"> <summary> <para> <para>The KMS key ID to use for server-side encryption with AWS KMS-managed keys (SSE-KMS). This parameter is only expected with KMS as the S3 SSE algorithm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.StartSDBV2DomainExportCmdlet.ClientToken"> <summary> <para> <para>Providing a ClientToken makes the call to StartDomainExport API 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, a ConflictException will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.StartSDBV2DomainExportCmdlet.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.SimpleDBv2.Model.StartDomainExportResponse). Specifying the name of a property of type Amazon.SimpleDBv2.Model.StartDomainExportResponse 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.SDBV2.StartSDBV2DomainExportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDBV2.StartSDBV2DomainExportCmdlet.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> |