AWS.Tools.S3Tables.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.S3Tables</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TNamespaceCmdlet"> <summary> Gets details about a namespace. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html">Table namespaces</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetNamespace</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TNamespaceCmdlet.Namespace"> <summary> <para> <para>The name of the namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TNamespaceCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TNamespaceCmdlet.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.S3Tables.Model.GetNamespaceResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetNamespaceResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TNamespaceListCmdlet"> <summary> Lists the namespaces within a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html">Table namespaces</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:ListNamespaces</c> permission to use this operation. </para></dd></dl><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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TNamespaceListCmdlet.Prefix"> <summary> <para> <para>The prefix of the namespaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TNamespaceListCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TNamespaceListCmdlet.ContinuationToken"> <summary> <para> <para><c>ContinuationToken</c> indicates to Amazon S3 that the list is being continued on this bucket with a token. <c>ContinuationToken</c> is obfuscated and is not a real key. You can use this <c>ContinuationToken</c> for pagination of the list results.</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/>'ContinuationToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-ContinuationToken' to null for the first call then set the 'ContinuationToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TNamespaceListCmdlet.MaxNamespace"> <summary> <para> <para>The maximum number of namespaces to return in the list.</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.S3T.GetS3TNamespaceListCmdlet.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.S3Tables.Model.ListNamespacesResponse). Specifying the name of a property of type Amazon.S3Tables.Model.ListNamespacesResponse 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.S3T.GetS3TNamespaceListCmdlet.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 ContinuationToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableCmdlet"> <summary> Gets details about a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetTable</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableCmdlet.Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableCmdlet.Namespace"> <summary> <para> <para>The name of the namespace the table is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableCmdlet.TableArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket associated with the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableCmdlet.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.S3Tables.Model.GetTableResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTableResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketCmdlet"> <summary> Gets details on a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-details.html">Viewing details about an Amazon S3 table bucket</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetTableBucket</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketCmdlet.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.S3Tables.Model.GetTableBucketResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTableBucketResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketEncryptionCmdlet"> <summary> Gets the encryption configuration for a table bucket. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetTableBucketEncryption</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketEncryptionCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketEncryptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EncryptionConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Tables.Model.GetTableBucketEncryptionResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTableBucketEncryptionResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketListCmdlet"> <summary> Lists table buckets for your account. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets.html">S3 Table buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:ListTableBuckets</c> permission to use this operation. </para></dd></dl><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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketListCmdlet.Prefix"> <summary> <para> <para>The prefix of the table buckets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketListCmdlet.ContinuationToken"> <summary> <para> <para><c>ContinuationToken</c> indicates to Amazon S3 that the list is being continued on this bucket with a token. <c>ContinuationToken</c> is obfuscated and is not a real key. You can use this <c>ContinuationToken</c> for pagination of the list results.</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/>'ContinuationToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-ContinuationToken' to null for the first call then set the 'ContinuationToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketListCmdlet.MaxBucket"> <summary> <para> <para>The maximum number of table buckets to return in the list.</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.S3T.GetS3TTableBucketListCmdlet.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.S3Tables.Model.ListTableBucketsResponse). Specifying the name of a property of type Amazon.S3Tables.Model.ListTableBucketsResponse 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.S3T.GetS3TTableBucketListCmdlet.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 ContinuationToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketMaintenanceConfigurationCmdlet"> <summary> Gets details about a maintenance configuration for a given table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html">Amazon S3 table bucket maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetTableBucketMaintenanceConfiguration</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketMaintenanceConfigurationCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketMaintenanceConfigurationCmdlet.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.S3Tables.Model.GetTableBucketMaintenanceConfigurationResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTableBucketMaintenanceConfigurationResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketPolicyCmdlet"> <summary> Gets details about a table bucket policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-get">Viewing a table bucket policy</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetTableBucketPolicy</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketPolicyCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableBucketPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Tables.Model.GetTableBucketPolicyResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTableBucketPolicyResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableEncryptionCmdlet"> <summary> Gets the encryption configuration for a table. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetTableEncryption</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableEncryptionCmdlet.Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableEncryptionCmdlet.Namespace"> <summary> <para> <para>The namespace associated with the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableEncryptionCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket containing the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableEncryptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EncryptionConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Tables.Model.GetTableEncryptionResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTableEncryptionResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableListCmdlet"> <summary> List tables in the given table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:ListTables</c> permission to use this operation. </para></dd></dl><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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableListCmdlet.Namespace"> <summary> <para> <para>The namespace of the tables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableListCmdlet.Prefix"> <summary> <para> <para>The prefix of the tables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableListCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableListCmdlet.ContinuationToken"> <summary> <para> <para><c>ContinuationToken</c> indicates to Amazon S3 that the list is being continued on this bucket with a token. <c>ContinuationToken</c> is obfuscated and is not a real key. You can use this <c>ContinuationToken</c> for pagination of the list results.</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/>'ContinuationToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-ContinuationToken' to null for the first call then set the 'ContinuationToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableListCmdlet.MaxTable"> <summary> <para> <para>The maximum number of tables to return.</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.S3T.GetS3TTableListCmdlet.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.S3Tables.Model.ListTablesResponse). Specifying the name of a property of type Amazon.S3Tables.Model.ListTablesResponse 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.S3T.GetS3TTableListCmdlet.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 ContinuationToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceConfigurationCmdlet"> <summary> Gets details about the maintenance configuration of a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html">S3 Tables maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><ul><li><para> You must have the <c>s3tables:GetTableMaintenanceConfiguration</c> permission to use this operation. </para></li><li><para> You must have the <c>s3tables:GetTableData</c> permission to use set the compaction strategy to <c>sort</c> or <c>zorder</c>. </para></li></ul></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceConfigurationCmdlet.Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceConfigurationCmdlet.Namespace"> <summary> <para> <para>The namespace associated with the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceConfigurationCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceConfigurationCmdlet.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.S3Tables.Model.GetTableMaintenanceConfigurationResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTableMaintenanceConfigurationResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceJobStatusCmdlet"> <summary> Gets the status of a maintenance job for a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html">S3 Tables maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetTableMaintenanceJobStatus</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceJobStatusCmdlet.Name"> <summary> <para> <para>The name of the maintenance job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceJobStatusCmdlet.Namespace"> <summary> <para> <para>The name of the namespace the table is associated with. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceJobStatusCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMaintenanceJobStatusCmdlet.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.S3Tables.Model.GetTableMaintenanceJobStatusResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTableMaintenanceJobStatusResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMetadataLocationCmdlet"> <summary> Gets the location of the table metadata. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetTableMetadataLocation</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMetadataLocationCmdlet.Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMetadataLocationCmdlet.Namespace"> <summary> <para> <para>The namespace of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMetadataLocationCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTableMetadataLocationCmdlet.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.S3Tables.Model.GetTableMetadataLocationResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTableMetadataLocationResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.GetS3TTablePolicyCmdlet"> <summary> Gets details about a table policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-get">Viewing a table policy</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:GetTablePolicy</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTablePolicyCmdlet.Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTablePolicyCmdlet.Namespace"> <summary> <para> <para>The namespace associated with the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTablePolicyCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket that contains the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.GetS3TTablePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Tables.Model.GetTablePolicyResponse). Specifying the name of a property of type Amazon.S3Tables.Model.GetTablePolicyResponse 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="T:Amazon.PowerShell.Cmdlets.S3T.NewS3TNamespaceCmdlet"> <summary> Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace-create.html">Create a namespace</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:CreateNamespace</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TNamespaceCmdlet.Namespace"> <summary> <para> <para>A name for the namespace.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TNamespaceCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket to create the namespace in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TNamespaceCmdlet.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.S3Tables.Model.CreateNamespaceResponse). Specifying the name of a property of type Amazon.S3Tables.Model.CreateNamespaceResponse 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.S3T.NewS3TNamespaceCmdlet.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.S3T.NewS3TTableCmdlet"> <summary> Creates a new table associated with the given namespace in a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-create.html">Creating an Amazon S3 table</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><ul><li><para> You must have the <c>s3tables:CreateTable</c> permission to use this operation. </para></li><li><para> If you use this operation with the optional <c>metadata</c> request parameter you must have the <c>s3tables:PutTableData</c> permission. </para></li><li><para> If you use this operation with the optional <c>encryptionConfiguration</c> request parameter you must have the <c>s3tables:PutTableEncryption</c> permission. </para></li></ul><note><para> Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a>. </para></note></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableCmdlet.Schema_Field"> <summary> <para> <para>The schema fields for the table</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableCmdlet.Format"> <summary> <para> <para>The format for the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableCmdlet.EncryptionConfiguration_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when <c>sseAlgorithm</c> is set to <c>aws:kms</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableCmdlet.Name"> <summary> <para> <para>The name for the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableCmdlet.Namespace"> <summary> <para> <para>The namespace to associated with the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableCmdlet.EncryptionConfiguration_SseAlgorithm"> <summary> <para> <para>The server-side encryption algorithm to use. Valid values are <c>AES256</c> for S3-managed encryption keys, or <c>aws:kms</c> for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket to create the table in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableCmdlet.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.S3Tables.Model.CreateTableResponse). Specifying the name of a property of type Amazon.S3Tables.Model.CreateTableResponse 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.S3T.NewS3TTableCmdlet.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.S3T.NewS3TTableBucketCmdlet"> <summary> Creates a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-create.html">Creating a table bucket</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><ul><li><para> You must have the <c>s3tables:CreateTableBucket</c> permission to use this operation. </para></li><li><para> If you use this operation with the optional <c>encryptionConfiguration</c> parameter you must have the <c>s3tables:PutTableBucketEncryption</c> permission. </para></li></ul></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableBucketCmdlet.EncryptionConfiguration_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when <c>sseAlgorithm</c> is set to <c>aws:kms</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableBucketCmdlet.Name"> <summary> <para> <para>The name for the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableBucketCmdlet.EncryptionConfiguration_SseAlgorithm"> <summary> <para> <para>The server-side encryption algorithm to use. Valid values are <c>AES256</c> for S3-managed encryption keys, or <c>aws:kms</c> for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.NewS3TTableBucketCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Tables.Model.CreateTableBucketResponse). Specifying the name of a property of type Amazon.S3Tables.Model.CreateTableBucketResponse 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.S3T.NewS3TTableBucketCmdlet.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.S3T.RemoveS3TNamespaceCmdlet"> <summary> Deletes a namespace. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace-delete.html">Delete a namespace</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:DeleteNamespace</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TNamespaceCmdlet.Namespace"> <summary> <para> <para>The name of the namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TNamespaceCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket associated with the namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TNamespaceCmdlet.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.S3Tables.Model.DeleteNamespaceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TNamespaceCmdlet.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.S3T.RemoveS3TTableCmdlet"> <summary> Deletes a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-delete.html">Deleting an Amazon S3 table</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:DeleteTable</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableCmdlet.Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableCmdlet.Namespace"> <summary> <para> <para>The namespace associated with the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket that contains the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableCmdlet.VersionToken"> <summary> <para> <para>The version token of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableCmdlet.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.S3Tables.Model.DeleteTableResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableCmdlet.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.S3T.RemoveS3TTableBucketCmdlet"> <summary> Deletes a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-delete.html">Deleting a table bucket</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:DeleteTableBucket</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableBucketCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableBucketCmdlet.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.S3Tables.Model.DeleteTableBucketResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableBucketCmdlet.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.S3T.RemoveS3TTableBucketEncryptionCmdlet"> <summary> Deletes the encryption configuration for a table bucket. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:DeleteTableBucketEncryption</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableBucketEncryptionCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableBucketEncryptionCmdlet.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.S3Tables.Model.DeleteTableBucketEncryptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableBucketEncryptionCmdlet.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.S3T.RemoveS3TTableBucketPolicyCmdlet"> <summary> Deletes a table bucket policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-delete">Deleting a table bucket policy</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:DeleteTableBucketPolicy</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableBucketPolicyCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableBucketPolicyCmdlet.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.S3Tables.Model.DeleteTableBucketPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTableBucketPolicyCmdlet.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.S3T.RemoveS3TTablePolicyCmdlet"> <summary> Deletes a table policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-delete">Deleting a table policy</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:DeleteTablePolicy</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTablePolicyCmdlet.Name"> <summary> <para> <para>The table name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTablePolicyCmdlet.Namespace"> <summary> <para> <para>The namespace associated with the table. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTablePolicyCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket that contains the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTablePolicyCmdlet.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.S3Tables.Model.DeleteTablePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RemoveS3TTablePolicyCmdlet.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.S3T.RenameS3TTableCmdlet"> <summary> Renames a table or a namespace. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:RenameTable</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RenameS3TTableCmdlet.Name"> <summary> <para> <para>The current name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RenameS3TTableCmdlet.Namespace"> <summary> <para> <para>The namespace associated with the table. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RenameS3TTableCmdlet.NewName"> <summary> <para> <para>The new name for the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RenameS3TTableCmdlet.NewNamespaceName"> <summary> <para> <para>The new name for the namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RenameS3TTableCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RenameS3TTableCmdlet.VersionToken"> <summary> <para> <para>The version token of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RenameS3TTableCmdlet.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.S3Tables.Model.RenameTableResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.RenameS3TTableCmdlet.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.S3T.UpdateS3TTableMetadataLocationCmdlet"> <summary> Updates the metadata location for a table. The metadata location of a table must be an S3 URI that begins with the table's warehouse location. The metadata location for an Apache Iceberg table must end with <c>.metadata.json</c>, or if the metadata file is Gzip-compressed, <c>.metadata.json.gz</c>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:UpdateTableMetadataLocation</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.UpdateS3TTableMetadataLocationCmdlet.MetadataLocation"> <summary> <para> <para>The new metadata location for the table. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.UpdateS3TTableMetadataLocationCmdlet.Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.UpdateS3TTableMetadataLocationCmdlet.Namespace"> <summary> <para> <para>The namespace of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.UpdateS3TTableMetadataLocationCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.UpdateS3TTableMetadataLocationCmdlet.VersionToken"> <summary> <para> <para>The version token of the table. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.UpdateS3TTableMetadataLocationCmdlet.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.S3Tables.Model.UpdateTableMetadataLocationResponse). Specifying the name of a property of type Amazon.S3Tables.Model.UpdateTableMetadataLocationResponse 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.S3T.UpdateS3TTableMetadataLocationCmdlet.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.S3T.WriteS3TTableBucketEncryptionCmdlet"> <summary> Sets the encryption configuration for a table bucket. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:PutTableBucketEncryption</c> permission to use this operation. </para><note><para> If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para></note></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketEncryptionCmdlet.EncryptionConfiguration_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when <c>sseAlgorithm</c> is set to <c>aws:kms</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketEncryptionCmdlet.EncryptionConfiguration_SseAlgorithm"> <summary> <para> <para>The server-side encryption algorithm to use. Valid values are <c>AES256</c> for S3-managed encryption keys, or <c>aws:kms</c> for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketEncryptionCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketEncryptionCmdlet.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.S3Tables.Model.PutTableBucketEncryptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketEncryptionCmdlet.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.S3T.WriteS3TTableBucketMaintenanceConfigurationCmdlet"> <summary> Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html">Amazon S3 table bucket maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:PutTableBucketMaintenanceConfiguration</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketMaintenanceConfigurationCmdlet.IcebergUnreferencedFileRemoval_NonCurrentDay"> <summary> <para> <para>The number of days an object has to be non-current before it is deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketMaintenanceConfigurationCmdlet.Value_Status"> <summary> <para> <para>The status of the maintenance configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketMaintenanceConfigurationCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketMaintenanceConfigurationCmdlet.Type"> <summary> <para> <para>The type of the maintenance configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketMaintenanceConfigurationCmdlet.IcebergUnreferencedFileRemoval_UnreferencedDay"> <summary> <para> <para>The number of days an object has to be unreferenced before it is marked as non-current.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketMaintenanceConfigurationCmdlet.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.S3Tables.Model.PutTableBucketMaintenanceConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketMaintenanceConfigurationCmdlet.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.S3T.WriteS3TTableBucketPolicyCmdlet"> <summary> Creates a new maintenance configuration or replaces an existing table bucket policy for a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-add">Adding a table bucket policy</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:PutTableBucketPolicy</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketPolicyCmdlet.ResourcePolicy"> <summary> <para> <para>The <c>JSON</c> that defines the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketPolicyCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketPolicyCmdlet.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.S3Tables.Model.PutTableBucketPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableBucketPolicyCmdlet.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.S3T.WriteS3TTableMaintenanceConfigurationCmdlet"> <summary> Creates a new maintenance configuration or replaces an existing maintenance configuration for a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html">S3 Tables maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:PutTableMaintenanceConfiguration</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.IcebergSnapshotManagement_MaxSnapshotAgeHour"> <summary> <para> <para>The maximum age of a snapshot before it can be expired.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.IcebergSnapshotManagement_MinSnapshotsToKeep"> <summary> <para> <para>The minimum number of snapshots to keep.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.Name"> <summary> <para> <para>The name of the maintenance configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.Namespace"> <summary> <para> <para>The namespace of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.Value_Status"> <summary> <para> <para>The status of the maintenance configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.IcebergCompaction_Strategy"> <summary> <para> <para>The compaction strategy to use for the table. This determines how files are selected and combined during compaction operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table associated with the maintenance configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.IcebergCompaction_TargetFileSizeMB"> <summary> <para> <para>The target file size for the table in MB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.Type"> <summary> <para> <para>The type of the maintenance configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.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.S3Tables.Model.PutTableMaintenanceConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTableMaintenanceConfigurationCmdlet.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.S3T.WriteS3TTablePolicyCmdlet"> <summary> Creates a new maintenance configuration or replaces an existing table policy for a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-add">Adding a table policy</a> in the <i>Amazon Simple Storage Service User Guide</i>. <dl><dt>Permissions</dt><dd><para> You must have the <c>s3tables:PutTablePolicy</c> permission to use this operation. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTablePolicyCmdlet.Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTablePolicyCmdlet.Namespace"> <summary> <para> <para>The namespace associated with the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTablePolicyCmdlet.ResourcePolicy"> <summary> <para> <para>The <c>JSON</c> that defines the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTablePolicyCmdlet.TableBucketARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the table bucket that contains the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTablePolicyCmdlet.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.S3Tables.Model.PutTablePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3T.WriteS3TTablePolicyCmdlet.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> |