Ejemplos de Amazon Connect que utilizan la AWS CLI - AWS Command Line Interface

Ejemplos de Amazon Connect que utilizan la AWS CLI

En los siguientes ejemplos de código, se muestra cómo realizar acciones e implementar escenarios comunes usando la AWS Command Line Interface con Amazon Connect.

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 distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

Acciones

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

AWS CLI

Para crear un usuario

En el siguiente ejemplo de create-user, se añade un usuario con los atributos especificados a la instancia de Amazon Connect especificada.

aws connect create-user \ --username Mary \ --password Pass@Word1 \ --identity-info FirstName=Mary,LastName=Major \ --phone-config PhoneType=DESK_PHONE,AutoAccept=true,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+15555551212 \ --security-profile-id 12345678-1111-2222-aaaa-a1b2c3d4f5g7 \ --routing-profile-id 87654321-9999-3434-abcd-x1y2z3a1b2c3 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Salida:

{ "UserId": "87654321-2222-1234-1234-111234567891", "UserArn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent/87654321-2222-1234-1234-111234567891" }

Para obtener más información, consulte Add Users en la Guía del administrador de Amazon Connect.

  • Para obtener información sobre la API, consulte CreateUser en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para eliminar un usuario

En el siguiente ejemplo de delete-user, se elimina un usuario con los atributos especificados a la instancia de Amazon Connect especificada.

aws connect delete-user \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --user-id 87654321-2222-1234-1234-111234567891

Este comando no genera ninguna salida.

Para obtener más información, consulte Manage Users en la Guía del administrador de Amazon Connect.

  • Para obtener información sobre la API, consulte DeleteUser en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar describe-user-hierarchy-group.

AWS CLI

Visualización de los detalles de un grupo jerárquico

En el siguiente ejemplo de describe-user-hierarchy-group, se muestran los detalles del grupo jerárquico de Amazon Connect especificado.

aws connect describe-user-hierarchy-group \ --hierarchy-group-id 12345678-1111-2222-800e-aaabbb555gg \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Salida:

{ "HierarchyGroup": { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/12345678-1111-2222-800e-a2b3c4d5f6g7", "Name": "Example Corporation", "LevelId": "1", "HierarchyPath": { "LevelOne": { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/abcdefgh-3333-4444-8af3-201123456789", "Name": "Example Corporation" } } } }

Para obtener más información, consulte Set Up Agent Hierarchies en la Guía del administrador de Amazon Connect.

En el siguiente ejemplo de código, se muestra cómo utilizar describe-user-hierarchy-structure.

AWS CLI

Visualización de los detalles de una estructura jerárquica

En el siguiente ejemplo de describe-user-hierarchy-structure, se muestra la estructura del grupo jerárquico de la instancia de Amazon Connect especificada.

aws connect describe-user-hierarchy-group \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Salida:

{ "HierarchyStructure": { "LevelOne": { "Id": "12345678-1111-2222-800e-aaabbb555gg", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/1", "Name": "Corporation" }, "LevelTwo": { "Id": "87654321-2222-3333-ac99-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/2", "Name": "Services Division" }, "LevelThree": { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/3", "Name": "EU Site" } } }

Para obtener más información, consulte Set Up Agent Hierarchies en la Guía del administrador de Amazon Connect.

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

AWS CLI

Visualización de los detalles de un usuario

En el siguiente ejemplo de describe-user, se muestran los detalles del usuario de Amazon Connect especificado.

aws connect describe-user \ --user-id 0c245dc0-0cf5-4e37-800e-2a7481cc8a60 --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e

Salida:

{ "User": { "Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60", "Username": "Jane", "IdentityInfo": { "FirstName": "Jane", "LastName": "Doe", "Email": "example.com" }, "PhoneConfig": { "PhoneType": "SOFT_PHONE", "AutoAccept": false, "AfterContactWorkTimeLimit": 0, "DeskPhoneNumber": "" }, "DirectoryUserId": "8b444cf6-b368-4f29-ba18-07af27405658", "SecurityProfileIds": [ "b6f85a42-1dc5-443b-b621-de0abf70c9cf" ], "RoutingProfileId": "0be36ee9-2b5f-4ef4-bcf7-87738e5be0e5", "Tags": {} } }

Para obtener más información, consulte Manage Users en la Guía del administrador de Amazon Connect.

  • Para obtener detalles sobre la API, consulte DescribeUser en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-contact-attributes.

AWS CLI

Recuperación de los atributos de un contacto

En el siguiente ejemplo de get-contact-attributes, se recuperan los atributos que se establecieron para el contacto de Amazon Connect especificado.

aws connect get-contact-attributes \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --initial-contact-id 12345678-1111-2222-800e-a2b3c4d5f6g7

Salida:

{ "Attributes": { "greetingPlayed": "true" } }

Para obtener más información, consulte Amazon Connect Contact Attributes en la Guía del administrador de Amazon Connect.

  • Para obtener detalles sobre la API, consulte GetContactAttributes en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-contact-flows.

AWS CLI

Para enumerar los flujos de contactos de una instancia

En el siguiente ejemplo de list-contact-flows, se enumeran los flujos de contactos de la instancia de Amazon Connect especificada.

aws connect list-contact-flows \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Salida:

{ "ContactFlowSummaryList": [ { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/12345678-1111-2222-800e-a2b3c4d5f6g7", "Name": "Default queue transfer", "ContactFlowType": "QUEUE_TRANSFER" }, { "Id": "87654321-2222-3333-ac99-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/87654321-2222-3333-ac99-123456789102", "Name": "Default agent hold", "ContactFlowType": "AGENT_HOLD" }, { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/abcdefgh-3333-4444-8af3-201123456789", "Name": "Default customer hold", "ContactFlowType": "CUSTOMER_HOLD" }, ] }

Para obtener más información, consulte Create Amazon Connect Contact Flows en la Guía del administrador de Amazon Connect.

  • Para obtener detalles sobre la API, consulte ListContactFlows en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-hours-of-operations.

AWS CLI

Para enumerar las horas de funcionamiento de una instancia

En el siguiente ejemplo de list-hours-of-operations, se enumeran las horas de funcionamiento para una instancia de Amazon Connect especificada.

aws connect list-hours-of-operations \ --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e

Salida:

{ "HoursOfOperationSummaryList": [ { "Id": "d69f1f84-7457-4924-8fbe-e64875546259", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/operating-hours/d69f1f84-7457-4924-8fbe-e64875546259", "Name": "Basic Hours" } ] }

Para obtener más información, consulte Set the Hours of Operation for a Queue en la Guía del administrador de Amazon Connect.

  • Para obtener detalles sobre la API, consulte ListHoursOfOperations en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-phone-numbers.

AWS CLI

Para enumerar los números de teléfono de una instancia

En el siguiente ejemplo de list-phone-numbers, se enumeran los números de teléfono de la instancia de Amazon Connect especificada.

aws connect list-phone-numbers \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Salida:

{ "PhoneNumberSummaryList": [ { "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/xyz80zxy-xyz1-80zx-zx80-11111EXAMPLE", "PhoneNumber": "+17065551212", "PhoneNumberType": "DID", "PhoneNumberCountryCode": "US" }, { "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/ccc0ccc-xyz1-80zx-zx80-22222EXAMPLE", "PhoneNumber": "+18555551212", "PhoneNumberType": "TOLL_FREE", "PhoneNumberCountryCode": "US" } ] }

Para obtener más información, consulte Set Up Phone Numbers for Your Contact Center en la Guía del administrador de Amazon Connect.

  • Para obtener información sobre la API, consulte ListPhoneNumbers en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-queues.

AWS CLI

Para enumerar las colas de una instancia

En el siguiente ejemplo de list-queues, se enumeran las colas de la instancia de Amazon Connect especificada.

aws connect list-queues \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Salida:

{ "QueueSummaryList": [ { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/12345678-1111-2222-800e-a2b3c4d5f6g7", "QueueType": "AGENT" }, { "Id": "87654321-2222-3333-ac99-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/87654321-2222-3333-ac99-123456789102", "QueueType": "AGENT" }, { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/abcdefgh-3333-4444-8af3-201123456789", "QueueType": "AGENT" }, { "Id": "hgfedcba-4444-5555-a31f-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/hgfedcba-4444-5555-a31f-123456789102", "Name": "BasicQueue", "QueueType": "STANDARD" }, ] }

Para obtener más información, consulte Create a Queue en la Guía del administrador de Amazon Connect.

  • Para obtener información sobre la API, consulte ListQueues en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-routing-profiles.

AWS CLI

Para enumerar los perfiles de enrutamiento de una instancia

En el siguiente ejemplo de list-routing-profiles, se enumeran los perfiles de enrutamiento de la instancia de Amazon Connect especificada.

aws connect list-routing-profiles \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Salida:

{ "RoutingProfileSummaryList": [ { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/routing-profile/12345678-1111-2222-800e-a2b3c4d5f6g7", "Name": "Basic Routing Profile" }, ] }

Para obtener más información, consulte Create a Routing Profile en la Guía del administrador de Amazon Connect.

  • Para obtener detalles sobre la API, consulte ListRoutingProfiles en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-security-profiles.

AWS CLI

Para enumerar los perfiles de seguridad de la instancia

En el siguiente ejemplo de list-security-profiles, se enumeran los perfiles de seguridad de la instancia de Amazon Connect especificada.

aws connect list-security-profiles \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Salida:

{ "SecurityProfileSummaryList": [ { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-a2b3c4d5f6g7", "Name": "CallCenterManager" }, { "Id": "87654321-2222-3333-ac99-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/87654321-2222-3333-ac99-123456789102", "Name": "QualityAnalyst" }, { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/abcdefgh-3333-4444-8af3-201123456789", "Name": "Agent" }, { "Id": "12345678-1111-2222-800e-x2y3c4d5fzzzz", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-x2y3c4d5fzzzz", "Name": "Admin" } ] }

Para obtener más información, consulte Assign Permissions: Security Profiles en la Guía del administrador de Amazon Connect.

  • Para obtener detalles sobre la API, consulte ListSecurityProfiles en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-user-hierarchy-groups.

AWS CLI

Para enumerar los grupos jerárquicos de usuarios de una instancia

En el siguiente ejemplo de list-user-hierarchy-groups, se enumeran los grupos jerárquicos de la instancia de Amazon Connect especificada.

aws connect list-user-hierarchy-groups \ --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e

Salida:

{ "UserHierarchyGroupSummaryList": [ { "Id": "0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent-group/0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a", "Name": "Example Corporation" }, ] }

Para obtener más información, consulte Set Up Agent Hierarchies en la Guía del administrador de Amazon Connect.

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

AWS CLI

Para enumerar los grupos jerárquicos de usuarios de una instancia

En el siguiente ejemplo de list-users, se enumeran los usuarios de la instancia de Amazon Connect especificada.

aws connect list-users \ --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e

Salida:

{ "UserSummaryList": [ { "Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60", "Username": "Jane" }, { "Id": "46f0c67c-3fc7-4806-ac99-403798788c14", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/46f0c67c-3fc7-4806-ac99-403798788c14", "Username": "Paulo" }, { "Id": "55a83578-95e1-4710-8af3-2b7afe310e48", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/55a83578-95e1-4710-8af3-2b7afe310e48", "Username": "JohnD" }, { "Id": "703e27b5-c9f0-4f1f-a239-64ccbb160125", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/703e27b5-c9f0-4f1f-a239-64ccbb160125", "Username": "JohnS" } ] }

Para obtener más información, consulte Add Users en la Guía del administrador de Amazon Connect.

  • Para obtener información sobre la API, consulte ListUsers en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Actualización del atributo de un contacto

En el siguiente ejemplo de update-contact-attributes, se actualiza el atributo greetingPlayed del usuario de Amazon Connect especificado.

aws connect update-contact-attributes \ --initial-contact-id 11111111-2222-3333-4444-12345678910 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --attributes greetingPlayed=false

Este comando no genera ninguna salida.

Para obtener más información, consulte Amazon Connect Contact Attributes en la Guía del administrador de Amazon Connect.

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

AWS CLI

Actualización de la jerarquía del usuario

En el siguiente ejemplo de update-user-hierarchy, se actualiza la jerarquía del agente para el usuario de Amazon Connect especificado.

aws connect update-user-hierarchy \ --hierarchy-group-id 12345678-a1b2-c3d4-e5f6-123456789abc \ --user-id 87654321-2222-1234-1234-111234567891 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando no genera ninguna salida.

Para obtener más información, consulte Configure Agent Settings en la Guía del administrador de Amazon Connect.

  • Para obtener detalles sobre la API, consulte UpdateUserHierarchy en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-user-identity-info.

AWS CLI

Actualización de la información de identidad de un usuario

En el siguiente ejemplo de update-user-identity-info, se actualiza la información de identidad del usuario de Amazon Connect especificado.

aws connect update-user-identity-info \ --identity-info FirstName=Mary,LastName=Major,Email=marym@example.com \ --user-id 87654321-2222-1234-1234-111234567891 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando no genera ninguna salida.

Para obtener más información, consulte Configure Agent Settings en la Guía del administrador de Amazon Connect.

  • Para obtener detalles sobre la API, consulte UpdateUserIdentityInfo en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-user-phone-config.

AWS CLI

Actualización de la configuración del teléfono de un usuario

En el siguiente de ejemplo de update-user-phone-config, se actualiza la configuración del teléfono para el usuario especificado.

aws connect update-user-phone-config \ --phone-config PhoneType=SOFT_PHONE,AutoAccept=false,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+18005551212 \ --user-id 12345678-4444-3333-2222-111122223333 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando no genera ninguna salida.

Para obtener más información, consulte Configure Agent Settings en la Guía del administrador de Amazon Connect.

  • Para obtener detalles sobre la API, consulte UpdateUserPhoneConfig en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-user-routing-profile.

AWS CLI

Actualización del perfil de enrutamiento de un usuario

En el siguiente ejemplo de update-user-routing-profile, se actualiza el perfil de enrutamiento del usuario de Amazon Connect especificado.

aws connect update-user-routing-profile \ --routing-profile-id 12345678-1111-3333-2222-4444EXAMPLE \ --user-id 87654321-2222-1234-1234-111234567891 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando no genera ninguna salida.

Para obtener más información, consulte Configure Agent Settings en la Guía del administrador de Amazon Connect.

En el siguiente ejemplo de código, se muestra cómo utilizar update-user-security-profiles.

AWS CLI

Actualización de los perfiles de seguridad de un usuario

En el siguiente ejemplo de update-user-security-profiles, se actualiza el perfil de seguridad del usuario de Amazon Connect especificado.

aws connect update-user-security-profiles \ --security-profile-ids 12345678-1234-1234-1234-1234567892111 \ --user-id 87654321-2222-1234-1234-111234567891 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando no genera ninguna salida.

Para obtener más información, consulte Assign Permissions: Security Profiles en la Guía del administrador de Amazon Connect.