AWS.Tools.S3Control.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.S3Control</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.S3C.AddS3CJobTaggingCmdlet"> <summary> Sets the supplied tag-set on an S3 Batch Operations job. <para> A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html">GetJobTagging</a>, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags">Controlling access and labeling jobs using tags</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para><note><ul><li><para> If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>. </para></li><li><para> For deleting existing tags for your Batch Operations job, a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html">DeleteJobTagging</a> request is preferred because it achieves the same result without incurring charges. </para></li><li><para> A few things to consider about using tags: </para><ul><li><para> Amazon S3 limits the maximum number of tags to 50 tags per job. </para></li><li><para> You can associate up to 50 tags with a job as long as they have unique tag keys. </para></li><li><para> A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length. </para></li><li><para> The key and values are case sensitive. </para></li><li><para> For tagging-related restrictions related to characters and encodings, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>. </para></li></ul></li></ul></note><para> To use this action, you must have permission to perform the <code>s3:PutJobTagging</code> action. </para><para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreatJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html">GetJobTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html">DeleteJobTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CJobTaggingCmdlet.AccountId"> <summary> <para> <para>The AWS account ID associated with the S3 Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CJobTaggingCmdlet.JobId"> <summary> <para> <para>The ID for the S3 Batch Operations job whose tags you want to replace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CJobTaggingCmdlet.Tag"> <summary> <para> <para>The set of tags to associate with the S3 Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CJobTaggingCmdlet.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.S3Control.Model.PutJobTaggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CJobTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CJobTaggingCmdlet.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.S3C.AddS3CPublicAccessBlockCmdlet"> <summary> Creates or modifies the <code>PublicAccessBlock</code> configuration for an AWS account. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html"> Using Amazon S3 block public access</a>. <para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html">GetPublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CPublicAccessBlockCmdlet.AccountId"> <summary> <para> <para>The account ID for the AWS account whose <code>PublicAccessBlock</code> configuration you want to set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CPublicAccessBlockCmdlet.PublicAccessBlockConfiguration_BlockPublicAcl"> <summary> <para> <para>Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to <code>TRUE</code> causes the following behavior:</para><ul><li><para>PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.</para></li><li><para>PUT Object calls fail if the request includes a public ACL.</para></li><li><para>PUT Bucket calls fail if the request includes a public ACL.</para></li></ul><para>Enabling this setting doesn't affect existing policies or ACLs.</para><para>This is not supported for Amazon S3 on Outposts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CPublicAccessBlockCmdlet.PublicAccessBlockConfiguration_BlockPublicPolicy"> <summary> <para> <para>Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to <code>TRUE</code> causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. </para><para>Enabling this setting doesn't affect existing bucket policies.</para><para>This is not supported for Amazon S3 on Outposts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CPublicAccessBlockCmdlet.PublicAccessBlockConfiguration_IgnorePublicAcl"> <summary> <para> <para>Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to <code>TRUE</code> causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. </para><para>Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.</para><para>This is not supported for Amazon S3 on Outposts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CPublicAccessBlockCmdlet.PublicAccessBlockConfiguration_RestrictPublicBucket"> <summary> <para> <para>Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to <code>TRUE</code> restricts access to buckets with public policies to only AWS service principals and authorized users within this account.</para><para>Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.</para><para>This is not supported for Amazon S3 on Outposts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CPublicAccessBlockCmdlet.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.S3Control.Model.PutPublicAccessBlockResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.AddS3CPublicAccessBlockCmdlet.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.S3C.GetS3CAccessPointCmdlet"> <summary> Returns configuration information about the specified access point. <para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples">Examples</a> section. </para><para> The following actions are related to <code>GetAccessPoint</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html">CreateAccessPoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html">DeleteAccessPoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html">ListAccessPoints</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointCmdlet.Name"> <summary> <para> <para>The name of the access point whose configuration information you want to retrieve.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointCmdlet.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.S3Control.Model.GetAccessPointResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetAccessPointResponse 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.S3C.GetS3CAccessPointCmdlet.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.S3C.GetS3CAccessPointConfigurationForObjectLambdaCmdlet"> <summary> Returns configuration for an Object Lambda Access Point. <para> The following actions are related to <code>GetAccessPointConfigurationForObjectLambda</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html">PutAccessPointConfigurationForObjectLambda</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointConfigurationForObjectLambdaCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointConfigurationForObjectLambdaCmdlet.Name"> <summary> <para> <para>The name of the Object Lambda Access Point you want to return the configuration for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointConfigurationForObjectLambdaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Configuration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetAccessPointConfigurationForObjectLambdaResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetAccessPointConfigurationForObjectLambdaResponse 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.S3C.GetS3CAccessPointForObjectLambdaCmdlet"> <summary> Returns configuration information about the specified Object Lambda Access Point <para> The following actions are related to <code>GetAccessPointForObjectLambda</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html">CreateAccessPointForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html">DeleteAccessPointForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html">ListAccessPointsForObjectLambda</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointForObjectLambdaCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointForObjectLambdaCmdlet.Name"> <summary> <para> <para>The name of the Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointForObjectLambdaCmdlet.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.S3Control.Model.GetAccessPointForObjectLambdaResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetAccessPointForObjectLambdaResponse 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.S3C.GetS3CAccessPointListCmdlet"> <summary> Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in <code>maxResults</code>, whichever is less), the response will include a continuation token that you can use to list the additional access points. <para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples">Examples</a> section. </para><para> The following actions are related to <code>ListAccessPoints</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html">CreateAccessPoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html">DeleteAccessPoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html">GetAccessPoint</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointListCmdlet.AccountId"> <summary> <para> <para>The AWS account ID for owner of the bucket whose access points you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointListCmdlet.Bucket"> <summary> <para> <para>The name of the bucket whose associated access points you want to list.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the <code>NextToken</code> field that you can use to retrieve the next page of access points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointListCmdlet.NextToken"> <summary> <para> <para>A continuation token. If a previous call to <code>ListAccessPoints</code> returned a continuation token in the <code>NextToken</code> field, then providing that value here causes Amazon S3 to retrieve the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPointList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.ListAccessPointsResponse). Specifying the name of a property of type Amazon.S3Control.Model.ListAccessPointsResponse 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.S3C.GetS3CAccessPointListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyCmdlet"> <summary> Returns the access point policy associated with the specified access point. <para> The following actions are related to <code>GetAccessPointPolicy</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html">PutAccessPointPolicy</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html">DeleteAccessPointPolicy</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyCmdlet.Name"> <summary> <para> <para>The name of the access point whose policy you want to retrieve.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetAccessPointPolicyResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetAccessPointPolicyResponse 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.S3C.GetS3CAccessPointPolicyCmdlet.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.S3C.GetS3CAccessPointPolicyForObjectLambdaCmdlet"> <summary> Returns the resource policy for an Object Lambda Access Point. <para> The following actions are related to <code>GetAccessPointPolicyForObjectLambda</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html">DeleteAccessPointPolicyForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html">PutAccessPointPolicyForObjectLambda</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyForObjectLambdaCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyForObjectLambdaCmdlet.Name"> <summary> <para> <para>The name of the Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyForObjectLambdaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetAccessPointPolicyForObjectLambdaResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetAccessPointPolicyForObjectLambdaResponse 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.S3C.GetS3CAccessPointPolicyStatusCmdlet"> <summary> Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing Data Access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyStatusCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyStatusCmdlet.Name"> <summary> <para> <para>The name of the access point whose policy status you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetAccessPointPolicyStatusResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetAccessPointPolicyStatusResponse 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.S3C.GetS3CAccessPointPolicyStatusCmdlet.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.S3C.GetS3CAccessPointPolicyStatusForObjectLambdaCmdlet"> <summary> Returns the status of the resource policy associated with an Object Lambda Access Point. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyStatusForObjectLambdaCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyStatusForObjectLambdaCmdlet.Name"> <summary> <para> <para>The name of the Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointPolicyStatusForObjectLambdaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetAccessPointPolicyStatusForObjectLambdaResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetAccessPointPolicyStatusForObjectLambdaResponse 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.S3C.GetS3CAccessPointsForObjectLambdaListCmdlet"> <summary> Returns a list of the access points associated with the Object Lambda Access Point. You can retrieve up to 1000 access points per call. If there are more than 1,000 access points (or the number specified in <code>maxResults</code>, whichever is less), the response will include a continuation token that you can use to list the additional access points. <para> The following actions are related to <code>ListAccessPointsForObjectLambda</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html">CreateAccessPointForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html">DeleteAccessPointForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html">GetAccessPointForObjectLambda</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointsForObjectLambdaListCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointsForObjectLambdaListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of access points that you want to include in the list. If there are more than this number of access points, then the response will include a continuation token in the <code>NextToken</code> field that you can use to retrieve the next page of access points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointsForObjectLambdaListCmdlet.NextToken"> <summary> <para> <para>If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CAccessPointsForObjectLambdaListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ObjectLambdaAccessPointList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.ListAccessPointsForObjectLambdaResponse). Specifying the name of a property of type Amazon.S3Control.Model.ListAccessPointsForObjectLambdaResponse 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.S3C.GetS3CAccessPointsForObjectLambdaListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketCmdlet"> <summary> Gets an Amazon S3 on Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html"> Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the <code>s3-outposts:GetBucket</code> permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. </para><para> If you don't have <code>s3-outposts:GetBucket</code> permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access Denied</code> error. </para><para> The following actions are related to <code>GetBucket</code> for Amazon S3 on Outposts: </para><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples">Examples</a> section. </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">CreateBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html">DeleteBucket</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketCmdlet.AccountId"> <summary> <para> <para>The AWS account ID of the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketCmdlet.Bucket"> <summary> <para> <para>Specifies the bucket.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketCmdlet.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.S3Control.Model.GetBucketResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetBucketResponse 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.S3C.GetS3CBucketCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketLifecycleConfigurationCmdlet"> <summary> <note><para> This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> Returns the lifecycle configuration information set on the Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> and for information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html"> Object Lifecycle Management</a> in <i>Amazon Simple Storage Service User Guide</i>. </para><para> To use this action, you must have permission to perform the <code>s3-outposts:GetLifecycleConfiguration</code> action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>. </para><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples">Examples</a> section. </para><para><code>GetBucketLifecycleConfiguration</code> has the following special error: </para><ul><li><para> Error code: <code>NoSuchLifecycleConfiguration</code></para><ul><li><para> Description: The lifecycle configuration does not exist. </para></li><li><para> HTTP Status Code: 404 Not Found </para></li><li><para> SOAP Fault Code Prefix: Client </para></li></ul></li></ul><para> The following actions are related to <code>GetBucketLifecycleConfiguration</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html">DeleteBucketLifecycleConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketLifecycleConfigurationCmdlet.AccountId"> <summary> <para> <para>The AWS account ID of the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketLifecycleConfigurationCmdlet.Bucket"> <summary> <para> <para>The Amazon Resource Name (ARN) of the bucket.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketLifecycleConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Rules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetBucketLifecycleConfigurationResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetBucketLifecycleConfigurationResponse 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.S3C.GetS3CBucketLifecycleConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketPolicyCmdlet"> <summary> <note><para> This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html">GetBucketPolicy</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> Returns the policy of a specified Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para><para> If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>GetBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this action. </para><para> Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have <code>s3-outposts:GetBucketPolicy</code> permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access Denied</code> error. </para><important><para> As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action. </para></important><para> For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a>. </para><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples">Examples</a> section. </para><para> The following actions are related to <code>GetBucketPolicy</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html">PutBucketPolicy</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html">DeleteBucketPolicy</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketPolicyCmdlet.AccountId"> <summary> <para> <para>The AWS account ID of the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketPolicyCmdlet.Bucket"> <summary> <para> <para>Specifies the bucket.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetBucketPolicyResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetBucketPolicyResponse 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.S3C.GetS3CBucketPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketTaggingCmdlet"> <summary> <note><para> This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> Returns the tag set associated with the Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para><para> To use this action, you must have permission to perform the <code>GetBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others. </para><para><code>GetBucketTagging</code> has the following special error: </para><ul><li><para> Error code: <code>NoSuchTagSetError</code></para><ul><li><para> Description: There is no tag set associated with the bucket. </para></li></ul></li></ul><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples">Examples</a> section. </para><para> The following actions are related to <code>GetBucketTagging</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html">PutBucketTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html">DeleteBucketTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketTaggingCmdlet.AccountId"> <summary> <para> <para>The AWS account ID of the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketTaggingCmdlet.Bucket"> <summary> <para> <para>Specifies the bucket.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CBucketTaggingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TagSet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetBucketTaggingResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetBucketTaggingResponse 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.S3C.GetS3CBucketTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobCmdlet"> <summary> Retrieves the configuration parameters and status for a Batch Operations job. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html">UpdateJobPriority</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobCmdlet.AccountId"> <summary> <para> <para>The AWS account ID associated with the S3 Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobCmdlet.JobId"> <summary> <para> <para>The ID for the job whose information you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Job'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.DescribeJobResponse). Specifying the name of a property of type Amazon.S3Control.Model.DescribeJobResponse 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.S3C.GetS3CJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobListCmdlet"> <summary> Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html">UpdateJobPriority</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobListCmdlet.AccountId"> <summary> <para> <para>The AWS account ID associated with the S3 Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobListCmdlet.JobStatus"> <summary> <para> <para>The <code>List Jobs</code> request returns jobs that match the statuses listed in this element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of jobs that Amazon S3 will include in the <code>List Jobs</code> response. If there are more jobs than this number, the response will include a pagination token in the <code>NextToken</code> field to enable you to retrieve the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobListCmdlet.NextToken"> <summary> <para> <para>A pagination token to request the next page of results. Use the token that Amazon S3 returned in the <code>NextToken</code> element of the <code>ListJobsResult</code> from the previous <code>List Jobs</code> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Jobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.ListJobsResponse). Specifying the name of a property of type Amazon.S3Control.Model.ListJobsResponse 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.S3C.GetS3CJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobTaggingCmdlet"> <summary> Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the <code>s3:GetJobTagging</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags">Controlling access and labeling jobs using tags</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html">PutJobTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html">DeleteJobTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobTaggingCmdlet.AccountId"> <summary> <para> <para>The AWS account ID associated with the S3 Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobTaggingCmdlet.JobId"> <summary> <para> <para>The ID for the S3 Batch Operations job whose tags you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CJobTaggingCmdlet.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.S3Control.Model.GetJobTaggingResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetJobTaggingResponse 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.S3C.GetS3CJobTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CPublicAccessBlockCmdlet"> <summary> Retrieves the <code>PublicAccessBlock</code> configuration for an AWS account. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html"> Using Amazon S3 block public access</a>. <para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html">PutPublicAccessBlock</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CPublicAccessBlockCmdlet.AccountId"> <summary> <para> <para>The account ID for the AWS account whose <code>PublicAccessBlock</code> configuration you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CPublicAccessBlockCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublicAccessBlockConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetPublicAccessBlockResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetPublicAccessBlockResponse 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.S3C.GetS3CPublicAccessBlockCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CRegionalBucketListCmdlet"> <summary> Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and <code>x-amz-outpost-id</code> in your request, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples">Examples</a> section. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CRegionalBucketListCmdlet.AccountId"> <summary> <para> <para>The AWS account ID of the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CRegionalBucketListCmdlet.OutpostId"> <summary> <para> <para>The ID of the AWS Outposts.</para><note><para>This is required by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CRegionalBucketListCmdlet.MaxResult"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CRegionalBucketListCmdlet.NextToken"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CRegionalBucketListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RegionalBucketList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.ListRegionalBucketsResponse). Specifying the name of a property of type Amazon.S3Control.Model.ListRegionalBucketsResponse 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.S3C.GetS3CRegionalBucketListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationCmdlet"> <summary> Gets the Amazon S3 Storage Lens configuration. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>. <note><para> To use this action, you must have permission to perform the <code>s3:GetStorageLensConfiguration</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationCmdlet.AccountId"> <summary> <para> <para>The account ID of the requester.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationCmdlet.ConfigId"> <summary> <para> <para>The ID of the Amazon S3 Storage Lens configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageLensConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetStorageLensConfigurationResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetStorageLensConfigurationResponse 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.S3C.GetS3CStorageLensConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigId parameter. The -PassThru parameter is deprecated, use -Select '^ConfigId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationListCmdlet"> <summary> Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>. <note><para> To use this action, you must have permission to perform the <code>s3:ListStorageLensConfigurations</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationListCmdlet.AccountId"> <summary> <para> <para>The account ID of the requester.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationListCmdlet.NextToken"> <summary> <para> <para>A pagination token to request the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageLensConfigurationList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.ListStorageLensConfigurationsResponse). Specifying the name of a property of type Amazon.S3Control.Model.ListStorageLensConfigurationsResponse 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.S3C.GetS3CStorageLensConfigurationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationTaggingCmdlet"> <summary> Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>. <note><para> To use this action, you must have permission to perform the <code>s3:GetStorageLensConfigurationTagging</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationTaggingCmdlet.AccountId"> <summary> <para> <para>The account ID of the requester.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationTaggingCmdlet.ConfigId"> <summary> <para> <para>The ID of the Amazon S3 Storage Lens configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.GetS3CStorageLensConfigurationTaggingCmdlet.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.S3Control.Model.GetStorageLensConfigurationTaggingResponse). Specifying the name of a property of type Amazon.S3Control.Model.GetStorageLensConfigurationTaggingResponse 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.S3C.GetS3CStorageLensConfigurationTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigId parameter. The -PassThru parameter is deprecated, use -Select '^ConfigId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet"> <summary> Creates an access point and associates it with the specified bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing Data Access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>. <note><para> S3 on Outposts only supports VPC-style Access Points. </para><para> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html"> Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para></note><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples">Examples</a> section. </para><para> The following actions are related to <code>CreateAccessPoint</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html">GetAccessPoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html">DeleteAccessPoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html">ListAccessPoints</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.AccountId"> <summary> <para> <para>The AWS account ID for the owner of the bucket for which you want to create an access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.PublicAccessBlockConfiguration_BlockPublicAcl"> <summary> <para> <para>Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to <code>TRUE</code> causes the following behavior:</para><ul><li><para>PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.</para></li><li><para>PUT Object calls fail if the request includes a public ACL.</para></li><li><para>PUT Bucket calls fail if the request includes a public ACL.</para></li></ul><para>Enabling this setting doesn't affect existing policies or ACLs.</para><para>This is not supported for Amazon S3 on Outposts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.PublicAccessBlockConfiguration_BlockPublicPolicy"> <summary> <para> <para>Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to <code>TRUE</code> causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. </para><para>Enabling this setting doesn't affect existing bucket policies.</para><para>This is not supported for Amazon S3 on Outposts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.Bucket"> <summary> <para> <para>The name of the bucket that you want to associate this access point with.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.PublicAccessBlockConfiguration_IgnorePublicAcl"> <summary> <para> <para>Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to <code>TRUE</code> causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. </para><para>Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.</para><para>This is not supported for Amazon S3 on Outposts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.Name"> <summary> <para> <para>The name you want to assign to this access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.PublicAccessBlockConfiguration_RestrictPublicBucket"> <summary> <para> <para>Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to <code>TRUE</code> restricts access to buckets with public policies to only AWS service principals and authorized users within this account.</para><para>Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.</para><para>This is not supported for Amazon S3 on Outposts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.VpcConfiguration_VpcId"> <summary> <para> <para>If this field is specified, this access point will only allow connections from the specified VPC ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPointArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.CreateAccessPointResponse). Specifying the name of a property of type Amazon.S3Control.Model.CreateAccessPointResponse 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.S3C.NewS3CAccessPointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Bucket parameter. The -PassThru parameter is deprecated, use -Select '^Bucket' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointCmdlet.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.S3C.NewS3CAccessPointForObjectLambdaCmdlet"> <summary> Creates an Object Lambda Access Point. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming objects with Object Lambda Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> The following actions are related to <code>CreateAccessPointForObjectLambda</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html">DeleteAccessPointForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html">GetAccessPointForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html">ListAccessPointsForObjectLambda</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointForObjectLambdaCmdlet.AccountId"> <summary> <para> <para>The AWS account ID for owner of the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointForObjectLambdaCmdlet.Configuration_AllowedFeature"> <summary> <para> <para>A container for allowed features. Valid inputs are <code>GetObject-Range</code> and <code>GetObject-PartNumber</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointForObjectLambdaCmdlet.Configuration_CloudWatchMetricsEnabled"> <summary> <para> <para>A container for whether the CloudWatch metrics configuration is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointForObjectLambdaCmdlet.Name"> <summary> <para> <para>The name you want to assign to this Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointForObjectLambdaCmdlet.Configuration_SupportingAccessPoint"> <summary> <para> <para>Standard access point associated with the Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointForObjectLambdaCmdlet.Configuration_TransformationConfiguration"> <summary> <para> <para>A container for transformation configurations for an Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CAccessPointForObjectLambdaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ObjectLambdaAccessPointArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.CreateAccessPointForObjectLambdaResponse). Specifying the name of a property of type Amazon.S3Control.Model.CreateAccessPointForObjectLambdaResponse 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.S3C.NewS3CAccessPointForObjectLambdaCmdlet.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.S3C.NewS3CBucketCmdlet"> <summary> <note><para> This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">Create Bucket</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service User Guide</i>. </para><para> Not every string is an acceptable bucket name. For information on bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules">Working with Amazon S3 Buckets</a>. </para><para> S3 on Outposts buckets support: </para><ul><li><para> Tags </para></li><li><para> LifecycleConfigurations for deleting expired objects </para></li></ul><para> For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html"> Amazon S3 on Outposts Restrictions and Limitations</a>. </para><para> For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and <code>x-amz-outpost-id</code> in your API request, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples">Examples</a> section. </para><para> The following actions are related to <code>CreateBucket</code> for Amazon S3 on Outposts: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html">GetBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html">DeleteBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html">CreateAccessPoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html">PutAccessPointPolicy</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.ACL"> <summary> <para> <para>The canned ACL to apply to the bucket.</para><note><para>This is not supported by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.Bucket"> <summary> <para> <para>The name of the bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.GrantFullControl"> <summary> <para> <para>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</para><note><para>This is not supported by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.GrantRead"> <summary> <para> <para>Allows grantee to list the objects in the bucket.</para><note><para>This is not supported by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.GrantReadACP"> <summary> <para> <para>Allows grantee to read the bucket ACL.</para><note><para>This is not supported by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.GrantWrite"> <summary> <para> <para>Allows grantee to create, overwrite, and delete any object in the bucket.</para><note><para>This is not supported by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.GrantWriteACP"> <summary> <para> <para>Allows grantee to write the ACL for the applicable bucket.</para><note><para>This is not supported by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.CreateBucketConfiguration_LocationConstraint"> <summary> <para> <para>Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location. </para><note><para>This is not supported by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.ObjectLockEnabledForBucket"> <summary> <para> <para>Specifies whether you want S3 Object Lock to be enabled for the new bucket.</para><note><para>This is not supported by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.OutpostId"> <summary> <para> <para>The ID of the Outposts where the bucket is being created.</para><note><para>This is required by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.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.S3Control.Model.CreateBucketResponse). Specifying the name of a property of type Amazon.S3Control.Model.CreateBucketResponse 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.S3C.NewS3CBucketCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Bucket parameter. The -PassThru parameter is deprecated, use -Select '^Bucket' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CBucketCmdlet.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.S3C.NewS3CJobCmdlet"> <summary> You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> This action creates a S3 Batch Operations job. </para><para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html">UpdateJobPriority</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html">JobOperation</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_AccessControlGrant"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.AccountId"> <summary> <para> <para>The AWS account ID that creates the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Report_Bucket"> <summary> <para> <para>The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectRetention_BypassGovernanceRetention"> <summary> <para> <para>Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock <code> GOVERNANCE</code> type in place.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_CacheControl"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.AccessControlPolicy_CannedAccessControlList"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_CannedAccessControlList"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.ClientRequestToken"> <summary> <para> <para>An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.ConfirmationRequired"> <summary> <para> <para>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_ContentDisposition"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_ContentEncoding"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_ContentLanguage"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_ContentLength"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_ContentMD5"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_ContentType"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Description"> <summary> <para> <para>A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Owner_DisplayName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Report_Enabled"> <summary> <para> <para>Indicates whether the specified job will generate a job-completion report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Location_ETag"> <summary> <para> <para>The ETag for the specified manifest object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3InitiateRestoreObject_ExpirationInDay"> <summary> <para> <para>This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require <code>ExpirationInDays</code> set to 1 or greater.</para><para>Conversely, do <i>not</i> set <code>ExpirationInDays</code> when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying <code>ExpirationInDays</code> results in restore request failure.</para><para>S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you <i>must</i> create separate Batch Operations jobs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Spec_Field"> <summary> <para> <para>If the specified manifest object is in the <code>S3BatchOperations_CSV_20180820</code> format, this element describes which columns contain the required data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Spec_Format"> <summary> <para> <para>Indicates which of the available formats the specified manifest uses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Report_Format"> <summary> <para> <para>The format of the specified job-completion report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.LambdaInvoke_FunctionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke on every object in the manifest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3InitiateRestoreObject_GlacierJobTier"> <summary> <para> <para>S3 Batch Operations supports <code>STANDARD</code> and <code>BULK</code> retrieval tiers, but not the <code>EXPEDITED</code> retrieval tier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.AccessControlList_Grant"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_HttpExpiresDate"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Owner_ID"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_MetadataDirective"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Retention_Mode"> <summary> <para> <para>The Object Lock retention mode to be applied to all objects in the Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_ModifiedSinceConstraint"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_NewObjectTagging"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Location_ObjectArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for a manifest object.</para><important><para>Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints"> XML related object key constraints</a>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_ObjectLockLegalHoldStatus"> <summary> <para> <para>The legal hold status to be applied to all objects in the Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_ObjectLockMode"> <summary> <para> <para>The retention mode to be applied to all objects in the Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_ObjectLockRetainUntilDate"> <summary> <para> <para>The date when the applied object retention configuration expires on all objects in the Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Location_ObjectVersionId"> <summary> <para> <para>The optional version ID to identify a specific version of the manifest object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Report_Prefix"> <summary> <para> <para>An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <code><prefix>/job-<job-id>/report.json</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Priority"> <summary> <para> <para>The numerical priority for this job. Higher numbers indicate higher priority.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_RedirectLocation"> <summary> <para> <para>Specifies an optional metadata property for website redirects, <code>x-amz-website-redirect-location</code>. Allows webpage redirects if the object is accessed through a website endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Report_ReportScope"> <summary> <para> <para>Indicates whether the job-completion report will include details of all tasks or only failed tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_RequesterCharged"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_RequesterPay"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Retention_RetainUntilDate"> <summary> <para> <para>The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Operation_S3DeleteObjectTagging"> <summary> <para> <para>Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_SSEAlgorithm"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_SSEAwsKmsKeyId"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.LegalHold_Status"> <summary> <para> <para>The Object Lock legal hold status to be applied to all objects in the Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_StorageClass"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Tag"> <summary> <para> <para>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectTagging_TagSet"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_TargetKeyPrefix"> <summary> <para> <para>Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named "Folder1" in the destination bucket, set the TargetKeyPrefix to "Folder1/".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_TargetResource"> <summary> <para> <para>Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.S3PutObjectCopy_UnModifiedSinceConstraint"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.NewObjectMetadata_UserMetadata"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.CreateJobResponse). Specifying the name of a property of type Amazon.S3Control.Model.CreateJobResponse 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.S3C.NewS3CJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.NewS3CJobCmdlet.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.S3C.RemoveS3CAccessPointCmdlet"> <summary> Deletes the specified access point. <para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples">Examples</a> section. </para><para> The following actions are related to <code>DeleteAccessPoint</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html">CreateAccessPoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html">GetAccessPoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html">ListAccessPoints</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointCmdlet.Name"> <summary> <para> <para>The name of the access point you want to delete.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointCmdlet.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.S3Control.Model.DeleteAccessPointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointCmdlet.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.S3C.RemoveS3CAccessPointCmdlet.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.S3C.RemoveS3CAccessPointForObjectLambdaCmdlet"> <summary> Deletes the specified Object Lambda Access Point. <para> The following actions are related to <code>DeleteAccessPointForObjectLambda</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html">CreateAccessPointForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html">GetAccessPointForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html">ListAccessPointsForObjectLambda</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointForObjectLambdaCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointForObjectLambdaCmdlet.Name"> <summary> <para> <para>The name of the access point you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointForObjectLambdaCmdlet.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.S3Control.Model.DeleteAccessPointForObjectLambdaResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointForObjectLambdaCmdlet.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.S3C.RemoveS3CAccessPointPolicyCmdlet"> <summary> Deletes the access point policy for the specified access point. <para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples">Examples</a> section. </para><para> The following actions are related to <code>DeleteAccessPointPolicy</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html">PutAccessPointPolicy</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html">GetAccessPointPolicy</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointPolicyCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointPolicyCmdlet.Name"> <summary> <para> <para>The name of the access point whose policy you want to delete.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointPolicyCmdlet.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.S3Control.Model.DeleteAccessPointPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointPolicyCmdlet.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.S3C.RemoveS3CAccessPointPolicyCmdlet.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.S3C.RemoveS3CAccessPointPolicyForObjectLambdaCmdlet"> <summary> Removes the resource policy for an Object Lambda Access Point. <para> The following actions are related to <code>DeleteAccessPointPolicyForObjectLambda</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html">GetAccessPointPolicyForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html">PutAccessPointPolicyForObjectLambda</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointPolicyForObjectLambdaCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointPolicyForObjectLambdaCmdlet.Name"> <summary> <para> <para>The name of the Object Lambda Access Point you want to delete the policy for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointPolicyForObjectLambdaCmdlet.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.S3Control.Model.DeleteAccessPointPolicyForObjectLambdaResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CAccessPointPolicyForObjectLambdaCmdlet.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.S3C.RemoveS3CBucketCmdlet"> <summary> Amazon.S3Control.IAmazonS3Control.DeleteBucket </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketCmdlet.AccountId"> <summary> <para> <para>The account ID that owns the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketCmdlet.Bucket"> <summary> <para> <para>Specifies the bucket being deleted.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketCmdlet.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.S3Control.Model.DeleteBucketResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketCmdlet.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.S3C.RemoveS3CBucketLifecycleConfigurationCmdlet"> <summary> <note><para> This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service User Guide</i>. </para><para> To use this action, you must have permission to perform the <code>s3-outposts:DeleteLifecycleConfiguration</code> action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others. </para><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples">Examples</a> section. </para><para> For more information about object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to Describe Lifecycle Actions</a>. </para><para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketLifecycleConfigurationCmdlet.AccountId"> <summary> <para> <para>The account ID of the lifecycle configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketLifecycleConfigurationCmdlet.Bucket"> <summary> <para> <para>Specifies the bucket.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketLifecycleConfigurationCmdlet.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.S3Control.Model.DeleteBucketLifecycleConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketLifecycleConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketLifecycleConfigurationCmdlet.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.S3C.RemoveS3CBucketPolicyCmdlet"> <summary> <note><para> This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html">DeleteBucketPolicy</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>s3-outposts:DeleteBucketPolicy</code> permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service User Guide</i>. </para><para> If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error. </para><important><para> As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action. </para></important><para> For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a>. </para><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples">Examples</a> section. </para><para> The following actions are related to <code>DeleteBucketPolicy</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html">GetBucketPolicy</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html">PutBucketPolicy</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketPolicyCmdlet.AccountId"> <summary> <para> <para>The account ID of the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketPolicyCmdlet.Bucket"> <summary> <para> <para>Specifies the bucket.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketPolicyCmdlet.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.S3Control.Model.DeleteBucketPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketPolicyCmdlet.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.S3C.RemoveS3CBucketTaggingCmdlet"> <summary> <note><para> This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> Deletes the tags from the Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service User Guide</i>. </para><para> To use this action, you must have permission to perform the <code>PutBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others. </para><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples">Examples</a> section. </para><para> The following actions are related to <code>DeleteBucketTagging</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html">GetBucketTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html">PutBucketTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketTaggingCmdlet.AccountId"> <summary> <para> <para>The AWS account ID of the Outposts bucket tag set to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketTaggingCmdlet.Bucket"> <summary> <para> <para>The bucket ARN that has the tag set to be removed.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketTaggingCmdlet.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.S3Control.Model.DeleteBucketTaggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CBucketTaggingCmdlet.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.S3C.RemoveS3CJobTaggingCmdlet"> <summary> Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the <code>s3:DeleteJobTagging</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags">Controlling access and labeling jobs using tags</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html">GetJobTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html">PutJobTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CJobTaggingCmdlet.AccountId"> <summary> <para> <para>The AWS account ID associated with the S3 Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CJobTaggingCmdlet.JobId"> <summary> <para> <para>The ID for the S3 Batch Operations job whose tags you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CJobTaggingCmdlet.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.S3Control.Model.DeleteJobTaggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CJobTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CJobTaggingCmdlet.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.S3C.RemoveS3CPublicAccessBlockCmdlet"> <summary> Removes the <code>PublicAccessBlock</code> configuration for an AWS account. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html"> Using Amazon S3 block public access</a>. <para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html">GetPublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html">PutPublicAccessBlock</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CPublicAccessBlockCmdlet.AccountId"> <summary> <para> <para>The account ID for the AWS account whose <code>PublicAccessBlock</code> configuration you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CPublicAccessBlockCmdlet.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.S3Control.Model.DeletePublicAccessBlockResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CPublicAccessBlockCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CPublicAccessBlockCmdlet.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.S3C.RemoveS3CStorageLensConfigurationCmdlet"> <summary> Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>. <note><para> To use this action, you must have permission to perform the <code>s3:DeleteStorageLensConfiguration</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationCmdlet.AccountId"> <summary> <para> <para>The account ID of the requester.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationCmdlet.ConfigId"> <summary> <para> <para>The ID of the S3 Storage Lens configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationCmdlet.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.S3Control.Model.DeleteStorageLensConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigId parameter. The -PassThru parameter is deprecated, use -Select '^ConfigId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationCmdlet.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.S3C.RemoveS3CStorageLensConfigurationTaggingCmdlet"> <summary> Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>. <note><para> To use this action, you must have permission to perform the <code>s3:DeleteStorageLensConfigurationTagging</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationTaggingCmdlet.AccountId"> <summary> <para> <para>The account ID of the requester.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationTaggingCmdlet.ConfigId"> <summary> <para> <para>The ID of the S3 Storage Lens configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationTaggingCmdlet.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.S3Control.Model.DeleteStorageLensConfigurationTaggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigId parameter. The -PassThru parameter is deprecated, use -Select '^ConfigId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.RemoveS3CStorageLensConfigurationTaggingCmdlet.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.S3C.UpdateS3CJobPriorityCmdlet"> <summary> Updates an existing S3 Batch Operations job's priority. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobPriorityCmdlet.AccountId"> <summary> <para> <para>The AWS account ID associated with the S3 Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobPriorityCmdlet.JobId"> <summary> <para> <para>The ID for the job whose priority you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobPriorityCmdlet.Priority"> <summary> <para> <para>The priority you want to assign to this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobPriorityCmdlet.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.S3Control.Model.UpdateJobPriorityResponse). Specifying the name of a property of type Amazon.S3Control.Model.UpdateJobPriorityResponse 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.S3C.UpdateS3CJobPriorityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobPriorityCmdlet.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.S3C.UpdateS3CJobStatusCmdlet"> <summary> Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobStatusCmdlet.AccountId"> <summary> <para> <para>The AWS account ID associated with the S3 Batch Operations job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobStatusCmdlet.JobId"> <summary> <para> <para>The ID of the job whose status you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobStatusCmdlet.RequestedJobStatus"> <summary> <para> <para>The status that you want to move the specified job to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobStatusCmdlet.StatusUpdateReason"> <summary> <para> <para>A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobStatusCmdlet.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.S3Control.Model.UpdateJobStatusResponse). Specifying the name of a property of type Amazon.S3Control.Model.UpdateJobStatusResponse 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.S3C.UpdateS3CJobStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.UpdateS3CJobStatusCmdlet.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.S3C.WriteS3CAccessPointConfigurationForObjectLambdaCmdlet"> <summary> Replaces configuration for an Object Lambda Access Point. <para> The following actions are related to <code>PutAccessPointConfigurationForObjectLambda</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointConfigurationForObjectLambda.html">GetAccessPointConfigurationForObjectLambda</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointConfigurationForObjectLambdaCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointConfigurationForObjectLambdaCmdlet.Configuration_AllowedFeature"> <summary> <para> <para>A container for allowed features. Valid inputs are <code>GetObject-Range</code> and <code>GetObject-PartNumber</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointConfigurationForObjectLambdaCmdlet.Configuration_CloudWatchMetricsEnabled"> <summary> <para> <para>A container for whether the CloudWatch metrics configuration is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointConfigurationForObjectLambdaCmdlet.Name"> <summary> <para> <para>The name of the Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointConfigurationForObjectLambdaCmdlet.Configuration_SupportingAccessPoint"> <summary> <para> <para>Standard access point associated with the Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointConfigurationForObjectLambdaCmdlet.Configuration_TransformationConfiguration"> <summary> <para> <para>A container for transformation configurations for an Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointConfigurationForObjectLambdaCmdlet.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.S3Control.Model.PutAccessPointConfigurationForObjectLambdaResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointConfigurationForObjectLambdaCmdlet.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.S3C.WriteS3CAccessPointPolicyCmdlet"> <summary> Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point. <para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples">Examples</a> section. </para><para> The following actions are related to <code>PutAccessPointPolicy</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html">GetAccessPointPolicy</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html">DeleteAccessPointPolicy</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyCmdlet.AccountId"> <summary> <para> <para>The AWS account ID for owner of the bucket associated with the specified access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyCmdlet.Name"> <summary> <para> <para>The name of the access point that you want to associate with the specified policy.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyCmdlet.Policy"> <summary> <para> <para>The policy that you want to apply to the specified access point. For more information about access point policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing data access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyCmdlet.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.S3Control.Model.PutAccessPointPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Policy parameter. The -PassThru parameter is deprecated, use -Select '^Policy' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyCmdlet.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.S3C.WriteS3CAccessPointPolicyForObjectLambdaCmdlet"> <summary> Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli">Creating Object Lambda Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>. <para> The following actions are related to <code>PutAccessPointPolicyForObjectLambda</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html">DeleteAccessPointPolicyForObjectLambda</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html">GetAccessPointPolicyForObjectLambda</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyForObjectLambdaCmdlet.AccountId"> <summary> <para> <para>The account ID for the account that owns the specified Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyForObjectLambdaCmdlet.Name"> <summary> <para> <para>The name of the Object Lambda Access Point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyForObjectLambdaCmdlet.Policy"> <summary> <para> <para>Object Lambda Access Point resource policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyForObjectLambdaCmdlet.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.S3Control.Model.PutAccessPointPolicyForObjectLambdaResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CAccessPointPolicyForObjectLambdaCmdlet.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.S3C.WriteS3CBucketLifecycleConfigurationCmdlet"> <summary> <note><para> This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads. </para><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples">Examples</a> section. </para><para> The following actions are related to <code>PutBucketLifecycleConfiguration</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html">DeleteBucketLifecycleConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketLifecycleConfigurationCmdlet.AccountId"> <summary> <para> <para>The AWS account ID of the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketLifecycleConfigurationCmdlet.Bucket"> <summary> <para> <para>The name of the bucket for which to set the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketLifecycleConfigurationCmdlet.LifecycleConfiguration_Rule"> <summary> <para> <para>A lifecycle rule for individual objects in an Outposts bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketLifecycleConfigurationCmdlet.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.S3Control.Model.PutBucketLifecycleConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketLifecycleConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketLifecycleConfigurationCmdlet.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.S3C.WriteS3CBucketPolicyCmdlet"> <summary> <note><para> This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html">PutBucketPolicy</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para><para> If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the <code>PutBucketPolicy</code> permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action. </para><para> If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error. </para><important><para> As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action. </para></important><para> For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a>. </para><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples">Examples</a> section. </para><para> The following actions are related to <code>PutBucketPolicy</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html">GetBucketPolicy</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html">DeleteBucketPolicy</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketPolicyCmdlet.AccountId"> <summary> <para> <para>The AWS account ID of the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketPolicyCmdlet.Bucket"> <summary> <para> <para>Specifies the bucket.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketPolicyCmdlet.ConfirmRemoveSelfBucketAccess"> <summary> <para> <para>Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.</para><note><para>This is not supported by Amazon S3 on Outposts buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketPolicyCmdlet.Policy"> <summary> <para> <para>The bucket policy as a JSON document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketPolicyCmdlet.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.S3Control.Model.PutBucketPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketPolicyCmdlet.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.S3C.WriteS3CBucketTaggingCmdlet"> <summary> <note><para> This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> in the <i>Amazon Simple Storage Service API</i>. </para></note><para> Sets the tags for an S3 on Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para><para> Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost allocation and tagging</a>. </para><note><para> Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html"> Using cost allocation in Amazon S3 bucket tags</a>. </para></note><para> To use this action, you must have permissions to perform the <code>s3-outposts:PutBucketTagging</code> action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources"> Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing access permissions to your Amazon S3 resources</a>. </para><para><code>PutBucketTagging</code> has the following special errors: </para><ul><li><para> Error code: <code>InvalidTagError</code></para><ul><li><para> Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html"> User-Defined Tag Restrictions</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html"> AWS-Generated Cost Allocation Tag Restrictions</a>. </para></li></ul></li><li><para> Error code: <code>MalformedXMLError</code></para><ul><li><para> Description: The XML provided does not match the schema. </para></li></ul></li><li><para> Error code: <code>OperationAbortedError </code></para><ul><li><para> Description: A conflicting conditional action is currently in progress against this resource. Try again. </para></li></ul></li><li><para> Error code: <code>InternalError</code></para><ul><li><para> Description: The service was unable to apply the provided tag to the bucket. </para></li></ul></li></ul><para> All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples">Examples</a> section. </para><para> The following actions are related to <code>PutBucketTagging</code>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html">GetBucketTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html">DeleteBucketTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketTaggingCmdlet.AccountId"> <summary> <para> <para>The AWS account ID of the Outposts bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketTaggingCmdlet.Bucket"> <summary> <para> <para>The Amazon Resource Name (ARN) of the bucket.</para><para>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</para><para>For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketTaggingCmdlet.Tagging_TagSet"> <summary> <para> <para>A collection for a set of tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketTaggingCmdlet.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.S3Control.Model.PutBucketTaggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CBucketTaggingCmdlet.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.S3C.WriteS3CStorageLensConfigurationCmdlet"> <summary> Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Working with Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>. <note><para> To use this action, you must have permission to perform the <code>s3:PutStorageLensConfiguration</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.AccountId"> <summary> <para> <para>The account ID of the requester.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.S3BucketDestination_AccountId"> <summary> <para> <para>The account ID of the owner of the S3 Storage Lens metrics export bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.AwsOrg_Arn"> <summary> <para> <para>A container for the Amazon Resource Name (ARN) of the AWS organization. This property is read-only and follows the following format: <code> arn:aws:organizations:<i>us-east-1</i>:<i>example-account-id</i>:organization/<i>o-ex2l495dck</i></code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.S3BucketDestination_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: <code> arn:aws:s3:<i>us-east-1</i>:<i>example-account-id</i>:bucket/<i>your-destination-bucket-name</i></code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.Exclude_Bucket"> <summary> <para> <para>A container for the S3 Storage Lens bucket excludes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.Include_Bucket"> <summary> <para> <para>A container for the S3 Storage Lens bucket includes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.ConfigId"> <summary> <para> <para>The ID of the S3 Storage Lens configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.SelectionCriteria_Delimiter"> <summary> <para> <para>A container for the delimiter of the selection criteria being used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.S3BucketDestination_Format"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.StorageLensConfiguration_Id"> <summary> <para> <para>A container for the Amazon S3 Storage Lens configuration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.StorageLensConfiguration_AccountLevel_ActivityMetrics_IsEnabled"> <summary> <para> <para>A container for whether the activity metrics are enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.StorageLensConfiguration_BucketLevel_ActivityMetrics_IsEnabled"> <summary> <para> <para>A container for whether the activity metrics are enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.StorageMetrics_IsEnabled"> <summary> <para> <para>A container for whether prefix-level storage metrics are enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.StorageLensConfiguration_IsEnabled"> <summary> <para> <para>A container for whether the S3 Storage Lens configuration is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.SSEKMS_KeyId"> <summary> <para> <para>A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format: <code> arn:aws:kms:<i>us-east-1</i>:<i>example-account-id</i>:key/<i>example-9a73-4afc-8d29-8f5900cef44e</i></code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.SelectionCriteria_MaxDepth"> <summary> <para> <para>The max depth of the selection criteria</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.SelectionCriteria_MinStorageBytesPercentage"> <summary> <para> <para>The minimum number of storage bytes percentage whose metrics will be selected.</para><note><para>You must choose a value greater than or equal to <code>1.0</code>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.S3BucketDestination_OutputSchemaVersion"> <summary> <para> <para>The schema version of the export file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.S3BucketDestination_Prefix"> <summary> <para> <para>The prefix of the destination bucket where the metrics export will be delivered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.Exclude_Region"> <summary> <para> <para>A container for the S3 Storage Lens Region excludes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.Include_Region"> <summary> <para> <para>A container for the S3 Storage Lens Region includes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.Encryption_SSES3"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.StorageLensConfiguration_StorageLensArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: <code> arn:aws:s3:<i>us-east-1</i>:<i>example-account-id</i>:storage-lens/<i>your-dashboard-name</i></code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.Tag"> <summary> <para> <para>The tag set of the S3 Storage Lens configuration.</para><note><para>You can set up to a maximum of 50 tags.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.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.S3Control.Model.PutStorageLensConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationCmdlet.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.S3C.WriteS3CStorageLensConfigurationTaggingCmdlet"> <summary> Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>. <note><para> To use this action, you must have permission to perform the <code>s3:PutStorageLensConfigurationTagging</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationTaggingCmdlet.AccountId"> <summary> <para> <para>The account ID of the requester.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationTaggingCmdlet.ConfigId"> <summary> <para> <para>The ID of the S3 Storage Lens configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationTaggingCmdlet.Tag"> <summary> <para> <para>The tag set of the S3 Storage Lens configuration.</para><note><para>You can set up to a maximum of 50 tags.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationTaggingCmdlet.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.S3Control.Model.PutStorageLensConfigurationTaggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigId parameter. The -PassThru parameter is deprecated, use -Select '^ConfigId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3C.WriteS3CStorageLensConfigurationTaggingCmdlet.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> |