Skip to content

Commit fd6a285

Browse files
authored
Move Result docbloc from property to getter (#266)
1 parent 7639942 commit fd6a285

File tree

5 files changed

+77
-77
lines changed

5 files changed

+77
-77
lines changed

src/Sts/Result/AssumeRoleResponse.php

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,41 +8,41 @@
88

99
class AssumeRoleResponse extends Result
1010
{
11-
/**
12-
* The temporary security credentials, which include an access key ID, a secret access key, and a security (or session)
13-
* token.
14-
*/
1511
private $Credentials;
1612

13+
private $AssumedRoleUser;
14+
15+
private $PackedPolicySize;
16+
1717
/**
1818
* The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the
1919
* resulting temporary security credentials. For example, you can reference these credentials as a principal in a
2020
* resource-based policy by using the ARN or assumed role ID. The ARN and ID include the `RoleSessionName` that you
2121
* specified when you called `AssumeRole`.
2222
*/
23-
private $AssumedRoleUser;
24-
25-
/**
26-
* A percentage value that indicates the packed size of the session policies and session tags combined passed in the
27-
* request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded
28-
* the allowed space.
29-
*/
30-
private $PackedPolicySize;
31-
3223
public function getAssumedRoleUser(): ?AssumedRoleUser
3324
{
3425
$this->initialize();
3526

3627
return $this->AssumedRoleUser;
3728
}
3829

30+
/**
31+
* The temporary security credentials, which include an access key ID, a secret access key, and a security (or session)
32+
* token.
33+
*/
3934
public function getCredentials(): ?Credentials
4035
{
4136
$this->initialize();
4237

4338
return $this->Credentials;
4439
}
4540

41+
/**
42+
* A percentage value that indicates the packed size of the session policies and session tags combined passed in the
43+
* request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded
44+
* the allowed space.
45+
*/
4646
public function getPackedPolicySize(): ?int
4747
{
4848
$this->initialize();

src/Sts/Result/AssumeRoleWithWebIdentityResponse.php

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,82 +8,82 @@
88

99
class AssumeRoleWithWebIdentityResponse extends Result
1010
{
11-
/**
12-
* The temporary security credentials, which include an access key ID, a secret access key, and a security token.
13-
*/
1411
private $Credentials;
1512

16-
/**
17-
* The unique user identifier that is returned by the identity provider. This identifier is associated with the
18-
* `WebIdentityToken` that was submitted with the `AssumeRoleWithWebIdentity` call. The identifier is typically unique
19-
* to the user and the application that acquired the `WebIdentityToken` (pairwise identifier). For OpenID Connect ID
20-
* tokens, this field contains the value returned by the identity provider as the token's `sub` (Subject) claim.
21-
*/
2213
private $SubjectFromWebIdentityToken;
2314

24-
/**
25-
* The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the
26-
* resulting temporary security credentials. For example, you can reference these credentials as a principal in a
27-
* resource-based policy by using the ARN or assumed role ID. The ARN and ID include the `RoleSessionName` that you
28-
* specified when you called `AssumeRole`.
29-
*/
3015
private $AssumedRoleUser;
3116

32-
/**
33-
* A percentage value that indicates the packed size of the session policies and session tags combined passed in the
34-
* request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded
35-
* the allowed space.
36-
*/
3717
private $PackedPolicySize;
3818

39-
/**
40-
* The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of
41-
* the `iss` field. For OAuth 2.0 access tokens, this contains the value of the `ProviderId` parameter that was passed
42-
* in the `AssumeRoleWithWebIdentity` request.
43-
*/
4419
private $Provider;
4520

46-
/**
47-
* The intended audience (also known as client ID) of the web identity token. This is traditionally the client
48-
* identifier issued to the application that requested the web identity token.
49-
*/
5021
private $Audience;
5122

23+
/**
24+
* The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the
25+
* resulting temporary security credentials. For example, you can reference these credentials as a principal in a
26+
* resource-based policy by using the ARN or assumed role ID. The ARN and ID include the `RoleSessionName` that you
27+
* specified when you called `AssumeRole`.
28+
*/
5229
public function getAssumedRoleUser(): ?AssumedRoleUser
5330
{
5431
$this->initialize();
5532

5633
return $this->AssumedRoleUser;
5734
}
5835

36+
/**
37+
* The intended audience (also known as client ID) of the web identity token. This is traditionally the client
38+
* identifier issued to the application that requested the web identity token.
39+
*/
5940
public function getAudience(): ?string
6041
{
6142
$this->initialize();
6243

6344
return $this->Audience;
6445
}
6546

47+
/**
48+
* The temporary security credentials, which include an access key ID, a secret access key, and a security token.
49+
*/
6650
public function getCredentials(): ?Credentials
6751
{
6852
$this->initialize();
6953

7054
return $this->Credentials;
7155
}
7256

57+
/**
58+
* A percentage value that indicates the packed size of the session policies and session tags combined passed in the
59+
* request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded
60+
* the allowed space.
61+
*/
7362
public function getPackedPolicySize(): ?int
7463
{
7564
$this->initialize();
7665

7766
return $this->PackedPolicySize;
7867
}
7968

69+
/**
70+
* The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of
71+
* the `iss` field. For OAuth 2.0 access tokens, this contains the value of the `ProviderId` parameter that was passed
72+
* in the `AssumeRoleWithWebIdentity` request.
73+
*/
8074
public function getProvider(): ?string
8175
{
8276
$this->initialize();
8377

8478
return $this->Provider;
8579
}
8680

81+
/**
82+
* The unique user identifier that is returned by the identity provider. This identifier is associated with the
83+
* `WebIdentityToken` that was submitted with the `AssumeRoleWithWebIdentity` call. The identifier is typically unique
84+
* to the user and the application that acquired the `WebIdentityToken` (pairwise identifier). For OpenID Connect ID
85+
* tokens, this field contains the value returned by the identity provider as the token's `sub` (Subject) claim.
86+
*/
8787
public function getSubjectFromWebIdentityToken(): ?string
8888
{
8989
$this->initialize();

src/Sts/Result/AssumedRoleUser.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,8 @@
44

55
class AssumedRoleUser
66
{
7-
/**
8-
* A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role
9-
* ID is generated by AWS when the role is created.
10-
*/
117
private $AssumedRoleId;
128

13-
/**
14-
* The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information
15-
* about ARNs and how to use them in policies, see IAM Identifiers in the *IAM User Guide*.
16-
*
17-
* @see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
18-
*/
199
private $Arn;
2010

2111
/**
@@ -35,11 +25,21 @@ public static function create($input): self
3525
return $input instanceof self ? $input : new self($input);
3626
}
3727

28+
/**
29+
* The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information
30+
* about ARNs and how to use them in policies, see IAM Identifiers in the *IAM User Guide*.
31+
*
32+
* @see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
33+
*/
3834
public function getArn(): string
3935
{
4036
return $this->Arn;
4137
}
4238

39+
/**
40+
* A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role
41+
* ID is generated by AWS when the role is created.
42+
*/
4343
public function getAssumedRoleId(): string
4444
{
4545
return $this->AssumedRoleId;

src/Sts/Result/Credentials.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,12 @@
44

55
class Credentials
66
{
7-
/**
8-
* The access key ID that identifies the temporary security credentials.
9-
*/
107
private $AccessKeyId;
118

12-
/**
13-
* The secret access key that can be used to sign requests.
14-
*/
159
private $SecretAccessKey;
1610

17-
/**
18-
* The token that users must pass to the service API to use the temporary credentials.
19-
*/
2011
private $SessionToken;
2112

22-
/**
23-
* The date on which the current credentials expire.
24-
*/
2513
private $Expiration;
2614

2715
/**
@@ -45,21 +33,33 @@ public static function create($input): self
4533
return $input instanceof self ? $input : new self($input);
4634
}
4735

36+
/**
37+
* The access key ID that identifies the temporary security credentials.
38+
*/
4839
public function getAccessKeyId(): string
4940
{
5041
return $this->AccessKeyId;
5142
}
5243

44+
/**
45+
* The date on which the current credentials expire.
46+
*/
5347
public function getExpiration(): \DateTimeInterface
5448
{
5549
return $this->Expiration;
5650
}
5751

52+
/**
53+
* The secret access key that can be used to sign requests.
54+
*/
5855
public function getSecretAccessKey(): string
5956
{
6057
return $this->SecretAccessKey;
6158
}
6259

60+
/**
61+
* The token that users must pass to the service API to use the temporary credentials.
62+
*/
6363
public function getSessionToken(): string
6464
{
6565
return $this->SessionToken;

src/Sts/Result/GetCallerIdentityResponse.php

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,39 @@
88

99
class GetCallerIdentityResponse extends Result
1010
{
11-
/**
12-
* The unique identifier of the calling entity. The exact value depends on the type of entity that is making the call.
13-
* The values returned are those listed in the **aws:userid** column in the Principal table found on the **Policy
14-
* Variables** reference page in the *IAM User Guide*.
15-
*
16-
* @see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable
17-
*/
1811
private $UserId;
1912

20-
/**
21-
* The AWS account ID number of the account that owns or contains the calling entity.
22-
*/
2313
private $Account;
2414

25-
/**
26-
* The AWS ARN associated with the calling entity.
27-
*/
2815
private $Arn;
2916

17+
/**
18+
* The AWS account ID number of the account that owns or contains the calling entity.
19+
*/
3020
public function getAccount(): ?string
3121
{
3222
$this->initialize();
3323

3424
return $this->Account;
3525
}
3626

27+
/**
28+
* The AWS ARN associated with the calling entity.
29+
*/
3730
public function getArn(): ?string
3831
{
3932
$this->initialize();
4033

4134
return $this->Arn;
4235
}
4336

37+
/**
38+
* The unique identifier of the calling entity. The exact value depends on the type of entity that is making the call.
39+
* The values returned are those listed in the **aws:userid** column in the Principal table found on the **Policy
40+
* Variables** reference page in the *IAM User Guide*.
41+
*
42+
* @see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable
43+
*/
4444
public function getUserId(): ?string
4545
{
4646
$this->initialize();

0 commit comments

Comments
 (0)