Skip to content

Commit 9479fca

Browse files
authored
Add documentation on top of classes (#924)
* Add documentation on top of classes * Add changelog * remove debug code
1 parent 3193b40 commit 9479fca

File tree

7 files changed

+30
-0
lines changed

7 files changed

+30
-0
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
## NOT RELEASED
44

5+
### Added
6+
7+
- Added documentation in class's headers.
8+
59
## 1.2.0
610

711
### Added

src/Enum/InvocationType.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
namespace AsyncAws\Lambda\Enum;
44

5+
/**
6+
* Choose from the following options.
7+
*
8+
* - `RequestResponse` (default) - Invoke the function synchronously. Keep the connection open until the function
9+
* returns a response or times out. The API response includes the function response and additional data.
10+
* - `Event` - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter
11+
* queue (if it's configured). The API response only includes a status code.
12+
* - `DryRun` - Validate parameter values and verify that the user or role has permission to invoke the function.
13+
*/
514
final class InvocationType
615
{
716
public const DRY_RUN = 'DryRun';

src/Enum/LogType.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace AsyncAws\Lambda\Enum;
44

5+
/**
6+
* Set to `Tail` to include the execution log in the response.
7+
*/
58
final class LogType
69
{
710
public const NONE = 'None';

src/Enum/Runtime.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace AsyncAws\Lambda\Enum;
44

5+
/**
6+
* A runtime identifier. For example, `go1.x`.
7+
*/
58
final class Runtime
69
{
710
public const DOTNETCORE_1_0 = 'dotnetcore1.0';

src/ValueObject/LayerVersionContentInput.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace AsyncAws\Lambda\ValueObject;
44

5+
/**
6+
* The function layer archive.
7+
*/
58
final class LayerVersionContentInput
69
{
710
/**

src/ValueObject/LayerVersionContentOutput.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace AsyncAws\Lambda\ValueObject;
44

5+
/**
6+
* Details about the layer version.
7+
*/
58
final class LayerVersionContentOutput
69
{
710
/**

src/ValueObject/LayerVersionsListItem.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
use AsyncAws\Lambda\Enum\Runtime;
66

7+
/**
8+
* Details about a version of an AWS Lambda layer.
9+
*
10+
* @see https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html
11+
*/
712
final class LayerVersionsListItem
813
{
914
/**

0 commit comments

Comments
 (0)