AWS solutions documentation change
Summary
Updated documentation formatting by replacing en dash (–) with hyphen (-) in various places and fixed quotation marks from curly to straight quotes
Security assessment
The changes are purely formatting and stylistic, with no indication of addressing security vulnerabilities or adding security-related content
Diff
diff --git a/solutions/latest/serverless-image-handler/create-and-use-image-requests.md index fc1448da2..ce5167983 100644 --- a/solutions/latest/serverless-image-handler/create-and-use-image-requests.md +++ b/solutions/latest/serverless-image-handler/create-and-use-image-requests.md @@ -21 +21 @@ The following image formats are supported for modifications: JPG/JPEG, PNG, TIFF - * **Bucket** – Specify the S3 bucket containing your original image file. This is the name that’s specified in the **SourceBuckets** template parameter. You can update the image location by adding it into the SOURCE_BUCKETS environment variable of your image handler Lambda function. See [Using AWS Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) in the _AWS Lambda Developer Guide_ for more information. + * **Bucket** \- Specify the S3 bucket containing your original image file. This is the name that’s specified in the **SourceBuckets** template parameter. You can update the image location by adding it into the SOURCE_BUCKETS environment variable of your image handler Lambda function. See [Using AWS Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) in the _AWS Lambda Developer Guide_ for more information. @@ -23 +23 @@ The following image formats are supported for modifications: JPG/JPEG, PNG, TIFF - * **Key** – Specify the filename of your original image. This name should include the file extension and subfolders between its location and the root of the bucket. For example, `folder1/folder2/image.jpeg`. + * **Key** \- Specify the filename of your original image. This name should include the file extension and subfolders between its location and the root of the bucket. For example, `folder1/folder2/image.jpeg`. @@ -25 +25 @@ The following image formats are supported for modifications: JPG/JPEG, PNG, TIFF - * **Edits** – Specify image edits as key-value pairs. If you don’t specify image edits, the original image returns with no changes made. + * **Edits** \- Specify image edits as key-value pairs. If you don’t specify image edits, the original image returns with no changes made. @@ -138 +138 @@ This solution uses Amazon Rekognition for face detection in images submitted for - * **smartCrop(optional, boolean || object)** – Activates the smart cropping feature for an original image. If the value is `true`, then the feature returns the first face detected from the original image with no additional options. For example: + * **smartCrop(optional, boolean || object)** \- Activates the smart cropping feature for an original image. If the value is `true`, then the feature returns the first face detected from the original image with no additional options. For example: @@ -150 +150 @@ The following **smartCrop** variables are shown in the following code sample: -**smartCrop.faceIndex(optional, number)** – Specifies which face to focus on if multiple are present within an original image. The solution indexes detected faces in a zero-based array from the largest detected face to the smallest. If this value isn’t specified, Amazon Rekognition returns the largest face detected from the original image. **smartCrop.padding(optional, number)** – Specifies an amount of padding in pixels to add around the cropped image. The solution applies the padding value to all sides of the cropped image. +**smartCrop.faceIndex(optional, number)** \- Specifies which face to focus on if multiple are present within an original image. The solution indexes detected faces in a zero-based array from the largest detected face to the smallest. If this value isn’t specified, Amazon Rekognition returns the largest face detected from the original image. **smartCrop.padding(optional, number)** \- Specifies an amount of padding in pixels to add around the cropped image. The solution applies the padding value to all sides of the cropped image. @@ -174 +174 @@ This solution can crop images in a circular pattern. To activate round cropping - * **roundCrop(optional, boolean || object)** – Activates the round cropping feature for an original image. If the value is true, then the feature returns a circular cropped image that’s centered from the original image and has a diameter of the smallest edge of the original image. For example: + * **roundCrop(optional, boolean || object)** \- Activates the round cropping feature for an original image. If the value is true, then the feature returns a circular cropped image that’s centered from the original image and has a diameter of the smallest edge of the original image. For example: @@ -186 +186 @@ The following **roundCrop** variables are shown in the following code sample: -**roundCrop.rx (optional, number)** – Specifies the radius along the x-axis of the ellipse. If a value isn’t provided, the image handler defaults to a value that’s half the length of the smallest edge. **roundCrop.ry (optional, number)** – Specifies the radius along the y-axis of the ellipse. If a value isn’t provided, the image handler defaults to a value that’s half the length of the smallest edge. **roundCrop.top(optional, number)** – Specifies the offset from the top of the original image to place the center of the ellipse. If a value isn’t provided, the image handler defaults to a value that’s half of the height. **roundCrop.left (optional, number)** – Specifies the offset from the left-most edge of the original image to place the center of the ellipse. If a value isn’t provided, the image handler defaults to a value that’s half of the width. +**roundCrop.rx (optional, number)** \- Specifies the radius along the x-axis of the ellipse. If a value isn’t provided, the image handler defaults to a value that’s half the length of the smallest edge. **roundCrop.ry (optional, number)** \- Specifies the radius along the y-axis of the ellipse. If a value isn’t provided, the image handler defaults to a value that’s half the length of the smallest edge. **roundCrop.top(optional, number)** \- Specifies the offset from the top of the original image to place the center of the ellipse. If a value isn’t provided, the image handler defaults to a value that’s half of the height. **roundCrop.left (optional, number)** \- Specifies the offset from the left-most edge of the original image to place the center of the ellipse. If a value isn’t provided, the image handler defaults to a value that’s half of the width. @@ -212 +212 @@ This solution can overlay images on top of others, for cases like watermarking c -**overlayWith(optional, object)** – Overlays an image on top of the original. For example: +**overlayWith(optional, object)** \- Overlays an image on top of the original. For example: @@ -220,2 +220,2 @@ This solution can overlay images on top of others, for cases like watermarking c - bucket: “<myImageBucket>”, - key: “<myOverlayImage.jpeg>”, + bucket: "<myImageBucket>", + key: "<myOverlayImage.jpeg>", @@ -226 +226 @@ This solution can overlay images on top of others, for cases like watermarking c - top: “-10p”, + top: "-10p", @@ -235 +235 @@ The following **overlayWith** variables are shown in the previous code sample: - * **overlayWith.bucket (required, string)** – Specifies the bucket that the overlay image should be retrieved from. This bucket must be present in the `SOURCE_BUCKETS` parameter. + * **overlayWith.bucket (required, string)** \- Specifies the bucket that the overlay image should be retrieved from. This bucket must be present in the `SOURCE_BUCKETS` parameter. @@ -237 +237 @@ The following **overlayWith** variables are shown in the previous code sample: - * **overlayWith.key (required, string)** – Specifies the object key that is used for the overlay image. + * **overlayWith.key (required, string)** \- Specifies the object key that is used for the overlay image. @@ -239 +239 @@ The following **overlayWith** variables are shown in the previous code sample: - * **overlayWith.alpha (optional, number)** – Specifies the opacity that should be used for the overlay image. This can be set from 0 (fully opaque) and 100 (fully transparent). + * **overlayWith.alpha (optional, number)** \- Specifies the opacity that should be used for the overlay image. This can be set from 0 (fully opaque) and 100 (fully transparent). @@ -241 +241 @@ The following **overlayWith** variables are shown in the previous code sample: - * **overlayWith.wRatio (required, number)** – Specifies the percentage of the width of underlying image that the overlay image should be sized to. This can be set from 0 and 100, where 100 indicates that the overlay image has the same width as the underlying image. + * **overlayWith.wRatio (required, number)** \- Specifies the percentage of the width of underlying image that the overlay image should be sized to. This can be set from 0 and 100, where 100 indicates that the overlay image has the same width as the underlying image. @@ -243 +243 @@ The following **overlayWith** variables are shown in the previous code sample: - * **overlayWith.hRatio (required, number)** – Specifies the percentage of the height of underlying image that the overlay image should be sized to. This can be set from 0 and 100, where 100 indicates that the overlay image has the same height as the underlying image. + * **overlayWith.hRatio (required, number)** \- Specifies the percentage of the height of underlying image that the overlay image should be sized to. This can be set from 0 and 100, where 100 indicates that the overlay image has the same height as the underlying image. @@ -245 +245 @@ The following **overlayWith** variables are shown in the previous code sample: - * **overlayWith.options.top (optional, number | string)** – Specifies the distance in pixels from the top edge of the underlying photo that the overlay should be placed. A number formatted as a string with a `p` at the end is treated as a percentage. + * **overlayWith.options.top (optional, number | string)** \- Specifies the distance in pixels from the top edge of the underlying photo that the overlay should be placed. A number formatted as a string with a `p` at the end is treated as a percentage. @@ -247 +247 @@ The following **overlayWith** variables are shown in the previous code sample: - * **overlayWith.options.left (optional, number | string)** – Specifies the distance in pixels from the left edge of the underlying photo that the overlay should be placed. A number formatted as a string with a `p` at the end is treated as a percentage. + * **overlayWith.options.left (optional, number | string)** \- Specifies the distance in pixels from the left edge of the underlying photo that the overlay should be placed. A number formatted as a string with a `p` at the end is treated as a percentage. @@ -260 +260 @@ This solution assumes that GIF files with multiple pages should be animated. If - * **animated (optional, boolean)** – Overwrites the initial animated status of the image. If the value is `true` , the solution will attempt to process the image as animated. For example: + * **animated (optional, boolean)** \- Overwrites the initial animated status of the image. If the value is `true` , the solution will attempt to process the image as animated. For example: @@ -291 +291 @@ This solution can detect inappropriate content using Amazon Rekognition. To acti - * **contentModeration (optional, boolean || object)** – Activates the content moderation feature for an original image. If the value is true, then the feature detects inappropriate content using Amazon Rekognition with a minimum confidence that’s set higher than 75%. If Amazon Rekognition finds inappropriate content, the solution blurs the image. For example: + * **contentModeration (optional, boolean || object)** \- Activates the content moderation feature for an original image. If the value is true, then the feature detects inappropriate content using Amazon Rekognition with a minimum confidence that’s set higher than 75%. If Amazon Rekognition finds inappropriate content, the solution blurs the image. For example: @@ -303 +303 @@ The following **contentModeration** variables are shown in the following code sa - * **contentModeration.minConfidence (optional, number)** – Specifies the minimum confidence level for Amazon Rekognition to use. Amazon Rekognition only returns detected content that’s higher than the minimum confidence. If a value isn’t provided, the default value is set to 75%. + * **contentModeration.minConfidence (optional, number)** \- Specifies the minimum confidence level for Amazon Rekognition to use. Amazon Rekognition only returns detected content that’s higher than the minimum confidence. If a value isn’t provided, the default value is set to 75%. @@ -305 +305 @@ The following **contentModeration** variables are shown in the following code sa - * **contentModeration.blur (optional, number**) – Specifies the intensity level that an image is blurred if inappropriate content is found. The number represents the sigma of the Gaussian mask, where _sigma = 1 + radius /2_. For more information, refer to the [sharp](https://sharp.pixelplumbing.com/api-operation#blur) documentation. If a value isn’t provided, the default value is set to 50. + * **contentModeration.blur (optional, number**) - Specifies the intensity level that an image is blurred if inappropriate content is found. The number represents the sigma of the Gaussian mask, where _sigma = 1 + radius /2_. For more information, refer to the [sharp](https://sharp.pixelplumbing.com/api-operation#blur) documentation. If a value isn’t provided, the default value is set to 50. @@ -307 +307 @@ The following **contentModeration** variables are shown in the following code sa - * **contentModeration.moderationLabels (optional, array)** – Identifies the specific content to search for. The image is blurred only if Amazon Rekognition locates the content specified in the **smartCrop.moderationLabels** provided. You can use either a top-level category or a second-level category. Top-level categories include its associated second-level categories. For more information about moderation label options, refer to [Content moderation](https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html) in the _Amazon Rekognition Developer Guide_. + * **contentModeration.moderationLabels (optional, array)** \- Identifies the specific content to search for. The image is blurred only if Amazon Rekognition locates the content specified in the **smartCrop.moderationLabels** provided. You can use either a top-level category or a second-level category. Top-level categories include its associated second-level categories. For more information about moderation label options, refer to [Content moderation](https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html) in the _Amazon Rekognition Developer Guide_. @@ -335 +335 @@ This solution allows you to include headers you’d like returned alongside the - * **headers (optional, object)** – Includes the provided headers in the response. Header should be written in Pascal-Case and cannot overwrite headers that would otherwise be present in the response (Except for Cache-Control). + * **headers (optional, object)** \- Includes the provided headers in the response. Header should be written in Pascal-Case and cannot overwrite headers that would otherwise be present in the response (Except for Cache-Control). @@ -341,2 +341,2 @@ This solution allows you to include headers you’d like returned alongside the - “Cache-Control”:“max-age=86400,public” - “Custom-Header”:”some-custom-value” + "Cache-Control":"max-age=86400,public" + "Custom-Header":"some-custom-value"