Creates a new user in the specified user pool.
\nIf MessageAction isn't set, the default is to send a welcome message via\n email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThis message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.
\nAlternatively, you can call AdminCreateUser with SUPPRESS\n for the MessageAction parameter, and Amazon Cognito won't send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until\n they sign in and change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates a new user in the specified user pool.
\nIf MessageAction isn't set, the default is to send a welcome message via\n email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThis message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.
\nAlternatively, you can call AdminCreateUser with SUPPRESS\n for the MessageAction parameter, and Amazon Cognito won't send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until\n they sign in and change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nInitiates the authentication flow, as an administrator.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nInitiates the authentication flow, as an administrator.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nResets the specified user's password in a user pool as an administrator. Works on any\n user.
\nTo use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nDeactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nResets the specified user's password in a user pool as an administrator. Works on any\n user.
\nTo use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nDeactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nSome API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. An AdminRespondToAuthChallenge API request provides the answer\n to that challenge, like a code or a secure remote password (SRP). The parameters of a\n response to an authentication challenge vary with the type of challenge.
For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nSome API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. An AdminRespondToAuthChallenge API request provides the answer\n to that challenge, like a code or a secure remote password (SRP). The parameters of a\n response to an authentication challenge vary with the type of challenge.
For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user. To delete an attribute from your user, submit the\n attribute in your API request with a blank value.
\nFor custom attributes, you must prepend the custom: prefix to the\n attribute name.
In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user. To delete an attribute from your user, submit the\n attribute in your API request with a blank value.
\nFor custom attributes, you must prepend the custom: prefix to the\n attribute name.
In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nAdvanced security configuration options for additional authentication types\n in your user pool, including custom authentication and refresh-token \n authentication.\n
" + "smithy.api#documentation": "Advanced security configuration options for additional authentication types in your\n user pool, including custom\n authentication.
" } }, "com.amazonaws.cognitoidentityprovider#AdvancedSecurityEnabledModeType": { @@ -5604,7 +5604,7 @@ } ], "traits": { - "smithy.api#documentation": "This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCreates a new Amazon Cognito user pool and sets the password policy for the\n pool.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCreates a new Amazon Cognito user pool and sets the password policy for the\n pool.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCalling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. To\n use the confirmation code for resetting the password, call ConfirmForgotPassword.
If neither a verified phone number nor a verified email exists, this API returns\n InvalidParameterException. If your app client has a client secret and\n you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.
To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. To\n use the confirmation code for resetting the password, call ConfirmForgotPassword.
If neither a verified phone number nor a verified email exists, this API returns\n InvalidParameterException. If your app client has a client secret and\n you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.
To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nGenerates a user attribute verification code for the specified attribute name. Sends a\n message to a user with a code that they must return in a VerifyUserAttribute\n request.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nGenerates a user attribute verification code for the specified attribute name. Sends a\n message to a user with a code that they must return in a VerifyUserAttribute\n request.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nInitiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user\n with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nInitiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user\n with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nResends the confirmation (for confirmation of registration) to a specific user in the\n user pool.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nResends the confirmation (for confirmation of registration) to a specific user in the\n user pool.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nSome API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. A RespondToAuthChallenge API request provides the answer to that\n challenge, like a code or a secure remote password (SRP). The parameters of a response\n to an authentication challenge vary with the type of challenge.
For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nSome API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. A RespondToAuthChallenge API request provides the answer to that\n challenge, like a code or a secure remote password (SRP). The parameters of a response\n to an authentication challenge vary with the type of challenge.
For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nSets the user pool multi-factor authentication (MFA) configuration.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nSets the user pool multi-factor authentication (MFA) configuration.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nRegisters the user in the specified user pool and creates a user name, password, and\n user attributes.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nRegisters the user in the specified user pool and creates a user name, password, and\n user attributes.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nWith this operation, your users can update one or more of their attributes with their\n own credentials. You authorize this API request with the user's access token. To delete\n an attribute from your user, submit the attribute in your API request with a blank\n value. Custom attribute values in this request must include the custom:\n prefix.
Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nWith this operation, your users can update one or more of their attributes with their\n own credentials. You authorize this API request with the user's access token. To delete\n an attribute from your user, submit the attribute in your API request with a blank\n value. Custom attribute values in this request must include the custom:\n prefix.
Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user pool with the specified attributes. You can get a list of\n the current user pool settings using DescribeUserPool.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user pool with the specified attributes. You can get a list of\n the current user pool settings using DescribeUserPool.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nAdvanced security configuration options for additional authentication types\n in your user pool, including custom authentication and refresh-token \n authentication.\n
" + "smithy.api#documentation": "Advanced security configuration options for additional authentication types in your\n user pool, including custom\n authentication.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 881e18ba71d..4ac501a5dba 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -789,12 +789,12 @@ "AgentIds": { "target": "com.amazonaws.connect#AgentIds", "traits": { - "smithy.api#documentation": "An object to specify a list of agents, by Agent ID.
" + "smithy.api#documentation": "An object to specify a list of agents, by user ID.
" } } }, "traits": { - "smithy.api#documentation": "Can be used to define a list of preferred agents to target the contact within the queue.\n Note that agents must have the queue in their routing profile in order to be offered the\n contact.
" + "smithy.api#documentation": "Can be used to define a list of preferred agents to target the contact to within the queue.\u2028\n Note that agents must have the queue in their routing profile in order to be offered the\u2028\n contact.
" } }, "com.amazonaws.connect#AgentsMinOneMaxHundred": { @@ -7150,7 +7150,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nInitiates an Amazon Connect instance with all the supported channels enabled. It does\n not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It\n also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
\nAmazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nInitiates an Amazon Connect instance with all the supported channels enabled. It does\n not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It\n also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
\nFor more information, see Create an Amazon Connect\n instance in the Amazon Connect Administrator Guide.
\nAmazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.
", "smithy.api#http": { "method": "PUT", "uri": "/instance", @@ -7556,7 +7556,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new predefined attribute for the specified Amazon Connect instance.
", + "smithy.api#documentation": "Creates a new predefined attribute for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", "smithy.api#http": { "method": "PUT", "uri": "/predefined-attributes/{InstanceId}", @@ -8190,7 +8190,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a security profile.
", + "smithy.api#documentation": "Creates a security profile.
\nFor information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide. For a mapping of the API name and\n user interface name of the security profile permissions, see List of security profile\n permissions.
", "smithy.api#http": { "method": "PUT", "uri": "/security-profiles/{InstanceId}", @@ -10088,7 +10088,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDeletes the Amazon Connect instance.
\nAmazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDeletes the Amazon Connect instance. For more information, see Delete your\n Amazon Connect instance in the Amazon Connect Administrator\n Guide.
\nAmazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.
", "smithy.api#http": { "method": "DELETE", "uri": "/instance/{InstanceId}", @@ -10316,7 +10316,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a queue.
", + "smithy.api#documentation": "Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.
", "smithy.api#http": { "method": "DELETE", "uri": "/queues/{InstanceId}/{QueueId}", @@ -12027,7 +12027,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes a predefined attribute for the specified Amazon Connect instance.
", + "smithy.api#documentation": "Describes a predefined attribute for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", "smithy.api#http": { "method": "GET", "uri": "/predefined-attributes/{InstanceId}/{Name}", @@ -12460,7 +12460,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets basic information about the security profle.
", + "smithy.api#documentation": "Gets basic information about the security profile.
\nFor information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide. For a mapping of the API name and\n user interface name of the security profile permissions, see List of security profile\n permissions.
", "smithy.api#http": { "method": "GET", "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", @@ -21613,7 +21613,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists predefined attributes for the specified Amazon Connect instance.
", + "smithy.api#documentation": "Lists predefined attributes for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", "smithy.api#http": { "method": "GET", "uri": "/predefined-attributes/{InstanceId}", @@ -22729,7 +22729,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the permissions granted to a security profile.
", + "smithy.api#documentation": "Lists the permissions granted to a security profile.
\nFor information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide. For a mapping of the API name and\n user interface name of the security profile permissions, see List of security profile\n permissions.
", "smithy.api#http": { "method": "GET", "uri": "/security-profiles-permissions/{InstanceId}/{SecurityProfileId}", @@ -22839,7 +22839,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides summary information about the security profiles for the specified Amazon Connect instance.
\nFor more information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Provides summary information about the security profiles for the specified Amazon Connect instance.
\nFor more information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide. For a mapping of the API name and\n user interface name of the security profile permissions, see List of security profile\n permissions.
", "smithy.api#http": { "method": "GET", "uri": "/security-profiles-summary/{InstanceId}", @@ -23845,12 +23845,12 @@ "AgentsCriteria": { "target": "com.amazonaws.connect#AgentsCriteria", "traits": { - "smithy.api#documentation": "An object to define AgentIds.
An object to define agentIds.
" } } }, "traits": { - "smithy.api#documentation": "An object to define AgentsCriteria.
An object to define AgentsCriteria.
" } }, "com.amazonaws.connect#MaxResult10": { @@ -28485,7 +28485,7 @@ "FailureCode": { "target": "com.amazonaws.connect#RealTimeContactAnalysisPostContactSummaryFailureCode", "traits": { - "smithy.api#documentation": "If the summary failed to be generated, one of the following failure codes\n occurs:
\n\n QUOTA_EXCEEDED: The number of concurrent analytics jobs reached\n your service quota.
\n INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have\n at least one turn from both the participants in order to generate the\n summary.
\n FAILED_SAFETY_GUIDELINES: The generated summary cannot be\n provided because it failed to meet system safety guidelines.
\n INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for\n example, you're using a \n language \n that isn't supported by generative AI-powered post-contact summaries.\n
\n INTERNAL_ERROR: Internal system error.
If the summary failed to be generated, one of the following failure codes occurs:
\n\n QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service\n quota.
\n INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least\n one turn from both the participants in order to generate the summary.
\n FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it\n failed to meet system safety guidelines.
\n INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're\n using a language that isn't supported by generative AI-powered post-contact summaries.\n
\n INTERNAL_ERROR: Internal system error.
Latest routing criteria on the contact.
" } }, + "com.amazonaws.connect#RoutingCriteriaInput": { + "type": "structure", + "members": { + "Steps": { + "target": "com.amazonaws.connect#RoutingCriteriaInputSteps", + "traits": { + "smithy.api#documentation": "When Amazon Connect does not find an available agent meeting the requirements in a step for\u2028 \n a given step duration, the routing criteria will move on to the next step sequentially until a\u2028 \n join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent \n in the queue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object to define the RoutingCriteria.
" + } + }, + "com.amazonaws.connect#RoutingCriteriaInputStep": { + "type": "structure", + "members": { + "Expiry": { + "target": "com.amazonaws.connect#RoutingCriteriaInputStepExpiry", + "traits": { + "smithy.api#documentation": "An object to specify the expiration of a routing step.
" + } + }, + "Expression": { + "target": "com.amazonaws.connect#Expression", + "traits": { + "smithy.api#documentation": "A tagged union to specify expression for a routing step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, \n Name, or Value.
" + } + }, + "com.amazonaws.connect#RoutingCriteriaInputStepExpiry": { + "type": "structure", + "members": { + "DurationInSeconds": { + "target": "com.amazonaws.connect#DurationInSeconds", + "traits": { + "smithy.api#documentation": "The number of seconds that the contact will be routed only to agents matching this routing\u2028 step, if expiry \n was configured for this routing step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify whether this routing criteria step should apply for only a limited amount of time,\u2028 or if it should \n never expire.
" + } + }, + "com.amazonaws.connect#RoutingCriteriaInputSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingCriteriaInputStep" + } + }, "com.amazonaws.connect#RoutingCriteriaStepStatus": { "type": "enum", "members": { @@ -31073,7 +31127,7 @@ } ], "traits": { - "smithy.api#documentation": "Predefined attributes that meet certain criteria.
", + "smithy.api#documentation": "Searches predefined attributes that meet certain criteria. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", "smithy.api#http": { "method": "POST", "uri": "/search-predefined-attributes", @@ -31694,7 +31748,7 @@ } ], "traits": { - "smithy.api#documentation": "Searches security profiles in an Amazon Connect instance, with optional\n filtering.
", + "smithy.api#documentation": "Searches security profiles in an Amazon Connect instance, with optional\n filtering.
\nFor information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide. For a mapping of the API name and\n user interface name of the security profile permissions, see List of security profile\n permissions.
", "smithy.api#http": { "method": "POST", "uri": "/search-security-profiles", @@ -36832,6 +36886,12 @@ "traits": { "smithy.api#documentation": "Priority of the contact in the queue. The default priority for new contacts is 5. You can\n raise the priority of a contact compared to other contacts in the queue by assigning them a\n higher priority, such as 1 or 2.
" } + }, + "RoutingCriteria": { + "target": "com.amazonaws.connect#RoutingCriteriaInput", + "traits": { + "smithy.api#documentation": "Updates the routing criteria on the contact. These properties can be used to change how a\u2028\n contact is routed within the queue.
" + } } }, "traits": { @@ -37571,7 +37631,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a predefined attribute for the specified Amazon Connect instance.
", + "smithy.api#documentation": "Updates a predefined attribute for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", "smithy.api#http": { "method": "POST", "uri": "/predefined-attributes/{InstanceId}/{Name}", @@ -38630,7 +38690,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a security profile.
", + "smithy.api#documentation": "Updates a security profile.
\nFor information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide. For a mapping of the API name and\n user interface name of the security profile permissions, see List of security profile\n permissions.
", "smithy.api#http": { "method": "POST", "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", diff --git a/codegen/sdk-codegen/aws-models/ssm.json b/codegen/sdk-codegen/aws-models/ssm.json index aa2c5101a31..892e047223a 100644 --- a/codegen/sdk-codegen/aws-models/ssm.json +++ b/codegen/sdk-codegen/aws-models/ssm.json @@ -6687,7 +6687,7 @@ "RejectedPatchesAction": { "target": "com.amazonaws.ssm#PatchAction", "traits": { - "smithy.api#documentation": "The action for Patch Manager to take on patches included in the\n RejectedPackages list.
\n \n ALLOW_AS_DEPENDENCY\n : A package in the\n Rejected patches list is installed only if it is a dependency of another package.\n It is considered compliant with the patch baseline, and its status is reported as\n InstalledOther. This is the default action if no option is specified.
\n BLOCK: Packages in the Rejected\n patches list, and packages that include them as dependencies, aren't installed by\n Patch Manager under any circumstances. If a package was installed before it was added to the\n Rejected patches list, or is installed outside of Patch\n Manager afterward, it's considered noncompliant with the patch baseline and its status is\n reported as InstalledRejected.
\nThe action for Patch Manager to take on patches included in the\n RejectedPackages list.
\n Linux and macOS: A package in the rejected patches list\n is installed only if it is a dependency of another package. It is considered compliant with\n the patch baseline, and its status is reported as INSTALLED_OTHER. This is the\n default action if no option is specified.
\n Windows Server: Windows Server doesn't support the\n concept of package dependencies. If a package in the rejected patches list and already\n installed on the node, its status is reported as INSTALLED_OTHER. Any package not\n already installed on the node is skipped. This is the default action if no option is\n specified.
\n All OSs: Packages in the rejected patches list, and\n packages that include them as dependencies, aren't installed by Patch Manager under any\n circumstances. If a package was installed before it was added to the rejected patches list, or\n is installed outside of Patch Manager afterward, it's considered noncompliant with the patch\n baseline and its status is reported as INSTALLED_REJECTED.
Provides information about one or more of your managed nodes, including the operating system\n platform, SSM Agent version, association status, and IP address. This operation does not return\n information for nodes that are either Stopped or Terminated.
\nIf you specify one or more node IDs, the operation returns information for those managed\n nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you\n specify a node ID that isn't valid or a node that you don't own, you receive an error.
\nThe IamRole field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation does not\n return the IAM role for EC2 instances.
Provides information about one or more of your managed nodes, including the operating system\n platform, SSM Agent version, association status, and IP address. This operation does not return\n information for nodes that are either Stopped or Terminated.
\nIf you specify one or more node IDs, the operation returns information for those managed\n nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you\n specify a node ID that isn't valid or a node that you don't own, you receive an error.
\nThe IamRole field returned for this API operation is the role assigned to an\n Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or\n the role assigned to an on-premises managed node.
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
", + "smithy.api#documentation": "An API operation used by the Systems Manager console to display information about Systems Manager managed\n nodes.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9138,7 +9138,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#DescribeInstancePropertiesMaxResults", "traits": { - "smithy.api#documentation": "The maximum number of items to return for the call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" + "smithy.api#documentation": "The maximum number of items to return for the call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, "NextToken": { @@ -9164,7 +9164,7 @@ "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { - "smithy.api#documentation": "The token for the next set of properties to return. Use this token to get the next set of\n results.
" + "smithy.api#documentation": "The token for the next set of properties to return. Use this token to get the next set of\n results.
" } } }, @@ -10323,7 +10323,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the properties of available patches organized by product, product family,\n classification, severity, and other properties of available patches. You can use the reported\n properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
\nThe following section lists the properties that can be used in filters for each major\n operating system type:
\nValid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | PRIORITY\n
Valid properties: PRODUCT | CLASSIFICATION\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | PRIORITY\n
Valid properties: PRODUCT | PRODUCT_FAMILY |\n CLASSIFICATION | MSRC_SEVERITY\n
Lists the properties of available patches organized by product, product family,\n classification, severity, and other properties of available patches. You can use the reported\n properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
\nThe following section lists the properties that can be used in filters for each major\n operating system type:
\nValid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | PRIORITY\n
Valid properties: PRODUCT | CLASSIFICATION\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | CLASSIFICATION |\n SEVERITY\n
Valid properties: PRODUCT | PRIORITY\n
Valid properties: PRODUCT | PRODUCT_FAMILY |\n CLASSIFICATION | MSRC_SEVERITY\n
Returns detailed information about command execution for an invocation or plugin.
\n\n GetCommandInvocation only gives the execution status of a plugin in a document.\n To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes,\n use ListCommands.
Returns detailed information about command execution for an invocation or plugin. The Run\n Command API follows an eventual consistency model, due to the distributed nature of the system\n supporting the API. This means that the result of an API command you run that affects your\n resources might not be immediately visible to all subsequent commands you run. You should keep\n this in mind when you carry out an API command that immediately follows a previous API\n command.
\n\n GetCommandInvocation only gives the execution status of a plugin in a document.\n To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes,\n use ListCommands.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service \n(Amazon SNS) notifications for maintenance window Run Command tasks.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for\n Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a\n service role ARN, Systems Manager uses a service-linked role in your account. If no\n appropriate service-linked role for Systems Manager exists in your account, it is created when\n you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom\n policy and custom service role for running your maintenance window tasks. The policy\n can be crafted to provide only the permissions needed for your particular\n maintenance window tasks. For more information, see Setting up maintenance windows in the in the\n Amazon Web Services Systems Manager User Guide.
" } }, "TaskType": { @@ -14797,7 +14797,7 @@ "IamRole": { "target": "com.amazonaws.ssm#IamRole", "traits": { - "smithy.api#documentation": "The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager\n managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud\n (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use\n the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.
The role assigned to an Amazon EC2 instance configured with a Systems Manager\n Quick Setup host management configuration or the role assigned to an on-premises managed\n node.
\n This call doesn't return the IAM role for unmanaged\n Amazon EC2 instances (instances not configured for Systems Manager). To retrieve the\n role for an unmanaged instance, use the Amazon EC2 DescribeInstances operation. For\n information, see DescribeInstances in the\n Amazon EC2 API Reference or describe-instances in the\n Amazon Web Services CLI Command Reference.
The value of the EC2 Name tag associated with the node. If a Name tag hasn't been applied to the node, this value is blank.
The value of the EC2 Name tag associated with the node. If a Name\n tag hasn't been applied to the node, this value is blank.
The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.
" + "smithy.api#documentation": "The instance profile attached to the node. If an instance profile isn't attached to the\n node, this value is blank.
" } }, "KeyName": { "target": "com.amazonaws.ssm#KeyName", "traits": { - "smithy.api#documentation": "The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.
" + "smithy.api#documentation": "The name of the key pair associated with the node. If a key pair isnt't associated with the\n node, this value is blank.
" } }, "InstanceState": { @@ -15365,13 +15365,13 @@ "Architecture": { "target": "com.amazonaws.ssm#Architecture", "traits": { - "smithy.api#documentation": "The CPU architecture of the node. For example, x86_64.
" + "smithy.api#documentation": "The CPU architecture of the node. For example, x86_64.
The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.
" + "smithy.api#documentation": "The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the\n node, this value is blank.
" } }, "LaunchTime": { @@ -15419,13 +15419,13 @@ "ActivationId": { "target": "com.amazonaws.ssm#ActivationId", "traits": { - "smithy.api#documentation": "The activation ID created by Systems Manager when the server or virtual machine (VM) was registered
" + "smithy.api#documentation": "The activation ID created by Systems Manager when the server or virtual machine (VM) was\n registered
" } }, "IamRole": { "target": "com.amazonaws.ssm#IamRole", "traits": { - "smithy.api#documentation": "The IAM role used in the hybrid activation to register the node with Systems Manager.
" + "smithy.api#documentation": "The IAM role used in the hybrid activation to register the node with\n Systems Manager.
" } }, "RegistrationDate": { @@ -15503,7 +15503,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.
" + "smithy.api#documentation": "Describes a filter for a specific list of managed nodes. You can filter node information by\n using tags. You specify tags by using a key-value mapping.
" } }, "com.amazonaws.ssm#InstancePropertyFilterKey": { @@ -19516,7 +19516,7 @@ "ServiceRoleArn": { "target": "com.amazonaws.ssm#ServiceRole", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service \n(Amazon SNS) notifications for maintenance window Run Command tasks.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for\n Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a\n service role ARN, Systems Manager uses a service-linked role in your account. If no\n appropriate service-linked role for Systems Manager exists in your account, it is created when\n you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom\n policy and custom service role for running your maintenance window tasks. The policy\n can be crafted to provide only the permissions needed for your particular\n maintenance window tasks. For more information, see Setting up maintenance windows in the in the\n Amazon Web Services Systems Manager User Guide.
" } }, "TimeoutSeconds": { @@ -19710,7 +19710,7 @@ "ServiceRoleArn": { "target": "com.amazonaws.ssm#ServiceRole", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service \n(Amazon SNS) notifications for maintenance window Run Command tasks.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for\n Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a\n service role ARN, Systems Manager uses a service-linked role in your account. If no\n appropriate service-linked role for Systems Manager exists in your account, it is created when\n you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom\n policy and custom service role for running your maintenance window tasks. The policy\n can be crafted to provide only the permissions needed for your particular\n maintenance window tasks. For more information, see Setting up maintenance windows in the in the\n Amazon Web Services Systems Manager User Guide.
" } }, "MaxConcurrency": { @@ -23262,7 +23262,7 @@ "target": "com.amazonaws.ssm#DefaultBaseline", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether this is the default baseline. Amazon Web Services Systems Manager supports creating multiple default patch\n baselines. For example, you can create a default patch baseline for each operating system.
" + "smithy.api#documentation": "Indicates whether this is the default baseline. Amazon Web Services Systems Manager supports creating multiple default\n patch baselines. For example, you can create a default patch baseline for each operating\n system.
" } } }, @@ -23997,13 +23997,13 @@ "target": "com.amazonaws.ssm#ApproveAfterDays", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The number of days after the release date of each patch matched by the rule that the patch\n is marked as approved in the patch baseline. For example, a value of 7 means that\n patches are approved seven days after they are released. Not supported on Debian Server or Ubuntu\n Server.
The number of days after the release date of each patch matched by the rule that the patch\n is marked as approved in the patch baseline. For example, a value of 7 means that\n patches are approved seven days after they are released.
This parameter is marked as not required, but your request must include a value\n for either ApproveAfterDays or ApproveUntilDate.
Not supported for Debian Server or Ubuntu Server.
" } }, "ApproveUntilDate": { "target": "com.amazonaws.ssm#PatchStringDateTime", "traits": { - "smithy.api#documentation": "The cutoff date for auto approval of released patches. Any patches released on or before\n this date are installed automatically. Not supported on Debian Server or Ubuntu Server.
\nEnter dates in the format YYYY-MM-DD. For example,\n 2021-12-31.
The cutoff date for auto approval of released patches. Any patches released on or before\n this date are installed automatically.
\nEnter dates in the format YYYY-MM-DD. For example,\n 2021-12-31.
This parameter is marked as not required, but your request must include a value\n for either ApproveUntilDate or ApproveAfterDays.
Not supported for Debian Server or Ubuntu Server.
" } }, "EnableNonSecurity": { @@ -29792,7 +29792,7 @@ "ServiceRoleArn": { "target": "com.amazonaws.ssm#ServiceRole", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service \n(Amazon SNS) notifications for maintenance window Run Command tasks.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for\n Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a\n service role ARN, Systems Manager uses a service-linked role in your account. If no\n appropriate service-linked role for Systems Manager exists in your account, it is created when\n you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom\n policy and custom service role for running your maintenance window tasks. The policy\n can be crafted to provide only the permissions needed for your particular\n maintenance window tasks. For more information, see Setting up maintenance windows in the in the\n Amazon Web Services Systems Manager User Guide.
" } }, "TaskParameters": { @@ -30203,7 +30203,7 @@ "RejectedPatchesAction": { "target": "com.amazonaws.ssm#PatchAction", "traits": { - "smithy.api#documentation": "The action for Patch Manager to take on patches included in the\n RejectedPackages list.
\n \n ALLOW_AS_DEPENDENCY\n : A package in the\n Rejected patches list is installed only if it is a dependency of another package.\n It is considered compliant with the patch baseline, and its status is reported as\n InstalledOther. This is the default action if no option is specified.
\n BLOCK: Packages in the Rejected\n patches list, and packages that include them as dependencies, aren't installed by\n Patch Manager under any circumstances. If a package was installed before it was added to the\n Rejected patches list, or is installed outside of Patch\n Manager afterward, it's considered noncompliant with the patch baseline and its status is\n reported as InstalledRejected.
\nThe action for Patch Manager to take on patches included in the\n RejectedPackages list.
\n Linux and macOS: A package in the rejected patches list\n is installed only if it is a dependency of another package. It is considered compliant with\n the patch baseline, and its status is reported as INSTALLED_OTHER. This is the\n default action if no option is specified.
\n Windows Server: Windows Server doesn't support the\n concept of package dependencies. If a package in the rejected patches list and already\n installed on the node, its status is reported as INSTALLED_OTHER. Any package not\n already installed on the node is skipped. This is the default action if no option is\n specified.
\n All OSs: Packages in the rejected patches list, and\n packages that include them as dependencies, aren't installed by Patch Manager under any\n circumstances. If a package was installed before it was added to the rejected patches list, or\n is installed outside of Patch Manager afterward, it's considered noncompliant with the patch\n baseline and its status is reported as INSTALLED_REJECTED.