Skip to content

Commit fcd73f5

Browse files
authored
Generate the property type for generated objects (#1467)
1 parent efb9d8b commit fcd73f5

12 files changed

+76
-0
lines changed

src/Result/CreateAccessKeyResponse.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ class CreateAccessKeyResponse extends Result
1313
{
1414
/**
1515
* A structure with details about the access key.
16+
*
17+
* @var AccessKey
1618
*/
1719
private $accessKey;
1820

src/Result/CreateServiceSpecificCredentialResponse.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ class CreateServiceSpecificCredentialResponse extends Result
1313
*
1414
* ! This is the only time that the password for this credential set is available. It cannot be recovered later.
1515
* ! Instead, you must reset the password with ResetServiceSpecificCredential.
16+
*
17+
* @var ServiceSpecificCredential|null
1618
*/
1719
private $serviceSpecificCredential;
1820

src/Result/CreateUserResponse.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ class CreateUserResponse extends Result
1515
{
1616
/**
1717
* A structure with details about the new IAM user.
18+
*
19+
* @var User|null
1820
*/
1921
private $user;
2022

src/Result/GetUserResponse.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ class GetUserResponse extends Result
3030
*
3131
* [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_finding-unused.html
3232
* [^2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html
33+
*
34+
* @var User
3335
*/
3436
private $user;
3537

src/Result/ListServiceSpecificCredentialsResponse.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ class ListServiceSpecificCredentialsResponse extends Result
1010
{
1111
/**
1212
* A list of structures that each contain details about a service-specific credential.
13+
*
14+
* @var ServiceSpecificCredentialMetadata[]
1315
*/
1416
private $serviceSpecificCredentials;
1517

src/Result/ListUsersResponse.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ class ListUsersResponse extends Result implements \IteratorAggregate
2020
{
2121
/**
2222
* A list of users.
23+
*
24+
* @var User[]
2325
*/
2426
private $users;
2527

@@ -28,12 +30,16 @@ class ListUsersResponse extends Result implements \IteratorAggregate
2830
* subsequent pagination request using the `Marker` request parameter to retrieve more items. Note that IAM might return
2931
* fewer than the `MaxItems` number of results even when there are more results available. We recommend that you check
3032
* `IsTruncated` after every call to ensure that you receive all your results.
33+
*
34+
* @var bool|null
3135
*/
3236
private $isTruncated;
3337

3438
/**
3539
* When `IsTruncated` is `true`, this element is present and contains the value to use for the `Marker` parameter in a
3640
* subsequent pagination request.
41+
*
42+
* @var string|null
3743
*/
3844
private $marker;
3945

src/ValueObject/AccessKey.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,36 @@ final class AccessKey
1818
{
1919
/**
2020
* The name of the IAM user that the access key is associated with.
21+
*
22+
* @var string
2123
*/
2224
private $userName;
2325

2426
/**
2527
* The ID for this access key.
28+
*
29+
* @var string
2630
*/
2731
private $accessKeyId;
2832

2933
/**
3034
* The status of the access key. `Active` means that the key is valid for API calls, while `Inactive` means it is not.
35+
*
36+
* @var StatusType::*
3137
*/
3238
private $status;
3339

3440
/**
3541
* The secret key used to sign requests.
42+
*
43+
* @var string
3644
*/
3745
private $secretAccessKey;
3846

3947
/**
4048
* The date when the access key was created.
49+
*
50+
* @var \DateTimeImmutable|null
4151
*/
4252
private $createDate;
4353

src/ValueObject/AttachedPermissionsBoundary.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,15 @@ final class AttachedPermissionsBoundary
2020
/**
2121
* The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for
2222
* an entity. This data type can only have a value of `Policy`.
23+
*
24+
* @var PermissionsBoundaryAttachmentType::*|null
2325
*/
2426
private $permissionsBoundaryType;
2527

2628
/**
2729
* The ARN of the policy used to set the permissions boundary for the user or role.
30+
*
31+
* @var string|null
2832
*/
2933
private $permissionsBoundaryArn;
3034

src/ValueObject/ServiceSpecificCredential.php

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,39 +14,53 @@ final class ServiceSpecificCredential
1414
* The date and time, in ISO 8601 date-time format [^1], when the service-specific credential were created.
1515
*
1616
* [^1]: http://www.iso.org/iso/iso8601
17+
*
18+
* @var \DateTimeImmutable
1719
*/
1820
private $createDate;
1921

2022
/**
2123
* The name of the service associated with the service-specific credential.
24+
*
25+
* @var string
2226
*/
2327
private $serviceName;
2428

2529
/**
2630
* The generated user name for the service-specific credential. This value is generated by combining the IAM user's name
2731
* combined with the ID number of the Amazon Web Services account, as in `jane-at-123456789012`, for example. This value
2832
* cannot be configured by the user.
33+
*
34+
* @var string
2935
*/
3036
private $serviceUserName;
3137

3238
/**
3339
* The generated password for the service-specific credential.
40+
*
41+
* @var string
3442
*/
3543
private $servicePassword;
3644

3745
/**
3846
* The unique identifier for the service-specific credential.
47+
*
48+
* @var string
3949
*/
4050
private $serviceSpecificCredentialId;
4151

4252
/**
4353
* The name of the IAM user associated with the service-specific credential.
54+
*
55+
* @var string
4456
*/
4557
private $userName;
4658

4759
/**
4860
* The status of the service-specific credential. `Active` means that the key is valid for API calls, while `Inactive`
4961
* means it is not.
62+
*
63+
* @var StatusType::*
5064
*/
5165
private $status;
5266

src/ValueObject/ServiceSpecificCredentialMetadata.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,34 +12,46 @@ final class ServiceSpecificCredentialMetadata
1212
{
1313
/**
1414
* The name of the IAM user associated with the service-specific credential.
15+
*
16+
* @var string
1517
*/
1618
private $userName;
1719

1820
/**
1921
* The status of the service-specific credential. `Active` means that the key is valid for API calls, while `Inactive`
2022
* means it is not.
23+
*
24+
* @var StatusType::*
2125
*/
2226
private $status;
2327

2428
/**
2529
* The generated user name for the service-specific credential.
30+
*
31+
* @var string
2632
*/
2733
private $serviceUserName;
2834

2935
/**
3036
* The date and time, in ISO 8601 date-time format [^1], when the service-specific credential were created.
3137
*
3238
* [^1]: http://www.iso.org/iso/iso8601
39+
*
40+
* @var \DateTimeImmutable
3341
*/
3442
private $createDate;
3543

3644
/**
3745
* The unique identifier for the service-specific credential.
46+
*
47+
* @var string
3848
*/
3949
private $serviceSpecificCredentialId;
4050

4151
/**
4252
* The name of the service associated with the service-specific credential.
53+
*
54+
* @var string
4355
*/
4456
private $serviceName;
4557

0 commit comments

Comments
 (0)