このドキュメントは、 のバージョン 1 AWS CLI 専用です。のバージョン 2 に関連するドキュメントについては AWS CLI、バージョン 2 ユーザーガイド を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
を使用した Amazon Connect の例 AWS CLI
次のコード例は、Amazon Connect AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。
トピック
アクション
次の例は、create-user
を使用する方法を説明しています。
- AWS CLI
-
ユーザーを作成するには
次の
create-user
例では、指定された属性を持つユーザーを指定された Amazon Connect インスタンスに追加します。aws connect create-user \ --username
Mary
\ --passwordPass@Word1
\ --identity-infoFirstName=Mary,LastName=Major
\ --phone-configPhoneType=DESK_PHONE,AutoAccept=true,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+15555551212
\ --security-profile-id12345678-1111-2222-aaaa-a1b2c3d4f5g7
\ --routing-profile-id87654321-9999-3434-abcd-x1y2z3a1b2c3
\ --instance-ida1b2c3d4-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 管理者ガイド」の「ユーザーの追加」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateUser
」の「」を参照してください。
-
次のコード例は、delete-user
を使用する方法を示しています。
- AWS CLI
-
ユーザーを削除するには
次の
delete-user
例では、指定された Amazon Connect インスタンスから指定されたユーザーを削除します。aws connect delete-user \ --instance-id
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
\ --user-id87654321-2222-1234-1234-111234567891
このコマンドでは何も出力されません。
詳細については、「Amazon Connect 管理者ガイド」の「ユーザーの管理」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteUser
」の「」を参照してください。
-
次のコード例は、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-ida1b2c3d4-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 詳細については、AWS CLI 「 コマンドリファレンスDescribeUserHierarchyGroup
」の「」を参照してください。
-
次のコード例は、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 詳細については、AWS CLI 「 コマンドリファレンスDescribeUserHierarchyStructure
」の「」を参照してください。
-
次のコード例は、describe-user
を使用する方法を示しています。
- AWS CLI
-
ユーザーの詳細を表示するには
次の
describe-user
例では、指定された Amazon Connect ユーザーの詳細を表示します。aws connect describe-user \ --user-id
0c245dc0-0cf5-4e37-800e-2a7481cc8a60
--instance-id40c83b68-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 管理者ガイド」の「ユーザーの管理」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeUser
」の「」を参照してください。
-
次の例は、get-contact-attributes
を使用する方法を説明しています。
- AWS CLI
-
問い合わせの属性を取得するには
次の
get-contact-attributes
例では、指定された Amazon Connect 連絡先に設定された属性を取得します。aws connect get-contact-attributes \ --instance-id
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
\ --initial-contact-id12345678-1111-2222-800e-a2b3c4d5f6g7
出力:
{ "Attributes": { "greetingPlayed": "true" } }
詳細については、Amazon Connect 管理者ガイド」の「Amazon Connect 問い合わせ属性の使用」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetContactAttributes
」の「」を参照してください。
-
次の例は、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 問い合わせフローの作成」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスListContactFlows
」の「」を参照してください。
-
次の例は、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 詳細については、AWS CLI 「 コマンドリファレンスListHoursOfOperations
」の「」を参照してください。
-
次のコード例は、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 詳細については、AWS CLI 「 コマンドリファレンスListPhoneNumbers
」の「」を参照してください。
-
次の例は、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 管理者ガイド」の「キューの作成」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスListQueues
」の「」を参照してください。
-
次のコード例は、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 詳細については、AWS CLI 「 コマンドリファレンスListRoutingProfiles
」の「」を参照してください。
-
次のコード例は、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 詳細については、AWS CLI 「 コマンドリファレンスListSecurityProfiles
」の「」を参照してください。
-
次のコード例は、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 詳細については、AWS CLI 「 コマンドリファレンスListUserHierarchyGroups
」の「」を参照してください。
-
次のコード例は、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 管理者ガイド」の「ユーザーの追加」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスListUsers
」の「」を参照してください。
-
次のコード例は、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-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
\ --attributesgreetingPlayed=false
このコマンドでは何も出力されません。
詳細については、Amazon Connect 管理者ガイド」の「Amazon Connect 問い合わせ属性の使用」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateContactAttributes
」の「」を参照してください。
-
次の例は、update-user-hierarchy
を使用する方法を説明しています。
- AWS CLI
-
ユーザーの階層を更新するには
次の
update-user-hierarchy
例では、指定された Amazon Connect ユーザーのエージェント階層を更新します。aws connect update-user-hierarchy \ --hierarchy-group-id
12345678-a1b2-c3d4-e5f6-123456789abc
\ --user-id87654321-2222-1234-1234-111234567891
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
このコマンドでは何も出力されません。
詳細については、「Amazon Connect 管理者ガイド」の「エージェント設定の設定」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateUserHierarchy
」の「」を参照してください。
-
次のコード例は、update-user-identity-info
を使用する方法を示しています。
- AWS CLI
-
ユーザーの ID 情報を更新するには
次の
update-user-identity-info
例では、指定された Amazon Connect ユーザーの ID 情報を更新します。aws connect update-user-identity-info \ --identity-info
FirstName=Mary,LastName=Major,Email=marym@example.com
\ --user-id87654321-2222-1234-1234-111234567891
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
このコマンドでは何も出力されません。
詳細については、Amazon Connect 管理者ガイド」の「エージェント設定の設定」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateUserIdentityInfo
」の「」を参照してください。
-
次のコード例は、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-id12345678-4444-3333-2222-111122223333
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
このコマンドでは何も出力されません。
詳細については、Amazon Connect 管理者ガイド」の「エージェント設定の設定」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateUserPhoneConfig
」の「」を参照してください。
-
次の例は、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-id87654321-2222-1234-1234-111234567891
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
このコマンドでは何も出力されません。
詳細については、「Amazon Connect 管理者ガイド」の「エージェント設定の設定」を参照してください。 Amazon Connect
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateUserRoutingProfile
」の「」を参照してください。
-
次のコード例は、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-id87654321-2222-1234-1234-111234567891
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
このコマンドでは何も出力されません。
詳細については、Amazon Connect 管理者ガイド」の「アクセス許可の割り当て: セキュリティプロファイル」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateUserSecurityProfiles
」の「」を参照してください。
-