Rust
Rust
Amazon Cognito - Describe User Pool
See more Amazon Cognito Examples
Returns the configuration information and metadata of the specified user pool.Chilkat Rust Downloads
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let rest = chilkat::Rest::new();
let auth_aws = chilkat::AuthAws::new();
auth_aws.set_access_key("AWS_ACCESS_KEY");
auth_aws.set_secret_key("AWS_SECRET_KEY");
// Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
auth_aws.set_region("us-west-2");
auth_aws.set_service_name("cognito-idp");
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
let _ = rest.set_auth_aws(&auth_aws);
// URL: https://cognito-idp.us-west-2.amazonaws.com/
let b_tls = true;
let port = 443;
let b_auto_reconnect = true;
// Use the same region as specified above.
if rest.connect("cognito-idp.us-west-2.amazonaws.com", port, b_tls, b_auto_reconnect).is_err() {
println!("ConnectFailReason: {}", rest.connect_fail_reason());
println!("{}", rest.last_error_text());
return;
}
// Note: The above code does not need to be repeatedly called for each REST request.
// The rest object can be setup once, and then many requests can be sent. Chilkat will automatically
// reconnect within a FullRequest* method as needed. It is only the very first connection that is explicitly
// made via the Connect method.
let json = chilkat::JsonObject::new();
let _ = json.update_string("UserPoolId", "us-west-2_yt6WzO3SA");
let _ = rest.add_header("Content-Type", "application/x-amz-json-1.0");
let _ = rest.add_header("X-Amz-Target", "AWSCognitoIdentityProviderService.DescribeUserPool");
let _ = rest.add_header("Accept-Encoding", "identity");
let sb_request_body = chilkat::StringBuilder::new();
let _ = json.emit_sb(&sb_request_body);
let sb_response_body = chilkat::StringBuilder::new();
if rest.full_request_sb("POST", "/", &sb_request_body, &sb_response_body).is_err() {
println!("{}", rest.last_error_text());
return;
}
let resp_status_code = rest.response_status_code();
println!("response status code = {}", resp_status_code);
if resp_status_code != 200 {
println!("Response Status Code = {}", resp_status_code);
println!("Response Header:");
println!("{}", rest.response_header());
println!("Response Body:");
println!("{}", sb_response_body.get_as_string().unwrap_or_default());
return;
}
let json_response = chilkat::JsonObject::new();
let _ = json_response.load_sb(&sb_response_body);
json_response.set_emit_compact(false);
println!("{}", json_response.emit().unwrap_or_default());
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
// {
// "UserPool": {
// "AccountRecoverySetting": {
// "RecoveryMechanisms": [
// {
// "Name": "verified_phone_number",
// "Priority": 1
// },
// {
// "Name": "verified_email",
// "Priority": 2
// }
// ]
// },
// "AdminCreateUserConfig": {
// "AllowAdminCreateUserOnly": false,
// "InviteMessageTemplate": {
// "EmailMessage": "Your username is {username} and temporary password is {####}. ",
// "EmailSubject": "Your temporary password",
// "SMSMessage": "Your username is {username} and temporary password is {####}. "
// },
// "UnusedAccountValidityDays": 7
// },
// "Arn": "arn:aws:cognito-idp:us-west-2:954491834127:userpool/us-west-2_yt6WzO3SA",
// "AutoVerifiedAttributes": [
// "email",
// "phone_number"
// ],
// "CreationDate": 1.636388909817E9,
// "EmailConfiguration": {
// "EmailSendingAccount": "DEVELOPER",
// "From": "admin@chilkatsoft.com",
// "ReplyToEmailAddress": "admin@chilkatsoft.com",
// "SourceArn": "arn:aws:ses:us-west-2:954491834127:identity/admin@chilkatsoft.com"
// },
// "EmailVerificationMessage": "Your verification code is {####}. ",
// "EmailVerificationSubject": "Your verification code",
// "EstimatedNumberOfUsers": 0,
// "Id": "us-west-2_yt6WzO3SA",
// "LambdaConfig": {},
// "LastModifiedDate": 1.636388910377E9,
// "MfaConfiguration": "ON",
// "Name": "chilkat",
// "Policies": {
// "PasswordPolicy": {
// "MinimumLength": 8,
// "RequireLowercase": true,
// "RequireNumbers": true,
// "RequireSymbols": true,
// "RequireUppercase": true,
// "TemporaryPasswordValidityDays": 7
// }
// },
// "SchemaAttributes": [
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": false,
// "Name": "sub",
// "Required": true,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "1"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "name",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "given_name",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "family_name",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "middle_name",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "nickname",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "preferred_username",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "profile",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "picture",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "website",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "email",
// "Required": true,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "Boolean",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "email_verified",
// "Required": false
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "gender",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "birthdate",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "10",
// "MinLength": "10"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "zoneinfo",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "locale",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "phone_number",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "Boolean",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "phone_number_verified",
// "Required": false
// },
// {
// "AttributeDataType": "String",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "address",
// "Required": false,
// "StringAttributeConstraints": {
// "MaxLength": "2048",
// "MinLength": "0"
// }
// },
// {
// "AttributeDataType": "Number",
// "DeveloperOnlyAttribute": false,
// "Mutable": true,
// "Name": "updated_at",
// "NumberAttributeConstraints": {
// "MinValue": "0"
// },
// "Required": false
// }
// ],
// "SmsAuthenticationMessage": "Your verification code is {####}. ",
// "SmsConfiguration": {
// "ExternalId": "94b17737-216b-4cf7-a29e-17e990e91300",
// "SnsCallerArn": "arn:aws:iam::954491834127:role/service-role/chilkat-SMS-Role"
// },
// "SmsVerificationMessage": "Your verification code is {####}. ",
// "UserPoolTags": {
// "sampleUserPoolTag": "test"
// },
// "UsernameConfiguration": {
// "CaseSensitive": false
// },
// "VerificationMessageTemplate": {
// "DefaultEmailOption": "CONFIRM_WITH_CODE",
// "EmailMessage": "Your verification code is {####}. ",
// "EmailSubject": "Your verification code",
// "SmsMessage": "Your verification code is {####}. "
// }
// }
// }
let user_pool_admin_create_user_config_allow_admin_create_user_only = json_response.bool_of("UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly");
let user_pool_admin_create_user_config_invite_message_template_email_message = json_response.string_of("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage").unwrap_or_default();
let user_pool_admin_create_user_config_invite_message_template_email_subject = json_response.string_of("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject").unwrap_or_default();
let user_pool_admin_create_user_config_invite_message_template_sms_message = json_response.string_of("UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage").unwrap_or_default();
let user_pool_admin_create_user_config_unused_account_validity_days = json_response.int_of("UserPool.AdminCreateUserConfig.UnusedAccountValidityDays");
let user_pool_arn = json_response.string_of("UserPool.Arn").unwrap_or_default();
let user_pool_creation_date = json_response.string_of("UserPool.CreationDate").unwrap_or_default();
let user_pool_email_configuration_email_sending_account = json_response.string_of("UserPool.EmailConfiguration.EmailSendingAccount").unwrap_or_default();
let user_pool_email_configuration_from = json_response.string_of("UserPool.EmailConfiguration.From").unwrap_or_default();
let user_pool_email_configuration_reply_to_email_address = json_response.string_of("UserPool.EmailConfiguration.ReplyToEmailAddress").unwrap_or_default();
let user_pool_email_configuration_source_arn = json_response.string_of("UserPool.EmailConfiguration.SourceArn").unwrap_or_default();
let user_pool_email_verification_message = json_response.string_of("UserPool.EmailVerificationMessage").unwrap_or_default();
let user_pool_email_verification_subject = json_response.string_of("UserPool.EmailVerificationSubject").unwrap_or_default();
let user_pool_estimated_number_of_users = json_response.int_of("UserPool.EstimatedNumberOfUsers");
let user_pool_id = json_response.string_of("UserPool.Id").unwrap_or_default();
let user_pool_last_modified_date = json_response.string_of("UserPool.LastModifiedDate").unwrap_or_default();
let user_pool_mfa_configuration = json_response.string_of("UserPool.MfaConfiguration").unwrap_or_default();
let user_pool_name = json_response.string_of("UserPool.Name").unwrap_or_default();
let user_pool_policies_password_policy_minimum_length = json_response.int_of("UserPool.Policies.PasswordPolicy.MinimumLength");
let user_pool_policies_password_policy_require_lowercase = json_response.bool_of("UserPool.Policies.PasswordPolicy.RequireLowercase");
let user_pool_policies_password_policy_require_numbers = json_response.bool_of("UserPool.Policies.PasswordPolicy.RequireNumbers");
let user_pool_policies_password_policy_require_symbols = json_response.bool_of("UserPool.Policies.PasswordPolicy.RequireSymbols");
let user_pool_policies_password_policy_require_uppercase = json_response.bool_of("UserPool.Policies.PasswordPolicy.RequireUppercase");
let user_pool_policies_password_policy_temporary_password_validity_days = json_response.int_of("UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays");
let user_pool_sms_authentication_message = json_response.string_of("UserPool.SmsAuthenticationMessage").unwrap_or_default();
let user_pool_sms_configuration_external_id = json_response.string_of("UserPool.SmsConfiguration.ExternalId").unwrap_or_default();
let user_pool_sms_configuration_sns_caller_arn = json_response.string_of("UserPool.SmsConfiguration.SnsCallerArn").unwrap_or_default();
let user_pool_sms_verification_message = json_response.string_of("UserPool.SmsVerificationMessage").unwrap_or_default();
let user_pool_user_pool_tags_sample_user_pool_tag = json_response.string_of("UserPool.UserPoolTags.sampleUserPoolTag").unwrap_or_default();
let user_pool_username_configuration_case_sensitive = json_response.bool_of("UserPool.UsernameConfiguration.CaseSensitive");
let user_pool_verification_message_template_default_email_option = json_response.string_of("UserPool.VerificationMessageTemplate.DefaultEmailOption").unwrap_or_default();
let user_pool_verification_message_template_email_message = json_response.string_of("UserPool.VerificationMessageTemplate.EmailMessage").unwrap_or_default();
let user_pool_verification_message_template_email_subject = json_response.string_of("UserPool.VerificationMessageTemplate.EmailSubject").unwrap_or_default();
let user_pool_verification_message_template_sms_message = json_response.string_of("UserPool.VerificationMessageTemplate.SmsMessage").unwrap_or_default();
let mut i = 0;
let mut count_i = json_response.size_of_array("UserPool.AccountRecoverySetting.RecoveryMechanisms");
while i < count_i {
json_response.set_i(i);
let _ = json_response.string_of("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Name").unwrap_or_default();
let _ = json_response.int_of("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Priority");
i = i + 1;
}
i = 0;
count_i = json_response.size_of_array("UserPool.AutoVerifiedAttributes");
while i < count_i {
json_response.set_i(i);
let _ = json_response.string_of("UserPool.AutoVerifiedAttributes[i]").unwrap_or_default();
i = i + 1;
}
i = 0;
count_i = json_response.size_of_array("UserPool.SchemaAttributes");
while i < count_i {
json_response.set_i(i);
let _ = json_response.string_of("UserPool.SchemaAttributes[i].AttributeDataType").unwrap_or_default();
let _ = json_response.bool_of("UserPool.SchemaAttributes[i].DeveloperOnlyAttribute");
let _ = json_response.bool_of("UserPool.SchemaAttributes[i].Mutable");
let _ = json_response.string_of("UserPool.SchemaAttributes[i].Name").unwrap_or_default();
let _ = json_response.bool_of("UserPool.SchemaAttributes[i].Required");
let _ = json_response.string_of("UserPool.SchemaAttributes[i].StringAttributeConstraints.MaxLength").unwrap_or_default();
let _ = json_response.string_of("UserPool.SchemaAttributes[i].StringAttributeConstraints.MinLength").unwrap_or_default();
let _ = json_response.string_of("UserPool.SchemaAttributes[i].NumberAttributeConstraints.MinValue").unwrap_or_default();
i = i + 1;
}