AWS.Tools.S3.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.S3</name> </assembly> <members> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.CleanKey(System.String)"> <summary> 'Cleans' a user-supplied S3 key to ensure it does not start with space, \ or / and all remaining partitions use / and it does not end with a space. </summary> <param name="userKeyOrPrefix">The original user key or key prefix</param> <returns>Cleaned key</returns> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.BucketNameFromParam(System.Object,System.String)"> <summary> Extracts a bucket name from a supplied parameter object, which should be a string or S3Bucket instance. </summary> <param name="paramValue"></param> <param name="paramName"></param> <returns></returns> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.BucketRegionFromParam(System.Object,System.String)"> <summary> Extracts the system name of a region for a bucket from parameter value </summary> <param name="paramValue"></param> <param name="paramName"></param> <returns></returns> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.SetExtraRequestFields(Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest,Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CmdletContext)"> <summary> Sets metadata and headers collections for the request. </summary> <param name="request"></param> <param name="cmdletContext"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.SetMetadataAndHeaders(Amazon.S3.Transfer.TransferUtilityUploadRequest,System.Collections.Hashtable,System.Collections.Hashtable)"> <summary> Sets metadata and headers collections for the request. </summary> <param name="request"></param> <param name="metadata"></param> <param name="headers"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.SetMetadataAndHeaders(Amazon.S3.Model.PutObjectRequest,System.Collections.Hashtable,System.Collections.Hashtable)"> <summary> Sets metadata and headers collections for the request. </summary> <param name="request"></param> <param name="metadata"></param> <param name="headers"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.SetMetadataAndHeaders(Amazon.S3.Model.CopyObjectRequest,System.Collections.Hashtable,System.Collections.Hashtable)"> <summary> Sets metadata and headers collections for the request. </summary> <param name="request"></param> <param name="metadata"></param> <param name="headers"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.SetMetadataAndHeaders(Amazon.S3.Model.InitiateMultipartUploadRequest,System.Collections.Hashtable,System.Collections.Hashtable)"> <summary> Sets metadata and headers collections for the request. </summary> <param name="request"></param> <param name="metadata"></param> <param name="headers"></param> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.BucketName"> <summary> <para> The name of the bucket containing the source object. </para> <para> When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. </para> <para> When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.Key"> <summary> The key of the single source object to copy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.VersionId"> <summary> Specifies the version of the source object to copy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.DestinationKey"> <summary> The key for the copy of the source S3 object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.DestinationBucket"> <summary> <para> The name of the bucket that will contain the copied object. If not specified, the copy is to another S3 object in the source bucket. </para> <para> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <c> <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <c> <i>bucket_base_name</i>--<i>az-id</i>--x-s3</c> (for example, <c> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>. </para> <para> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. </para> <note> <para> Access points and Object Lambda access points are not supported by directory buckets. </para> </note> <para> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.MetadataDirective"> <summary> Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. Valid values are COPY or REPLACE. COPY is the default if not specified. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ContentType"> <summary> Sets the content type of the target object; if not specified an attempt is made to infer it using the destination or source object keys. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.SourceRegion"> <summary> Specifies the Region that the source bucket resides in; If not specified an attempt is made to infer it using the Region set in your credential profile. The -Region parameter specifies the Destination Region. </summary> </member> <!-- Badly formed XML comment ignored for member "P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CannedACLName" --> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.PublicReadOnly"> <summary> If set, applies an ACL making the bucket public with read-only permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.PublicReadWrite"> <summary> If set, applies an ACL making the bucket public with read-write permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.StorageClass"> <summary> Specifies the storage class for the object. Please refer to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> for information on S3 storage classes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.StandardStorage"> <summary> Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ReducedRedundancyStorage"> <summary> Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that doesn’t require the higher level of durability that S3 provides with the STANDARD storage class. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryption"> <summary> <para> The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, <code>aws:kms</code>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryptionKeyManagementServiceKeyId"> <summary> Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. <para> Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the Signature Version in Request Authentication</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.WebsiteRedirectLocation"> <summary> <para> If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the <code>x-amz-metadata-directive</code> header. Instead, you may opt to provide this header in combination with the directive. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.Metadata"> <summary> Metadata headers to set on the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.HeaderCollection"> <summary> Response headers to set on the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.TagSet"> <summary> One or more tags to apply to the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.LocalFile"> <summary> The full path to the local file that will be created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.LocalFolder"> <summary> <para> The path to a local folder that will contain the downloaded object. If a relative path is supplied, it will be resolved to a full path using the current session's location. </para> <para> When copying to a local folder the object key is used as the filename. Note that object keys that are not valid filenames for the host system could cause an exception to be thrown. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.KeyPrefix"> <summary> Used to download multiple objects to the specified local folder. The supplied prefix will be used to determine the set of objects to download that share the same key prefix. You must specify either this parameter, or the -Key parameter, to determine what object(s) to download. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ETagToMatch"> <summary> Copies the object if its entity tag (ETag) matches the specified tag; otherwise return a PreconditionFailed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ETagToNotMatch"> <summary> Copies the object if its entity tag (ETag) is different than the specified Etag; otherwise returns an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ModifiedSinceDate"> <summary> Copies the object if it has been modified since the specified time; otherwise returns an error. <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.UnmodifiedSinceDate"> <summary> Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed. <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.UtcModifiedSinceDate"> <summary> Copies the object if it has been modified since the specified time; otherwise returns an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.UtcUnmodifiedSinceDate"> <summary> Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CopySourceServerSideEncryptionCustomerMethod"> <summary> Specifies the server-side encryption algorithm used on the source object with the customer provided key. Allowable values: None or AES256. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CopySourceServerSideEncryptionCustomerProvidedKey"> <summary> Specifies base64-encoded encryption key for Amazon S3 used on the source object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CopySourceServerSideEncryptionCustomerProvidedKeyMD5"> <summary> Specifies base64-encoded MD5 of the encryption key for Amazon S3 used on the source object. This field is optional, the SDK will calculate the MD5 if this is not set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryptionCustomerMethod"> <summary> Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKey"> <summary> Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKeyMD5"> <summary> Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ChecksumAlgorithm"> <summary> Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ChecksumMode"> <summary> Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.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.S3.CopyS3ObjectCmdlet.MultiPartObjectCopyController.PartDetail"> <summary> Byte range for each part and the service's etag value on completion of the part upload </summary> </member> <member name="F:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.MultiPartObjectCopyController._parts"> <summary> Contains the collection of parts we need to process </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.MultiPartObjectCopyController.NumberOfParts"> <summary> The number of parts we've broken the upload into, based on the max allowed by S3 in conjunction with the minimum part size </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.MultiPartObjectCopyController.Error"> <summary> If set, an error was trapped by one of the upload threads and the outer code should quit (ShouldExit will yield true) and report this to the user. The exception is posted by the first thread to encounter an error; errors on other threads are dropped on the floor. </summary> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.MultiPartObjectCopyController.ShouldExit"> <summary> Indicates to the caller we're done either because we've encountered an error or all parts have been processed </summary> <returns></returns> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.MultiPartObjectCopyController.Run"> <summary> Launches threads to process the part list and immediately exits back to the caller. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the <c>s3:ListAllMyBuckets</c> permission. </para><para> For information about Amazon S3 buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3 buckets</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketCmdlet.BucketName"> <summary> If set, returns a single S3Bucket instance mapping to the specified bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Buckets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.ListBucketsResponse). Specifying the name of a property of type Amazon.S3.Model.ListBucketsResponse 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.S3.GetMultipartUploadCmdlet"> <summary> This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.BucketName"> <summary> <para> The name of the bucket to which the multipart upload was initiated. </para> <para> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <c> <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <c> <i>bucket_base_name</i>--<i>az-id</i>--x-s3</c> (for example, <c> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>. </para> <para> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. </para> <note> <para> Access points and Object Lambda access points are not supported by directory buckets. </para> </note> <para> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.Encoding"> <summary> <para> Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.ExpectedBucketOwner"> <summary> <para> The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.Delimiter"> <summary> <para> Character you use to group keys. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.KeyMarker"> <summary> <para> Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. </para> <para> If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list. </para> <para> If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.MaxUpload"> <summary> <para> Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response. </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.Prefix"> <summary> <para> Lists in-progress uploads only for those keys that begin with the specified prefix. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.UploadIdMarker"> <summary> Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetMultipartUploadCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MultipartUploads'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.ListMultipartUploadsResponse). Specifying the name of a property of type Amazon.S3.Model.ListMultipartUploadsResponse 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.S3.GetMultipartUploadCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of KeyMarker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately. </para><important><para> This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, when developing applications. For backward compatibility, Amazon S3 continues to support <c>ListObjects</c>. </para></important><para> The following operations are related to <c>ListObjects</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a></para></li><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_PutObject.html">PutObject</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a></para></li></ul><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Key"> <summary> Key value identifying a single object in S3 to return metadata for. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.BucketName"> <summary> <para> <para>The name of the bucket containing the objects.</para><para><b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <c><i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <c><i>bucket_base_name</i>--<i>az-id</i>--x-s3</c> (for example, <c><i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para><note><para>Access points and Object Lambda access points are not supported by directory buckets.</para></note><para><b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c><i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Encoding"> <summary> <para> Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.OptionalObjectAttribute"> <summary> <para> <para>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.RequestPayer"> <summary> <para> <para>Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Delimiter"> <summary> <para> A delimiter is a character that you use to group keys. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Marker"> <summary> <para> <para>Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.MaxKey"> <summary> <para> <para>Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Prefix"> <summary> <para> Limits the response to keys that begin with the specified prefix. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'S3Objects'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.ListObjectsResponse). Specifying the name of a property of type Amazon.S3.Model.ListObjectsResponse 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.S3.GetS3ObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet"> <summary> Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A <c>200 OK</c> response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. For more information about listing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object keys programmatically</a> in the <i>Amazon S3 User Guide</i>. To get a list of your buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>. <note><para><b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <c>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i></c>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the <i>Amazon S3 User Guide</i>. </para></note><dl><dt>Permissions</dt><dd><ul><li><para><b>General purpose bucket permissions</b> - To use this operation, you must have READ access to the bucket. You must have permission to perform the <c>s3:ListBucket</c> action. The 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> in the <i>Amazon S3 User Guide</i>. </para></li><li><para><b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"><c>CreateSession</c></a> API operation for session-based authorization. Specifically, you grant the <c>s3express:CreateSession</c> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <c>CreateSession</c> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <c>CreateSession</c> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"><c>CreateSession</c></a>. </para></li></ul></dd><dt>Sorting order of returned objects</dt><dd><ul><li><para><b>General purpose bucket</b> - For general purpose buckets, <c>ListObjectsV2</c> returns objects in lexicographical order based on their key names. </para></li><li><para><b>Directory bucket</b> - For directory buckets, <c>ListObjectsV2</c> does not return objects in lexicographical order. </para></li></ul></dd><dt>HTTP Host header syntax</dt><dd><para><b>Directory buckets </b> - The HTTP Host header syntax is <c><i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. </para></dd></dl><important><para> This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>. </para></important><para> The following operations are related to <c>ListObjectsV2</c>: </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_PutObject.html">PutObject</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li></ul><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.Key"> <summary> Key value identifying a single object in S3 to return metadata for. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.BucketName"> <summary> <para> <para><b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <c><i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <c><i>bucket_base_name</i>--<i>az-id</i>--x-s3</c> (for example, <c><i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para><note><para>Access points and Object Lambda access points are not supported by directory buckets.</para></note><para><b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c><i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.Encoding"> <summary> <para> <para>Encoding type used by Amazon S3 to encode object keys in the response. If using <c>url</c>, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <c>403 Forbidden</c> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.FetchOwner"> <summary> <para> <para>The owner field is not present in <c>ListObjectsV2</c> by default. If you want to return the owner field with each key in the result, then set the <c>FetchOwner</c> field to <c>true</c>.</para><note><para><b>Directory buckets</b> - For directory buckets, the bucket owner is returned as the object owner for all objects.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.OptionalObjectAttribute"> <summary> <para> <para>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</para><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.RequestPayer"> <summary> <para> <para>Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.</para><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.StartAfter"> <summary> <para> <para>StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.</para><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.ContinuationToken"> <summary> <para> <para><c>ContinuationToken</c> indicates to Amazon S3 that the list is being continued on this bucket with a token. <c>ContinuationToken</c> is obfuscated and is not a real key. You can use this <c>ContinuationToken</c> for pagination of the list results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-ContinuationToken $null' for the first call and '-ContinuationToken $AWSHistory.LastServiceResponse.NextContinuationToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.Delimiter"> <summary> <para> <para>A delimiter is a character that you use to group keys.</para><note><ul><li><para><b>Directory buckets</b> - For directory buckets, <c>/</c> is the only supported delimiter.</para></li><li><para><b>Directory buckets </b> - When you query <c>ListObjectsV2</c> with a delimiter during in-progress multipart uploads, the <c>CommonPrefixes</c> response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide</i>.</para></li></ul></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.MaxKey"> <summary> <para> <para>Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.Prefix"> <summary> <para> <para>Limits the response to keys that begin with the specified prefix.</para><note><para><b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<c>/</c>) are supported.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'S3Objects'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.ListObjectsV2Response). Specifying the name of a property of type Amazon.S3.Model.ListObjectsV2Response 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.S3.GetS3ObjectV2Cmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectV2Cmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of ContinuationToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet"> <summary> <para> Create a signed URL allowing access to a resource that would usually require authentication. </para> <para> Note that you can pipe an Amazon.S3.Model.S3Object instance to this cmdlet and its members will be used to satisfy the BucketName, Key and optionally VersionId (if an S3ObjectVersion instance is supplied), parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.BucketName"> <summary> <para> The name of the bucket to create a pre-signed url to, or containing the object. </para> <para> When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_CacheControl"> <summary> <para> CacheControl header value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_ContentDisposition"> <summary> <para> Specifies presentational information for the object. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc6266#section-4">https://www.rfc-editor.org/rfc/rfc6266#section-4</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_ContentEncoding"> <summary> <para> Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding">https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_ContentLanguage"> <summary> <para> ContentLanguage header value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ContentType"> <summary> <para> A standard MIME type describing the format of the contents. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_ContentType"> <summary> <para> A standard MIME type describing the format of the object data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.Expire"> <summary> <para> The expiry date and time for the pre-signed url. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_Expire"> <summary> <para> Expiry header value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.Key"> <summary> <para> The key to the object for which a pre-signed url should be created. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.Protocol"> <summary> <para> The requested protocol (http/https) for the pre-signed url. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ServerSideEncryptionCustomerMethod"> <summary> <para> The Server-side encryption algorithm to be used with the customer provided key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ServerSideEncryptionKeyManagementServiceKeyId"> <summary> <para> The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ServerSideEncryptionMethod"> <summary> <para> Specifies the encryption used on the server to store the content. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.Verb"> <summary> <para> The verb for the pre-signed url. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.VersionId"> <summary> <para> Version id for the object that the pre-signed url will reference. If not set, the url will reference the latest version of the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.RequestorPay"> <summary> Confirms that the requester knows that they will be charged for the request. Bucket owners do not need to specify this parameter. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet"> <summary> Creates a new bucket with the supplied name and permissions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.BucketName"> <summary> <para> The name of the bucket to create. </para> <para> <b>General purpose buckets</b> - For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Bucket naming rules</a> in the <i>Amazon S3 User Guide</i>. </para> <para> <b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i> </c>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format <c> <i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i> </para> </summary> </member> <!-- Badly formed XML comment ignored for member "P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.CannedACLName" --> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.PublicReadOnly"> <summary> If set, applies an ACL making the bucket public with read-only permissions This parameter is obsolete. Use CannedACLName instead. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.PublicReadWrite"> <summary> If set, applies an ACL making the bucket public with read-write permissions. This parameter is obsolete. Use CannedACLName instead. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.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="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.ObjectLockEnabledForBucket"> <summary> Specifies whether you want S3 Object Lock to be enabled for the new bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.BucketConfiguration"> <summary> The configuration information for a bucket </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.PutBucketResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet"> <summary> <para> Downloads an S3 object, optionally including sub-objects, to a local file or folder location. Returns a FileInfo or DirectoryInfo instance to the downloaded file or the containing folder. </para> <para> Note that you can pipe an Amazon.S3.Model.S3Object instance to this cmdlet and its members will be used to satisfy the BucketName, Key and optionally VersionId (if an S3ObjectVersion instance is supplied), parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.BucketName"> <summary> <para> Name of the bucket that holds the content to be downloaded. </para> <para> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <c> <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <c> <i>bucket_base_name</i>--<i>az-id</i>--x-s3</c> (for example, <c> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>. </para> <para> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. </para> <para> <b>Object Lambda access points</b> - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-object-lambda.<i>Region</i>.amazonaws.com. </para> <note> <para> Access points and Object Lambda access points are not supported by directory buckets. </para> </note> <para> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.Key"> <summary> The key that identifies the single object in S3. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.File"> <summary> The full path to the local file that will be created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.Version"> <summary> If specified, the specific version of the S3 object is returned. </summary> </member> <!-- Badly formed XML comment ignored for member "P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.KeyPrefix" --> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.Folder"> <summary> The full path to a local folder; all downloaded content will be placed under this folder, with subfolders maintaining the S3 object key hierarchies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.DisableSlashCorrection"> <summary> By default if KeyPrefix doesn't have a trailing '/' then a '/' is appended to mimic a virtual S3 directory. If the KeyPrefix is not meant to be S3 virtual directory set DisableSlashCorrection to true to disable the behavior for adding a trailing '/' to the KeyPrefix value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.S3Object"> <summary> <para> Amazon.S3.Model.S3Object instance containing the bucketname and key of the object to download. If the supplied object is an Amazon.S3.Model.S3ObjectVersion instance (derived from S3Object), the version of the object to download will be inferred automatically. </para> <para> The object identified by the supplied S3Object can be downloaded to a specific file (by supplying a value for the -File parameter) or to a folder (specified using the -Folder parameter). When downloading to a folder, the object key is used as the filename. Note that object keys that are not valid filenames for the host system could cause an exception to be thrown. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.ModifiedSinceDate"> <summary> If specified, only objects that have been modified since this date will be downloaded. <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.UnmodifiedSinceDate"> <summary> If specified, only objects that have not been modified since this date will be downloaded. <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.UtcModifiedSinceDate"> <summary> If specified, only objects that have been modified since this date will be downloaded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.UtcUnmodifiedSinceDate"> <summary> If specified, only objects that have not been modified since this date will be downloaded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.ServerSideEncryptionCustomerMethod"> <summary> Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKey"> <summary> Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKeyMD5"> <summary> Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.ChecksumMode"> <summary> This must be enabled to retrieve the checksum. In addition, if you enable <code>ChecksumMode</code> and the object is KMS encrypted, you must have permission to the <code>kms:Decrypt</code> action for the request to succeed. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketCmdlet"> <summary> Deletes an S3 bucket, optionally deleting remaining bucket content first (non-empty buckets cannot be deleted). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketCmdlet.BucketName"> <summary> <para> Specifies the bucket being deleted. </para> <para> <b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i> </c>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format <c> <i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketCmdlet.DeleteBucketContent"> <summary> <para> If set, all remaining objects and/or object versions in the bucket are deleted proir to the bucket itself being deleted. </para> <para>Default: Off.</para> <para> Buckets that contain objects cannot be deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketCmdlet.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="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketCmdlet.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.S3.Model.DeleteBucketResponse). Specifying the name of a property of type Amazon.S3.Model.DeleteBucketResponse 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.S3.RemoveS3MultipartUploadCmdlet"> <summary> <para> This operation aborts multipart uploads. </para> <para> After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. If you are uploading large files, Write-S3Object cmdlet will use multipart upload to fulfill the request. If a multipart upload is interrupted, Write-S3Object cmdlet will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), Write-S3Object cmdlet will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke the Remove-S3MultipartUploads to abort the incomplete multipart uploads. </para> <para> Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Remove-S3MultipartUploads</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3MultipartUploadCmdlet.BucketName"> <summary> <para> The bucket name to which the upload was taking place. </para> <para> When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. </para> <para> When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3MultipartUploadCmdlet.InitiatedDate"> <summary> The date before which the multipart uploads were initiated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3MultipartUploadCmdlet.DaysBefore"> <summary> The number of days ago that the multipart uploads were initiated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3MultipartUploadCmdlet.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.S3.RemoveS3ObjectCmdlet"> <summary> <para> Deletes the specified object, object version or set of objects from S3. The DeleteObject operation removes the specified object from Amazon S3.Once deleted, there is no method to restore or undelete an object. </para> <para> You can pipe Amazon.S3.Model.S3Object or Amazon.S3.Model.S3ObjectVersion instances to this cmdlet and their members will be used to satisfy the BucketName, Key (and VersionId if an S3ObjectVersion instance is supplied) parameters. <br/><br/> <b>Note: </b>When piping a collection of Amazon.S3.Model.S3Object or Amazon.S3.Model.S3ObjectVersion instances to identify the objects to be deleted the cmdlet receives the elements from the piped collection one element at a time and will therefore make one service call per collection element to be deleted. To perform the deletion as a batch up to 1000 objects with a single call to the service specify the collection as the value of the -InputObject parameter. The -KeyCollection and -KeyAndVersionCollection parameters also automatically process as a batch and make a single call to the service to delete up to 1000 objects identified in the collections supplied to the parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.BucketName"> <summary> <para> The bucket name of the bucket containing the object. </para> <para> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <c> <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <c> <i>bucket_base_name</i>--<i>az-id</i>--x-s3</c> (for example, <c> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>. </para> <para> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. </para> <note> <para> Access points and Object Lambda access points are not supported by directory buckets. </para> </note> <para> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.Key"> <summary> The object key identifying the object to be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.VersionId"> <summary> Version identifier of the S3 object to be deleted, for buckets with versioning enabled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.KeyAndVersionCollection"> <summary> Collection of Amazon.S3.Model.KeyVersion objects describing the S3 objects to be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.InputObject"> <summary> Collection of S3Object or S3ObjectVersion instances describing the S3 objects to be deleted. <br/> <b>Note: </b>the objects must all belong to the same bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.KeyCollection"> <summary> Collection of key names describing the S3 objects to be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.ReportErrorsOnly"> <summary> <para> If set when deleting multiple objects the service response will include only those keys for objects on which the delete operation failed. By default this switch is not set and keys for both successful multi-object deletes and failures are returned in the response. </para> <para> This parameter is used only when deleting multiple objects using the <code>-KeyCollection</code> parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.ChecksumAlgorithm"> <summary> Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.SerialNumber"> <summary> <para> Specifies the serial number of the multi-factor authentication device associated with your AWS Account. </para> <para> This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.AuthenticationValue"> <summary> <para> Specifies the current token/code displayed on the multi-factor authentication device associated with your AWS Account. </para> <para> This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.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.S3.SetS3ACLCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets the permissions on an existing bucket using access control lists (ACL). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set the ACL of a bucket, you must have the <c>WRITE_ACP</c> permission. </para><para> You can use one of the following two ways to set a bucket's permissions: </para><ul><li><para> Specify the ACL in the request body </para></li><li><para> Specify permissions using request headers </para></li></ul><note><para> You cannot specify access permission using both the body and the request headers. </para></note><para> Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach. </para><important><para> If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the <c>AccessControlListNotSupported</c> error code. Requests to read ACLs are still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a> in the <i>Amazon S3 User Guide</i>. </para></important><dl><dt>Permissions</dt><dd><para> You can set access permissions by using one of the following methods: </para><ul><li><para> Specify a canned ACL with the <c>x-amz-acl</c> request header. Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of <c>x-amz-acl</c>. If you use this header, you cannot use other access control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>. </para></li><li><para> Specify access permissions explicitly with the <c>x-amz-grant-read</c>, <c>x-amz-grant-read-acp</c>, <c>x-amz-grant-write-acp</c>, and <c>x-amz-grant-full-control</c> headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the <c>x-amz-acl</c> header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>. </para><para> You specify each grantee as a type=value pair, where the type is one of the following: </para><ul><li><para><c>id</c> – if the value specified is the canonical user ID of an Amazon Web Services account </para></li><li><para><c>uri</c> – if you are granting permissions to a predefined group </para></li><li><para><c>emailAddress</c> – if the value specified is the email address of an Amazon Web Services account </para><note><para> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </para><ul><li><para> US East (N. Virginia) </para></li><li><para> US West (N. California) </para></li><li><para> US West (Oregon) </para></li><li><para> Asia Pacific (Singapore) </para></li><li><para> Asia Pacific (Sydney) </para></li><li><para> Asia Pacific (Tokyo) </para></li><li><para> Europe (Ireland) </para></li><li><para> South America (São Paulo) </para></li></ul><para> For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference. </para></note></li></ul><para> For example, the following <c>x-amz-grant-write</c> header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses. </para><para><c>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777" </c></para></li></ul><para> You can use either a canned ACL or specify access permissions explicitly. You cannot do both. </para></dd><dt>Grantee Values</dt><dd><para> You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: </para><ul><li><para> By the person's ID: </para><para><c><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></c></para><para> DisplayName is optional and ignored in the request </para></li><li><para> By URI: </para><para><c><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></c></para></li><li><para> By Email address: </para><para><c><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee></c></para><para> The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. </para><note><para> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </para><ul><li><para> US East (N. Virginia) </para></li><li><para> US West (N. California) </para></li><li><para> US West (Oregon) </para></li><li><para> Asia Pacific (Singapore) </para></li><li><para> Asia Pacific (Sydney) </para></li><li><para> Asia Pacific (Tokyo) </para></li><li><para> Europe (Ireland) </para></li><li><para> South America (São Paulo) </para></li></ul><para> For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference. </para></note></li></ul></dd></dl><para> The following operations are related to <c>PutBucketAcl</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.PublicReadOnly"> <summary> If set, applies an ACL making the bucket public with read-only permissions This parameter is obsolete. Use CannedACL instead. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.PublicReadWrite"> <summary> If set, applies an ACL making the bucket public with read-write permissions This parameter is obsolete. Use CannedACL instead. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.BucketName"> <summary> <para> <para>The bucket name that contains the object to which you want to attach the ACL.</para><para>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.CannedACL"> <summary> <para> The canned ACL to apply to the bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.Owner_DisplayName"> <summary> <para> <para>Container for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:</para><ul><li><para>US East (N. Virginia)</para></li><li><para>US West (N. California)</para></li><li><para>US West (Oregon)</para></li><li><para>Asia Pacific (Singapore)</para></li><li><para>Asia Pacific (Sydney)</para></li><li><para>Asia Pacific (Tokyo)</para></li><li><para>Europe (Ireland)</para></li><li><para>South America (São Paulo)</para></li></ul><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.AccessControlList_Grant"> <summary> <para> A collection of grants. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.Owner_Id"> <summary> <para> The unique identifier of the owner. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.Key"> <summary> <para> The key of an S3 object. If not specified, the ACLs are applied to the bucket. <para>Key for which the PUT action was initiated.</para><para>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using Access Points</a> in the <i>Amazon S3 User Guide</i>.</para><para>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code><i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.VersionId"> <summary> <para> If set and an object key has been specified, the ACLs are applied to the specific version of the object. This property is ignored if the ACL is to be set on a Bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.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.S3.Model.PutACLResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.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.S3.TestS3BucketCmdlet"> <summary> Tests that an S3 Bucket exists </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.TestS3BucketCmdlet.BucketName"> <summary> The name of the bucket to test existence and access. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet"> <summary> <para> Uploads a local file, text content or a folder hierarchy of files to Amazon S3, placing them into the specified bucket using the specified key (single object) or key prefix (multiple objects). </para> <para> If you are uploading large files, Write-S3Object cmdlet will use multipart upload to fulfill the request. If a multipart upload is interrupted, Write-S3Object cmdlet will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), Write-S3Object cmdlet will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke the Remove-S3MultipartUploads to abort the incomplete multipart uploads. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.BucketName"> <summary> <para> The name of the bucket that will hold the uploaded content. </para> <para> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <c> <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <c> <i>bucket_base_name</i>--<i>az-id</i>--x-s3</c> (for example, <c> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>. </para> <para> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. </para> <note> <para> Access points and Object Lambda access points are not supported by directory buckets. </para> </note> <para> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Key"> <summary> The key that will be used to identify the object in S3. If the -File parameter is specified, -Key is optional and the object key can be inferred from the filename value supplied to the -File parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.File"> <summary> The full path to the local file to be uploaded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Stream"> <summary> <para> <para>The stream to be uploaded.</para> </para> <para>The cmdlet accepts a parameter of type string, string[], System.IO.FileInfo or System.IO.Stream.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Content"> <summary> Specifies text content that will be used to set the content of the object in S3. Use a here-string to specify multiple lines of text. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.KeyPrefix"> <summary> <para> The common key prefix that will be used for the objects uploaded to S3. Use this parameter when uploading multiple objects. Each object's final key will be of the form 'keyprefix/filename'. </para> <para> To indicate that all content should be uploaded to the root of the bucket, specify a KeyPrefix of '\' or '/'. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Folder"> <summary> The full path to a local folder; all content in the folder will be uploaded to the specified bucket and key. Sub-folders in the folder will only be uploaded if the Recurse switch is specified. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Recurse"> <summary> If set, all sub-folders beneath the folder set in LocalFolder will also be uploaded. The folder structure will be mirrored in S3. Defaults off [false]. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.SearchPattern"> <summary> The search pattern used to determine which files in the directory are uploaded. </summary> </member> <!-- Badly formed XML comment ignored for member "P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CannedACLName" --> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.PublicReadOnly"> <summary> If set, applies an ACL making the S3 object(s) public with read-only permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.PublicReadWrite"> <summary> If set, applies an ACL making the S3 object(s) public with read-write permissions </summary> </member> <!-- Badly formed XML comment ignored for member "P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ContentType" --> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.StorageClass"> <summary> Specifies the storage class for the object. Please refer to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> for information on S3 storage classes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.StandardStorage"> <summary> <para> Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. </para> <para> This parameter is deprecated. Please use the StorageClass parameter instead. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ReducedRedundancyStorage"> <summary> <para> Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that does not require the higher level of durability that S3 provides with the STANDARD storage class. </para> <para> This parameter is deprecated. Please use the StorageClass parameter instead. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryption"> <summary> The server-side encryption algorithm used when storing this object in Amazon S3 Allowable values: None, AES256, aws:kms. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryptionKeyManagementServiceKeyId"> <summary> The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption. <para> If <code>x-amz-server-side-encryption</code> has a valid value of <code>aws:kms</code>, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for the object. If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but do not provide<code> x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryptionCustomerMethod"> <summary> Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKey"> <summary> Specifies base64-encoded encryption key for Amazon S3 to use to encrypt the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKeyMD5"> <summary> Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Metadata"> <summary> Metadata headers to set on the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.HeaderCollection"> <summary> Response headers to set on the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.TagSet"> <summary> One or more tags to apply to the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ChecksumAlgorithm"> <summary> Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ConcurrentServiceRequest"> <summary> This property determines how many active threads will be used to upload the file . This property is only applicable if the file being uploaded is larger than 16 MB, in which case TransferUtility is used to upload multiple parts in parallel. The default value is 10. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CalculateContentMD5Header"> <summary> This property determines whether the Content-MD5 header should be calculated for upload. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.PartSize"> <summary> This property determines the part size of the upload. The uploaded file will be divided into parts of the size specified and uploaded to Amazon S3 individually. The part size can be between 5 MB to 5 GB. <para>You can specify this value in one of two ways:</para> <ul><li><para>The part size in bytes. For example, 6291456.</para></li> <li><para>The part size with a size suffix. You can use bytes, KB, MB, GB. For example, 6291456bytes, 15.12MB, "15.12 MB".</para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.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="P:Amazon.PowerShell.Cmdlets.S3.AmazonS3ClientCmdlet.UseAccelerateEndpoint"> <summary> Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AmazonS3ClientCmdlet.UseDualstackEndpoint"> <summary> Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AmazonS3ClientCmdlet.ForcePathStyleAddressing"> <summary> S3 requests can be performed using one of two URI styles: Virtual or Path. When using Virtual style, the bucket is included as part of the hostname. When using Path style the bucket is included as part of the URI path. The default value is $true when the EndpointUrl parameter is specified, $false otherwise. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Creates or modifies the <c>PublicAccessBlock</c> configuration for an Amazon S3 bucket. To use this operation, you must have the <c>s3:PutBucketPublicAccessBlock</c> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>. </para><important><para> When Amazon S3 evaluates the <c>PublicAccessBlock</c> configuration for a bucket or an object, it checks the <c>PublicAccessBlock</c> configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the <c>PublicAccessBlock</c> configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. </para></important><para> For more information about when Amazon S3 considers a bucket or an object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>. </para><para> The following operations are related to <c>PutPublicAccessBlock</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html">GetBucketPolicyStatus</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.PublicAccessBlockConfiguration_BlockPublicAcl"> <summary> <para> <para>Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this element to <code>TRUE</code> causes the following behavior:</para><ul><li><para>PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.</para></li><li><para>PUT Object calls will fail if the request includes an object ACL.</para></li></ul><para>Note that enabling this setting doesn't affect existing policies or ACLs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.PublicAccessBlockConfiguration_BlockPublicPolicy"> <summary> <para> <para>Specifies whether Amazon S3 should block public bucket policies for this bucket. 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>Note that enabling this setting doesn't affect existing bucket policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.BucketName"> <summary> <para> <para>The name of the Amazon S3 bucket whose Public Access Block configuration you want to set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.ContentMD5"> <summary> <para> <para>The MD5 hash of the <code>PutPublicAccessBlock</code> request body. </para><para>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.PublicAccessBlockConfiguration_IgnorePublicAcl"> <summary> <para> <para>Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this element to <code>TRUE</code> causes Amazon S3 to ignore all public ACLs on this bucket and any objects that it contains. </para><para>Note that enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.PublicAccessBlockConfiguration_RestrictPublicBucket"> <summary> <para> <para>Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to <code>TRUE</code> restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has a public policy.</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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.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.S3.Model.PutPublicAccessBlockResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.AddS3PublicAccessBlockCmdlet.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.S3.GetS3ACLCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> This implementation of the <c>GET</c> action uses the <c>acl</c> subresource to return the access control list (ACL) of a bucket. To use <c>GET</c> to return the ACL of the bucket, you must have the <c>READ_ACP</c> access to the bucket. If <c>READ_ACP</c> permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header. </para><para> When you use this API operation with an access point, provide the alias of the access point in place of the bucket name. </para><para> When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <c>InvalidAccessPointAliasError</c> is returned. For more information about <c>InvalidAccessPointAliasError</c>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>. </para><note><para> If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the <c>bucket-owner-full-control</c> ACL with the owner being the account that created the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>. </para></note><para> The following operations are related to <c>GetBucketAcl</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ACLCmdlet.BucketName"> <summary> <para> <para>Specifies the S3 bucket whose ACL is being requested.</para><para>When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.</para><para>When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ACLCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ACLCmdlet.Key"> <summary> <para> The key of the S3 object to be queried. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ACLCmdlet.VersionId"> <summary> <para> VersionId used to reference a specific version of the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ACLCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessControlList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetACLResponse). Specifying the name of a property of type Amazon.S3.Model.GetACLResponse 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.S3.GetS3ACLCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAccelerateConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> This implementation of the GET action uses the <c>accelerate</c> subresource to return the Transfer Acceleration state of a bucket, which is either <c>Enabled</c> or <c>Suspended</c>. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3. </para><para> To use this operation, you must have permission to perform the <c>s3:GetAccelerateConfiguration</c> action. The 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> in the <i>Amazon S3 User Guide</i>. </para><para> You set the Transfer Acceleration state of an existing bucket to <c>Enabled</c> or <c>Suspended</c> by using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> operation. </para><para> A GET <c>accelerate</c> request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket. </para><para> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a> in the Amazon S3 User Guide. </para><para> The following operations are related to <c>GetBucketAccelerateConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAccelerateConfigurationCmdlet.BucketName"> <summary> <para> <para>The name of the bucket for which the accelerate configuration is retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAccelerateConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAccelerateConfigurationCmdlet.RequestPayer"> <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.S3.GetS3BucketAccelerateConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketAccelerateConfigurationResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketAccelerateConfigurationResponse 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.S3.GetS3BucketAccelerateConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket. </para><para> To use this operation, you must have permissions to perform the <c>s3:GetAnalyticsConfiguration</c> action. The 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> in the <i>Amazon S3 User Guide</i>. </para><para> For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a> in the <i>Amazon S3 User Guide</i>. </para><para> The following operations are related to <c>GetBucketAnalyticsConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationCmdlet.AnalyticsId"> <summary> <para> The identifier used to represent an analytics configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket from which an analytics configuration is retrieved. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AnalyticsConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketAnalyticsConfigurationResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketAnalyticsConfigurationResponse 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.S3.GetS3BucketAnalyticsConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationListCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. </para><para> This action supports list pagination and does not return more than 100 configurations at a time. You should always check the <c>IsTruncated</c> element in the response. If there are no more configurations to list, <c>IsTruncated</c> is set to false. If there are more configurations to list, <c>IsTruncated</c> is set to true, and there will be a value in <c>NextContinuationToken</c>. You use the <c>NextContinuationToken</c> value to continue the pagination of the list by passing the value in continuation-token in the request to <c>GET</c> the next page. </para><para> To use this operation, you must have permissions to perform the <c>s3:GetAnalyticsConfiguration</c> action. The 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> For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>. </para><para> The following operations are related to <c>ListBucketAnalyticsConfigurations</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationListCmdlet.BucketName"> <summary> <para> The name of the bucket containing the analytics configurations to retrieve. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationListCmdlet.ContinuationToken"> <summary> <para> The <code>ContinuationToken</code> that represents a placeholder from where this request should begin. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationListCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketAnalyticsConfigurationListCmdlet.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.S3.Model.ListBucketAnalyticsConfigurationsResponse). Specifying the name of a property of type Amazon.S3.Model.ListBucketAnalyticsConfigurationsResponse 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.S3.GetS3BucketAnalyticsConfigurationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketEncryptionCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a> in the <i>Amazon S3 User Guide</i>. </para><para> To use this operation, you must have permission to perform the <c>s3:GetEncryptionConfiguration</c> action. The 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> The following operations are related to <c>GetBucketEncryption</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html">PutBucketEncryption</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html">DeleteBucketEncryption</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketEncryptionCmdlet.BucketName"> <summary> <para> The name of the bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketEncryptionCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketEncryptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServerSideEncryptionConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketEncryptionResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketEncryptionResponse 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.S3.GetS3BucketEncryptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketIntelligentTieringConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Gets the S3 Intelligent-Tiering configuration from the specified bucket. </para><para> The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. </para><para> The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. </para><para> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>. </para><para> Operations related to <c>GetBucketIntelligentTieringConfiguration</c> include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketIntelligentTieringConfigurationCmdlet.BucketName"> <summary> <para> The name of the Amazon S3 bucket whose configuration you want to modify or retrieve. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketIntelligentTieringConfigurationCmdlet.IntelligentTieringId"> <summary> <para> The ID used to identify the S3 Intelligent-Tiering configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketIntelligentTieringConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IntelligentTieringConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketIntelligentTieringConfigurationResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketIntelligentTieringConfigurationResponse 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.S3.GetS3BucketIntelligentTieringConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketIntelligentTieringConfigurationListCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Lists the S3 Intelligent-Tiering configuration from the specified bucket. </para><para> The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. </para><para> The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. </para><para> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>. </para><para> Operations related to <c>ListBucketIntelligentTieringConfigurations</c> include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketIntelligentTieringConfigurationListCmdlet.BucketName"> <summary> <para> The name of the Amazon S3 bucket whose configuration you want to modify or retrieve. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketIntelligentTieringConfigurationListCmdlet.ContinuationToken"> <summary> <para> The ContinuationToken that represents a placeholder from where this request should begin. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketIntelligentTieringConfigurationListCmdlet.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.S3.Model.ListBucketIntelligentTieringConfigurationsResponse). Specifying the name of a property of type Amazon.S3.Model.ListBucketIntelligentTieringConfigurationsResponse 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.S3.GetS3BucketIntelligentTieringConfigurationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns an inventory configuration (identified by the inventory configuration ID) from the bucket. </para><para> To use this operation, you must have permissions to perform the <c>s3:GetInventoryConfiguration</c> action. The 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> For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>. </para><para> The following operations are related to <c>GetBucketInventoryConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket containing the inventory configuration to retrieve. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationCmdlet.InventoryId"> <summary> <para> The ID used to identify the inventory configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InventoryConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketInventoryConfigurationResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketInventoryConfigurationResponse 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.S3.GetS3BucketInventoryConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationListCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. </para><para> This action supports list pagination and does not return more than 100 configurations at a time. Always check the <c>IsTruncated</c> element in the response. If there are no more configurations to list, <c>IsTruncated</c> is set to false. If there are more configurations to list, <c>IsTruncated</c> is set to true, and there is a value in <c>NextContinuationToken</c>. You use the <c>NextContinuationToken</c> value to continue the pagination of the list by passing the value in continuation-token in the request to <c>GET</c> the next page. </para><para> To use this operation, you must have permissions to perform the <c>s3:GetInventoryConfiguration</c> action. The 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> For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a></para><para> The following operations are related to <c>ListBucketInventoryConfigurations</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationListCmdlet.BucketName"> <summary> <para> The name of the bucket containing the inventory configurations to retrieve. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationListCmdlet.ContinuationToken"> <summary> <para> The marker used to continue an inventory configuration listing that has been truncated. Use the <code>NextContinuationToken</code> from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationListCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketInventoryConfigurationListCmdlet.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.S3.Model.ListBucketInventoryConfigurationsResponse). Specifying the name of a property of type Amazon.S3.Model.ListBucketInventoryConfigurationsResponse 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.S3.GetS3BucketInventoryConfigurationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLocationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the Region the bucket resides in. You set the bucket's Region using the <c>LocationConstraint</c> request parameter in a <c>CreateBucket</c> request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. </para><para> When you use this API operation with an access point, provide the alias of the access point in place of the bucket name. </para><para> When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <c>InvalidAccessPointAliasError</c> is returned. For more information about <c>InvalidAccessPointAliasError</c>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>. </para><note><para> We recommend that you use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a> to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation. </para></note><para> The following operations are related to <c>GetBucketLocation</c>: </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_CreateBucket.html">CreateBucket</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLocationCmdlet.BucketName"> <summary> <para> <para>The name of the bucket for which to get the location.</para><para>When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.</para><para>When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLocationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLocationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Location'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketLocationResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketLocationResponse 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.S3.GetS3BucketLocationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLoggingCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the logging status of a bucket and the permissions users have to view and modify that status. </para><para> The following operations are related to <c>GetBucketLogging</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html">PutBucketLogging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLoggingCmdlet.BucketName"> <summary> <para> The name of the bucket to query. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLoggingCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLoggingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BucketLoggingConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketLoggingResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketLoggingResponse 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.S3.GetS3BucketLoggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. </para><para> To use this operation, you must have permissions to perform the <c>s3:GetMetricsConfiguration</c> action. The 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> For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>. </para><para> The following operations are related to <c>GetBucketMetricsConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket containing the metrics configuration to retrieve. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationCmdlet.MetricsId"> <summary> <para> The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MetricsConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketMetricsConfigurationResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketMetricsConfigurationResponse 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.S3.GetS3BucketMetricsConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationListCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket. </para><para> This action supports list pagination and does not return more than 100 configurations at a time. Always check the <c>IsTruncated</c> element in the response. If there are no more configurations to list, <c>IsTruncated</c> is set to false. If there are more configurations to list, <c>IsTruncated</c> is set to true, and there is a value in <c>NextContinuationToken</c>. You use the <c>NextContinuationToken</c> value to continue the pagination of the list by passing the value in <c>continuation-token</c> in the request to <c>GET</c> the next page. </para><para> To use this operation, you must have permissions to perform the <c>s3:GetMetricsConfiguration</c> action. The 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> For more information about metrics configurations and CloudWatch request metrics, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>. </para><para> The following operations are related to <c>ListBucketMetricsConfigurations</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationListCmdlet.BucketName"> <summary> <para> The name of the bucket containing the metrics configurations to retrieve. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationListCmdlet.ContinuationToken"> <summary> <para> The marker that is used to continue a metrics configuration listing that has been truncated. Use the<code>NextContinuationToken</code> from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationListCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketMetricsConfigurationListCmdlet.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.S3.Model.ListBucketMetricsConfigurationsResponse). Specifying the name of a property of type Amazon.S3.Model.ListBucketMetricsConfigurationsResponse 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.S3.GetS3BucketMetricsConfigurationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketNotificationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the notification configuration of a bucket. </para><para> If notifications are not enabled on the bucket, the action returns an empty <c>NotificationConfiguration</c> element. </para><para> By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the <c>s3:GetBucketNotification</c> permission. </para><para> When you use this API operation with an access point, provide the alias of the access point in place of the bucket name. </para><para> When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <c>InvalidAccessPointAliasError</c> is returned. For more information about <c>InvalidAccessPointAliasError</c>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>. </para><para> For more information about setting and reading the notification configuration on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification of Bucket Events</a>. For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies</a>. </para><para> The following action is related to <c>GetBucketNotification</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html">PutBucketNotification</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketNotificationCmdlet.BucketName"> <summary> <para> <para>The name of the bucket for which to get the notification configuration.</para><para>When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.</para><para>When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketNotificationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketNotificationCmdlet.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.S3.Model.GetBucketNotificationResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketNotificationResponse 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.S3.GetS3BucketNotificationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketOwnershipControlCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Retrieves <c>OwnershipControls</c> for an Amazon S3 bucket. To use this operation, you must have the <c>s3:GetBucketOwnershipControls</c> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying permissions in a policy</a>. </para><para> For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Using Object Ownership</a>. </para><para> The following operations are related to <c>GetBucketOwnershipControls</c>: </para><ul><li><para><a>PutBucketOwnershipControls</a></para></li><li><para><a>DeleteBucketOwnershipControls</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketOwnershipControlCmdlet.BucketName"> <summary> <para> The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketOwnershipControlCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketOwnershipControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OwnershipControls'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketOwnershipControlsResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketOwnershipControlsResponse 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.S3.GetS3BucketOwnershipControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyCmdlet"> <summary> Returns the policy of a specified bucket. <note><para><b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i></c>. Virtual-hosted-style requests aren't supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the <i>Amazon S3 User Guide</i>. </para></note><dl><dt>Permissions</dt><dd><para> If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must both have the <c>GetBucketPolicy</c> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. </para><para> If you don't have <c>GetBucketPolicy</c> permissions, Amazon S3 returns a <c>403 Access Denied</c> 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 <c>405 Method Not Allowed</c> error. </para><important><para> To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the <c>GetBucketPolicy</c>, <c>PutBucketPolicy</c>, and <c>DeleteBucketPolicy</c> API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies. </para></important><ul><li><para><b>General purpose bucket permissions</b> - The <c>s3:GetBucketPolicy</c> permission is required in a policy. For more information about general purpose buckets bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a> in the <i>Amazon S3 User Guide</i>. </para></li><li><para><b>Directory bucket permissions</b> - To grant access to this API operation, you must have the <c>s3express:GetBucketPolicy</c> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>. </para></li></ul></dd><dt>Example bucket policies</dt><dd><para><b>General purpose buckets example bucket policies</b> - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy examples</a> in the <i>Amazon S3 User Guide</i>. </para><para><b>Directory bucket example bucket policies</b> - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>. </para></dd><dt>HTTP Host header syntax</dt><dd><para><b>Directory buckets </b> - The HTTP Host header syntax is <c>s3express-control.<i>region</i>.amazonaws.com</c>. </para></dd></dl><para> The following action is related to <c>GetBucketPolicy</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyCmdlet.BucketName"> <summary> <para> <para>The bucket name to get the bucket policy for.</para><para><b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i></c>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format <c><i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c><i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i></para><para><b>Access points</b> - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.</para><para><b>Object Lambda access points</b> - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <c>InvalidAccessPointAliasError</c> is returned. For more information about <c>InvalidAccessPointAliasError</c>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>.</para><note><para>Access points and Object Lambda access points are not supported by directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <c>403 Forbidden</c> (access denied).</para><note><para>For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code <c>501 Not Implemented</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyCmdlet.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.S3.Model.GetBucketPolicyResponse). Specifying the name of a property of type Amazon.S3.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.S3.GetS3BucketPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyStatusCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the <c>s3:GetBucketPolicyStatus</c> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>. </para><para> For more information about when Amazon S3 considers a bucket public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>. </para><para> The following operations are related to <c>GetBucketPolicyStatus</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyStatusCmdlet.BucketName"> <summary> <para> <para>The name of the Amazon S3 bucket whose public-policy status you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyStatusCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyStatusCmdlet.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.S3.Model.GetBucketPolicyStatusResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketPolicyStatusResponse 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.S3.GetS3BucketPolicyStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketReplicationCmdlet"> <summary> Retrieves the replication configuration for the given Amazon S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketReplicationCmdlet.BucketName"> <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.S3.GetS3BucketReplicationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketReplicationCmdlet.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.S3.Model.GetBucketReplicationResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketReplicationResponse 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.S3.GetS3BucketReplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketRequestPaymentCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>. </para><para> The following operations are related to <c>GetBucketRequestPayment</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketRequestPaymentCmdlet.BucketName"> <summary> <para> The name of the bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketRequestPaymentCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketRequestPaymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Payer'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketRequestPaymentResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketRequestPaymentResponse 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.S3.GetS3BucketRequestPaymentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketTaggingCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the tag set associated with the bucket. </para><para> To use this operation, you must have permission to perform the <c>s3:GetBucketTagging</c> action. By default, the bucket owner has this permission and can grant this permission to others. </para><para><c>GetBucketTagging</c> has the following special error: </para><ul><li><para> Error code: <c>NoSuchTagSet</c></para><ul><li><para> Description: There is no tag set associated with the bucket. </para></li></ul></li></ul><para> The following operations are related to <c>GetBucketTagging</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketTaggingCmdlet.BucketName"> <summary> <para> The name of the bucket to be queried. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketTaggingCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketTaggingCmdlet.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.S3.Model.GetBucketTaggingResponse). Specifying the name of a property of type Amazon.S3.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.S3.GetS3BucketTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketVersioningCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the versioning state of a bucket. </para><para> To retrieve the versioning state of a bucket, you must be the bucket owner. </para><para> This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is <c>enabled</c>, the bucket owner must use an authentication device to change the versioning state of the bucket. </para><para> The following operations are related to <c>GetBucketVersioning</c>: </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_PutObject.html">PutObject</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketVersioningCmdlet.BucketName"> <summary> <para> The name of the bucket to be queried. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketVersioningCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketVersioningCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VersioningConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketVersioningResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketVersioningResponse 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.S3.GetS3BucketVersioningCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketWebsiteCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </para><para> This GET action requires the <c>S3:GetBucketWebsite</c> permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the <c>S3:GetBucketWebsite</c> permission. </para><para> The following operations are related to <c>GetBucketWebsite</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html">DeleteBucketWebsite</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketWebsiteCmdlet.BucketName"> <summary> <para> <para>The bucket name for which to get the website configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketWebsiteCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketWebsiteCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WebsiteConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetBucketWebsiteResponse). Specifying the name of a property of type Amazon.S3.Model.GetBucketWebsiteResponse 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.S3.GetS3BucketWebsiteCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3CORSConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket. </para><para> To use this operation, you must have permission to perform the <c>s3:GetBucketCORS</c> action. By default, the bucket owner has this permission and can grant it to others. </para><para> When you use this API operation with an access point, provide the alias of the access point in place of the bucket name. </para><para> When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <c>InvalidAccessPointAliasError</c> is returned. For more information about <c>InvalidAccessPointAliasError</c>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>. </para><para> For more information about CORS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html"> Enabling Cross-Origin Resource Sharing</a>. </para><para> The following operations are related to <c>GetBucketCors</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3CORSConfigurationCmdlet.BucketName"> <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.S3.GetS3CORSConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3CORSConfigurationCmdlet.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.S3.Model.GetCORSConfigurationResponse). Specifying the name of a property of type Amazon.S3.Model.GetCORSConfigurationResponse 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.S3.GetS3CORSConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3DirectoryBucketCmdlet"> <summary> Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the <i>Amazon S3 User Guide</i>. <note><para><b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i></c>. Virtual-hosted-style requests aren't supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the <i>Amazon S3 User Guide</i>. </para></note><dl><dt>Permissions</dt><dd><para> You must have the <c>s3express:ListAllMyDirectoryBuckets</c> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>. </para></dd><dt>HTTP Host header syntax</dt><dd><para><b>Directory buckets </b> - The HTTP Host header syntax is <c>s3express-control.<i>region</i>.amazonaws.com</c>. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3DirectoryBucketCmdlet.ContinuationToken"> <summary> <para> <para><code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on this bucket with a token. <code>ContinuationToken</code> is obfuscated and is not a real key. You can use this <code>ContinuationToken</code> for pagination of the list results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3DirectoryBucketCmdlet.MaxDirectoryBucket"> <summary> <para> <para>Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3DirectoryBucketCmdlet.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.S3.Model.ListDirectoryBucketsResponse). Specifying the name of a property of type Amazon.S3.Model.ListDirectoryBucketsResponse 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.S3.GetS3LifecycleConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><note><para> Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, </para></note><para> Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>. </para><para> To use this operation, you must have permission to perform the <c>s3:GetLifecycleConfiguration</c> action. The 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><c>GetBucketLifecycleConfiguration</c> has the following special error: </para><ul><li><para> Error code: <c>NoSuchLifecycleConfiguration</c></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 operations are related to <c>GetBucketLifecycleConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3LifecycleConfigurationCmdlet.BucketName"> <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.S3.GetS3LifecycleConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <c>403 Forbidden</c> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3LifecycleConfigurationCmdlet.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.S3.Model.GetLifecycleConfigurationResponse). Specifying the name of a property of type Amazon.S3.Model.GetLifecycleConfigurationResponse 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.S3.GetS3LifecycleConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet"> <summary> Retrieves all the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata. <para><c>GetObjectAttributes</c> combines the functionality of <c>HeadObject</c> and <c>ListParts</c>. All of the data returned with each of those individual calls can be returned with a single call to <c>GetObjectAttributes</c>. </para><note><para><b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <c>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i></c>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the <i>Amazon S3 User Guide</i>. </para></note><dl><dt>Permissions</dt><dd><ul><li><para><b>General purpose bucket permissions</b> - To use <c>GetObjectAttributes</c>, you must have READ access to the object. The permissions that you need to use this operation with depend on whether the bucket is versioned. If the bucket is versioned, you need both the <c>s3:GetObjectVersion</c> and <c>s3:GetObjectVersionAttributes</c> permissions for this operation. If the bucket is not versioned, you need the <c>s3:GetObject</c> and <c>s3:GetObjectAttributes</c> permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the <c>s3:ListBucket</c> permission. </para><ul><li><para> If you have the <c>s3:ListBucket</c> permission on the bucket, Amazon S3 returns an HTTP status code <c>404 Not Found</c> ("no such key") error. </para></li><li><para> If you don't have the <c>s3:ListBucket</c> permission, Amazon S3 returns an HTTP status code <c>403 Forbidden</c> ("access denied") error. </para></li></ul></li><li><para><b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"><c>CreateSession</c></a> API operation for session-based authorization. Specifically, you grant the <c>s3express:CreateSession</c> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <c>CreateSession</c> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <c>CreateSession</c> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"><c>CreateSession</c></a>. </para></li></ul></dd><dt>Encryption</dt><dd><note><para> Encryption request headers, like <c>x-amz-server-side-encryption</c>, should not be sent for <c>HEAD</c> requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The <c>x-amz-server-side-encryption</c> header is used when you <c>PUT</c> an object to S3 and want to specify the encryption method. If you include this header in a <c>GET</c> request for an object that uses these types of keys, you’ll get an HTTP <c>400 Bad Request</c> error. It's because the encryption method can't be changed when you retrieve the object. </para></note><para> If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are: </para><ul><li><para><c>x-amz-server-side-encryption-customer-algorithm</c></para></li><li><para><c>x-amz-server-side-encryption-customer-key</c></para></li><li><para><c>x-amz-server-side-encryption-customer-key-MD5</c></para></li></ul><para> For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User Guide</i>. </para><note><para><b>Directory bucket permissions</b> - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<c>AES256</c>) is supported. </para></note></dd><dt>Versioning</dt><dd><para><b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <c>null</c> value of the version ID is supported by directory buckets. You can only specify <c>null</c> to the <c>versionId</c> query parameter in the request. </para></dd><dt>Conditional request headers</dt><dd><para> Consider the following when using request headers: </para><ul><li><para> If both of the <c>If-Match</c> and <c>If-Unmodified-Since</c> headers are present in the request as follows, then Amazon S3 returns the HTTP status code <c>200 OK</c> and the data requested: </para><ul><li><para><c>If-Match</c> condition evaluates to <c>true</c>. </para></li><li><para><c>If-Unmodified-Since</c> condition evaluates to <c>false</c>. </para></li></ul><para> For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>. </para></li><li><para> If both of the <c>If-None-Match</c> and <c>If-Modified-Since</c> headers are present in the request as follows, then Amazon S3 returns the HTTP status code <c>304 Not Modified</c>: </para><ul><li><para><c>If-None-Match</c> condition evaluates to <c>false</c>. </para></li><li><para><c>If-Modified-Since</c> condition evaluates to <c>true</c>. </para></li></ul><para> For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>. </para></li></ul></dd><dt>HTTP Host header syntax</dt><dd><para><b>Directory buckets </b> - The HTTP Host header syntax is <c><i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. </para></dd></dl><para> The following actions are related to <c>GetObjectAttributes</c>: </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_GetObjectAcl.html">GetObjectAcl</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html">GetObjectLegalHold</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html">GetObjectLockConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html">GetObjectRetention</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html">HeadObject</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.BucketName"> <summary> <para> <para>The name of the bucket that contains the object.</para><para><b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <c><i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <c><i>bucket_base_name</i>--<i>az-id</i>--x-s3</c> (for example, <c><i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para><note><para>Access points and Object Lambda access points are not supported by directory buckets.</para></note><para><b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c><i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <c>403 Forbidden</c> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.Key"> <summary> <para> <para>The object key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.MaxPart"> <summary> <para> <para>Sets the maximum number of parts to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.ObjectAttribute"> <summary> <para> <para>Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.PartNumberMarker"> <summary> <para> <para>Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.RequestPayer"> <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.S3.GetS3ObjectAttributeCmdlet.SSECustomerAlgorithm"> <summary> <para> <para>Specifies the algorithm to use to when encrypting the object (for example, AES256).</para><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.SSECustomerKey"> <summary> <para> <para>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <c>x-amz-server-side-encryption-customer-algorithm</c> header.</para><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.SSECustomerKeyMD5"> <summary> <para> <para>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</para><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.VersionId"> <summary> <para> <para>The version ID used to reference a specific version of the object.</para><note><para>S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <c>null</c> value of the version ID is supported by directory buckets. You can only specify <c>null</c> to the <c>versionId</c> query parameter in the request.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectAttributeCmdlet.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.S3.Model.GetObjectAttributesResponse). Specifying the name of a property of type Amazon.S3.Model.GetObjectAttributesResponse 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.S3.GetS3ObjectAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLegalHoldCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. </para><para> This functionality is not supported for Amazon S3 on Outposts. </para><para> The following action is related to <c>GetObjectLegalHold</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLegalHoldCmdlet.BucketName"> <summary> <para> <para>The bucket name containing the object whose legal hold status you want to retrieve. </para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLegalHoldCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLegalHoldCmdlet.Key"> <summary> <para> <para>The key name for the object whose Legal Hold status you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLegalHoldCmdlet.RequestPayer"> <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.S3.GetS3ObjectLegalHoldCmdlet.VersionId"> <summary> <para> <para>The version ID of the object whose Legal Hold status you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLegalHoldCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LegalHold'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetObjectLegalHoldResponse). Specifying the name of a property of type Amazon.S3.Model.GetObjectLegalHoldResponse 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.S3.GetS3ObjectLegalHoldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLockConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. </para><para> The following action is related to <c>GetObjectLockConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLockConfigurationCmdlet.BucketName"> <summary> <para> <para>The bucket whose Object Lock configuration you want to retrieve.</para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLockConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectLockConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ObjectLockConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetObjectLockConfigurationResponse). Specifying the name of a property of type Amazon.S3.Model.GetObjectLockConfigurationResponse 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.S3.GetS3ObjectLockConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet"> <summary> The <c>HEAD</c> operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata. <para> A <c>HEAD</c> request has the same options as a <c>GET</c> operation on an object. The response is identical to the <c>GET</c> response except that there is no response body. Because of this, if the <c>HEAD</c> request generates an error, it returns a generic code, such as <c>400 Bad Request</c>, <c>403 Forbidden</c>, <c>404 Not Found</c>, <c>405 Method Not Allowed</c>, <c>412 Precondition Failed</c>, or <c>304 Not Modified</c>. It's not possible to retrieve the exact exception of these error codes. </para><para> Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common Request Headers</a>. </para><note><para><b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <c>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i></c>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the <i>Amazon S3 User Guide</i>. </para></note><dl><dt>Permissions</dt><dd><ul><li><para><b>General purpose bucket permissions</b> - To use <c>HEAD</c>, you must have the <c>s3:GetObject</c> permission. You need the relevant read object (or version) permission for this operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, resources, and condition keys for Amazon S3</a> in the <i>Amazon S3 User Guide</i>. </para><para> If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the <c>s3:ListBucket</c> permission. </para><ul><li><para> If you have the <c>s3:ListBucket</c> permission on the bucket, Amazon S3 returns an HTTP status code <c>404 Not Found</c> error. </para></li><li><para> If you don’t have the <c>s3:ListBucket</c> permission, Amazon S3 returns an HTTP status code <c>403 Forbidden</c> error. </para></li></ul></li><li><para><b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"><c>CreateSession</c></a> API operation for session-based authorization. Specifically, you grant the <c>s3express:CreateSession</c> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <c>CreateSession</c> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <c>CreateSession</c> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"><c>CreateSession</c></a>. </para></li></ul></dd><dt>Encryption</dt><dd><note><para> Encryption request headers, like <c>x-amz-server-side-encryption</c>, should not be sent for <c>HEAD</c> requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The <c>x-amz-server-side-encryption</c> header is used when you <c>PUT</c> an object to S3 and want to specify the encryption method. If you include this header in a <c>HEAD</c> request for an object that uses these types of keys, you’ll get an HTTP <c>400 Bad Request</c> error. It's because the encryption method can't be changed when you retrieve the object. </para></note><para> If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are: </para><ul><li><para><c>x-amz-server-side-encryption-customer-algorithm</c></para></li><li><para><c>x-amz-server-side-encryption-customer-key</c></para></li><li><para><c>x-amz-server-side-encryption-customer-key-MD5</c></para></li></ul><para> For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User Guide</i>. </para><note><para><b>Directory bucket permissions</b> - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<c>AES256</c>) is supported. </para></note></dd><dt>Versioning</dt><dd><ul><li><para> If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes <c>x-amz-delete-marker: true</c> in the response. </para></li><li><para> If the specified version is a delete marker, the response returns a <c>405 Method Not Allowed</c> error and the <c>Last-Modified: timestamp</c> response header. </para></li></ul><note><ul><li><para><b>Directory buckets</b> - Delete marker is not supported by directory buckets. </para></li><li><para><b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <c>null</c> value of the version ID is supported by directory buckets. You can only specify <c>null</c> to the <c>versionId</c> query parameter in the request. </para></li></ul></note></dd><dt>HTTP Host header syntax</dt><dd><para><b>Directory buckets </b> - The HTTP Host header syntax is <c><i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. </para></dd></dl><para> The following actions are related to <c>HeadObject</c>: </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_GetObjectAttributes.html">GetObjectAttributes</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.BucketName"> <summary> <para> <para>The name of the bucket that contains the object.</para><para><b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <c><i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <c><i>bucket_base_name</i>--<i>az-id</i>--x-s3</c> (for example, <c><i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para><note><para>Access points and Object Lambda access points are not supported by directory buckets.</para></note><para><b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c><i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ChecksumMode"> <summary> <para> <para>This must be enabled to retrieve the checksum.</para><para>In addition, if you enable <c>ChecksumMode</c> and the object is KMS encrypted, you must have permission to the <c>kms:Decrypt</c> action for the request to succeed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.EtagToMatch"> <summary> <para> ETag to be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.EtagToNotMatch"> <summary> <para> ETag that should not be matched as a pre-condition for returning the object, otherwise a NotModified (304) signal is returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <c>403 Forbidden</c> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.Key"> <summary> <para> The key of the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.UtcModifiedSinceDate"> <summary> <para> Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.PartNumber"> <summary> <para> Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.RequestPayer"> <summary> <para> Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ServerSideEncryptionCustomerMethod"> <summary> <para> The Server-side encryption algorithm to be used with the customer provided key. <note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ServerSideEncryptionCustomerProvidedKey"> <summary> <para> The base64-encoded encryption key for Amazon S3 to use to decrypt the object <para>Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide.</para><para>When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you.</para><para>Important: Amazon S3 does not store the encryption key you provide.</para><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ServerSideEncryptionCustomerProvidedKeyMD5"> <summary> <para> The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.UtcUnmodifiedSinceDate"> <summary> <para> Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.VersionId"> <summary> <para> <para>Version ID used to reference a specific version of the object.</para><note><para>For directory buckets in this API operation, only the <c>null</c> value of the version ID is supported.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ModifiedSinceDate"> <summary> <para> <para>This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.</para> Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed. </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.UnmodifiedSinceDate"> <summary> <para> <para>This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.</para> Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed. </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.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.S3.Model.GetObjectMetadataResponse). Specifying the name of a property of type Amazon.S3.Model.GetObjectMetadataResponse 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.S3.GetS3ObjectMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectRetentionCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. </para><para> This functionality is not supported for Amazon S3 on Outposts. </para><para> The following action is related to <c>GetObjectRetention</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectRetentionCmdlet.BucketName"> <summary> <para> <para>The bucket name containing the object whose retention settings you want to retrieve. </para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectRetentionCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectRetentionCmdlet.Key"> <summary> <para> <para>The key name for the object whose retention settings you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectRetentionCmdlet.RequestPayer"> <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.S3.GetS3ObjectRetentionCmdlet.VersionId"> <summary> <para> <para>The version ID for the object whose retention settings you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectRetentionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Retention'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetObjectRetentionResponse). Specifying the name of a property of type Amazon.S3.Model.GetObjectRetentionResponse 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.S3.GetS3ObjectRetentionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectTagSetCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object. </para><para> To use this operation, you must have permission to perform the <c>s3:GetObjectTagging</c> action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the <c>s3:GetObjectVersionTagging</c> action. </para><para> By default, the bucket owner has this permission and can grant this permission to others. </para><para> For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>. </para><para> The following actions are related to <c>GetObjectTagging</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html">DeleteObjectTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html">PutObjectTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectTagSetCmdlet.BucketName"> <summary> <para> <para>The bucket name containing the object for which to get the tagging information. </para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para><para><b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code><i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectTagSetCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectTagSetCmdlet.Key"> <summary> <para> <para>Object key for which to get the tagging information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectTagSetCmdlet.RequestPayer"> <summary> <para> <para>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests</para>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectTagSetCmdlet.VersionId"> <summary> <para> <para>The versionId of the object for which to get the tagging information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectTagSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tagging'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetObjectTaggingResponse). Specifying the name of a property of type Amazon.S3.Model.GetObjectTaggingResponse 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.S3.GetS3ObjectTagSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Key parameter. The -PassThru parameter is deprecated, use -Select '^Key' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3PublicAccessBlockCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Retrieves the <c>PublicAccessBlock</c> configuration for an Amazon S3 bucket. To use this operation, you must have the <c>s3:GetBucketPublicAccessBlock</c> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>. </para><important><para> When Amazon S3 evaluates the <c>PublicAccessBlock</c> configuration for a bucket or an object, it checks the <c>PublicAccessBlock</c> configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the <c>PublicAccessBlock</c> settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. </para></important><para> For more information about when Amazon S3 considers a bucket or an object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>. </para><para> The following operations are related to <c>GetPublicAccessBlock</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PublicAccessBlockCmdlet.BucketName"> <summary> <para> <para> The name of the Amazon S3 bucket whose Public Access Block configuration you want to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PublicAccessBlockCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PublicAccessBlockCmdlet.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.S3.Model.GetPublicAccessBlockResponse). Specifying the name of a property of type Amazon.S3.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.S3.GetS3PublicAccessBlockCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions. </para><important><para> To use this operation, you must have permission to perform the <c>s3:ListBucketVersions</c> action. Be aware of the name difference. </para></important><note><para> A <c>200 OK</c> response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. </para></note><para> To use this operation, you must have READ access to the bucket. </para><para> The following operations are related to <c>ListObjectVersions</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a></para></li><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_PutObject.html">PutObject</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.BucketName"> <summary> <para> <para>The bucket name that contains the objects. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.Encoding"> <summary> <para> Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.KeyMarker"> <summary> <para> Specifies the key to start with when listing objects in a bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.OptionalObjectAttribute"> <summary> <para> <para>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.RequestPayer"> <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.S3.GetS3VersionCmdlet.VersionIdMarker"> <summary> <para> Specifies the object version you want to start listing from. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.Delimiter"> <summary> <para> <para>A delimiter is a character that you specify to group keys. All keys that contain the same string between the <code>prefix</code> and the first occurrence of the delimiter are grouped under a single result element in <code>CommonPrefixes</code>. These groups are counted as one result against the <code>max-keys</code> limitation. These keys are not returned elsewhere in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.MaxKey"> <summary> <para> <para>Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because <code>max-keys</code> was exceeded, the response contains <code><isTruncated>true</isTruncated></code>. To return the additional keys, see <code>key-marker</code> and <code>version-id-marker</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.Prefix"> <summary> <para> <para>Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.) You can use <code>prefix</code> with <code>delimiter</code> to roll up numerous objects into a single result under <code>CommonPrefixes</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.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.S3.Model.ListVersionsResponse). Specifying the name of a property of type Amazon.S3.Model.ListVersionsResponse 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.S3.GetS3VersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.NewS3SessionCmdlet"> <summary> Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint APIs on directory buckets. For more information about Zonal endpoint APIs that include the Availability Zone in the request endpoint, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html">S3 Express One Zone APIs</a> in the <i>Amazon S3 User Guide</i>. <para> To make Zonal endpoint API requests on a directory bucket, use the <c>CreateSession</c> API operation. Specifically, you grant <c>s3express:CreateSession</c> permission to a bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the <c>CreateSession</c> API request on the bucket, which returns temporary security credentials that include the access key ID, secret access key, session token, and expiration. These credentials have associated permissions to access the Zonal endpoint APIs. After the session is created, you don’t need to use other policies to grant permissions to each Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by applying the temporary security credentials of the session to the request headers and following the SigV4 protocol for authentication. You also apply the session token to the <c>x-amz-s3session-token</c> request header for authorization. Temporary security credentials are scoped to the bucket and expire after 5 minutes. After the expiration time, any calls that you make with those credentials will fail. You must use IAM credentials again to make a <c>CreateSession</c> API request that generates a new set of temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond the original specified interval. </para><para> If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to initiate and manage requests to the CreateSession API. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-optimizing-performance-guidelines-design-patterns.html#s3-express-optimizing-performance-session-authentication">Performance guidelines and design patterns</a> in the <i>Amazon S3 User Guide</i>. </para><note><ul><li><para> You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <c>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the <i>Amazon S3 User Guide</i>. </para></li><li><para><b><c>CopyObject</c> API operation</b> - Unlike other Zonal endpoint APIs, the <c>CopyObject</c> API operation doesn't use the temporary security credentials returned from the <c>CreateSession</c> API operation for authentication and authorization. For information about authentication and authorization of the <c>CopyObject</c> API operation on directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>. </para></li><li><para><b><c>HeadBucket</c> API operation</b> - Unlike other Zonal endpoint APIs, the <c>HeadBucket</c> API operation doesn't use the temporary security credentials returned from the <c>CreateSession</c> API operation for authentication and authorization. For information about authentication and authorization of the <c>HeadBucket</c> API operation on directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a>. </para></li></ul></note><dl><dt>Permissions</dt><dd><para> To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that grants <c>s3express:CreateSession</c> permission to the bucket. In a policy, you can have the <c>s3express:SessionMode</c> condition key to control who can create a <c>ReadWrite</c> or <c>ReadOnly</c> session. For more information about <c>ReadWrite</c> or <c>ReadOnly</c> sessions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters"><c>x-amz-create-session-mode</c></a>. For example policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html">Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>. </para><para> To grant cross-account access to Zonal endpoint APIs, the bucket policy should also grant both accounts the <c>s3express:CreateSession</c> permission. </para></dd><dt>HTTP Host header syntax</dt><dd><para><b>Directory buckets </b> - The HTTP Host header syntax is <c><i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</c>. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3SessionCmdlet.BucketName"> <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.S3.NewS3SessionCmdlet.SessionMode"> <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.S3.NewS3SessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Credentials'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.CreateSessionResponse). Specifying the name of a property of type Amazon.S3.Model.CreateSessionResponse 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.S3.NewS3SessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3SessionCmdlet.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.S3.RemoveS3BucketAnalyticsConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). </para><para> To use this operation, you must have permissions to perform the <c>s3:PutAnalyticsConfiguration</c> action. The 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> For information about the Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>. </para><para> The following operations are related to <c>DeleteBucketAnalyticsConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketAnalyticsConfigurationCmdlet.AnalyticsId"> <summary> <para> The identifier used to represent an analytics configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketAnalyticsConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket from which an analytics configuration is deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketAnalyticsConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketAnalyticsConfigurationCmdlet.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.S3.Model.DeleteBucketAnalyticsConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketAnalyticsConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketAnalyticsConfigurationCmdlet.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.S3.RemoveS3BucketEncryptionCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a> in the <i>Amazon S3 User Guide</i>. </para><para> To use this operation, you must have permissions to perform the <c>s3:PutEncryptionConfiguration</c> action. The 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> in the <i>Amazon S3 User Guide</i>. </para><para> The following operations are related to <c>DeleteBucketEncryption</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html">PutBucketEncryption</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html">GetBucketEncryption</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketEncryptionCmdlet.BucketName"> <summary> <para> The name of the bucket containing the server-side encryption configuration to delete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketEncryptionCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketEncryptionCmdlet.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.S3.Model.DeleteBucketEncryptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketEncryptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketEncryptionCmdlet.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.S3.RemoveS3BucketIntelligentTieringConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Deletes the S3 Intelligent-Tiering configuration from the specified bucket. </para><para> The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. </para><para> The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. </para><para> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>. </para><para> Operations related to <c>DeleteBucketIntelligentTieringConfiguration</c> include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketIntelligentTieringConfigurationCmdlet.BucketName"> <summary> <para> The name of the Amazon S3 bucket whose configuration you want to modify or retrieve. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketIntelligentTieringConfigurationCmdlet.IntelligentTieringId"> <summary> <para> The ID used to identify the S3 Intelligent-Tiering configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketIntelligentTieringConfigurationCmdlet.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.S3.Model.DeleteBucketIntelligentTieringConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketIntelligentTieringConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketIntelligentTieringConfigurationCmdlet.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.S3.RemoveS3BucketInventoryConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Deletes an inventory configuration (identified by the inventory ID) from the bucket. </para><para> To use this operation, you must have permissions to perform the <c>s3:PutInventoryConfiguration</c> action. The 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> For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>. </para><para> Operations related to <c>DeleteBucketInventoryConfiguration</c> include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketInventoryConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket containing the inventory configuration to delete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketInventoryConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketInventoryConfigurationCmdlet.InventoryId"> <summary> <para> The ID used to identify the inventory configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketInventoryConfigurationCmdlet.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.S3.Model.DeleteBucketInventoryConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketInventoryConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketInventoryConfigurationCmdlet.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.S3.RemoveS3BucketMetricsConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. </para><para> To use this operation, you must have permissions to perform the <c>s3:PutMetricsConfiguration</c> action. The 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> For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>. </para><para> The following operations are related to <c>DeleteBucketMetricsConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketMetricsConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket on which Inventory configuration is to be removed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketMetricsConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketMetricsConfigurationCmdlet.MetricsId"> <summary> <para> The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketMetricsConfigurationCmdlet.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.S3.Model.DeleteBucketMetricsConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketMetricsConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketMetricsConfigurationCmdlet.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.S3.RemoveS3BucketOwnershipControlCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Removes <c>OwnershipControls</c> for an Amazon S3 bucket. To use this operation, you must have the <c>s3:PutBucketOwnershipControls</c> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>. </para><para> For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html">Using Object Ownership</a>. </para><para> The following operations are related to <c>DeleteBucketOwnershipControls</c>: </para><ul><li><para><a>GetBucketOwnershipControls</a></para></li><li><para><a>PutBucketOwnershipControls</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketOwnershipControlCmdlet.BucketName"> <summary> <para> The Amazon S3 bucket whose OwnershipControls you want to delete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketOwnershipControlCmdlet.ExpectedBucketOwner"> <summary> <para> The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketOwnershipControlCmdlet.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.S3.Model.DeleteBucketOwnershipControlsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketOwnershipControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketOwnershipControlCmdlet.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.S3.RemoveS3BucketPolicyCmdlet"> <summary> Deletes the policy of a specified bucket. <note><para><b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i></c>. Virtual-hosted-style requests aren't supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the <i>Amazon S3 User Guide</i>. </para></note><dl><dt>Permissions</dt><dd><para> If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must both have the <c>DeleteBucketPolicy</c> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. </para><para> If you don't have <c>DeleteBucketPolicy</c> permissions, Amazon S3 returns a <c>403 Access Denied</c> 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 <c>405 Method Not Allowed</c> error. </para><important><para> To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the <c>GetBucketPolicy</c>, <c>PutBucketPolicy</c>, and <c>DeleteBucketPolicy</c> API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies. </para></important><ul><li><para><b>General purpose bucket permissions</b> - The <c>s3:DeleteBucketPolicy</c> permission is required in a policy. For more information about general purpose buckets bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a> in the <i>Amazon S3 User Guide</i>. </para></li><li><para><b>Directory bucket permissions</b> - To grant access to this API operation, you must have the <c>s3express:DeleteBucketPolicy</c> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>. </para></li></ul></dd><dt>HTTP Host header syntax</dt><dd><para><b>Directory buckets </b> - The HTTP Host header syntax is <c>s3express-control.<i>region</i>.amazonaws.com</c>. </para></dd></dl><para> The following operations are related to <c>DeleteBucketPolicy</c></para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketPolicyCmdlet.BucketName"> <summary> <para> <para>The bucket name.</para><para><b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i></c>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format <c><i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c><i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketPolicyCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <c>403 Forbidden</c> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketPolicyCmdlet.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.S3.Model.DeleteBucketPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketPolicyCmdlet.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.S3.RemoveS3BucketReplicationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Deletes the replication configuration from the bucket. </para><para> To use this operation, you must have permissions to perform the <c>s3:PutReplicationConfiguration</c> action. The bucket owner has these permissions by default and can grant it 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><note><para> It can take a while for the deletion of a replication configuration to fully propagate. </para></note><para> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>. </para><para> The following operations are related to <c>DeleteBucketReplication</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html">PutBucketReplication</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketReplicationCmdlet.BucketName"> <summary> <para> <para>Deletes the replication subresource associated with the specified bucket.</para><note><para>There is usually some time lag before replication configuration deletion is fully propagated to all the Amazon S3 systems.</para></note><para> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/crr.html"> Cross-Region Replication (CRR)</a> in the Amazon S3 Developer Guide. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketReplicationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketReplicationCmdlet.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.S3.Model.DeleteBucketReplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketReplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketReplicationCmdlet.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.S3.RemoveS3BucketTaggingCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Deletes the tags from the bucket. </para><para> To use this operation, you must have permission to perform the <c>s3:PutBucketTagging</c> action. By default, the bucket owner has this permission and can grant this permission to others. </para><para> The following operations are related to <c>DeleteBucketTagging</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketTaggingCmdlet.BucketName"> <summary> <para> The name of the bucket on which the tag set is to be removed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketTaggingCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketTaggingCmdlet.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.S3.Model.DeleteBucketTaggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketTaggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketTaggingCmdlet.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.S3.RemoveS3BucketWebsiteCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> This action removes the website configuration for a bucket. Amazon S3 returns a <c>200 OK</c> response upon successfully deleting a website configuration on the specified bucket. You will get a <c>200 OK</c> response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a <c>404</c> response if the bucket specified in the request does not exist. </para><para> This DELETE action requires the <c>S3:DeleteBucketWebsite</c> permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the <c>S3:DeleteBucketWebsite</c> permission. </para><para> For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </para><para> The following operations are related to <c>DeleteBucketWebsite</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html">GetBucketWebsite</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketWebsiteCmdlet.BucketName"> <summary> <para> The name of the bucket on which website configuration is to be removed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketWebsiteCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketWebsiteCmdlet.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.S3.Model.DeleteBucketWebsiteResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketWebsiteCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketWebsiteCmdlet.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.S3.RemoveS3CORSConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Deletes the <c>cors</c> configuration information set for the bucket. </para><para> To use this operation, you must have permission to perform the <c>s3:PutBucketCORS</c> action. The bucket owner has this permission by default and can grant this permission to others. </para><para> For information about <c>cors</c>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>. </para><para><b>Related Resources</b></para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3CORSConfigurationCmdlet.BucketName"> <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.S3.RemoveS3CORSConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3CORSConfigurationCmdlet.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.S3.Model.DeleteCORSConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3CORSConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3CORSConfigurationCmdlet.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.S3.RemoveS3LifecycleConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. </para><para> To use this operation, you must have permission to perform the <c>s3:PutLifecycleConfiguration</c> action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others. </para><para> There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. </para><para> For more information about the 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_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3LifecycleConfigurationCmdlet.BucketName"> <summary> <para> <para>The bucket name of the lifecycle to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3LifecycleConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3LifecycleConfigurationCmdlet.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.S3.Model.DeleteLifecycleConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3LifecycleConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3LifecycleConfigurationCmdlet.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.S3.RemoveS3ObjectTagSetCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Removes the entire tag set from the specified object. For more information about managing object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> Object Tagging</a>. </para><para> To use this operation, you must have permission to perform the <c>s3:DeleteObjectTagging</c> action. </para><para> To delete tags of a specific object version, add the <c>versionId</c> query parameter in the request. You will need permission for the <c>s3:DeleteObjectVersionTagging</c> action. </para><para> The following operations are related to <c>DeleteObjectTagging</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html">PutObjectTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectTagSetCmdlet.BucketName"> <summary> <para> <para>The bucket name containing the objects from which to remove the tags. </para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para><para><b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code><i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectTagSetCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectTagSetCmdlet.Key"> <summary> <para> The key identifying the object tagging to delete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectTagSetCmdlet.VersionId"> <summary> <para> <para>The versionId of the object that the tag-set will be removed from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectTagSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VersionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.DeleteObjectTaggingResponse). Specifying the name of a property of type Amazon.S3.Model.DeleteObjectTaggingResponse 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.S3.RemoveS3ObjectTagSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Key parameter. The -PassThru parameter is deprecated, use -Select '^Key' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectTagSetCmdlet.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.S3.RemoveS3PublicAccessBlockCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Removes the <c>PublicAccessBlock</c> configuration for an Amazon S3 bucket. To use this operation, you must have the <c>s3:PutBucketPublicAccessBlock</c> permission. 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> The following operations are related to <c>DeletePublicAccessBlock</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html">GetBucketPolicyStatus</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3PublicAccessBlockCmdlet.BucketName"> <summary> <para> <para>The Amazon S3 bucket whose Public Access Block configuration you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3PublicAccessBlockCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3PublicAccessBlockCmdlet.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.S3.Model.DeletePublicAccessBlockResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3PublicAccessBlockCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3PublicAccessBlockCmdlet.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.S3.RestoreS3ObjectCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Restores an archived copy of an object back into Amazon S3 </para><para> This functionality is not supported for Amazon S3 on Outposts. </para><para> This action performs the following types of requests: </para><ul><li><para><c>restore an archive</c> - Restore an archived object </para></li></ul><para> For more information about the <c>S3</c> structure in the request body, see the following: </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/dev/S3_ACLs_UsingACLs.html">Managing Access with ACLs</a> in the <i>Amazon S3 User Guide</i></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i></para></li></ul><dl><dt>Permissions</dt><dd><para> To use this operation, you must have permissions to perform the <c>s3:RestoreObject</c> action. The 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> in the <i>Amazon S3 User Guide</i>. </para></dd><dt>Restoring objects</dt><dd><para> Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first initiate a restore request, and then wait until a temporary copy of the object is available. If you want a permanent copy of the object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must restore the object for the duration (number of days) that you specify. For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. </para><para> To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version. </para><para> When restoring an archived object, you can specify one of the following data access tier options in the <c>Tier</c> element of the request body: </para><ul><li><para><c>Expedited</c> - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. </para></li><li><para><c>Standard</c> - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering. </para></li><li><para><c>Bulk</c> - Bulk retrievals free for objects stored in the S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. </para></li></ul><para> For more information about archive retrieval options and provisioned capacity for <c>Expedited</c> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in the <i>Amazon S3 User Guide</i>. </para><para> You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. </para><para> To get the status of object restoration, you can send a <c>HEAD</c> request. Operations return the <c>x-amz-restore</c> header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>. </para><para> After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object. </para><para> If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> in <i>Amazon S3 User Guide</i>. </para></dd><dt>Responses</dt><dd><para> A successful action returns either the <c>200 OK</c> or <c>202 Accepted</c> status code. </para><ul><li><para> If the object is not previously restored, then Amazon S3 returns <c>202 Accepted</c> in the response. </para></li><li><para> If the object is previously restored, Amazon S3 returns <c>200 OK</c> in the response. </para></li></ul><ul><li><para> Special errors: </para><ul><li><para><i>Code: RestoreAlreadyInProgress</i></para></li><li><para><i>Cause: Object restore is already in progress.</i></para></li><li><para><i>HTTP Status Code: 409 Conflict</i></para></li><li><para><i>SOAP Fault Code Prefix: Client</i></para></li></ul></li><li><ul><li><para><i>Code: GlacierExpeditedRetrievalNotAvailable</i></para></li><li><para><i>Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)</i></para></li><li><para><i>HTTP Status Code: 503</i></para></li><li><para><i>SOAP Fault Code Prefix: N/A</i></para></li></ul></li></ul></dd></dl><para> The following operations are related to <c>RestoreObject</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.BucketName"> <summary> <para> <para>The bucket name containing the object to restore. </para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para><para><b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <c><i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</c>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.S3_BucketName"> <summary> <para> The name of the bucket where the restore results will be placed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.S3_CannedACL"> <summary> <para> The canned ACL to apply to the restore results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <c>x-amz-checksum</c> or <c>x-amz-trailer</c> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <c>400 Bad Request</c>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <c>ChecksumAlgorithm</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.CopyLifetimeInDays"> <summary> <para> <para>Lifetime of the active copy in days. Do not use with restores that specify <c>OutputLocation</c>.</para><para>The Days element is required for regular restores, and must not be provided for select requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Description"> <summary> <para> The optional description for the job. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Owner_DisplayName"> <summary> <para> <para>Container for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:</para><ul><li><para>US East (N. Virginia)</para></li><li><para>US West (N. California)</para></li><li><para>US West (Oregon)</para></li><li><para>Asia Pacific (Singapore)</para></li><li><para>Asia Pacific (Sydney)</para></li><li><para>Asia Pacific (Tokyo)</para></li><li><para>Europe (Ireland)</para></li><li><para>South America (São Paulo)</para></li></ul><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Encryption_EncryptionType"> <summary> <para> The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, <code>aws:kms</code>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <c>403 Forbidden</c> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.AccessControlList_Grant"> <summary> <para> A collection of grants. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Owner_Id"> <summary> <para> The unique identifier of the owner. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Key"> <summary> <para> This key indicates the S3 object to restore. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Encryption_KMSContext"> <summary> <para> If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Encryption_KMSKeyId"> <summary> <para> If the encryption type is <code>aws:kms</code>, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html"> Asymmetric keys in Amazon Web Services KMS</a> in the <i>Amazon Web Services Key Management Service Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.S3_Prefix"> <summary> <para> The prefix that is prepended to the restore results for this request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.RequestPayer"> <summary> <para> Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.RestoreRequestType"> <summary> <para> Type of restore request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.RetrievalTier"> <summary> <para> Retrieval tier at which the restore will be processed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.SelectParameter"> <summary> <para> Describes the parameters for Select job types. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.S3_StorageClass"> <summary> <para> The class of storage used to store the restore results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Tagging_TagSet"> <summary> <para> TagSet </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Tier"> <summary> <para> Tier at which the restore will be processed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.S3_UserMetadata"> <summary> <para> A map of metadata to store with the restore results in S3. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.VersionId"> <summary> <para> VersionId used to reference a specific version of the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.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.S3.Model.RestoreObjectResponse). Specifying the name of a property of type Amazon.S3.Model.RestoreObjectResponse 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.S3.RestoreS3ObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.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.S3.SelectS3ObjectContentCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. </para><para> This functionality is not supported for Amazon S3 on Outposts. </para><para> For more information about Amazon S3 Select, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html">Selecting Content from Objects</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html">SELECT Command</a> in the <i>Amazon S3 User Guide</i>. </para><dl><dt>Permissions</dt><dd><para> You must have the <c>s3:GetObject</c> permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. </para></dd><dt>Object Data Formats</dt><dd><para> You can use Amazon S3 Select to query objects that have the following format properties: </para><ul><li><para><i>CSV, JSON, and Parquet</i> - Objects must be in CSV, JSON, or Parquet format. </para></li><li><para><i>UTF-8</i> - UTF-8 is the only encoding type Amazon S3 Select supports. </para></li><li><para><i>GZIP or BZIP2</i> - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects. </para></li><li><para><i>Server-side encryption</i> - Amazon S3 Select supports querying objects that are protected with server-side encryption. </para><para> For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User Guide</i>. </para><para> For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>. </para></li></ul></dd><dt>Working with the Response Body</dt><dd><para> Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a <c>Transfer-Encoding</c> header with <c>chunked</c> as its value in the response. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html">Appendix: SelectObjectContent Response</a>. </para></dd><dt>GetObject Support</dt><dd><para> The <c>SelectObjectContent</c> action does not support the following <c>GetObject</c> functionality. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. </para><ul><li><para><c>Range</c>: Although you can specify a scan range for an Amazon S3 Select request (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange">SelectObjectContentRequest - ScanRange</a> in the request parameters), you cannot specify the range of bytes of an object to return. </para></li><li><para> The <c>GLACIER</c>, <c>DEEP_ARCHIVE</c>, and <c>REDUCED_REDUNDANCY</c> storage classes, or the <c>ARCHIVE_ACCESS</c> and <c>DEEP_ARCHIVE_ACCESS</c> access tiers of the <c>INTELLIGENT_TIERING</c> storage class: You cannot query objects in the <c>GLACIER</c>, <c>DEEP_ARCHIVE</c>, or <c>REDUCED_REDUNDANCY</c> storage classes, nor objects in the <c>ARCHIVE_ACCESS</c> or <c>DEEP_ARCHIVE_ACCESS</c> access tiers of the <c>INTELLIGENT_TIERING</c> storage class. For more information about storage classes, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html">Using Amazon S3 storage classes</a> in the <i>Amazon S3 User Guide</i>. </para></li></ul></dd><dt>Special Errors</dt><dd><para> For a list of special errors for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList">List of SELECT Object Content Error Codes</a></para></dd></dl><para> The following operations are related to <c>SelectObjectContent</c>: </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_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.BucketName"> <summary> <para> The S3 Bucket name. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.ScanRange_End"> <summary> <para> Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.Expression"> <summary> <para> The expression that is used to query the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.ExpressionType"> <summary> <para> The type of the provided expression (e.g., SQL). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.InputSerialization"> <summary> <para> Describes the format of the data in the object that is being queried. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.Key"> <summary> <para> The Object Key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.OutputSerialization"> <summary> <para> Describes the format of the data that you want Amazon S3 to return in response. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.RequestProgress"> <summary> <para> Specifies if periodic request progress information should be enabled. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.ServerSideCustomerEncryptionMethod"> <summary> <para> The SSE Algorithm used to encrypt the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.ServerSideEncryptionCustomerProvidedKey"> <summary> <para> The SSE Customer Key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.ServerSideEncryptionCustomerProvidedKeyMD5"> <summary> <para> The SSE Customer Key MD5. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.ScanRange_Start"> <summary> <para> Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.Bucket"> <summary> <para> The S3 Bucket. </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SelectS3ObjectContentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Payload'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.SelectObjectContentResponse). Specifying the name of a property of type Amazon.S3.Model.SelectObjectContentResponse 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.S3.SelectS3ObjectContentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Expression parameter. The -PassThru parameter is deprecated, use -Select '^Expression' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.SetS3BucketEncryptionCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> This action uses the <c>encryption</c> subresource to configure default encryption and Amazon S3 Bucket Keys for an existing bucket. </para><para> By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configure <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a>. If you use PutBucketEncryption to set your <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">default bucket encryption</a> to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 does not validate the KMS key ID provided in PutBucketEncryption requests. </para><important><para> This action requires Amazon Web Services Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html"> Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </para></important><para> To use this operation, you must have permission to perform the <c>s3:PutEncryptionConfiguration</c> action. The 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> in the <i>Amazon S3 User Guide</i>. </para><para> The following operations are related to <c>PutBucketEncryption</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html">GetBucketEncryption</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html">DeleteBucketEncryption</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3BucketEncryptionCmdlet.BucketName"> <summary> <para> <para>Specifies default encryption for a bucket using server-side encryption with different key options. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For information about the bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3BucketEncryptionCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3BucketEncryptionCmdlet.ContentMD5"> <summary> <para> <para>The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.</para><para>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3BucketEncryptionCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3BucketEncryptionCmdlet.ServerSideEncryptionConfiguration_ServerSideEncryptionRule"> <summary> <para> Container for information about a particular server-side encryption configuration rule. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3BucketEncryptionCmdlet.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.S3.PutBucketEncryptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3BucketEncryptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3BucketEncryptionCmdlet.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.S3.WriteS3BucketAccelerateConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3. </para><para> To use this operation, you must have permission to perform the <c>s3:PutAccelerateConfiguration</c> action. The 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> The Transfer Acceleration state of a bucket can be set to one of the following two values: </para><ul><li><para> Enabled – Enables accelerated data transfers to the bucket. </para></li><li><para> Suspended – Disables accelerated data transfers to the bucket. </para></li></ul><para> The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration state of a bucket. </para><para> After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase. </para><para> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods ("."). </para><para> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>. </para><para> The following operations are related to <c>PutBucketAccelerateConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAccelerateConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket for which the accelerate configuration is set. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAccelerateConfigurationCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAccelerateConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAccelerateConfigurationCmdlet.AccelerateConfiguration_Status"> <summary> <para> The accelerate status of the bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAccelerateConfigurationCmdlet.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.S3.Model.PutBucketAccelerateConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAccelerateConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAccelerateConfigurationCmdlet.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.S3.WriteS3BucketAnalyticsConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket. </para><para> You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the <c>DataExport</c> request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>. </para><important><para> You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9">Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>. </para></important><para> To use this operation, you must have permissions to perform the <c>s3:PutAnalyticsConfiguration</c> action. The 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><c>PutBucketAnalyticsConfiguration</c> has the following special errors: </para><ul><li><ul><li><para><i>HTTP Error: HTTP 400 Bad Request</i></para></li><li><para><i>Code: InvalidArgument</i></para></li><li><para><i>Cause: Invalid argument.</i></para></li></ul></li><li><ul><li><para><i>HTTP Error: HTTP 400 Bad Request</i></para></li><li><para><i>Code: TooManyConfigurations</i></para></li><li><para><i>Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.</i></para></li></ul></li><li><ul><li><para><i>HTTP Error: HTTP 403 Forbidden</i></para></li><li><para><i>Code: AccessDenied</i></para></li><li><para><i>Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.</i></para></li></ul></li></ul><para> The following operations are related to <c>PutBucketAnalyticsConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.AnalyticsFilter_AnalyticsFilterPredicate"> <summary> <para> Filter Predicate setup for specific filter types. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.AnalyticsId"> <summary> <para> The identifier used to represent an analytics configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.AnalyticsConfiguration_AnalyticsId"> <summary> <para> The identifier used to represent an analytics configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.S3BucketDestination_BucketAccountId"> <summary> <para> The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket to which an analytics configuration is stored. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.S3BucketDestination_BucketName"> <summary> <para> The Amazon resource name (ARN) of the bucket to which data is exported. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.S3BucketDestination_Format"> <summary> <para> The file format used when exporting data to Amazon S3. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.DataExport_OutputSchemaVersion"> <summary> <para> The version of the output schema to use when exporting data. Must be V_1. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.S3BucketDestination_Prefix"> <summary> <para> The prefix to use when exporting data. The exported data begins with this prefix. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.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.S3.Model.PutBucketAnalyticsConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketAnalyticsConfigurationCmdlet.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.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket. </para><para> The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. </para><para> The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. </para><para> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>. </para><para> Operations related to <c>PutBucketIntelligentTieringConfiguration</c> include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a></para></li></ul><note><para> You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier. </para></note><para><c>PutBucketIntelligentTieringConfiguration</c> has the following special errors: </para><dl><dt>HTTP 400 Bad Request Error</dt><dd><para><i>Code:</i> InvalidArgument </para><para><i>Cause:</i> Invalid Argument </para></dd><dt>HTTP 400 Bad Request Error</dt><dd><para><i>Code:</i> TooManyConfigurations </para><para><i>Cause:</i> You are attempting to create a new configuration but have already reached the 1,000-configuration limit. </para></dd><dt>HTTP 403 Forbidden Error</dt><dd><para><i>Cause:</i> You are not the owner of the specified bucket, or you do not have the <c>s3:PutIntelligentTieringConfiguration</c> bucket permission to set the configuration on the bucket. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet.BucketName"> <summary> <para> The name of the Amazon S3 bucket whose configuration you want to modify or retrieve. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet.IntelligentTieringFilter_IntelligentTieringFilterPredicate"> <summary> <para> Filter Predicate setup for specific filter types. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet.IntelligentTieringId"> <summary> <para> The ID used to identify the S3 Intelligent-Tiering configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet.IntelligentTieringConfiguration_IntelligentTieringId"> <summary> <para> The ID used to identify the S3 Intelligent-Tiering configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet.IntelligentTieringConfiguration_Status"> <summary> <para> Specifies the status of the configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet.IntelligentTieringConfiguration_Tiering"> <summary> <para> Specifies the S3 Intelligent-Tiering storage class tier of the configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet.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.S3.Model.PutBucketIntelligentTieringConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketIntelligentTieringConfigurationCmdlet.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.S3.WriteS3BucketInventoryConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> This implementation of the <c>PUT</c> action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. </para><para> Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the <i>source</i> bucket, and the bucket where the inventory flat file is stored is called the <i>destination</i> bucket. The <i>destination</i> bucket must be in the same Amazon Web Services Region as the <i>source</i> bucket. </para><para> When you configure an inventory for a <i>source</i> bucket, you specify the <i>destination</i> bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a> in the Amazon S3 User Guide. </para><important><para> You must create a bucket policy on the <i>destination</i> bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9"> Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>. </para></important><dl><dt>Permissions</dt><dd><para> To use this operation, you must have permission to perform the <c>s3:PutInventoryConfiguration</c> action. The bucket owner has this permission by default and can grant this permission to others. </para><para> The <c>s3:PutInventoryConfiguration</c> permission allows a user to create an <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html">S3 Inventory</a> report that includes all object metadata fields available and to specify the destination bucket to store the inventory. A user with read access to objects in the destination bucket can also access all object metadata fields that are available in the inventory report. </para><para> To restrict access to an inventory report, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-use-case-10">Restricting access to an Amazon S3 Inventory report</a> in the <i>Amazon S3 User Guide</i>. For more information about the metadata fields available in S3 Inventory, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents">Amazon S3 Inventory lists</a> in the <i>Amazon S3 User Guide</i>. 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">Identity and access management in Amazon S3</a> in the <i>Amazon S3 User Guide</i>. </para></dd></dl><para><c>PutBucketInventoryConfiguration</c> has the following special errors: </para><dl><dt>HTTP 400 Bad Request Error</dt><dd><para><i>Code:</i> InvalidArgument </para><para><i>Cause:</i> Invalid Argument </para></dd><dt>HTTP 400 Bad Request Error</dt><dd><para><i>Code:</i> TooManyConfigurations </para><para><i>Cause:</i> You are attempting to create a new configuration but have already reached the 1,000-configuration limit. </para></dd><dt>HTTP 403 Forbidden Error</dt><dd><para><i>Cause:</i> You are not the owner of the specified bucket, or you do not have the <c>s3:PutInventoryConfiguration</c> bucket permission to set the configuration on the bucket. </para></dd></dl><para> The following operations are related to <c>PutBucketInventoryConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.S3BucketDestination_AccountId"> <summary> <para> The ID of the account that owns the destination bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket where the inventory configuration will be stored. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.S3BucketDestination_BucketName"> <summary> <para> The Amazon resource name (ARN) of the bucket where inventory results will be published. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.Schedule_Frequency"> <summary> <para> Specifies how frequently inventory results are produced. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.InventoryConfiguration_IncludedObjectVersion"> <summary> <para> <para>Object versions to include in the inventory list. If set to <code>All</code>, the list includes all the object versions, which adds the version-related fields <code>VersionId</code>, <code>IsLatest</code>, and <code>DeleteMarker</code> to the list. If set to <code>Current</code>, the list does not contain these version-related fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.InventoryFilter_InventoryFilterPredicate"> <summary> <para> Filter Predicate setup for specific filter types. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.S3BucketDestination_InventoryFormat"> <summary> <para> Specifies the output format of the inventory results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.InventoryId"> <summary> <para> Specifies the inventory Id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.InventoryConfiguration_InventoryId"> <summary> <para> The ID used to identify the inventory configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.InventoryConfiguration_InventoryOptionalField"> <summary> <para> Contains the optional fields that are included in the inventory results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.InventoryConfiguration_IsEnabled"> <summary> <para> <para>Specifies whether the inventory is enabled or disabled. If set to <code>True</code>, an inventory list is generated. If set to <code>False</code>, no inventory list is generated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.SSEKMS_KeyId"> <summary> <para> <para>Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key to use for encrypting inventory reports.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.S3BucketDestination_Prefix"> <summary> <para> The prefix that is prepended to all inventory results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.InventoryEncryption_SSES3"> <summary> <para> Specifies the use of SSE-S3 to encrypt delievered Inventory reports. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.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.S3.Model.PutBucketInventoryConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketInventoryConfigurationCmdlet.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.S3.WriteS3BucketLoggingCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner. </para><para> The bucket owner is automatically granted FULL_CONTROL to all logs. You use the <c>Grantee</c> request element to grant access to other people. The <c>Permissions</c> request element specifies the kind of access the grantee has to the logs. </para><important><para> If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't use the <c>Grantee</c> request element to grant access to others. Permissions can only be granted using policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions for server access log delivery</a> in the <i>Amazon S3 User Guide</i>. </para></important><dl><dt>Grantee Values</dt><dd><para> You can specify the person (grantee) to whom you're assigning access rights (by using request elements) in the following ways: </para><ul><li><para> By the person's ID: </para><para><c><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></c></para><para><c>DisplayName</c> is optional and ignored in the request. </para></li><li><para> By Email address: </para><para><c> <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee></c></para><para> The grantee is resolved to the <c>CanonicalUser</c> and, in a response to a <c>GETObjectAcl</c> request, appears as the CanonicalUser. </para></li><li><para> By URI: </para><para><c><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></c></para></li></ul></dd></dl><para> To enable logging, you use <c>LoggingEnabled</c> and its children request elements. To disable logging, you use an empty <c>BucketLoggingStatus</c> request element: </para><para><c><BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /></c></para><para> For more information about server access logging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html">Server Access Logging</a> in the <i>Amazon S3 User Guide</i>. </para><para> For more information about creating a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. For more information about returning the logging status of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a>. </para><para> The following operations are related to <c>PutBucketLogging</c>: </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_DeleteBucket.html">DeleteBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.BucketName"> <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.S3.WriteS3BucketLoggingCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.LoggingConfig_Grant"> <summary> <para> A collection of grants. <para>Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions for server access log delivery</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.PartitionedPrefix_PartitionDateSource"> <summary> <para> <para>Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.TargetObjectKeyFormat_SimplePrefix"> <summary> <para> <para>To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.LoggingConfig_TargetBucketName"> <summary> <para> Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.LoggingConfig_TargetPrefix"> <summary> <para> <para>A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.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.S3.Model.PutBucketLoggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.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.S3.WriteS3BucketMetricsConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. </para><para> To use this operation, you must have permissions to perform the <c>s3:PutMetricsConfiguration</c> action. The 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> For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>. </para><para> The following operations are related to <c>PutBucketMetricsConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a></para></li></ul><para><c>PutBucketMetricsConfiguration</c> has the following special error: </para><ul><li><para> Error code: <c>TooManyConfigurations</c></para><ul><li><para> Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. </para></li><li><para> HTTP Status Code: HTTP 400 Bad Request </para></li></ul></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketMetricsConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket for which the metrics configuration is set. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketMetricsConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketMetricsConfigurationCmdlet.MetricsFilter_MetricsFilterPredicate"> <summary> <para> Filter Predicate setup for specific filter types. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketMetricsConfigurationCmdlet.MetricsId"> <summary> <para> The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketMetricsConfigurationCmdlet.MetricsConfiguration_MetricsId"> <summary> <para> The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketMetricsConfigurationCmdlet.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.S3.Model.PutBucketMetricsConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketMetricsConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketMetricsConfigurationCmdlet.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.S3.WriteS3BucketNotificationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Enables notifications of specified events for a bucket. For more information about event notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event Notifications</a>. </para><para> Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. </para><para> By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty <c>NotificationConfiguration</c>. </para><para><c><NotificationConfiguration></c></para><para><c></NotificationConfiguration></c></para><para> This action replaces the existing notification configuration with the configuration you include in the request body. </para><para> After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3 Events</a>. </para><para> You can disable notifications by adding the empty NotificationConfiguration element. </para><para> For more information about the number of event notification configurations that you can create per bucket, see <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon S3 service quotas</a> in <i>Amazon Web Services General Reference</i>. </para><para> By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with the required <c>s3:PutBucketNotification</c> permission. </para><note><para> The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket. </para></note><para> If the configuration in the request body includes only one <c>TopicConfiguration</c> specifying only the <c>s3:ReducedRedundancyLostObject</c> event type, the response will also include the <c>x-amz-sns-test-message-id</c> header containing the message ID of the test notification sent to the topic. </para><para> The following action is related to <c>PutBucketNotificationConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.BucketName"> <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.S3.WriteS3BucketNotificationCmdlet.ChecksumAlgorithm"> <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.S3.WriteS3BucketNotificationCmdlet.EventBridgeConfiguration"> <summary> <para> <para>Enables delivery of all bucket events to Amazon EventBridge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.LambdaFunctionConfiguration"> <summary> <para> LambdaFunctionConfigurations are configuration for Amazon S3 events to be sent to an Amazon Lambda cloud function. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.QueueConfiguration"> <summary> <para> QueueConfigurations are configuration for Amazon S3 events to be sent to Amazon SQS queues. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.SkipDestinationValidation"> <summary> <para> <para>Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.TopicConfiguration"> <summary> <para> TopicConfigurations are configuration for Amazon S3 events to be sent to Amazon SNS topics. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.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.S3.Model.PutBucketNotificationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.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.S3.WriteS3BucketOwnershipControlCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Creates or modifies <c>OwnershipControls</c> for an Amazon S3 bucket. To use this operation, you must have the <c>s3:PutBucketOwnershipControls</c> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a policy</a>. </para><para> For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html">Using object ownership</a>. </para><para> The following operations are related to <c>PutBucketOwnershipControls</c>: </para><ul><li><para><a>GetBucketOwnershipControls</a></para></li><li><para><a>DeleteBucketOwnershipControls</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketOwnershipControlCmdlet.BucketName"> <summary> <para> The name of the Amazon S3 bucket whose OwnershipControls you want to set </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketOwnershipControlCmdlet.ExpectedBucketOwner"> <summary> <para> <p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketOwnershipControlCmdlet.OwnershipControls_Rule"> <summary> <para> A bucket's ownership control rules </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketOwnershipControlCmdlet.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.S3.Model.PutBucketOwnershipControlsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketOwnershipControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketOwnershipControlCmdlet.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.S3.WriteS3BucketPolicyCmdlet"> <summary> Applies an Amazon S3 bucket policy to an Amazon S3 bucket. <note><para><b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i></c>. Virtual-hosted-style requests aren't supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the <i>Amazon S3 User Guide</i>. </para></note><dl><dt>Permissions</dt><dd><para> If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must both have the <c>PutBucketPolicy</c> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. </para><para> If you don't have <c>PutBucketPolicy</c> permissions, Amazon S3 returns a <c>403 Access Denied</c> 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 <c>405 Method Not Allowed</c> error. </para><important><para> To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the <c>GetBucketPolicy</c>, <c>PutBucketPolicy</c>, and <c>DeleteBucketPolicy</c> API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies. </para></important><ul><li><para><b>General purpose bucket permissions</b> - The <c>s3:PutBucketPolicy</c> permission is required in a policy. For more information about general purpose buckets bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a> in the <i>Amazon S3 User Guide</i>. </para></li><li><para><b>Directory bucket permissions</b> - To grant access to this API operation, you must have the <c>s3express:PutBucketPolicy</c> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>. </para></li></ul></dd><dt>Example bucket policies</dt><dd><para><b>General purpose buckets example bucket policies</b> - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy examples</a> in the <i>Amazon S3 User Guide</i>. </para><para><b>Directory bucket example bucket policies</b> - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>. </para></dd><dt>HTTP Host header syntax</dt><dd><para><b>Directory buckets </b> - The HTTP Host header syntax is <c>s3express-control.<i>region</i>.amazonaws.com</c>. </para></dd></dl><para> The following operations are related to <c>PutBucketPolicy</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.BucketName"> <summary> <para> <para>The name of the bucket.</para><para><b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i></c>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format <c><i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c><i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <c>x-amz-checksum-<i>algorithm</i></c> or <c>x-amz-trailer</c> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <c>400 Bad Request</c>.</para><para>For the <c>x-amz-checksum-<i>algorithm</i></c> header, replace <c><i>algorithm</i></c> with the supported algorithm from the following list: </para><ul><li><para>CRC32</para></li><li><para>CRC32C</para></li><li><para>SHA1</para></li><li><para>SHA256</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If the individual checksum value you provide through <c>x-amz-checksum-<i>algorithm</i></c> doesn't match the checksum algorithm you set through <c>x-amz-sdk-checksum-algorithm</c>, Amazon S3 ignores any provided <c>ChecksumAlgorithm</c> parameter and uses the checksum algorithm that matches the provided value in <c>x-amz-checksum-<i>algorithm</i></c>.</para><note><para>For directory buckets, when you use Amazon Web Services SDKs, <c>CRC32</c> is the default checksum algorithm that's used for performance.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.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 functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.ContentMD5"> <summary> <para> <para>The MD5 hash of the request body.</para><para>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</para><note><para>This functionality is not supported for directory buckets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <c>403 Forbidden</c> (access denied).</para><note><para>For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code <c>501 Not Implemented</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.Policy"> <summary> <para> <para>The bucket policy as a JSON document.</para><para>For directory buckets, the only IAM action supported in the bucket policy is <c>s3express:CreateSession</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.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.S3.Model.PutBucketPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.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.S3.WriteS3BucketReplicationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Creates a replication configuration or replaces an existing one. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>. </para><para> Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. You can invoke this request for a specific Amazon Web Services Region by using the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion"><c>aws:RequestedRegion</c></a> condition key. </para><para> A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. </para><para> To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: <c>DeleteMarkerReplication</c>, <c>Status</c>, and <c>Priority</c>. </para><note><para> If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations">Backward Compatibility</a>. </para></note><para> For information about enabling versioning on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html">Using Versioning</a>. </para><dl><dt>Handling Replication of Encrypted Objects</dt><dd><para> By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: <c>SourceSelectionCriteria</c>, <c>SseKmsEncryptedObjects</c>, <c>Status</c>, <c>EncryptionConfiguration</c>, and <c>ReplicaKmsKeyID</c>. For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating Objects Created with SSE Using KMS keys</a>. </para><para> For information on <c>PutBucketReplication</c> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of replication-related error codes</a></para></dd><dt>Permissions</dt><dd><para> To create a <c>PutBucketReplication</c> request, you must have <c>s3:PutReplicationConfiguration</c> permissions for the bucket. </para><para> By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</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><note><para> To perform this operation, the user or role performing the action must have the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> permission. </para></note></dd></dl><para> The following operations are related to <c>PutBucketReplication</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html">DeleteBucketReplication</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.BucketName"> <summary> <para> <para>The name of the bucket</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.Configuration_Role"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html">How to Set Up Replication</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.Configuration_Rule"> <summary> <para> Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.Token"> <summary> <para> <para>A token to allow Object Lock to be enabled for an existing bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.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.S3.Model.PutBucketReplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.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.S3.WriteS3BucketRequestPaymentCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>. </para><para> The following operations are related to <c>PutBucketRequestPayment</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html">GetBucketRequestPayment</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.BucketName"> <summary> <para> The name of the bucket to set payment config. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.RequestPaymentConfiguration_Payer"> <summary> <para> Specifies who pays for the download and request fees. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.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.S3.Model.PutBucketRequestPaymentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.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.S3.WriteS3BucketTaggingCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets the tags for a bucket. </para><para> Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services 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> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket Tags</a>. </para><note><para> When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags. </para></note><para> To use this operation, you must have permissions to perform the <c>s3:PutBucketTagging</c> action. The 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><c>PutBucketTagging</c> has the following special errors. For more Amazon S3 errors see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error Responses</a>. </para><ul><li><para><c>InvalidTag</c> - The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. 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></li><li><para><c>MalformedXML</c> - The XML provided does not match the schema. </para></li><li><para><c>OperationAborted</c> - A conflicting conditional action is currently in progress against this resource. Please try again. </para></li><li><para><c>InternalError</c> - The service was unable to apply the provided tag to the bucket. </para></li></ul><para> The following operations are related to <c>PutBucketTagging</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.BucketName"> <summary> <para> The name of the bucket to apply the tags to. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.TagSet"> <summary> <para> The collection of tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.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.S3.Model.PutBucketTaggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.PassThru"> <summary> Returns the collection of Tag objects that were added The -PassThru parameter is deprecated, use -Select instead. This parameter will be removed in future </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.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.S3.WriteS3BucketVersioningCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets the versioning state of an existing bucket. </para><para> You can set the versioning state with one of the following values: </para><para><b>Enabled</b>—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID. </para><para><b>Suspended</b>—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null. </para><para> If the versioning state has never been set on a bucket, it has no versioning state; a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> request does not return a versioning state value. </para><para> In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the <c>x-amz-mfa request</c> header and the <c>Status</c> and the <c>MfaDelete</c> request elements in a request to set the versioning state of the bucket. </para><important><para> If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config">Lifecycle and Versioning</a>. </para></important><para> The following operations are related to <c>PutBucketVersioning</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.MfaCodes_AuthenticationValue"> <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.S3.WriteS3BucketVersioningCmdlet.BucketName"> <summary> <para> The name of the bucket to be updated. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.VersioningConfig_EnableMfaDelete"> <summary> <para> Specifies whether MFA Delete is enabled on this S3 Bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.MfaCodes_SerialNumber"> <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.S3.WriteS3BucketVersioningCmdlet.VersioningConfig_Status"> <summary> <para> Versioning status for the bucket. Accepted values: Off, Enabled, Suspended. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.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.S3.Model.PutBucketVersioningResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.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.S3.WriteS3BucketWebsiteCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets the configuration of the website that is specified in the <c>website</c> subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </para><para> This PUT action requires the <c>S3:PutBucketWebsite</c> permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the <c>S3:PutBucketWebsite</c> permission. </para><para> To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket. </para><ul><li><para><c>WebsiteConfiguration</c></para></li><li><para><c>RedirectAllRequestsTo</c></para></li><li><para><c>HostName</c></para></li><li><para><c>Protocol</c></para></li></ul><para> If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected. </para><ul><li><para><c>WebsiteConfiguration</c></para></li><li><para><c>IndexDocument</c></para></li><li><para><c>Suffix</c></para></li><li><para><c>ErrorDocument</c></para></li><li><para><c>Key</c></para></li><li><para><c>RoutingRules</c></para></li><li><para><c>RoutingRule</c></para></li><li><para><c>Condition</c></para></li><li><para><c>HttpErrorCodeReturnedEquals</c></para></li><li><para><c>KeyPrefixEquals</c></para></li><li><para><c>Redirect</c></para></li><li><para><c>Protocol</c></para></li><li><para><c>HostName</c></para></li><li><para><c>ReplaceKeyPrefixWith</c></para></li><li><para><c>ReplaceKeyWith</c></para></li><li><para><c>HttpRedirectCode</c></para></li></ul><para> Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">Configuring an Object Redirect</a> in the <i>Amazon S3 User Guide</i>. </para><para> The maximum request length is limited to 128 KB. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.BucketName"> <summary> <para> The name of the bucket to apply the configuration to. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.WebsiteConfiguration_ErrorDocument"> <summary> <para> The ErrorDocument value, an object key name to use when a 4XX class error occurs. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_HostName"> <summary> <para> Name of the host where requests will be redirected. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_HttpRedirectCode"> <summary> <para> The HTTP redirect code to use on the response. Not required if one of the siblings is present. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.WebsiteConfiguration_IndexDocumentSuffix"> <summary> <para> <para>This value is a suffix that is appended to a request that is for a "directory" on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html)</para><para>The suffix must not be empty and must not include a slash character.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_Protocol"> <summary> <para> Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_ReplaceKeyPrefixWith"> <summary> <para> The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_ReplaceKeyWith"> <summary> <para> The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.WebsiteConfiguration_RoutingRule"> <summary> <para> The list of routing rules that can be used for configuring redirects if certain conditions are meet. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.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.S3.Model.PutBucketWebsiteResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.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.S3.WriteS3CORSConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets the <c>cors</c> configuration for your bucket. If the configuration exists, Amazon S3 replaces it. </para><para> To use this operation, you must be allowed to perform the <c>s3:PutBucketCORS</c> action. By default, the bucket owner has this permission and can grant it to others. </para><para> You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is <c>http://www.example.com</c> to access your Amazon S3 bucket at <c>my.example.bucket.com</c> by using the browser's <c>XMLHttpRequest</c> capability. </para><para> To enable cross-origin resource sharing (CORS) on a bucket, you add the <c>cors</c> subresource to the bucket. The <c>cors</c> subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. </para><para> When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the <c>cors</c> configuration on the bucket and uses the first <c>CORSRule</c> rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met: </para><ul><li><para> The request's <c>Origin</c> header must match <c>AllowedOrigin</c> elements. </para></li><li><para> The request method (for example, GET, PUT, HEAD, and so on) or the <c>Access-Control-Request-Method</c> header in case of a pre-flight <c>OPTIONS</c> request must be one of the <c>AllowedMethod</c> elements. </para></li><li><para> Every header specified in the <c>Access-Control-Request-Headers</c> request header of a pre-flight request must match an <c>AllowedHeader</c> element. </para></li></ul><para> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>. </para><para> The following operations are related to <c>PutBucketCors</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html">GetBucketCors</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket to have the CORS configuration applied. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.Configuration_Rule"> <summary> <para> The collection of rules in this configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.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.S3.Model.PutCORSConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.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.S3.WriteS3GetObjectResponseCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Passes transformed objects to a <c>GetObject</c> operation when using Object Lambda access points. For information about Object Lambda access points, 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 S3 User Guide</i>. </para><para> This operation supports metadata that can be returned by <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>, in addition to <c>RequestRoute</c>, <c>RequestToken</c>, <c>StatusCode</c>, <c>ErrorCode</c>, and <c>ErrorMessage</c>. The <c>GetObject</c> response metadata is supported so that the <c>WriteGetObjectResponse</c> caller, typically an Lambda function, can provide the same metadata when it internally invokes <c>GetObject</c>. When <c>WriteGetObjectResponse</c> is called by a customer-owned Lambda function, the metadata returned to the end user <c>GetObject</c> call might differ from what Amazon S3 would normally return. </para><para> You can include any number of metadata headers. When including a metadata header, it should be prefaced with <c>x-amz-meta</c>. For example, <c>x-amz-meta-my-custom-header: MyCustomValue</c>. The primary use case for this is to forward <c>GetObject</c> metadata. </para><para> Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point. </para><para> Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket. </para><para> Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket. </para><para> Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP. </para><para> For information on how to view and use these functions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html">Using Amazon Web Services built Lambda functions</a> in the <i>Amazon S3 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.AcceptRange"> <summary> <para> Indicates that a range of bytes was specified. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.Body"> <summary> <para> <para>The object data</para>. </para> <para>The cmdlet accepts a parameter of type string, string[], System.IO.FileInfo or System.IO.Stream.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.BucketKeyEnabled"> <summary> <para> <para> Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.CacheControl"> <summary> <para> Specifies caching behavior along the request/reply chain. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ChecksumCRC32"> <summary> <para> <para>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ChecksumCRC32C"> <summary> <para> <para>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ChecksumSHA1"> <summary> <para> <para>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ChecksumSHA256"> <summary> <para> <para>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ContentDisposition"> <summary> <para> Specifies presentational information for the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ContentEncoding"> <summary> <para> Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ContentLanguage"> <summary> <para> The language the content is in. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ContentLength"> <summary> <para> The size of the body in bytes. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ContentRange"> <summary> <para> The portion of the object returned in the response. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ContentType"> <summary> <para> A standard MIME type describing the format of the object data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.DeleteMarker"> <summary> <para> Specifies whether an object stored in Amazon S3 is (<code>true</code>) or is not (<code>false</code>) a delete marker. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ErrorCode"> <summary> <para> A string that uniquely identifies an error condition. Returned in <Code> tag of error XML response for corresponding GetObject call. Cannot be used with successful <code>StatusCode</code> header or when transformed object is provided in body. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ErrorMessage"> <summary> <para> Contains a generic description of the error condition. Returned in <Message> tag of error XML response for corresponding GetObject call. Cannot be used with successful <code>StatusCode</code> header or when transformed object is provided in body. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.Expiration"> <summary> <para> If object stored in Amazon S3 expiration is configured (see PUT Bucket lifecycle) it includes expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.Expire"> <summary> <para> The date and time at which the object is no longer cacheable. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.LastModified"> <summary> <para> Date and time the object was last modified. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.MissingMeta"> <summary> <para> Set to the number of metadata entries not returned in <code>x-amz-meta</code> headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ObjectLockLegalHoldStatus"> <summary> <para> Indicates whether object stored in Amazon S3 has an active legal hold. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ObjectLockMode"> <summary> <para> Amazon.S3.Model.WriteGetObjectResponseRequest.ObjectLockMode </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ObjectLockRetainUntilDate"> <summary> <para> Date and time when Object Lock is configured to expire. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.PartsCount"> <summary> <para> The count of parts this object has. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ReplicationStatus"> <summary> <para> Amazon.S3.Model.WriteGetObjectResponseRequest.ReplicationStatus </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.RequestCharged"> <summary> <para> If present, indicates that the requester was successfully charged for the request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.RequestRoute"> <summary> <para> Route prefix to the HTTP URL generated. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.RequestToken"> <summary> <para> A single use encrypted token that maps <code>WriteGetObjectResponse</code> to the end user <code>GetObject</code> request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.Restore"> <summary> <para> Provides information about object restoration operation and expiration time of the restored object copy. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ServerSideEncryptionMethod"> <summary> <para> The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, <code>aws:kms</code>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.SSECustomerAlgorithm"> <summary> <para> Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.SSECustomerKeyMD5"> <summary> <para> Amazon.S3.Model.WriteGetObjectResponseRequest.SSECustomerKeyMD5 </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.SSEKMSKeyId"> <summary> <para> <para> If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.StatusCode"> <summary> <para> <para>The integer status code for an HTTP response of a corresponding <code>GetObject</code> request. The following is a list of status codes. </para><ul><li><para><i>200 - OK</i></para></li><li><para><i>206 - Partial Content</i></para></li><li><para><i>304 - Not Modified</i></para></li><li><para><i>400 - Bad Request</i></para></li><li><para><i>401 - Unauthorized</i></para></li><li><para><i>403 - Forbidden</i></para></li><li><para><i>404 - Not Found</i></para></li><li><para><i>405 - Method Not Allowed</i></para></li><li><para><i>409 - Conflict</i></para></li><li><para><i>411 - Length Required</i></para></li><li><para><i>412 - Precondition Failed</i></para></li><li><para><i>416 - Range Not Satisfiable</i></para></li><li><para><i>500 - Internal Server Error</i></para></li><li><para><i>503 - Service Unavailable</i></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.StorageClass"> <summary> <para> The class of storage used to store object in Amazon S3. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.TagCount"> <summary> <para> The number of tags, if any, on the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.VersionId"> <summary> <para> VersionId used to reference a specific version of the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.ETag"> <summary> <para> An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.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.S3.Model.WriteGetObjectResponseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3GetObjectResponseCmdlet.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.S3.WriteS3LifecycleConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage lifecycle</a>. </para><note><para> Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>. </para></note><dl><dt>Rules</dt><dd><para> You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following: </para><ul><li><para> A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these. </para></li><li><para> A status indicating whether the rule is in effect. </para></li><li><para> One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration Elements</a>. </para></dd><dt>Permissions</dt><dd><para> By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the <c>s3:PutLifecycleConfiguration</c> permission. </para><para> You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: </para><ul><li><para><c>s3:DeleteObject</c></para></li><li><para><c>s3:DeleteObjectVersion</c></para></li><li><para><c>s3:PutLifecycleConfiguration</c></para></li></ul><para> For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>. </para></dd></dl><para> The following operations are related to <c>PutBucketLifecycleConfiguration</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html">Examples of Lifecycle Configuration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.BucketName"> <summary> <para> <para>The name of the bucket for which to set the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.ChecksumAlgorithm"> <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.S3.WriteS3LifecycleConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <c>403 Forbidden</c> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.Configuration_Rule"> <summary> <para> These rules defined the lifecycle configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.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.S3.Model.PutLifecycleConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.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.S3.WriteS3ObjectLegalHoldCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Applies a legal hold configuration to the specified object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. </para><para> This functionality is not supported for Amazon S3 on Outposts. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLegalHoldCmdlet.BucketName"> <summary> <para> <para>The bucket name containing the object that you want to place a Legal Hold on. </para><para>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLegalHoldCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLegalHoldCmdlet.ContentMD5"> <summary> <para> <para>The MD5 hash for the request body.</para><para>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLegalHoldCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLegalHoldCmdlet.Key"> <summary> <para> <para>The key name for the object that you want to place a Legal Hold on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLegalHoldCmdlet.RequestPayer"> <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.S3.WriteS3ObjectLegalHoldCmdlet.LegalHold_Status"> <summary> <para> <para>Indicates whether the specified object has a Legal Hold in place.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLegalHoldCmdlet.VersionId"> <summary> <para> <para>The version ID of the object that you want to place a Legal Hold on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLegalHoldCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RequestCharged'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.PutObjectLegalHoldResponse). Specifying the name of a property of type Amazon.S3.Model.PutObjectLegalHoldResponse 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.S3.WriteS3ObjectLegalHoldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLegalHoldCmdlet.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.S3.WriteS3ObjectLockConfigurationCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. </para><note><ul><li><para> The <c>DefaultRetention</c> settings require both a mode and a period. </para></li><li><para> The <c>DefaultRetention</c> period can be either <c>Days</c> or <c>Years</c> but you must select one. You cannot specify <c>Days</c> and <c>Years</c> at the same time. </para></li><li><para> You can enable Object Lock for new or existing buckets. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html">Configuring Object Lock</a>. </para></li></ul></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.BucketName"> <summary> <para> <para>The bucket whose Object Lock configuration you want to create or replace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.ContentMD5"> <summary> <para> <para>The MD5 hash for the request body.</para><para>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.DefaultRetention_Day"> <summary> <para> <para>The number of days that you want to specify for the default retention period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.DefaultRetention_Mode"> <summary> <para> <para>The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.ObjectLockConfiguration_ObjectLockEnabled"> <summary> <para> <para>Indicates whether this object has an Object Lock configuration enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.RequestPayer"> <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.S3.WriteS3ObjectLockConfigurationCmdlet.Token"> <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.S3.WriteS3ObjectLockConfigurationCmdlet.DefaultRetention_Year"> <summary> <para> <para>The number of years that you want to specify for the default retention period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RequestCharged'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.PutObjectLockConfigurationResponse). Specifying the name of a property of type Amazon.S3.Model.PutObjectLockConfigurationResponse 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.S3.WriteS3ObjectLockConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectLockConfigurationCmdlet.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.S3.WriteS3ObjectRetentionCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Places an Object Retention configuration on an object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. Users or accounts require the <c>s3:PutObjectRetention</c> permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the <c>s3:BypassGovernanceRetention</c> permission. </para><para> This functionality is not supported for Amazon S3 on Outposts. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.BucketName"> <summary> <para> <para>The bucket name that contains the object you want to apply this Object Retention configuration to. </para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.BypassGovernanceRetention"> <summary> <para> <para>Indicates whether this action should bypass Governance-mode restrictions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.ContentMD5"> <summary> <para> <para>The MD5 hash for the request body.</para><para>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.Key"> <summary> <para> <para>The key name for the object that you want to apply this Object Retention configuration to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.Retention_Mode"> <summary> <para> <para>Indicates the Retention mode for the specified object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.RequestPayer"> <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.S3.WriteS3ObjectRetentionCmdlet.Retention_RetainUntilDate"> <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.S3.WriteS3ObjectRetentionCmdlet.VersionId"> <summary> <para> <para>The version ID for the object that you want to apply this Object Retention configuration to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RequestCharged'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.PutObjectRetentionResponse). Specifying the name of a property of type Amazon.S3.Model.PutObjectRetentionResponse 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.S3.WriteS3ObjectRetentionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectRetentionCmdlet.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.S3.WriteS3ObjectTagSetCmdlet"> <summary> <note><para> This operation is not supported by directory buckets. </para></note><para> Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html">Object Tagging</a>. </para><para> You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>. </para><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">Tag Restrictions</a>. Note that Amazon S3 limits the maximum number of tags to 10 tags per object. </para><para> To use this operation, you must have permission to perform the <c>s3:PutObjectTagging</c> action. By default, the bucket owner has this permission and can grant this permission to others. </para><para> To put tags of any other version, use the <c>versionId</c> query parameter. You also need permission for the <c>s3:PutObjectVersionTagging</c> action. </para><para><c>PutObjectTagging</c> has the following special errors. For more Amazon S3 errors see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error Responses</a>. </para><ul><li><para><c>InvalidTag</c> - The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html">Object Tagging</a>. </para></li><li><para><c>MalformedXML</c> - The XML provided does not match the schema. </para></li><li><para><c>OperationAborted</c> - A conflicting conditional action is currently in progress against this resource. Please try again. </para></li><li><para><c>InternalError</c> - The service was unable to apply the provided tag to the object. </para></li></ul><para> The following operations are related to <c>PutObjectTagging</c>: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html">DeleteObjectTagging</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectTagSetCmdlet.BucketName"> <summary> <para> <para>The bucket name containing the object. </para><para><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</para><para><b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code><i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectTagSetCmdlet.ChecksumAlgorithm"> <summary> <para> <para>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</para><para>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectTagSetCmdlet.ExpectedBucketOwner"> <summary> <para> <para>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectTagSetCmdlet.Key"> <summary> <para> This key is used to identify the object in S3. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectTagSetCmdlet.RequestPayer"> <summary> <para> <para>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests</para>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectTagSetCmdlet.Tagging_TagSet"> <summary> <para> TagSet </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectTagSetCmdlet.VersionId"> <summary> <para> <para>The versionId of the object that the tag-set will be added to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectTagSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VersionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.PutObjectTaggingResponse). Specifying the name of a property of type Amazon.S3.Model.PutObjectTaggingResponse 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.S3.WriteS3ObjectTagSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Key parameter. The -PassThru parameter is deprecated, use -Select '^Key' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectTagSetCmdlet.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> |