Exemples d’utilisation de l’AWS CLI avec Amazon Connect - AWS Command Line Interface

Exemples d’utilisation de l’AWS CLI avec Amazon Connect

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec Amazon Connect.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser create-user.

AWS CLI

Pour créer un utilisateur

L’exemple create-user suivant ajoute un utilisateur avec les attributs spécifiés à l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" }

Pour plus d’informations, consultez Ajout d’utilisateurs dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez CreateUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-user.

AWS CLI

Pour supprimer un utilisateur

L’exemple delete-user suivant supprime l’utilisateur spécifié de l’instance Amazon Connect spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion des utilisateurs dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez DeleteUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-user-hierarchy-group.

AWS CLI

Pour afficher les informations sur un groupe hiérarchique

L’exemple describe-user-hierarchy-group suivant affiche les informations sur le groupe hiérarchique Amazon Connect spécifié.

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

Sortie :

{ "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" } } } }

Pour plus d’informations, consultez Configuration des hiérarchies d’un agent dans le Guide de l’administrateur Amazon Connect.

L’exemple de code suivant montre comment utiliser describe-user-hierarchy-structure.

AWS CLI

Pour afficher les informations d’une structure hiérarchique

L’exemple describe-user-hierarchy-structure suivant affiche les informations de la structure hiérarchique pour l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" } } }

Pour plus d’informations, consultez Configuration des hiérarchies d’un agent dans le Guide de l’administrateur Amazon Connect.

L’exemple de code suivant montre comment utiliser describe-user.

AWS CLI

Pour afficher les informations relatives à un utilisateur

L’exemple describe-user suivant affiche les informations de l’utilisateur Amazon Connect spécifié.

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

Sortie :

{ "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": {} } }

Pour plus d’informations, consultez Gestion des utilisateurs dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez DescribeUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-contact-attributes.

AWS CLI

Pour récupérer les attributs d’un contact

L’exemple get-contact-attributes suivant récupère les attributs définis pour le contact Amazon Connect spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Use Amazon Connect Contact Attributes dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez GetContactAttributes dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-contact-flows.

AWS CLI

Pour répertorier les flux de contacts dans une instance

L’exemple list-contact-flows suivant répertorie les flux de contact dans l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" }, ] }

Pour plus d’informations, consultez Création de flux Amazon Connect dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez ListContactFlows dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-hours-of-operations.

AWS CLI

Pour répertorier les heures de fonctionnement d’une instance

L’exemple list-hours-of-operations suivant répertorie les heures de fonctionnement de l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" } ] }

Pour plus d’informations, consultez Définition des heures de fonctionnement pour une file d’attente dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez ListHoursOfOperations dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-phone-numbers.

AWS CLI

Pour répertorier les numéros de téléphone dans une instance

L’exemple list-phone-numbers suivant répertorie les numéros de téléphone dans l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" } ] }

Pour plus d’informations, consultez Configuration de numéros de téléphone pour votre centre de contact dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez ListPhoneNumbers dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-queues.

AWS CLI

Pour répertorier les files d’attente dans une instance

L’exemple list-queues suivant répertorie les files d’attente dans l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" }, ] }

Pour plus d’informations, consultez Création d’une file d’attente dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez ListQueues dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-routing-profiles.

AWS CLI

Pour répertorier les profils de routage d’une instance

L’exemple list-routing-profiles suivant répertorie les profils de routage dans l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" }, ] }

Pour plus d’informations, consultez Création d’un profil de routage dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez ListRoutingProfiles dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-security-profiles.

AWS CLI

Pour répertorier les profils de sécurité d’une instance

L’exemple list-security-profiles suivant répertorie les profils de sécurité dans l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" } ] }

Pour plus d’informations, consultez Attribution d’autorisations : profils de sécurité dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez ListSecurityProfiles dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-user-hierarchy-groups.

AWS CLI

Pour répertorier les groupes hiérarchiques d’utilisateurs dans une instance

L’exemple list-user-hierarchy-groups suivant répertorie les groupes hiérarchiques d’utilisateurs dans l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" }, ] }

Pour plus d’informations, consultez Configuration des hiérarchies d’un agent dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez ListUserHierarchyGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-users.

AWS CLI

Pour répertorier les groupes hiérarchiques d’utilisateurs dans une instance

L’exemple list-users suivant répertorie les utilisateurs dans l’instance Amazon Connect spécifiée.

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

Sortie :

{ "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" } ] }

Pour plus d’informations, consultez Ajout d’utilisateurs dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez ListUsers dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-contact-attributes.

AWS CLI

Pour mettre à jour l’attribut d’un contact

L’exemple update-contact-attributes suivant met à jour l’attribut greetingPlayed pour l’utilisateur Amazon Connect spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Use Amazon Connect Contact Attributes dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez UpdateContactAttributes dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-user-hierarchy.

AWS CLI

Pour mettre à jour la hiérarchie d’un utilisateur

L’exemple update-user-hierarchy suivant met à jour la hiérarchie des agents pour l’utilisateur Amazon Connect spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Configuration des paramètres de l’agent dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez UpdateUserHierarchy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-user-identity-info.

AWS CLI

Pour mettre à jour les informations d’identité d’un utilisateur

L’exemple update-user-identity-info suivant met à jour les informations d’identité de l’utilisateur Amazon Connect spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Configuration des paramètres de l’agent dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez UpdateUserIdentityInfo dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-user-phone-config.

AWS CLI

Pour mettre à jour la configuration du téléphone d’un utilisateur

L’exemple update-user-phone-config suivant met à jour la configuration du téléphone de l’utilisateur spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Configuration des paramètres de l’agent dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez UpdateUserPhoneConfig dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-user-routing-profile.

AWS CLI

Pour mettre à jour le profil de routage d’un utilisateur

L’exemple update-user-routing-profile suivant met à jour le profil de routage pour l’utilisateur Amazon Connect spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Configuration des paramètres de l’agent dans le Guide de l’administrateur Amazon Connect.

  • Pour plus de détails sur l’API, consultez UpdateUserRoutingProfile dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-user-security-profiles.

AWS CLI

Pour mettre à jour les profils de sécurité d’un utilisateur

L’exemple update-user-security-profiles suivant met à jour le profil de sécurité pour l’utilisateur Amazon Connect spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Attribution d’autorisations : profils de sécurité dans le Guide de l’administrateur Amazon Connect.