@aws-sdk/client-s3 3.325.0 → 3.327.0

package/dist-types/commands/WriteGetObjectResponseCommand.d.ts

@@ -29,29 +29,40 @@ export interface WriteGetObjectResponseCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Passes transformed
- *          objects to a <code>GetObject</code> 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
+ * <p>Passes transformed objects to a <code>GetObject</code> 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>.</p>
  *          <p>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
- *            <code>RequestRoute</code>, <code>RequestToken</code>, <code>StatusCode</code>,
- *            <code>ErrorCode</code>, and <code>ErrorMessage</code>. The <code>GetObject</code>
- *         response metadata is supported so that the <code>WriteGetObjectResponse</code> caller,
- *         typically an Lambda function, can provide the same metadata when it internally invokes
- *            <code>GetObject</code>. When <code>WriteGetObjectResponse</code> is called by a
- *         customer-owned Lambda function, the metadata returned to the end user
- *            <code>GetObject</code> call might differ from what Amazon S3 would normally return.</p>
- *          <p>You can include any number of metadata headers. When including a metadata header, it should be
- *          prefaced with <code>x-amz-meta</code>. For example, <code>x-amz-meta-my-custom-header: MyCustomValue</code>.
- *          The primary use case for this is to forward <code>GetObject</code> metadata.</p>
- *          <p>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.</p>
- *          <p>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. </p>
- *          <p>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. </p>
- *          <p>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. </p>
- *          <p>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>.</p>
+ *             <code>RequestRoute</code>, <code>RequestToken</code>, <code>StatusCode</code>,
+ *             <code>ErrorCode</code>, and <code>ErrorMessage</code>. The <code>GetObject</code>
+ *          response metadata is supported so that the <code>WriteGetObjectResponse</code> caller,
+ *          typically an Lambda function, can provide the same metadata when it internally invokes
+ *             <code>GetObject</code>. When <code>WriteGetObjectResponse</code> is called by a
+ *          customer-owned Lambda function, the metadata returned to the end user
+ *             <code>GetObject</code> call might differ from what Amazon S3 would normally return.</p>
+ *          <p>You can include any number of metadata headers. When including a metadata header, it
+ *          should be prefaced with <code>x-amz-meta</code>. For example,
+ *             <code>x-amz-meta-my-custom-header: MyCustomValue</code>. The primary use case for this
+ *          is to forward <code>GetObject</code> metadata.</p>
+ *          <p>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.</p>
+ *          <p>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. </p>
+ *          <p>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. </p>
+ *          <p>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. </p>
+ *          <p>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>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -104,6 +115,8 @@ export interface WriteGetObjectResponseCommandOutput extends __MetadataBearer {
  * };
  * const command = new WriteGetObjectResponseCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param WriteGetObjectResponseCommandInput - {@link WriteGetObjectResponseCommandInput}
@@ -112,6 +125,8 @@ export interface WriteGetObjectResponseCommandOutput extends __MetadataBearer {
  * @see {@link WriteGetObjectResponseCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @throws {@link S3ServiceException}
+ * <p>Base exception class for all service exceptions from S3 service.</p>
  *
  */
 export declare class WriteGetObjectResponseCommand extends $Command<WriteGetObjectResponseCommandInput, WriteGetObjectResponseCommandOutput, S3ClientResolvedConfig> {