Skip to content

Commit decf924

Browse files
authored
Add documentation on top of classes (#924)
* Add documentation on top of classes * Add changelog * remove debug code
1 parent 48e890d commit decf924

File tree

8 files changed

+40
-0
lines changed

8 files changed

+40
-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.8.0
610

711
### Added

src/Sts/Result/AssumeRoleResponse.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
use AsyncAws\Core\Sts\ValueObject\AssumedRoleUser;
88
use AsyncAws\Core\Sts\ValueObject\Credentials;
99

10+
/**
11+
* Contains the response to a successful AssumeRole request, including temporary AWS credentials that can be used to
12+
* make AWS requests.
13+
*/
1014
class AssumeRoleResponse extends Result
1115
{
1216
/**

src/Sts/Result/AssumeRoleWithWebIdentityResponse.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
use AsyncAws\Core\Sts\ValueObject\AssumedRoleUser;
88
use AsyncAws\Core\Sts\ValueObject\Credentials;
99

10+
/**
11+
* Contains the response to a successful AssumeRoleWithWebIdentity request, including temporary AWS credentials that can
12+
* be used to make AWS requests.
13+
*/
1014
class AssumeRoleWithWebIdentityResponse extends Result
1115
{
1216
/**

src/Sts/Result/GetCallerIdentityResponse.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
use AsyncAws\Core\Response;
66
use AsyncAws\Core\Result;
77

8+
/**
9+
* Contains the response to a successful GetCallerIdentity request, including information about the entity making the
10+
* request.
11+
*/
812
class GetCallerIdentityResponse extends Result
913
{
1014
/**

src/Sts/ValueObject/AssumedRoleUser.php

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

33
namespace AsyncAws\Core\Sts\ValueObject;
44

5+
/**
6+
* The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the
7+
* resulting temporary security credentials. For example, you can reference these credentials as a principal in a
8+
* resource-based policy by using the ARN or assumed role ID. The ARN and ID include the `RoleSessionName` that you
9+
* specified when you called `AssumeRole`.
10+
*/
511
final class AssumedRoleUser
612
{
713
/**

src/Sts/ValueObject/Credentials.php

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

33
namespace AsyncAws\Core\Sts\ValueObject;
44

5+
/**
6+
* The temporary security credentials, which include an access key ID, a secret access key, and a security (or session)
7+
* token.
8+
*
9+
* > The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no
10+
* > assumptions about the maximum size.
11+
*/
512
final class Credentials
613
{
714
/**

src/Sts/ValueObject/PolicyDescriptorType.php

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

33
namespace AsyncAws\Core\Sts\ValueObject;
44

5+
/**
6+
* A reference to the IAM managed policy that is passed as a session policy for a role session or a federated user
7+
* session.
8+
*/
59
final class PolicyDescriptorType
610
{
711
/**

src/Sts/ValueObject/Tag.php

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

55
use AsyncAws\Core\Exception\InvalidArgument;
66

7+
/**
8+
* You can pass custom key-value pair attributes when you assume a role or federate a user. These are called session
9+
* tags. You can then use the session tags to control access to resources. For more information, see Tagging AWS STS
10+
* Sessions in the *IAM User Guide*.
11+
*
12+
* @see https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html
13+
*/
714
final class Tag
815
{
916
/**

0 commit comments

Comments
 (0)