使用 Amazon Connect 的示例 AWS CLI

以下代码示例向您展示了如何在 Amazon Connect 中 AWS Command Line Interface 使用来执行操作和实现常见场景。

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以在其中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

操作

以下代码示例显示了如何使用create-user。

AWS CLI

创建用户

以下create-user示例将具有指定属性的用户添加到指定的 Amazon Connect 实例。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的添加用户。

有关API详细信息，请参阅 “CreateUser AWS CLI命令参考”。

以下代码示例显示了如何使用delete-user。

AWS CLI

删除用户

以下delete-user示例从指定的 Amazon Connect 实例中删除指定用户。


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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Connect 管理员指南中的管理用户。

有关API详细信息，请参阅 “DeleteUser AWS CLI命令参考”。

以下代码示例显示了如何使用describe-user-hierarchy-group。

AWS CLI

显示层次结构组的详细信息

以下describe-user-hierarchy-group示例显示了指定 Amazon Connect 层次结构组的详细信息。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的设置代理层次结构。

有关API详细信息，请参阅 “DescribeUserHierarchyGroup AWS CLI命令参考”。

以下代码示例显示了如何使用describe-user-hierarchy-structure。

AWS CLI

显示层次结构的详细信息

以下describe-user-hierarchy-structure示例显示了指定 Amazon Connect 实例的层次结构的详细信息。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的设置代理层次结构。

有关API详细信息，请参阅 “DescribeUserHierarchyStructure AWS CLI命令参考”。

以下代码示例显示了如何使用describe-user。

AWS CLI

显示用户的详细信息

以下describe-user示例显示了指定 Amazon Connect 用户的详细信息。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的管理用户。

有关API详细信息，请参阅 “DescribeUser AWS CLI命令参考”。

以下代码示例显示了如何使用get-contact-attributes。

AWS CLI

检索联系人的属性

以下get-contact-attributes示例检索为指定的 Amazon Connect 联系人设置的属性。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的使用 Amazon Connect 联系人属性。

有关API详细信息，请参阅 “GetContactAttributes AWS CLI命令参考”。

以下代码示例显示了如何使用list-contact-flows。

AWS CLI

列出实例中的联系人流

以下list-contact-flows示例列出了指定 Amazon Connect 实例中的联系流程。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的创建 Amazon Connect 联系流程。

有关API详细信息，请参阅 “ListContactFlows AWS CLI命令参考”。

以下代码示例显示了如何使用list-hours-of-operations。

AWS CLI

列出实例的运行时间

以下list-hours-of-operations示例列出了指定 Amazon Connect 实例的运行时间。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的设置队列的操作时间。

有关API详细信息，请参阅 “ListHoursOfOperations AWS CLI命令参考”。

以下代码示例显示了如何使用list-phone-numbers。

AWS CLI

列出实例中的电话号码

以下list-phone-numbers示例列出了指定 Amazon Connect 实例中的电话号码。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的为您的联络中心设置电话号码。

有关API详细信息，请参阅 “ListPhoneNumbers AWS CLI命令参考”。

以下代码示例显示了如何使用list-queues。

AWS CLI

列出实例中的队列

以下list-queues示例列出了指定 Amazon Connect 实例中的队列。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的创建队列。

有关API详细信息，请参阅 “ListQueues AWS CLI命令参考”。

以下代码示例显示了如何使用list-routing-profiles。

AWS CLI

列出实例中的路由配置文件

以下list-routing-profiles示例列出了指定 Amazon Connect 实例中的路由配置文件。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的创建路由配置文件。

有关API详细信息，请参阅 “ListRoutingProfiles AWS CLI命令参考”。

以下代码示例显示了如何使用list-security-profiles。

AWS CLI

列出实例中的安全配置文件

以下list-security-profiles示例列出了指定 Amazon Connect 实例中的安全配置文件。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的分配权限：安全配置文件。

有关API详细信息，请参阅 “ListSecurityProfiles AWS CLI命令参考”。

以下代码示例显示了如何使用list-user-hierarchy-groups。

AWS CLI

列出实例中的用户层次结构组

以下list-user-hierarchy-groups示例列出了指定 Amazon Connect 实例中的用户层次结构群组。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的设置代理层次结构。

有关API详细信息，请参阅 “ListUserHierarchyGroups AWS CLI命令参考”。

以下代码示例显示了如何使用list-users。

AWS CLI

列出实例中的用户层次结构组

以下list-users示例列出了指定 Amazon Connect 实例中的用户。


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

输出：


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

有关更多信息，请参阅 Amazon Connect 管理员指南中的添加用户。

有关API详细信息，请参阅 “ListUsers AWS CLI命令参考”。

以下代码示例显示了如何使用update-contact-attributes。

AWS CLI

更新联系人的属性

以下update-contact-attributes示例更新了指定的 Amazon Connect 用户的greetingPlayed属性。


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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Connect 管理员指南中的使用 Amazon Connect 联系人属性。

有关API详细信息，请参阅 “UpdateContactAttributes AWS CLI命令参考”。

以下代码示例显示了如何使用update-user-hierarchy。

AWS CLI

更新用户的层次结构

以下update-user-hierarchy示例更新了指定 Amazon Connect 用户的代理层次结构。


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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Connect 管理员指南中的配置代理设置。

有关API详细信息，请参阅 “UpdateUserHierarchy AWS CLI命令参考”。

以下代码示例显示了如何使用update-user-identity-info。

AWS CLI

更新用户的身份信息

以下update-user-identity-info示例更新了指定 Amazon Connect 用户的身份信息。


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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Connect 管理员指南中的配置代理设置。

有关API详细信息，请参阅 “UpdateUserIdentityInfo AWS CLI命令参考”。

以下代码示例显示了如何使用update-user-phone-config。

AWS CLI

更新用户的电话配置

以下update-user-phone-config示例更新了指定用户的电话配置。


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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Connect 管理员指南中的配置代理设置。

有关API详细信息，请参阅 “UpdateUserPhoneConfig AWS CLI命令参考”。

以下代码示例显示了如何使用update-user-routing-profile。

AWS CLI

更新用户的路由配置文件

以下update-user-routing-profile示例更新了指定 Amazon Connect 用户的路由配置文件。


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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Connect 管理员指南中的配置代理设置。

有关API详细信息，请参阅 “UpdateUserRoutingProfile AWS CLI命令参考”。

以下代码示例显示了如何使用update-user-security-profiles。

AWS CLI

更新用户的安全配置文件

以下update-user-security-profiles示例更新了指定 Amazon Connect 用户的安全配置文件。


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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Connect 管理员指南中的分配权限：安全配置文件。

有关API详细信息，请参阅 “UpdateUserSecurityProfiles AWS CLI命令参考”。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

AWS Config

AWS 成本和使用情况报告