Generate the property type for result objects

Author: stof

src/CodeGenerator/src/Generator/CodeGenerator/PopulatorGenerator.php

@@ -133,8 +133,9 @@ private function generateProperties(StructureShape $shape, ClassBuilder $classBu
                 $nullable = false;
             } elseif ($member->isStreaming()) {
                 $returnType = ResultStream::class;
-                $parameterType = ResultStream::class;
+                $parameterType = 'ResultStream';
                 $memberClassNames = [];
+                $classBuilder->addUse(ResultStream::class);
                 $nullable = false;
             }
 
@@ -161,6 +162,9 @@ private function generateProperties(StructureShape $shape, ClassBuilder $classBu
                 $method->addComment('@return ' . $parameterType . ($nullable ? '|null' : ''));
             }
             $method->setReturnNullable($nullable);
+            if ($parameterType) {
+                $property->addComment('@var ' . $parameterType . ($nullable ? '|null' : ''));
+            }
         }
 
         if ($forEndpoint) {

src/Core/src/Sts/Result/AssumeRoleResponse.php

@@ -19,6 +19,8 @@ class AssumeRoleResponse extends Result
      *
      * > The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no
      * > assumptions about the maximum size.
+     *
+     * @var Credentials|null
      */
     private $credentials;
 
@@ -27,13 +29,17 @@ class AssumeRoleResponse extends Result
      * resulting temporary security credentials. For example, you can reference these credentials as a principal in a
      * resource-based policy by using the ARN or assumed role ID. The ARN and ID include the `RoleSessionName` that you
      * specified when you called `AssumeRole`.
+     *
+     * @var AssumedRoleUser|null
      */
     private $assumedRoleUser;
 
     /**
      * A percentage value that indicates the packed size of the session policies and session tags combined passed in the
      * request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded
      * the allowed space.
+     *
+     * @var int|null
      */
     private $packedPolicySize;
 
@@ -50,6 +56,8 @@ class AssumeRoleResponse extends Result
      * characters with no spaces. You can also include underscores or any of the following characters: =,.@-
      *
      * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html
+     *
+     * @var string|null
      */
     private $sourceIdentity;
 

src/Core/src/Sts/Result/AssumeRoleWithWebIdentityResponse.php

@@ -18,6 +18,8 @@ class AssumeRoleWithWebIdentityResponse extends Result
      *
      * > The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no
      * > assumptions about the maximum size.
+     *
+     * @var Credentials|null
      */
     private $credentials;
 
@@ -26,6 +28,8 @@ class AssumeRoleWithWebIdentityResponse extends Result
      * `WebIdentityToken` that was submitted with the `AssumeRoleWithWebIdentity` call. The identifier is typically unique
      * to the user and the application that acquired the `WebIdentityToken` (pairwise identifier). For OpenID Connect ID
      * tokens, this field contains the value returned by the identity provider as the token's `sub` (Subject) claim.
+     *
+     * @var string|null
      */
     private $subjectFromWebIdentityToken;
 
@@ -34,26 +38,34 @@ class AssumeRoleWithWebIdentityResponse extends Result
      * resulting temporary security credentials. For example, you can reference these credentials as a principal in a
      * resource-based policy by using the ARN or assumed role ID. The ARN and ID include the `RoleSessionName` that you
      * specified when you called `AssumeRole`.
+     *
+     * @var AssumedRoleUser|null
      */
     private $assumedRoleUser;
 
     /**
      * A percentage value that indicates the packed size of the session policies and session tags combined passed in the
      * request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded
      * the allowed space.
+     *
+     * @var int|null
      */
     private $packedPolicySize;
 
     /**
      * The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of
      * the `iss` field. For OAuth 2.0 access tokens, this contains the value of the `ProviderId` parameter that was passed
      * in the `AssumeRoleWithWebIdentity` request.
+     *
+     * @var string|null
      */
     private $provider;
 
     /**
      * The intended audience (also known as client ID) of the web identity token. This is traditionally the client
      * identifier issued to the application that requested the web identity token.
+     *
+     * @var string|null
      */
     private $audience;
 
@@ -76,6 +88,8 @@ class AssumeRoleWithWebIdentityResponse extends Result
      * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining
      * [^2]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html
      * [^3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html
+     *
+     * @var string|null
      */
     private $sourceIdentity;
 

src/Core/src/Sts/Result/GetCallerIdentityResponse.php

@@ -17,16 +17,22 @@ class GetCallerIdentityResponse extends Result
      * Variables** reference page in the *IAM User Guide*.
      *
      * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable
+     *
+     * @var string|null
      */
     private $userId;
 
     /**
      * The Amazon Web Services account ID number of the account that owns or contains the calling entity.
+     *
+     * @var string|null
      */
     private $account;
 
     /**
      * The Amazon Web Services ARN associated with the calling entity.
+     *
+     * @var string|null
      */
     private $arn;
 

src/Service/AppSync/src/Exception/BadRequestException.php

@@ -15,8 +15,14 @@
  */
 final class BadRequestException extends ClientException
 {
+    /**
+     * @var BadRequestReason::*|null
+     */
     private $reason;
 
+    /**
+     * @var BadRequestDetail|null
+     */
     private $detail;
 
     public function getDetail(): ?BadRequestDetail

src/Service/AppSync/src/Result/CreateResolverResponse.php

@@ -15,6 +15,8 @@ class CreateResolverResponse extends Result
 {
     /**
      * The `Resolver` object.
+     *
+     * @var Resolver|null
      */
     private $resolver;
 

src/Service/AppSync/src/Result/GetSchemaCreationStatusResponse.php

@@ -11,11 +11,15 @@ class GetSchemaCreationStatusResponse extends Result
     /**
      * The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE
      * state, you can add data.
+     *
+     * @var SchemaStatus::*|null
      */
     private $status;
 
     /**
      * Detailed information about the status of the schema creation operation.
+     *
+     * @var string|null
      */
     private $details;
 

src/Service/AppSync/src/Result/ListApiKeysResponse.php

@@ -10,11 +10,15 @@ class ListApiKeysResponse extends Result
 {
     /**
      * The `ApiKey` objects.
+     *
+     * @var ApiKey[]
      */
     private $apiKeys;
 
     /**
      * An identifier to pass in the next request to this operation to return the next set of items in the list.
+     *
+     * @var string|null
      */
     private $nextToken;
 

src/Service/AppSync/src/Result/ListResolversResponse.php

@@ -15,11 +15,15 @@ class ListResolversResponse extends Result
 {
     /**
      * The `Resolver` objects.
+     *
+     * @var Resolver[]
      */
     private $resolvers;
 
     /**
      * An identifier to pass in the next request to this operation to return the next set of items in the list.
+     *
+     * @var string|null
      */
     private $nextToken;
 

src/Service/AppSync/src/Result/StartSchemaCreationResponse.php

@@ -11,6 +11,8 @@ class StartSchemaCreationResponse extends Result
     /**
      * The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE
      * state, you can add data.
+     *
+     * @var SchemaStatus::*|null
      */
     private $status;
 

src/Service/AppSync/src/Result/UpdateApiKeyResponse.php

@@ -10,6 +10,8 @@ class UpdateApiKeyResponse extends Result
 {
     /**
      * The API key.
+     *
+     * @var ApiKey|null
      */
     private $apiKey;
 

src/Service/AppSync/src/Result/UpdateDataSourceResponse.php

@@ -21,6 +21,8 @@ class UpdateDataSourceResponse extends Result
 {
     /**
      * The updated `DataSource` object.
+     *
+     * @var DataSource|null
      */
     private $dataSource;
 

src/Service/AppSync/src/Result/UpdateResolverResponse.php

@@ -15,6 +15,8 @@ class UpdateResolverResponse extends Result
 {
     /**
      * The updated `Resolver` object.
+     *
+     * @var Resolver|null
      */
     private $resolver;
 

src/Service/Athena/src/Exception/InvalidRequestException.php

@@ -11,6 +11,9 @@
  */
 final class InvalidRequestException extends ClientException
 {
+    /**
+     * @var string|null
+     */
     private $athenaErrorCode;
 
     public function getAthenaErrorCode(): ?string

src/Service/Athena/src/Exception/ResourceNotFoundException.php

@@ -12,6 +12,8 @@ final class ResourceNotFoundException extends ClientException
 {
     /**
      * The name of the Amazon resource.
+     *
+     * @var string|null
      */
     private $resourceName;
 

src/Service/Athena/src/Exception/TooManyRequestsException.php

@@ -11,6 +11,9 @@
  */
 final class TooManyRequestsException extends ClientException
 {
+    /**
+     * @var ThrottleReason::*|null
+     */
     private $reason;
 
     /**

src/Service/Athena/src/Result/GetCalculationExecutionResponse.php

@@ -12,37 +12,51 @@ class GetCalculationExecutionResponse extends Result
 {
     /**
      * The calculation execution UUID.
+     *
+     * @var string|null
      */
     private $calculationExecutionId;
 
     /**
      * The session ID that the calculation ran in.
+     *
+     * @var string|null
      */
     private $sessionId;
 
     /**
      * The description of the calculation execution.
+     *
+     * @var string|null
      */
     private $description;
 
     /**
      * The Amazon S3 location in which calculation results are stored.
+     *
+     * @var string|null
      */
     private $workingDirectory;
 
     /**
      * Contains information about the status of the calculation.
+     *
+     * @var CalculationStatus|null
      */
     private $status;
 
     /**
      * Contains information about the data processing unit (DPU) execution time and progress. This field is populated only
      * when statistics are available.
+     *
+     * @var CalculationStatistics|null
      */
     private $statistics;
 
     /**
      * Contains result information. This field is populated only if the calculation is completed.
+     *
+     * @var CalculationResult|null
      */
     private $result;
 

src/Service/Athena/src/Result/GetCalculationExecutionStatusResponse.php

@@ -11,11 +11,15 @@ class GetCalculationExecutionStatusResponse extends Result
 {
     /**
      * Contains information about the calculation execution status.
+     *
+     * @var CalculationStatus|null
      */
     private $status;
 
     /**
      * Contains information about the DPU execution time and progress.
+     *
+     * @var CalculationStatistics|null
      */
     private $statistics;
 

src/Service/Athena/src/Result/GetDataCatalogOutput.php

@@ -10,6 +10,8 @@ class GetDataCatalogOutput extends Result
 {
     /**
      * The data catalog returned.
+     *
+     * @var DataCatalog|null
      */
     private $dataCatalog;
 

src/Service/Athena/src/Result/GetDatabaseOutput.php

@@ -10,6 +10,8 @@ class GetDatabaseOutput extends Result
 {
     /**
      * The database returned.
+     *
+     * @var Database|null
      */
     private $database;
 

src/Service/Athena/src/Result/GetNamedQueryOutput.php

@@ -10,6 +10,8 @@ class GetNamedQueryOutput extends Result
 {
     /**
      * Information about the query.
+     *
+     * @var NamedQuery|null
      */
     private $namedQuery;
 

src/Service/Athena/src/Result/GetQueryExecutionOutput.php

@@ -21,6 +21,8 @@ class GetQueryExecutionOutput extends Result
 {
     /**
      * Information about the query execution.
+     *
+     * @var QueryExecution|null
      */
     private $queryExecution;