Skip to content

Commit

Permalink
Update generated code (#1631)
Browse files Browse the repository at this point in the history
* update generated code

* Update src/Service/S3/CHANGELOG.md

---------

Co-authored-by: Jérémy Derussé <[email protected]>
  • Loading branch information
async-aws-bot and jderusse authored Dec 19, 2023
1 parent f38d396 commit 5dc8653
Show file tree
Hide file tree
Showing 26 changed files with 191 additions and 72 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## NOT RELEASED

### Changed

- AWS enhancement: Documentation updates.

## 1.7.1

### Changed
Expand Down
83 changes: 59 additions & 24 deletions src/CognitoIdentityProviderClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@
class CognitoIdentityProviderClient extends AbstractApi
{
/**
* Adds the specified user to the specified group.
* Adds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and
* populates a `cognito:groups` claim to their access and identity tokens.
*
* > Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this
* > operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM
Expand Down Expand Up @@ -159,7 +160,14 @@ public function adminAddUserToGroup($input): Result
}

/**
* Confirms user registration as an admin without using a confirmation code. Works on any user.
* This IAM-authenticated API operation provides a code that Amazon Cognito sent to your user when they signed up in
* your user pool. After your user enters their code, they confirm ownership of the email address or phone number that
* they provided, and their user account becomes active. Depending on your user pool configuration, your users will
* receive their confirmation code in an email or SMS message.
*
* Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who
* federate through an external identity provider (IdP) have already been confirmed by their IdP. Administrator-created
* users confirm their accounts when they respond to their invitation email message and choose a password.
*
* > Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this
* > operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM
Expand Down Expand Up @@ -872,26 +880,35 @@ public function adminUpdateUserAttributes($input): AdminUpdateUserAttributesResp
}

/**
* Signs out a user from all devices. `AdminUserGlobalSignOut` invalidates all identity, access and refresh tokens that
* Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration
* of the 1-hour cookie validity period.
* Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation with
* your administrative credentials when your user signs out of your app. This results in the following behavior.
*
* - Amazon Cognito no longer accepts *token-authorized* user operations that you authorize with a signed-out user's
* access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints [^1].
*
* Amazon Cognito returns an `Access Token has been revoked` error when your app attempts to authorize a user pools
* API request with a revoked access token that contains the scope `aws.cognito.signin.user.admin`.
* - Amazon Cognito no longer accepts a signed-out user's ID token in a GetId [^2] request to an identity pool with
* `ServerSideTokenCheck` enabled for its user pool IdP configuration in CognitoIdentityProvider [^3].
* - Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.
*
* Your app isn't aware that a user's access token is revoked unless it attempts to authorize a user pools API request
* with an access token that contains the scope `aws.cognito.signin.user.admin`. Your app might otherwise accept access
* tokens until they expire.
* Other requests might be valid until your user's token expires.
*
* > Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this
* > operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM
* > permission in a policy.
* >
* > **Learn more**
* >
* > - Signing Amazon Web Services API Requests [^1]
* > - Using the Amazon Cognito user pools API and user pool endpoints [^2]
* > - Signing Amazon Web Services API Requests [^4]
* > - Using the Amazon Cognito user pools API and user pool endpoints [^5]
* >
*
* [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
* [^2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
* [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
* [^2]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetId.html
* [^3]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_CognitoIdentityProvider.html
* [^4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
* [^5]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
*
* @see https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUserGlobalSignOut.html
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html#adminuserglobalsignout
Expand Down Expand Up @@ -1100,14 +1117,25 @@ public function confirmForgotPassword($input): ConfirmForgotPasswordResponse
}

/**
* Confirms registration of a new user.
* This public API operation provides a code that Amazon Cognito sent to your user when they signed up in your user pool
* via the SignUp [^1] API operation. After your user enters their code, they confirm ownership of the email address or
* phone number that they provided, and their user account becomes active. Depending on your user pool configuration,
* your users will receive their confirmation code in an email or SMS message.
*
* Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who
* federate through an external identity provider (IdP) have already been confirmed by their IdP. Administrator-created
* users, users created with the AdminCreateUser [^2] API operation, confirm their accounts when they respond to their
* invitation email message and choose a password. They do not receive a confirmation code. Instead, they receive a
* temporary password.
*
* > Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation.
* > For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in
* > policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native
* > and OIDC APIs [^1].
* > and OIDC APIs [^3].
*
* [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
* [^1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html
* [^2]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html
* [^3]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
*
* @see https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmSignUp.html
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html#confirmsignup
Expand Down Expand Up @@ -1603,29 +1631,36 @@ public function resendConfirmationCode($input): ResendConfirmationCodeResponse
}

/**
* Responds to the authentication challenge.
* Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication
* that bypasses MFA, or for a custom authentication challenge. A `RespondToAuthChallenge` API request provides the
* answer to that challenge, like a code or a secure remote password (SRP). The parameters of a response to an
* authentication challenge vary with the type of challenge.
*
* For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers
* [^1].
*
* > Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation.
* > For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in
* > policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native
* > and OIDC APIs [^1].
* > and OIDC APIs [^2].
*
* > This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register
* > an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in
* > Amazon Cognito, you must register a phone number with Amazon Pinpoint [^2]. Amazon Cognito uses the registered
* > Amazon Cognito, you must register a phone number with Amazon Pinpoint [^3]. Amazon Cognito uses the registered
* > number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up,
* > activate their accounts, or sign in.
* >
* > If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple
* > Notification Service might place your account in the SMS sandbox. In *sandbox mode [^3]*, you can send messages
* > Notification Service might place your account in the SMS sandbox. In *sandbox mode [^4]*, you can send messages
* > only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the
* > sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools [^4] in
* > sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools [^5] in
* > the *Amazon Cognito Developer Guide*.
*
* [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
* [^2]: https://console.aws.amazon.com/pinpoint/home/
* [^3]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html
* [^4]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
* [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html
* [^2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
* [^3]: https://console.aws.amazon.com/pinpoint/home/
* [^4]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html
* [^5]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
*
* @see https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html#respondtoauthchallenge
Expand Down
6 changes: 4 additions & 2 deletions src/Input/AdminAddUserToGroupRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ final class AdminAddUserToGroupRequest extends Input
private $userPoolId;

/**
* The username for the user.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand All @@ -28,7 +30,7 @@ final class AdminAddUserToGroupRequest extends Input
private $username;

/**
* The group name.
* The name of the group that you want to add your user to.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminConfirmSignUpRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ final class AdminConfirmSignUpRequest extends Input
private $userPoolId;

/**
* The user name for which you want to confirm user registration.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
16 changes: 9 additions & 7 deletions src/Input/AdminCreateUserRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,17 @@ final class AdminCreateUserRequest extends Input
private $userAttributes;

/**
* The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values
* that you can use for custom validation, such as restricting the types of user accounts that can be registered. For
* example, you might choose to allow or disallow user sign-up based on the user's domain.
* Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value
* pairs are for custom validation of information that you collect from your users but don't need to retain.
*
* To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the
* Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation
* process.
* Your Lambda function can analyze this additional data and act on it. Your function might perform external API
* operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also
* affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign
* up from within your network.
*
* The user's validation data isn't persisted.
* For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger [^1].
*
* [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html
*
* @var AttributeType[]|null
*/
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminDeleteUserRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ final class AdminDeleteUserRequest extends Input
private $userPoolId;

/**
* The user name of the user you want to delete.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminDisableUserRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ final class AdminDisableUserRequest extends Input
private $userPoolId;

/**
* The user name of the user you want to disable.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminEnableUserRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ final class AdminEnableUserRequest extends Input
private $userPoolId;

/**
* The user name of the user you want to enable.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminGetUserRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ final class AdminGetUserRequest extends Input
private $userPoolId;

/**
* The user name of the user you want to retrieve.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
1 change: 0 additions & 1 deletion src/Input/AdminInitiateAuthRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ final class AdminInitiateAuthRequest extends Input
* - Pre token generation
* - Create auth challenge
* - Define auth challenge
* - Verify auth challenge
*
* For more information, see Customizing user pool Workflows with Lambda Triggers [^1] in the *Amazon Cognito Developer
* Guide*.
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminRemoveUserFromGroupRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ final class AdminRemoveUserFromGroupRequest extends Input
private $userPoolId;

/**
* The username for the user.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminResetUserPasswordRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ final class AdminResetUserPasswordRequest extends Input
private $userPoolId;

/**
* The user name of the user whose password you want to reset.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminSetUserPasswordRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ final class AdminSetUserPasswordRequest extends Input
private $userPoolId;

/**
* The user name of the user whose password you want to set.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminUpdateUserAttributesRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ final class AdminUpdateUserAttributesRequest extends Input
private $userPoolId;

/**
* The user name of the user for whom you want to update user attributes.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/AdminUserGlobalSignOutRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ final class AdminUserGlobalSignOutRequest extends Input
private $userPoolId;

/**
* The user name.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/ConfirmForgotPasswordRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ final class ConfirmForgotPasswordRequest extends Input
private $secretHash;

/**
* The user name of the user for whom you want to enter a code to retrieve a forgotten password.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
4 changes: 3 additions & 1 deletion src/Input/ConfirmSignUpRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ final class ConfirmSignUpRequest extends Input
private $secretHash;

/**
* The user name of the user whose registration you want to confirm.
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you
* can also use their `sub` in this request.
*
* @required
*
Expand Down
Loading

0 comments on commit 5dc8653

Please sign in to comment.