Skip to content

Commit acc79f5

Browse files
Update generated code (#1815)
update generated code
1 parent 2240255 commit acc79f5

38 files changed

+359
-214
lines changed

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"variables": {
3-
"${LATEST}": "3.334.2"
3+
"${LATEST}": "3.334.4"
44
},
55
"endpoints": "https://raw.githubusercontent.com/aws/aws-sdk-php/${LATEST}/src/data/endpoints.json",
66
"services": {

src/Service/CognitoIdentityProvider/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+
### Changed
6+
7+
- AWS enhancement: Documentation updates.
8+
59
## 1.10.0
610

711
### Added

src/Service/CognitoIdentityProvider/src/CognitoIdentityProviderClient.php

Lines changed: 102 additions & 67 deletions
Large diffs are not rendered by default.

src/Service/CognitoIdentityProvider/src/Input/AdminAddUserToGroupRequest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
final class AdminAddUserToGroupRequest extends Input
1111
{
1212
/**
13-
* The user pool ID for the user pool.
13+
* The ID of the user pool that contains the group that you want to add the user to.
1414
*
1515
* @required
1616
*

src/Service/CognitoIdentityProvider/src/Input/AdminConfirmSignUpRequest.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
final class AdminConfirmSignUpRequest extends Input
1414
{
1515
/**
16-
* The user pool ID for which you want to confirm user registration.
16+
* The ID of the user pool where you want to confirm a user's sign-up request.
1717
*
1818
* @required
1919
*
@@ -44,13 +44,13 @@ final class AdminConfirmSignUpRequest extends Input
4444
* For more information, see Customizing user pool Workflows with Lambda Triggers [^1] in the *Amazon Cognito Developer
4545
* Guide*.
4646
*
47-
* > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
47+
* > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following:
4848
* >
49-
* > - Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool
50-
* > to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata
49+
* > - Store the `ClientMetadata` value. This data is available only to Lambda triggers that are assigned to a user pool
50+
* > to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata`
5151
* > parameter serves no purpose.
52-
* > - Validate the ClientMetadata value.
53-
* > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
52+
* > - Validate the `ClientMetadata` value.
53+
* > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter.
5454
* >
5555
*
5656
* [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

src/Service/CognitoIdentityProvider/src/Input/AdminCreateUserRequest.php

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
final class AdminCreateUserRequest extends Input
1717
{
1818
/**
19-
* The user pool ID for the user pool where the user will be created.
19+
* The ID of the user pool where you want to create a user.
2020
*
2121
* @required
2222
*
@@ -123,9 +123,9 @@ final class AdminCreateUserRequest extends Input
123123
* This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True`. Otherwise,
124124
* it is ignored.
125125
*
126-
* If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter
127-
* already exists as an alias with a different user, the API call will migrate the alias from the previous user to the
128-
* newly created user. The previous user will no longer be able to log in using that alias.
126+
* If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter
127+
* already exists as an alias with a different user, this request migrates the alias from the previous user to the
128+
* newly-created user. The previous user will no longer be able to log in using that alias.
129129
*
130130
* If this parameter is set to `False`, the API throws an `AliasExistsException` error if the alias already exists. The
131131
* default value is `False`.
@@ -135,16 +135,17 @@ final class AdminCreateUserRequest extends Input
135135
private $forceAliasCreation;
136136

137137
/**
138-
* Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the
139-
* user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value.
138+
* Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password
139+
* duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one
140+
* value.
140141
*
141142
* @var MessageActionType::*|null
142143
*/
143144
private $messageAction;
144145

145146
/**
146-
* Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be
147-
* used. The default value is `"SMS"`. You can specify more than one value.
147+
* Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used.
148+
* The default value is `SMS`. You can specify more than one value.
148149
*
149150
* @var list<DeliveryMediumType::*>|null
150151
*/
@@ -156,20 +157,20 @@ final class AdminCreateUserRequest extends Input
156157
* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API
157158
* action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito
158159
* invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a
159-
* `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your
160+
* `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your
160161
* AdminCreateUser request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your
161162
* workflow for your specific needs.
162163
*
163164
* For more information, see Customizing user pool Workflows with Lambda Triggers [^1] in the *Amazon Cognito Developer
164165
* Guide*.
165166
*
166-
* > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
167+
* > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following:
167168
* >
168-
* > - Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool
169-
* > to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata
169+
* > - Store the `ClientMetadata` value. This data is available only to Lambda triggers that are assigned to a user pool
170+
* > to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata`
170171
* > parameter serves no purpose.
171-
* > - Validate the ClientMetadata value.
172-
* > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
172+
* > - Validate the `ClientMetadata` value.
173+
* > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter.
173174
* >
174175
*
175176
* [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

src/Service/CognitoIdentityProvider/src/Input/AdminDeleteUserRequest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
final class AdminDeleteUserRequest extends Input
1414
{
1515
/**
16-
* The user pool ID for the user pool where you want to delete the user.
16+
* The ID of the user pool where you want to delete the user.
1717
*
1818
* @required
1919
*

src/Service/CognitoIdentityProvider/src/Input/AdminDisableUserRequest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
final class AdminDisableUserRequest extends Input
1414
{
1515
/**
16-
* The user pool ID for the user pool where you want to disable the user.
16+
* The ID of the user pool where you want to disable the user.
1717
*
1818
* @required
1919
*

src/Service/CognitoIdentityProvider/src/Input/AdminEnableUserRequest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
final class AdminEnableUserRequest extends Input
1414
{
1515
/**
16-
* The user pool ID for the user pool where you want to enable the user.
16+
* The ID of the user pool where you want to activate sign-in for the user.
1717
*
1818
* @required
1919
*

src/Service/CognitoIdentityProvider/src/Input/AdminGetUserRequest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
final class AdminGetUserRequest extends Input
1414
{
1515
/**
16-
* The user pool ID for the user pool where you want to get information about the user.
16+
* The ID of the user pool where you want to get information about the user.
1717
*
1818
* @required
1919
*

0 commit comments

Comments
 (0)