Ejemplos de Amazon Cognito Identity Provider que utilizan AWS CLI - AWS Command Line Interface
Acciones

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ejemplos de Amazon Cognito Identity Provider que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el AWS Command Line Interface uso de Amazon Cognito Identity Provider.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

En el siguiente ejemplo de código, se muestra cómo usar add-custom-attributes.

AWS CLI

Para añadir un atributo personalizado

En este ejemplo, se agrega un atributo personalizado CustomAttr 1 a un grupo de usuarios. Es de tipo String y requiere un mínimo de 1 carácter y un máximo de 15. No es obligatorio.

Comando:

aws cognito-idp add-custom-attributes --user-pool-id us-west-2_aaaaaaaaa --custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}"

  • Para API obtener más información, consulte AddCustomAttributesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admim-disable-user.

AWS CLI

Para deshabilitar a un usuario

En este ejemplo, se deshabilita al usuario jane@example.com.

Comando:

aws cognito-idp admin-disable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

  • Para API obtener más información, consulte AdmimDisableUserla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admim-enable-user.

AWS CLI

Para habilitar un usuario

Este ejemplo habilita el nombre de usuario jane@example.com.

Comando:

aws cognito-idp admin-enable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

  • Para API obtener más información, consulte AdmimEnableUserla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-add-user-to-group.

AWS CLI

Para añadir un usuario a un grupo

En este ejemplo, se agrega la usuaria Jane al grupo MyGroup.

Comando:

aws cognito-idp admin-add-user-to-group --user-pool-id us-west-2_aaaaaaaaa --username Jane --group-name MyGroup

  • Para API obtener más información, consulte AdminAddUserToGroupla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-confirm-sign-up.

AWS CLI

Para confirmar el registro del usuario

Este ejemplo confirma al usuario jane@example.com.

Comando:

aws cognito-idp admin-confirm-sign-up --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

  • Para API obtener más información, consulte AdminConfirmSignUpla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-create-user.

AWS CLI

Para crear un usuario

En el siguiente admin-create-user ejemplo, se crea un usuario con la dirección de correo electrónico y el número de teléfono especificados.

aws cognito-idp admin-create-user \
    --user-pool-id us-west-2_aaaaaaaaa \
    --username diego \
    --user-attributes Name=email,Value=diego@example.com Name=phone_number,Value="+15555551212" \
    --message-action SUPPRESS

Salida:

{
    "User": {
        "Username": "diego",
        "Attributes": [
            {
                "Name": "sub",
                "Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2"
            },
            {
                "Name": "phone_number",
                "Value": "+15555551212"
            },
            {
                "Name": "email",
                "Value": "diego@example.com"
            }
        ],
        "UserCreateDate": 1548099495.428,
        "UserLastModifiedDate": 1548099495.428,
        "Enabled": true,
        "UserStatus": "FORCE_CHANGE_PASSWORD"
    }
}

  • Para API obtener más información, consulte AdminCreateUserla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-delete-user-attributes.

AWS CLI

Para eliminar un atributo de usuario

En este ejemplo, se elimina un atributo personalizado CustomAttr 1 para el usuario diego@example.com.

Comando:

aws cognito-idp admin-delete-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attribute-names "custom:CustomAttr1"

En el siguiente ejemplo de código, se muestra cómo usar admin-delete-user.

AWS CLI

Para eliminar un usuario

En este ejemplo se elimina un usuario.

Comando:

aws cognito-idp admin-delete-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com

  • Para API obtener más información, consulte AdminDeleteUserla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-forget-device.

AWS CLI

Para olvidar un dispositivo

En este ejemplo se olvida el nombre de usuario jane@example.com

Comando:

aws cognito-idp admin-forget-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678

  • Para API obtener más información, consulte AdminForgetDevicela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-get-device.

AWS CLI

Para obtener un dispositivo

En este ejemplo se obtiene un dispositivo con el nombre de usuario jane@example.com

Comando:

aws cognito-idp admin-get-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678

  • Para API obtener más información, consulte AdminGetDevicela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-get-user.

AWS CLI

Para obtener un usuario

En este ejemplo se obtiene información sobre el nombre de usuario jane@example.com.

Comando:

aws cognito-idp admin-get-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

Salida:

{
  "Username": "4320de44-2322-4620-999b-5e2e1c8df013",
  "Enabled": true,
  "UserStatus": "FORCE_CHANGE_PASSWORD",
  "UserCreateDate": 1548108509.537,
  "UserAttributes": [
      {
          "Name": "sub",
          "Value": "4320de44-2322-4620-999b-5e2e1c8df013"
      },
      {
          "Name": "email_verified",
          "Value": "true"
      },
      {
          "Name": "phone_number_verified",
          "Value": "true"
      },
      {
          "Name": "phone_number",
          "Value": "+01115551212"
      },
      {
          "Name": "email",
          "Value": "jane@example.com"
      }
  ],
  "UserLastModifiedDate": 1548108509.537
}

  • Para API obtener más información, consulte AdminGetUserla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-initiate-auth.

AWS CLI

Para iniciar la autorización

En este ejemplo, se inicia la autorización mediante el AUTH flujo ADMIN _NO_ SRP _ para el nombre de usuario jane@example.com

El cliente debe tener habilitado el inicio de sesión API para la autenticación basada en servidor (ADMIN_NO_ _). SRP AUTH

Use la información de la sesión en el valor devuelto para llamar a -challenge. admin-respond-to-auth

Comando:

aws cognito-idp admin-initiate-auth --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --auth-flow ADMIN_NO_SRP_AUTH --auth-parameters USERNAME=jane@example.com,PASSWORD=password

Salida:

{
  "ChallengeName": "NEW_PASSWORD_REQUIRED",
  "Session": "SESSION",
  "ChallengeParameters": {
      "USER_ID_FOR_SRP": "84514837-dcbc-4af1-abff-f3c109334894",
      "requiredAttributes": "[]",
      "userAttributes": "{\"email_verified\":\"true\",\"phone_number_verified\":\"true\",\"phone_number\":\"+01xxx5550100\",\"email\":\"jane@example.com\"}"
  }
}

  • Para API obtener más información, consulte AdminInitiateAuthla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-list-devices.

AWS CLI

Para enumerar los dispositivos de un usuario

En este ejemplo, se enumeran los dispositivos con el nombre de usuario jane@example.com.

Comando:

aws cognito-idp admin-list-devices --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

  • Para API obtener más información, consulte AdminListDevicesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-list-groups-for-user.

AWS CLI

Para enumerar los grupos de un usuario

En este ejemplo, se muestran los grupos del nombre de usuario jane@example.com.

Comando:

aws cognito-idp admin-list-groups-for-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com

Salida:

{
  "Groups": [
      {
          "Description": "Sample group",
          "Precedence": 1,
          "LastModifiedDate": 1548097827.125,
          "RoleArn": "arn:aws:iam::111111111111:role/SampleRole",
          "GroupName": "SampleGroup",
          "UserPoolId": "us-west-2_aaaaaaaaa",
          "CreationDate": 1548097827.125
      }
  ]
}

En el siguiente ejemplo de código, se muestra cómo usar admin-list-user-auth-events.

AWS CLI

Para enumerar los eventos de autorización de un usuario

En este ejemplo, se enumeran los eventos de autorización del nombre de usuario diego@example.com.

Comando:

aws cognito-idp admin-list-user-auth-events --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com

En el siguiente ejemplo de código, se muestra cómo usar admin-remove-user-from-group.

AWS CLI

Para eliminar un usuario de un grupo

En este ejemplo, se elimina jane@example.com de SampleGroup.

Comando:

aws cognito-idp admin-remove-user-from-group --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --group-name SampleGroup

En el siguiente ejemplo de código, se muestra cómo usar admin-reset-user-password.

AWS CLI

Para restablecer una contraseña de usuario

En este ejemplo se restablece la contraseña de diego@example.com.

Comando:

aws cognito-idp admin-reset-user-password --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com

En el siguiente ejemplo de código, se muestra cómo usar admin-set-user-mfa-preference.

AWS CLI

Para establecer las MFA preferencias del usuario

En este ejemplo se establece la SMS MFA preferencia del nombre de usuario diego@example.com.

Comando:

aws cognito-idp admin-set-user-mfa-preference --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --sms-mfa-settings Enabled=false,PreferredMfa=false

En el siguiente ejemplo de código, se muestra cómo usar admin-set-user-settings.

AWS CLI

Para establecer la configuración de usuario

En este ejemplo, se establece la preferencia de MFA entrega del nombre de usuario diego@example.com enEMAIL.

Comando:

aws cognito-idp admin-set-user-settings --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --mfa-options DeliveryMedium=EMAIL

  • Para API obtener más información, consulte AdminSetUserSettingsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar admin-update-auth-event-feedback.

AWS CLI

Para enviar comentarios sobre un evento de autorización

En este ejemplo, se establece el valor de los comentarios para un evento de autorización identificado por el identificador del evento en Valid.

Comando:

aws cognito-idp admin-update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id c2c2cf89-c0d3-482d-aba6-99d78a5b0bfe --feedback-value Valid

En el siguiente ejemplo de código, se muestra cómo usar admin-update-device-status.

AWS CLI

Para actualizar el estado del dispositivo

En este ejemplo, se establece el estado de recuerdo del dispositivo identificado por la clave del dispositivo en not_remember.

Comando:

aws cognito-idp admin-update-device-status --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --device-key xxxx  --device-remembered-status not_remembered

En el siguiente ejemplo de código, se muestra cómo usar admin-update-user-attributes.

AWS CLI

Para actualizar los atributos de usuario

En este ejemplo, se actualiza un atributo de usuario personalizado CustomAttr 1 para el usuario diego@example.com.

Comando:

aws cognito-idp admin-update-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attributes Name="custom:CustomAttr1",Value="Purple"

En el siguiente ejemplo de código, se muestra cómo usar change-password.

AWS CLI

Para cambiar una contraseña

En este ejemplo se cambia una contraseña.

Comando:

aws cognito-idp change-password --previous-password OldPassword --proposed-password NewPassword --access-token ACCESS_TOKEN

  • Para API obtener más información, consulte ChangePasswordla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar confirm-forgot-password.

AWS CLI

Para confirmar una contraseña olvidada

En este ejemplo se confirma una contraseña olvidada para el nombre de usuario diego@example.com.

Comando:

aws cognito-idp confirm-forgot-password --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --password PASSWORD --confirmation-code CONF_CODE

En el siguiente ejemplo de código, se muestra cómo usar confirm-sign-up.

AWS CLI

Para confirmar la inscripción

Este ejemplo confirma el registro del nombre de usuario diego@example.com.

Comando:

aws cognito-idp confirm-sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --confirmation-code CONF_CODE

  • Para API obtener más información, consulte ConfirmSignUpla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar create-group.

AWS CLI

Para crear un grupo

En este ejemplo se crea un grupo con una descripción.

Comando:

aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroup --description "New group."

Salida:

{
  "Group": {
      "GroupName": "MyNewGroup",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "Description": "New group.",
      "LastModifiedDate": 1548270073.795,
      "CreationDate": 1548270073.795
  }
}

Para crear un grupo con una función y una prioridad

En este ejemplo se crea un grupo con una descripción. También incluye una función y una prioridad.

Comando:

aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroupWithRole --description "New group with a role." --role-arn arn:aws:iam::111111111111:role/MyNewGroupRole --precedence 2

Salida:

{
  "Group": {
      "GroupName": "MyNewGroupWithRole",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "Description": "New group with a role.",
      "RoleArn": "arn:aws:iam::111111111111:role/MyNewGroupRole",
      "Precedence": 2,
      "LastModifiedDate": 1548270211.761,
      "CreationDate": 1548270211.761
  }
}

  • Para API obtener más información, consulte CreateGroupla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar create-user-import-job.

AWS CLI

Para crear un trabajo de importación de usuarios

En este ejemplo se crea un trabajo de importación de usuarios denominado MyImportJob.

Para obtener más información sobre la importación de usuarios, consulte Importación de usuarios a grupos de usuarios desde un CSV archivo.

Comando:

aws cognito-idp create-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-name MyImportJob --cloud-watch-logs-role-arn arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole

Salida:

{
  "UserImportJob": {
      "JobName": "MyImportJob",
      "JobId": "import-qQ0DCt2fRh",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "PreSignedUrl": "PRE_SIGNED_URL",
      "CreationDate": 1548271795.471,
      "Status": "Created",
      "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
      "ImportedUsers": 0,
      "SkippedUsers": 0,
      "FailedUsers": 0
  }
}

Cargue el archivo.csv con curl utilizando la siguiente información prefirmada: URL

Comando:

curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL"

  • Para API obtener más información, consulte la Referencia de CreateUserImportJobcomandos AWS CLI .

En el siguiente ejemplo de código, se muestra cómo usar create-user-pool-client.

AWS CLI

Para crear un cliente de grupo de usuarios

En este ejemplo, se crea un nuevo cliente de grupo de usuarios con dos flujos de autorización explícitos: USER _ PASSWORD _ AUTH y ADMIN _NO_ _SRP. AUTH

Comando:

aws cognito-idp create-user-pool-client --user-pool-id us-west-2_aaaaaaaaa  --client-name MyNewClient --no-generate-secret --explicit-auth-flows "USER_PASSWORD_AUTH" "ADMIN_NO_SRP_AUTH"

Salida:

{
  "UserPoolClient": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientName": "MyNewClient",
      "ClientId": "6p3bs000no6a4ue1idruvd05ad",
      "LastModifiedDate": 1548697449.497,
      "CreationDate": 1548697449.497,
      "RefreshTokenValidity": 30,
      "ExplicitAuthFlows": [
          "USER_PASSWORD_AUTH",
          "ADMIN_NO_SRP_AUTH"
      ],
      "AllowedOAuthFlowsUserPoolClient": false
  }
}

  • Para API obtener más información, consulte la Referencia CreateUserPoolClientde AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar create-user-pool-domain.

AWS CLI

Para crear un dominio de grupo de usuarios

En este ejemplo, se crea un nuevo dominio de grupo de usuarios con dos flujos de autorización explícitos: USER _ PASSWORD _ AUTH y ADMIN SRP _NO_ _. AUTH

Comando:

aws cognito-idp create-user-pool-domain --user-pool-id us-west-2_aaaaaaaaa  --domain my-new-domain

  • Para API obtener más información, consulte la Referencia de CreateUserPoolDomaincomandos AWS CLI .

En el siguiente ejemplo de código, se muestra cómo usar create-user-pool.

AWS CLI

Para crear un grupo de usuarios con una configuración mínima

En este ejemplo, se crea un grupo de usuarios denominado MyUserPool con los valores predeterminados. No se requieren atributos ni clientes de aplicación. MFAy la seguridad avanzada está deshabilitada.

Comando:

aws cognito-idp create-user-pool --pool-name MyUserPool

Salida:

{
  "UserPool": {
      "SchemaAttributes": [
          {
              "Name": "sub",
              "StringAttributeConstraints": {
                  "MinLength": "1",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": true,
              "AttributeDataType": "String",
              "Mutable": false
          },
          {
              "Name": "name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "given_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "family_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "middle_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "nickname",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "preferred_username",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "profile",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "picture",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "website",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "email",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "AttributeDataType": "Boolean",
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "Name": "email_verified",
              "Mutable": true
          },
          {
              "Name": "gender",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "birthdate",
              "StringAttributeConstraints": {
                  "MinLength": "10",
                  "MaxLength": "10"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "zoneinfo",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "locale",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "phone_number",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "AttributeDataType": "Boolean",
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "Name": "phone_number_verified",
              "Mutable": true
          },
          {
              "Name": "address",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "updated_at",
              "NumberAttributeConstraints": {
                  "MinValue": "0"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "Number",
              "Mutable": true
          }
      ],
      "MfaConfiguration": "OFF",
      "Name": "MyUserPool",
      "LastModifiedDate": 1547833345.777,
      "AdminCreateUserConfig": {
          "UnusedAccountValidityDays": 7,
          "AllowAdminCreateUserOnly": false
      },
      "EmailConfiguration": {},
      "Policies": {
          "PasswordPolicy": {
              "RequireLowercase": true,
              "RequireSymbols": true,
              "RequireNumbers": true,
              "MinimumLength": 8,
              "RequireUppercase": true
          }
      },
      "CreationDate": 1547833345.777,
      "EstimatedNumberOfUsers": 0,
      "Id": "us-west-2_aaaaaaaaa",
      "LambdaConfig": {}
  }
}

Creación de un grupo de usuarios con dos atributos obligatorios

En este ejemplo se crea un grupo de usuarios MyUserPool. El grupo está configurado para aceptar un correo electrónico como atributo de nombre de usuario. También establece la dirección de origen del correo electrónico en una dirección validada mediante Amazon Simple Email Service.

Comando:

aws cognito-idp create-user-pool --pool-name MyUserPool --username-attributes "email" --email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com"

Salida:

{
  "UserPool": {
      "SchemaAttributes": [
          {
              "Name": "sub",
              "StringAttributeConstraints": {
                  "MinLength": "1",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": true,
              "AttributeDataType": "String",
              "Mutable": false
          },
          {
              "Name": "name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "given_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "family_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "middle_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "nickname",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "preferred_username",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "profile",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "picture",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "website",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "email",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "AttributeDataType": "Boolean",
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "Name": "email_verified",
              "Mutable": true
          },
          {
              "Name": "gender",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "birthdate",
              "StringAttributeConstraints": {
                  "MinLength": "10",
                  "MaxLength": "10"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "zoneinfo",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "locale",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "phone_number",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "AttributeDataType": "Boolean",
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "Name": "phone_number_verified",
              "Mutable": true
          },
          {
              "Name": "address",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "updated_at",
              "NumberAttributeConstraints": {
                  "MinValue": "0"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "Number",
              "Mutable": true
          }
      ],
      "MfaConfiguration": "OFF",
      "Name": "MyUserPool",
      "LastModifiedDate": 1547837788.189,
      "AdminCreateUserConfig": {
          "UnusedAccountValidityDays": 7,
          "AllowAdminCreateUserOnly": false
      },
      "EmailConfiguration": {
          "ReplyToEmailAddress": "jane@example.com",
          "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/jane@example.com"
      },
      "Policies": {
          "PasswordPolicy": {
              "RequireLowercase": true,
              "RequireSymbols": true,
              "RequireNumbers": true,
              "MinimumLength": 8,
              "RequireUppercase": true
          }
      },
      "UsernameAttributes": [
          "email"
      ],
      "CreationDate": 1547837788.189,
      "EstimatedNumberOfUsers": 0,
      "Id": "us-west-2_aaaaaaaaa",
      "LambdaConfig": {}
  }
}

  • Para API obtener más información, consulte CreateUserPoolla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar delete-group.

AWS CLI

Para eliminar un grupo

En este ejemplo se elimina un grupo.

Comando:

aws cognito-idp delete-group --user-pool-id us-west-2_aaaaaaaaa  --group-name MyGroupName

  • Para API obtener más información, consulte DeleteGroupla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar delete-identity-provider.

AWS CLI

Para eliminar un proveedor de identidad

En este ejemplo, se elimina un proveedor de identidad.

Comando:

aws cognito-idp delete-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook

En el siguiente ejemplo de código, se muestra cómo usar delete-resource-server.

AWS CLI

Para eliminar un servidor de recursos

En este ejemplo, se elimina un servidor de recursos denominado weather.example.com.

Comando:

aws cognito-idp delete-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com

  • Para obtener API más información, consulte la Referencia de comandos DeleteResourceServer.AWS CLI

En el siguiente ejemplo de código, se muestra cómo usar delete-user-attributes.

AWS CLI

Para eliminar los atributos del usuario

En este ejemplo, se elimina el atributo de usuario "FAVORITE_ANIMAL».

Comando:

aws cognito-idp delete-user-attributes --access-token ACCESS_TOKEN --user-attribute-names "FAVORITE_ANIMAL"

  • Para API obtener más información, consulte DeleteUserAttributesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar delete-user-pool-client.

AWS CLI

Para eliminar un cliente de grupo de usuarios

En este ejemplo, se elimina un cliente de grupo de usuarios.

Comando:

aws cognito-idp delete-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0

  • Para API obtener más información, consulte DeleteUserPoolClientla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar delete-user-pool-domain.

AWS CLI

Para eliminar un dominio de grupo de usuarios

En el siguiente delete-user-pool-domain ejemplo, se elimina un dominio de grupo de usuarios denominado my-domain

aws cognito-idp delete-user-pool-domain \
    --user-pool-id us-west-2_aaaaaaaaa \
    --domain my-domain

  • Para API obtener más información, consulte DeleteUserPoolDomainla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar delete-user-pool.

AWS CLI

Para eliminar un grupo de usuarios

En este ejemplo, se elimina un grupo de usuarios mediante el identificador del grupo de usuarios, us-west-2_aaaaaaaaa.

Comando:

aws cognito-idp delete-user-pool --user-pool-id us-west-2_aaaaaaaaa

  • Para obtener más información, consulte la Referencia de comandos. API DeleteUserPoolAWS CLI

En el siguiente ejemplo de código, se muestra cómo usar delete-user.

AWS CLI

Para eliminar un usuario

En este ejemplo se elimina un usuario.

Comando:

aws cognito-idp delete-user --access-token ACCESS_TOKEN

  • Para API obtener más información, consulte DeleteUserla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar describe-identity-provider.

AWS CLI

Para describir un proveedor de identidad

En este ejemplo, se describe un proveedor de identidad denominado Facebook.

Comando:

aws cognito-idp describe-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook

Salida:

{
  "IdentityProvider": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ProviderName": "Facebook",
      "ProviderType": "Facebook",
      "ProviderDetails": {
          "attributes_url": "https://graph.facebook.com/me?fields=",
          "attributes_url_add_attributes": "true",
          "authorize_scopes": myscope",
          "authorize_url": "https://www.facebook.com/v2.9/dialog/oauth",
          "client_id": "11111",
          "client_secret": "11111",
          "token_request_method": "GET",
          "token_url": "https://graph.facebook.com/v2.9/oauth/access_token"
      },
      "AttributeMapping": {
          "username": "id"
      },
      "IdpIdentifiers": [],
      "LastModifiedDate": 1548105901.736,
      "CreationDate": 1548105901.736
  }
}

En el siguiente ejemplo de código, se muestra cómo usar describe-resource-server.

AWS CLI

Para describir un servidor de recursos

En este ejemplo se describe el servidor de recursos weather.example.com.

Comando:

aws cognito-idp describe-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com

Salida:

{
  "ResourceServer": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "Identifier": "weather.example.com",
      "Name": "Weather",
      "Scopes": [
          {
              "ScopeName": "weather.update",
              "ScopeDescription": "Update weather forecast"
          },
          {
              "ScopeName": "weather.read",
              "ScopeDescription": "Read weather forecasts"
          },
          {
              "ScopeName": "weather.delete",
              "ScopeDescription": "Delete a weather forecast"
          }
      ]
  }
}

En el siguiente ejemplo de código, se muestra cómo usar describe-risk-configuration.

AWS CLI

Para describir una configuración de riesgo

En este ejemplo se describe la configuración de riesgo asociada a la piscina us-west-2_aaaaaaaaa.

Comando:

aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa

Salida:

{
  "RiskConfiguration": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "CompromisedCredentialsRiskConfiguration": {
          "EventFilter": [
              "SIGN_IN",
              "SIGN_UP",
              "PASSWORD_CHANGE"
          ],
          "Actions": {
              "EventAction": "BLOCK"
          }
      },
      "AccountTakeoverRiskConfiguration": {
          "NotifyConfiguration": {
              "From": "diego@example.com",
              "ReplyTo": "diego@example.com",
              "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com",
              "BlockEmail": {
                  "Subject": "Blocked sign-in attempt",
                  "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
                  "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
              },
              "NoActionEmail": {
                  "Subject": "New sign-in attempt",
                  "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
                  "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
              },
              "MfaEmail": {
                  "Subject": "New sign-in attempt",
                  "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
                  "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
              }
          },
          "Actions": {
              "LowAction": {
                  "Notify": true,
                  "EventAction": "NO_ACTION"
              },
              "MediumAction": {
                  "Notify": true,
                  "EventAction": "MFA_IF_CONFIGURED"
              },
              "HighAction": {
                  "Notify": true,
                  "EventAction": "MFA_IF_CONFIGURED"
              }
          }
      }
  }
}

En el siguiente ejemplo de código, se muestra cómo usar describe-user-import-job.

AWS CLI

Para describir un trabajo de importación de usuarios

En este ejemplo se describe un trabajo de entrada de usuario.

Para obtener más información sobre la importación de usuarios, consulte Importación de usuarios a grupos de usuarios desde un CSV archivo.

Comando:

aws cognito-idp describe-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW

Salida:

{
  "UserImportJob": {
      "JobName": "import-Test1",
      "JobId": "import-TZqNQvDRnW",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "PreSignedUrl": "PRE_SIGNED URL",
      "CreationDate": 1548271708.512,
      "Status": "Created",
      "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
      "ImportedUsers": 0,
      "SkippedUsers": 0,
      "FailedUsers": 0
  }
}

En el siguiente ejemplo de código, se muestra cómo usar describe-user-pool-client.

AWS CLI

Para describir un cliente de grupo de usuarios

En este ejemplo se describe un cliente de grupo de usuarios.

Comando:

aws cognito-idp describe-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0

Salida:

{
  "UserPoolClient": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientName": "MyApp",
      "ClientId": "38fjsnc484p94kpqsnet7mpld0",
      "ClientSecret": "CLIENT_SECRET",
      "LastModifiedDate": 1548108676.163,
      "CreationDate": 1548108676.163,
      "RefreshTokenValidity": 30,
      "ReadAttributes": [
          "address",
          "birthdate",
          "custom:CustomAttr1",
          "custom:CustomAttr2",
          "email",
          "email_verified",
          "family_name",
          "gender",
          "given_name",
          "locale",
          "middle_name",
          "name",
          "nickname",
          "phone_number",
          "phone_number_verified",
          "picture",
          "preferred_username",
          "profile",
          "updated_at",
          "website",
          "zoneinfo"
      ],
      "WriteAttributes": [
          "address",
          "birthdate",
          "custom:CustomAttr1",
          "custom:CustomAttr2",
          "email",
          "family_name",
          "gender",
          "given_name",
          "locale",
          "middle_name",
          "name",
          "nickname",
          "phone_number",
          "picture",
          "preferred_username",
          "profile",
          "updated_at",
          "website",
          "zoneinfo"
      ],
      "ExplicitAuthFlows": [
          "ADMIN_NO_SRP_AUTH",
          "USER_PASSWORD_AUTH"
      ],
      "AllowedOAuthFlowsUserPoolClient": false
  }
}

En el siguiente ejemplo de código, se muestra cómo usar describe-user-pool-domain.

AWS CLI

Para describir un cliente de grupo de usuarios

En este ejemplo, se describe un dominio de grupo de usuarios denominado my-domain.

Comando:

aws cognito-idp describe-user-pool-domain --domain my-domain

Salida:

{
  "DomainDescription": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "AWSAccountId": "111111111111",
      "Domain": "my-domain",
      "S3Bucket": "aws-cognito-prod-pdx-assets",
      "CloudFrontDistribution": "aaaaaaaaaaaaa.cloudfront.net",
      "Version": "20190128175402",
      "Status": "ACTIVE",
      "CustomDomainConfig": {}
  }
}

En el siguiente ejemplo de código, se muestra cómo usar describe-user-pool.

AWS CLI

Para describir un grupo de usuarios

En este ejemplo se describe un grupo de usuarios con el identificador de grupo de usuarios us-west-2_aaaaaaaaa.

Comando:

aws cognito-idp describe-user-pool --user-pool-id us-west-2_aaaaaaaaa

Salida:

{
  "UserPool": {
      "SmsVerificationMessage": "Your verification code is {####}. ",
      "SchemaAttributes": [
          {
              "Name": "sub",
              "StringAttributeConstraints": {
                  "MinLength": "1",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": true,
              "AttributeDataType": "String",
              "Mutable": false
          },
          {
              "Name": "name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "given_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "family_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "middle_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "nickname",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "preferred_username",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "profile",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "picture",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "website",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "email",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": true,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "AttributeDataType": "Boolean",
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "Name": "email_verified",
              "Mutable": true
          },
          {
              "Name": "gender",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "birthdate",
              "StringAttributeConstraints": {
                  "MinLength": "10",
                  "MaxLength": "10"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "zoneinfo",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "locale",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "phone_number",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "AttributeDataType": "Boolean",
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "Name": "phone_number_verified",
              "Mutable": true
          },
          {
              "Name": "address",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "updated_at",
              "NumberAttributeConstraints": {
                  "MinValue": "0"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "Number",
              "Mutable": true
          }
      ],
      "EmailVerificationSubject": "Your verification code",
      "MfaConfiguration": "OFF",
      "Name": "MyUserPool",
      "EmailVerificationMessage": "Your verification code is {####}. ",
      "SmsAuthenticationMessage": "Your authentication code is {####}. ",
      "LastModifiedDate": 1547763720.822,
      "AdminCreateUserConfig": {
          "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,
          "AllowAdminCreateUserOnly": false
      },
      "EmailConfiguration": {
          "ReplyToEmailAddress": "myemail@mydomain.com"
          "SourceArn": "arn:aws:ses:us-east-1:000000000000:identity/myemail@mydomain.com"
      },
      "AutoVerifiedAttributes": [
          "email"
      ],
      "Policies": {
          "PasswordPolicy": {
              "RequireLowercase": true,
              "RequireSymbols": true,
              "RequireNumbers": true,
              "MinimumLength": 8,
              "RequireUppercase": true
          }
      },
      "UserPoolTags": {},
      "UsernameAttributes": [
          "email"
      ],
      "CreationDate": 1547763720.822,
      "EstimatedNumberOfUsers": 1,
      "Id": "us-west-2_aaaaaaaaa",
      "LambdaConfig": {}
  }
}

  • Para API obtener más información, consulte la Referencia de comandos. DescribeUserPoolAWS CLI

En el siguiente ejemplo de código, se muestra cómo usar forget-device.

AWS CLI

Para olvidar un dispositivo

En este ejemplo se olvida de un dispositivo por otro.

Comando:

aws cognito-idp forget-device --device-key us-west-2_abcd_1234-5678

  • Para API obtener más información, consulte ForgetDevicela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar forgot-password.

AWS CLI

Para forzar un cambio de contraseña

En el siguiente forgot-password ejemplo, se envía un mensaje a jane@example.com para cambiar su contraseña.

aws cognito-idp forgot-password --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com

Salida:

{
    "CodeDeliveryDetails": {
        "Destination": "j***@e***.com",
        "DeliveryMedium": "EMAIL",
        "AttributeName": "email"
    }
}

  • Para API obtener más información, consulte ForgotPasswordla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-csv-header.

AWS CLI

Para crear un encabezado csv

En este ejemplo, se crea un encabezado csv.

Para obtener más información sobre la importación de usuarios, consulte Importación de usuarios a grupos de usuarios desde un CSV archivo.

Comando:

aws cognito-idp get-csv-header --user-pool-id us-west-2_aaaaaaaaa

Salida:

{
  "UserPoolId": "us-west-2_aaaaaaaaa",
  "CSVHeader": [
      "name",
      "given_name",
      "family_name",
      "middle_name",
      "nickname",
      "preferred_username",
      "profile",
      "picture",
      "website",
      "email",
      "email_verified",
      "gender",
      "birthdate",
      "zoneinfo",
      "locale",
      "phone_number",
      "phone_number_verified",
      "address",
      "updated_at",
      "cognito:mfa_enabled",
      "cognito:username"
  ]
}

... Importación de usuarios a grupos de usuarios desde un CSV archivo: https://docs.aws.amazon.com/cognito/ cognito-user-pools-using latest/developerguide/ -import-tool.html

  • Para obtener API más información, consulte la Referencia de comandos. GetCsvHeaderAWS CLI

En el siguiente ejemplo de código, se muestra cómo usar get-group.

AWS CLI

Para obtener información sobre un grupo

En este ejemplo se obtiene información sobre un grupo denominado MyGroup.

Comando:

aws cognito-idp get-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup

Salida:

{
  "Group": {
      "GroupName": "MyGroup",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "Description": "A sample group.",
      "LastModifiedDate": 1548270073.795,
      "CreationDate": 1548270073.795
  }
}

  • Para API obtener más información, consulte GetGroupla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-signing-certificate.

AWS CLI

Para obtener un certificado de firma

En este ejemplo, se obtiene un certificado de firma para un grupo de usuarios.

Comando:

aws cognito-idp get-signing-certificate --user-pool-id us-west-2_aaaaaaaaa

Salida:

{
  "Certificate": "CERTIFICATE_DATA"
}

En el siguiente ejemplo de código, se muestra cómo usar get-ui-customization.

AWS CLI

Para obtener información sobre la personalización de la interfaz de usuario

En este ejemplo, se obtiene información de personalización de la interfaz de usuario de un grupo de usuarios.

Comando:

aws cognito-idp get-ui-customization --user-pool-id us-west-2_aaaaaaaaa

Salida:

{
  "UICustomization": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientId": "ALL",
      "ImageUrl": "https://aaaaaaaaaaaaa.cloudfront.net/us-west-2_aaaaaaaaa/ALL/20190128231240/assets/images/image.jpg",
      "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n",
      "CSSVersion": "20190128231240"
  }
}

  • Para API obtener más información, consulte GetUiCustomizationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-user-import-jobs.

AWS CLI

Para enumerar los trabajos de importación de usuarios

En este ejemplo se enumeran los trabajos de importación de usuarios.

Para obtener más información sobre la importación de usuarios, consulte Importación de usuarios a grupos de usuarios desde un CSV archivo.

Comando:

aws cognito-idp list-user-import-jobs --user-pool-id us-west-2_aaaaaaaaa  --max-results 20

Salida:

{
  "UserImportJobs": [
      {
          "JobName": "Test2",
          "JobId": "import-d0OnwGA3mV",
          "UserPoolId": "us-west-2_aaaaaaaaa",
          "PreSignedUrl": "PRE_SIGNED_URL",
          "CreationDate": 1548272793.069,
          "Status": "Created",
          "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
          "ImportedUsers": 0,
          "SkippedUsers": 0,
          "FailedUsers": 0
      },
      {
          "JobName": "Test1",
          "JobId": "import-qQ0DCt2fRh",
          "UserPoolId": "us-west-2_aaaaaaaaa",
          "PreSignedUrl": "PRE_SIGNED_URL",
          "CreationDate": 1548271795.471,
          "Status": "Created",
          "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
          "ImportedUsers": 0,
          "SkippedUsers": 0,
          "FailedUsers": 0
      },
      {
          "JobName": "import-Test1",
          "JobId": "import-TZqNQvDRnW",
          "UserPoolId": "us-west-2_aaaaaaaaa",
          "PreSignedUrl": "PRE_SIGNED_URL",
          "CreationDate": 1548271708.512,
          "StartDate": 1548277247.962,
          "CompletionDate": 1548277248.912,
          "Status": "Failed",
          "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
          "ImportedUsers": 0,
          "SkippedUsers": 0,
          "FailedUsers": 1,
          "CompletionMessage": "Too many users have failed or been skipped during the import."
      }
  ]
}

  • Para API obtener más información, consulte ListUserImportJobsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-user-pools.

AWS CLI

Para mostrar los grupos de usuarios

En este ejemplo se muestran hasta 20 grupos de usuarios.

Comando:

aws cognito-idp list-user-pools --max-results 20

Salida:

{
  "UserPools": [
      {
         "CreationDate": 1547763720.822,
         "LastModifiedDate": 1547763720.822,
         "LambdaConfig": {},
         "Id": "us-west-2_aaaaaaaaa",
         "Name": "MyUserPool"
      }
  ]
}

  • Para API obtener más información, consulte ListUserPoolsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-users-in-group.

AWS CLI

Para enumerar los usuarios de un grupo

En este ejemplo se enumeran los usuarios del grupo MyGroup.

Comando:

aws cognito-idp list-users-in-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup

Salida:

{
  "Users": [
      {
          "Username": "acf10624-80bb-401a-ac61-607bee2110ec",
          "Attributes": [
              {
                  "Name": "sub",
                  "Value": "acf10624-80bb-401a-ac61-607bee2110ec"
              },
              {
                  "Name": "custom:CustomAttr1",
                  "Value": "New Value!"
              },
              {
                  "Name": "email",
                  "Value": "jane@example.com"
              }
          ],
          "UserCreateDate": 1548102770.284,
          "UserLastModifiedDate": 1548103204.893,
          "Enabled": true,
          "UserStatus": "CONFIRMED"
      },
      {
          "Username": "22704aa3-fc10-479a-97eb-2af5806bd327",
          "Attributes": [
              {
                  "Name": "sub",
                  "Value": "22704aa3-fc10-479a-97eb-2af5806bd327"
              },
              {
                  "Name": "email_verified",
                  "Value": "true"
              },
              {
                  "Name": "email",
                  "Value": "diego@example.com"
              }
          ],
          "UserCreateDate": 1548089817.683,
          "UserLastModifiedDate": 1548089817.683,
          "Enabled": true,
          "UserStatus": "FORCE_CHANGE_PASSWORD"
      }
  ]
}

  • Para API obtener más información, consulte ListUsersInGroupla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-users.

AWS CLI

Para mostrar los usuarios

En este ejemplo se muestran hasta 20 usuarios.

Comando:

aws cognito-idp list-users --user-pool-id us-west-2_aaaaaaaaa --limit 20

Salida:

{
  "Users": [
      {
          "Username": "22704aa3-fc10-479a-97eb-2af5806bd327",
          "Enabled": true,
          "UserStatus": "FORCE_CHANGE_PASSWORD",
          "UserCreateDate": 1548089817.683,
          "UserLastModifiedDate": 1548089817.683,
          "Attributes": [
              {
                  "Name": "sub",
                  "Value": "22704aa3-fc10-479a-97eb-2af5806bd327"
              },
              {
                  "Name": "email_verified",
                  "Value": "true"
              },
              {
                  "Name": "email",
                  "Value": "mary@example.com"
              }
          ]
      }
  ]
}

  • Para API obtener más información, consulte ListUsersla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar resend-confirmation-code.

AWS CLI

Para reenviar un código de confirmación

En el siguiente ejemplo resend-confirmation-code, se envía un código de confirmación al usuario jane.

aws cognito-idp resend-confirmation-code \
    --client-id 12a3b456c7de890f11g123hijk \
    --username jane

Salida:

{
    "CodeDeliveryDetails": {
        "Destination": "j***@e***.com",
        "DeliveryMedium": "EMAIL",
        "AttributeName": "email"
    }
}

Para obtener más información, consulte Inscripción y confirmación de cuentas de usuarios en la Guía para desarrolladores de Amazon Cognito.

En el siguiente ejemplo de código, se muestra cómo usar respond-to-auth-challenge.

AWS CLI

Para responder a un desafío de autorización

Este ejemplo responde a un desafío de autorización iniciado con initiate-auth. Es una respuesta al REQUIRED desafío NEW PASSWORD _ _. Establece una contraseña para el usuario jane@example.com.

Comando:

aws cognito-idp respond-to-auth-challenge --client-id 3n4b5urk1ft4fl3mg5e62d9ado --challenge-name NEW_PASSWORD_REQUIRED --challenge-responses USERNAME=jane@example.com,NEW_PASSWORD="password" --session "SESSION_TOKEN"

Salida:

{
  "ChallengeParameters": {},
  "AuthenticationResult": {
      "AccessToken": "ACCESS_TOKEN",
      "ExpiresIn": 3600,
      "TokenType": "Bearer",
      "RefreshToken": "REFRESH_TOKEN",
      "IdToken": "ID_TOKEN",
      "NewDeviceMetadata": {
          "DeviceKey": "us-west-2_fec070d2-fa88-424a-8ec8-b26d7198eb23",
          "DeviceGroupKey": "-wt2ha1Zd"
      }
  }
}

En el siguiente ejemplo de código, se muestra cómo usar set-risk-configuration.

AWS CLI

Para establecer la configuración de riesgo

En este ejemplo, se establece la configuración de riesgo de un grupo de usuarios. Establece la acción del evento de registro en ACTION NO_.

Comando:

aws cognito-idp set-risk-configuration --user-pool-id us-west-2_aaaaaaaaa  --compromised-credentials-risk-configuration EventFilter=SIGN_UP,Actions={EventAction=NO_ACTION}

Salida:

{
  "RiskConfiguration": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "CompromisedCredentialsRiskConfiguration": {
          "EventFilter": [
              "SIGN_UP"
          ],
          "Actions": {
              "EventAction": "NO_ACTION"
          }
      }
  }
}

  • Para API obtener más información, consulte la Referencia SetRiskConfigurationde AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar set-ui-customization.

AWS CLI

Para configurar la personalización de la interfaz de usuario

En este ejemplo, se personaliza la CSS configuración de un grupo de usuarios.

Comando:

aws cognito-idp set-ui-customization --user-pool-id us-west-2_aaaaaaaaa --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n"

Salida:

{
  "UICustomization": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientId": "ALL",
      "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n",
      "CSSVersion": "20190129172214"
  }
}

  • Para API obtener más información, consulte SetUiCustomizationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar set-user-mfa-preference.

AWS CLI

Para establecer la MFA configuración de usuario

En el siguiente set-user-mfa-preference ejemplo, se modifican las opciones MFA de entrega. Cambia el medio de MFA entrega aSMS.

aws cognito-idp set-user-mfa-preference \
    --access-token "eyJra12345EXAMPLE" \
    --software-token-mfa-settings Enabled=true,PreferredMfa=true \
    --sms-mfa-settings Enabled=false,PreferredMfa=false

Este comando no genera ninguna salida.

Para obtener más información, consulte Añadir MFA a un grupo de usuarios en la Guía para desarrolladores de Amazon Cognito.

  • Para API obtener más información, consulte SetUserMfaPreferencela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar set-user-settings.

AWS CLI

Para establecer la configuración de usuario

En este ejemplo, se establece la preferencia de MFA entrega enEMAIL.

Comando:

aws cognito-idp set-user-settings --access-token ACCESS_TOKEN --mfa-options DeliveryMedium=EMAIL

  • Para API obtener más información, consulte SetUserSettingsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar sign-up.

AWS CLI

Para inscribir a un usuario

En este ejemplo, se registra jane@example.com.

Comando:

aws cognito-idp sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username jane@example.com --password PASSWORD --user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane"

Salida:

{
  "UserConfirmed": false,
  "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862"
}

  • Para API obtener más información, consulte SignUpla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar start-user-import-job.

AWS CLI

Para iniciar un trabajo de importación de usuarios

En este ejemplo se inicia un trabajo de entrada de usuario.

Para obtener más información sobre la importación de usuarios, consulte Importación de usuarios a grupos de usuarios desde un CSV archivo.

Comando:

aws cognito-idp start-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW

Salida:

{
  "UserImportJob": {
      "JobName": "import-Test10",
      "JobId": "import-lmpxSOuIzH",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "PreSignedUrl": "PRE_SIGNED_URL",
      "CreationDate": 1548278378.928,
      "StartDate": 1548278397.334,
      "Status": "Pending",
      "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
      "ImportedUsers": 0,
      "SkippedUsers": 0,
      "FailedUsers": 0
  }
}

  • Para API obtener más información, consulte StartUserImportJobla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar stop-user-import-job.

AWS CLI

Para detener un trabajo de importación de usuarios

En este ejemplo se detiene un trabajo de entrada de un usuario.

Para obtener más información sobre la importación de usuarios, consulte Importación de usuarios a grupos de usuarios desde un CSV archivo.

Comando:

aws cognito-idp stop-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW

Salida:

{
  "UserImportJob": {
      "JobName": "import-Test5",
      "JobId": "import-Fx0kARISFL",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "PreSignedUrl": "PRE_SIGNED_URL",
      "CreationDate": 1548278576.259,
      "StartDate": 1548278623.366,
      "CompletionDate": 1548278626.741,
      "Status": "Stopped",
      "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
      "ImportedUsers": 0,
      "SkippedUsers": 0,
      "FailedUsers": 0,
      "CompletionMessage": "The Import Job was stopped by the developer."
  }
}

  • Para API obtener más información, consulte StopUserImportJobla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-auth-event-feedback.

AWS CLI

Para actualizar los comentarios sobre los eventos de autenticación

En este ejemplo, se actualizan los comentarios sobre los eventos de autorización. Marca el evento como «Válido».

Comando:

aws cognito-idp update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id EVENT_ID --feedback-token FEEDBACK_TOKEN --feedback-value "Valid"

En el siguiente ejemplo de código, se muestra cómo usar update-device-status.

AWS CLI

Para actualizar el estado del dispositivo

En este ejemplo, se actualiza el estado de un dispositivo a «not_remember».

Comando:

aws cognito-idp update-device-status --access-token ACCESS_TOKEN --device-key DEVICE_KEY --device-remembered-status "not_remembered"

  • Para API obtener más información, consulte la Referencia UpdateDeviceStatusde AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-group.

AWS CLI

Para actualizar un grupo

En este ejemplo se actualizan la descripción y la prioridad de MyGroup.

Comando:

aws cognito-idp update-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup --description "New description" --precedence 2

Salida:

{
  "Group": {
      "GroupName": "MyGroup",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "Description": "New description",
      "RoleArn": "arn:aws:iam::111111111111:role/MyRole",
      "Precedence": 2,
      "LastModifiedDate": 1548800862.812,
      "CreationDate": 1548097827.125
  }
}

  • Para API obtener más información, consulte UpdateGroupla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-resource-server.

AWS CLI

Para actualizar un servidor de recursos

En este ejemplo, se actualiza el clima del servidor de recursos. Agrega un nuevo ámbito.

Comando:

aws cognito-idp update-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com --name Weather --scopes ScopeName=NewScope,ScopeDescription="New scope description"

Salida:

{
  "ResourceServer": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "Identifier": "weather.example.com",
      "Name": "Happy",
      "Scopes": [
          {
              "ScopeName": "NewScope",
              "ScopeDescription": "New scope description"
          }
      ]
  }
}

  • Para API obtener más información, consulte UpdateResourceServerla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-user-attributes.

AWS CLI

Para actualizar los atributos de usuario

En este ejemplo se actualiza el atributo de usuario «apodo».

Comando:

aws cognito-idp update-user-attributes --access-token ACCESS_TOKEN --user-attributes Name="nickname",Value="Dan"

  • Para API obtener más información, consulte UpdateUserAttributesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-user-pool-client.

AWS CLI

Para actualizar un cliente de grupo de usuarios

En este ejemplo se actualiza el nombre de un cliente de grupo de usuarios. También añade un atributo «apodo» que se puede escribir.

Comando:

aws cognito-idp update-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --client-name "NewClientName" --write-attributes "nickname"

Salida:

{
  "UserPoolClient": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientName": "NewClientName",
      "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
      "LastModifiedDate": 1548802761.334,
      "CreationDate": 1548178931.258,
      "RefreshTokenValidity": 30,
      "WriteAttributes": [
          "nickname"
      ],
      "AllowedOAuthFlowsUserPoolClient": false
  }
}

  • Para API obtener más información, consulte la Referencia UpdateUserPoolClientde AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-user-pool.

AWS CLI

Para actualizar un grupo de usuarios

En este ejemplo, se agregan etiquetas a un grupo de usuarios.

Comando:

aws cognito-idp update-user-pool --user-pool-id us-west-2_aaaaaaaaa --user-pool-tags Team=Blue,Area=West

  • Para API obtener más información, consulte UpdateUserPoolla Referencia de AWS CLI comandos.