この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。
こんにちは。
繁松です。
はじめに
Amazon Connect キューを検索するAPIがリリースされました。
このAPIを利用することで、名前、説明、タグ等によるキューの検索が可能になります。
やってみた
CloudShellを使ってAWS CLIを実行します。
絞り込み無しで実行
以下のAWS CLIコマンドを利用して検索します。
キューは、デフォルトの[BasicQueue]、作成した[testQueue1][testQueue2]、無効化している[testQueue3]、4つのキューが作成された状態です。
aws connect search-queues --instance-id AmazonConnectインスタンスID
結果
全てのキューの情報を表示することができます。
[testQueue3]のStatusがDISABLEDになっていることを確認できました。
{
"Queues": [
{
"Name": "BasicQueue",
"QueueArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/queue/ccfbdd91-a5e4-4620-a91d-4345884bb3d4",
"QueueId": "ccfbdd91-a5e4-4620-a91d-4345884bb3d4",
"Description": "A simple, basic voice queue.",
"OutboundCallerConfig": {
"OutboundCallerIdNumberId": "8470bd99-94f6-4840-ada1-05fafae651b1",
"OutboundFlowId": "c8a02738-7a8b-486f-a50f-a4c81f52cfc7"
},
"HoursOfOperationId": "a9d71141-3771-482e-83ea-16a1588db0aa",
"Status": "ENABLED",
"Tags": {}
},
{
"Name": "testQueue1",
"QueueArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/queue/ac4085b4-cc9d-4e12-9a35-925486e5bd0d",
"QueueId": "ac4085b4-cc9d-4e12-9a35-925486e5bd0d",
"OutboundCallerConfig": {},
"HoursOfOperationId": "a9d71141-3771-482e-83ea-16a1588db0aa",
"Status": "ENABLED",
"Tags": {}
},
{
"Name": "testQueue2",
"QueueArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/queue/9e73654a-e963-4f35-8de6-0af7badfae45",
"QueueId": "9e73654a-e963-4f35-8de6-0af7badfae45",
"OutboundCallerConfig": {},
"HoursOfOperationId": "a9d71141-3771-482e-83ea-16a1588db0aa",
"Status": "ENABLED",
"Tags": {
"testtag": "test001"
}
},
{
"Name": "testQueue3",
"QueueArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/queue/aa2246c2-f1de-4712-9c08-fb7ef8cb120e",
"QueueId": "aa2246c2-f1de-4712-9c08-fb7ef8cb120e",
"OutboundCallerConfig": {},
"HoursOfOperationId": "a9d71141-3771-482e-83ea-16a1588db0aa",
"Status": "DISABLED",
"Tags": {
"testtag": "test001"
}
}
],
"ApproximateTotalCount": 4
}
名前検索
以下のAWS CLIコマンドを利用してキュー名が[testQueue1]のキューを検索します。
aws connect search-queues --instance-id AmazonConnectインスタンスID --search-criteria 'StringCondition={FieldName=Name,Value=testQueue1,ComparisonType=EXACT}'
ComparisonTypeはSTARTS_WITH(先頭一致)、CONTAINS(文字列を含む一致)、EXACT(完全一致)があります。
結果
{
"Queues": [
{
"Name": "testQueue1",
"QueueArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/queue/ac4085b4-cc9d-4e12-9a35-925486e5bd0d",
"QueueId": "ac4085b4-cc9d-4e12-9a35-925486e5bd0d",
"OutboundCallerConfig": {},
"HoursOfOperationId": "a9d71141-3771-482e-83ea-16a1588db0aa",
"Status": "ENABLED",
"Tags": {}
}
],
"ApproximateTotalCount": 1
}
タグ検索
以下のCLIコマンドを利用して[testtag=test001]のタグが付いたキューを検索します。
タグは[testQueue2]と[testQueue3]につけています。
aws connect search-queues --instance-id AmazonConnectインスタンスID --search-filter 'TagFilter={TagCondition={TagKey=testtag,TagValue=test001}}'
結果
{
"Queues": [
{
"Name": "testQueue2",
"QueueArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/queue/9e73654a-e963-4f35-8de6-0af7badfae45",
"QueueId": "9e73654a-e963-4f35-8de6-0af7badfae45",
"OutboundCallerConfig": {},
"HoursOfOperationId": "a9d71141-3771-482e-83ea-16a1588db0aa",
"Status": "ENABLED",
"Tags": {
"testtag": "test001"
}
},
{
"Name": "testQueue3",
"QueueArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/queue/aa2246c2-f1de-4712-9c08-fb7ef8cb120e",
"QueueId": "aa2246c2-f1de-4712-9c08-fb7ef8cb120e",
"OutboundCallerConfig": {},
"HoursOfOperationId": "a9d71141-3771-482e-83ea-16a1588db0aa",
"Status": "DISABLED",
"Tags": {
"testtag": "test001"
}
}
],
"ApproximateTotalCount": 2
}
さいごに
検索が出来ようになったことでキューのパラメータ取得が容易になったかと思います。
以上、Amazon Connectのアップデートブログでした。