[アップデート]Amazon Connectでルーティングプロファイルを検索するAPIがリリースされました

2022.09.17

こんにちは。
繁松です。

はじめに

Amazon Connect ルーティングプロファイルを検索するAPIがリリースされました。
このAPIを利用することで、名前、説明、タグ等によるルーティングプロファイルの検索が可能になります。

やってみた

CloudShellを使ってAWS CLIを実行します。

絞り込み無しで実行

以下のAWS CLIコマンドを利用して検索します。
ルーティングプロファイルは、デフォルトの[Basic Routing profile]と、[RoutingProfiles001][RoutingProfiles002]の3つのルーティングプロファイルが作成された状態です。

aws connect search-routing-profiles --instance-id AmazonConnectインスタンスID

結果

{  
    "RoutingProfiles": [  
        {  
            "InstanceId": "AmazonConnectインスタンスID",  
            "Name": "Basic Routing Profile",  
            "RoutingProfileArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/routing-profile/f0a10f94-0eb8-48b9-a975-0acebd2058ad",  
            "RoutingProfileId": "f0a10f94-0eb8-48b9-a975-0acebd2058ad",  
            "Description": "A simple routing profile.",  
            "MediaConcurrencies": [  
                {  
                    "Channel": "CHAT",  
                    "Concurrency": 2  
                },  
                {  
                    "Channel": "TASK",  
                    "Concurrency": 1  
                },  
                {  
                    "Channel": "VOICE",  
                    "Concurrency": 1  
                }  
            ],  
            "DefaultOutboundQueueId": "ccfbdd91-a5e4-4620-a91d-4345884bb3d4",  
            "Tags": {},  
            "NumberOfAssociatedQueues": 1,  
            "NumberOfAssociatedUsers": 12  
        },  
        {  
            "InstanceId": "AmazonConnectインスタンスID",  
            "Name": "RoutingProfiles001",  
            "RoutingProfileArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/routing-profile/fcb9a225-e889-4870-acaf-a3593c9e27f9",  
            "RoutingProfileId": "fcb9a225-e889-4870-acaf-a3593c9e27f9",  
            "Description": "GroupA",  
            "MediaConcurrencies": [  
                {  
                    "Channel": "VOICE",  
                    "Concurrency": 1  
                }  
            ],  
            "DefaultOutboundQueueId": "ccfbdd91-a5e4-4620-a91d-4345884bb3d4",  
            "Tags": {  
                "testtag": "test001"  
            },  
            "NumberOfAssociatedQueues": 1,  
            "NumberOfAssociatedUsers": 0  
        },  
        {  
            "InstanceId": "AmazonConnectインスタンスID",  
            "Name": "RoutingProfiles002",  
            "RoutingProfileArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/routing-profile/49d0a7a9-4aac-4738-bf83-02847ee11c46",  
            "RoutingProfileId": "49d0a7a9-4aac-4738-bf83-02847ee11c46",  
            "Description": "GroupB",  
            "MediaConcurrencies": [  
                {  
                    "Channel": "VOICE",  
                    "Concurrency": 1  
                }  
            ],  
            "DefaultOutboundQueueId": "ccfbdd91-a5e4-4620-a91d-4345884bb3d4",  
            "Tags": {  
                "testtag": "test001"  
            },  
            "NumberOfAssociatedQueues": 1,  
            "NumberOfAssociatedUsers": 0  
        }  
    ],  
    "ApproximateTotalCount": 3  
}

名前検索

以下のAWS CLIコマンドを利用してルーティングプロファイル名が[RoutingProfiles001]のルーティングプロファイルを検索します。

aws connect search-routing-profiles --instance-id AmazonConnectインスタンスID --search-criteria 'StringCondition={FieldName=Name,Value=RoutingProfiles001,ComparisonType=EXACT}'

ComparisonTypeはSTARTS_WITH(先頭一致)、CONTAINS(文字列を含む一致)、EXACT(完全一致)があります。

結果

{  
    "RoutingProfiles": [  
        {  
            "InstanceId": "AmazonConnectインスタンスID",  
            "Name": "RoutingProfiles001",  
            "RoutingProfileArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/routing-profile/fcb9a225-e889-4870-acaf-a3593c9e27f9",  
            "RoutingProfileId": "fcb9a225-e889-4870-acaf-a3593c9e27f9",  
            "Description": "GroupA",  
            "MediaConcurrencies": [  
                {  
                    "Channel": "VOICE",  
                    "Concurrency": 1  
                }  
            ],  
            "DefaultOutboundQueueId": "ccfbdd91-a5e4-4620-a91d-4345884bb3d4",  
            "Tags": {  
                "testtag": "test001"  
            },  
            "NumberOfAssociatedQueues": 1,  
            "NumberOfAssociatedUsers": 0  
        }  
    ],  
    "ApproximateTotalCount": 1  
}

タグ検索

以下のCLIコマンドを利用して[testtag=test001]のタグが付いたルーティングプロファイルを検索します。

aws connect search-routing-profiles --instance-id AmazonConnectインスタンスID --search-filter 'TagFilter={TagCondition={TagKey=testtag,TagValue=test001}}'

Amazon Connectのリソースにタグを付ける方法

結果

{  
    "RoutingProfiles": [  
        {  
            "InstanceId": "AmazonConnectインスタンスID",  
            "Name": "RoutingProfiles001",  
            "RoutingProfileArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/routing-profile/fcb9a225-e889-4870-acaf-a3593c9e27f9",  
            "RoutingProfileId": "fcb9a225-e889-4870-acaf-a3593c9e27f9",  
            "Description": "GroupA",  
            "MediaConcurrencies": [  
                {  
                    "Channel": "VOICE",  
                    "Concurrency": 1  
                }  
            ],  
            "DefaultOutboundQueueId": "ccfbdd91-a5e4-4620-a91d-4345884bb3d4",  
            "Tags": {  
                "testtag": "test001"  
            },  
            "NumberOfAssociatedQueues": 1,  
            "NumberOfAssociatedUsers": 0  
        },  
        {  
            "InstanceId": "AmazonConnectインスタンスID",  
            "Name": "RoutingProfiles002",  
            "RoutingProfileArn": "arn:aws:connect:ap-northeast-1:AWSアカウント番号:instance/AmazonConnectインスタンスID/routing-profile/49d0a7a9-4aac-4738-bf83-02847ee11c46",  
            "RoutingProfileId": "49d0a7a9-4aac-4738-bf83-02847ee11c46",  
            "Description": "GroupB",  
            "MediaConcurrencies": [  
                {  
                    "Channel": "VOICE",  
                    "Concurrency": 1  
                }  
            ],  
            "DefaultOutboundQueueId": "ccfbdd91-a5e4-4620-a91d-4345884bb3d4",  
            "Tags": {  
                "testtag": "test001"  
            },  
            "NumberOfAssociatedQueues": 1,  
            "NumberOfAssociatedUsers": 0  
        }  
    ],  
    "ApproximateTotalCount": 2  
}

さいごに

検索が出来ようになったことでルーティングプロファイルのパラメータ取得が容易になったかと思います。
以上、Amazon Connectのアップデートブログでした。