SSM ドキュメントを検索する - AWS Systems Manager

SSM ドキュメントを検索する

AWS Systems Manager (SSM) ドキュメントストアでは、フリーテキスト検索やフィルターによる検索を使用して、SSM ドキュメントを検索することができます。このセクションでは、この両方の機能を使用して SSM ドキュメントを検索する方法について説明します。

フリーテキスト検索の使用

Systems Manager の [ドキュメント] ページの検索ボックスでは、フリーテキスト検索がサポートされています。フリーテキスト検索では、入力した検索語を各 SSM ドキュメントのドキュメント名と比較します。例えば、「ansible」という 1 つの検索語を入力すると、Systems Manager はこの語を含むすべての SSM ドキュメントを返します。複数の検索語を入力すると、Systems Manager は OR ステートメントを使用して検索します。例えば、ansiblelinux を指定すると、名前にどちらかの検索語を含むすべてのドキュメントが返されます。

フリーテキスト検索用語を入力して [Platform type] (プラットフォームタイプ) などの検索オプションを選択する場合は、検索が AND 文を使用して、名前に指定したキーワードが含まれ、かつ指定したプラットフォームタイプのすべてのドキュメントを返します。

注記

フリーテキスト検索では、次の点に注意してください。

  • フリーテキスト検索では、大文字と小文字は区別されません

  • 検索語は 3~20 文字にする必要があります。

  • フリーテキスト検索では、検索語を 5 つまで使用できます。

  • 検索語の間にスペースを入れると、検索時にスペースが含まれます。

  • フリーテキスト検索は、[Document type (ドキュメントタイプ)] や [Platform type (プラットフォームタイプ)] などの他の検索オプションと組み合わせることができます。

  • [Document name prefix (ドキュメント名のプレフィックス)] フィルターとフリーテキスト検索は一緒に使用できません。

SSM ドキュメントを検索するには

  1. AWS Systems Manager コンソール (https://console.aws.amazon.com/systems-manager/) を開きます。

  2. ナビゲーションペインで、[ドキュメント] を選択します。

    -または-

    AWS Systems Manager ホームページが最初に開く場合は、メニューアイコン ( ) を選択してナビゲーションペインを開き、[ドキュメント] を選択します。

  3. 検索ボックスに検索語を入力し、Enter キーを押します。

AWS CLI を使用したドキュメントのフリーテキスト検索の実行

CLI を使用してドキュメントのフリーテキスト検索を実行するには

  1. まだ AWS Command Line Interface (AWS CLI) をインストールして設定していない場合は、インストールして設定します。

    詳細については、「AWS コマンドラインツールのインストールまたはアップグレード」を参照してください。

  2. 1 つの検索語でドキュメントのフリーテキスト検索を実行するには、次のコマンドを実行します。このコマンドの search_term を使用する検索語に置き換えてください。

    aws ssm list-documents --filters Key="SearchKeyword",Values="search_term"

    以下に例を示します。

    aws ssm list-documents --filters Key="SearchKeyword",Values="aws-asg" --region us-east-2

    複数の検索語を使用して AND 演算で検索するには、次のコマンドを実行します。このコマンドの search_term_1search_term_2 を使用する検索語に置き換えてください。

    aws ssm list-documents --filters Key="SearchKeyword",Values="search_term_1","search_term_2","search_term_3" --region us-east-2

    以下に例を示します。

    aws ssm list-documents --filters Key="SearchKeyword",Values="aws-asg","aws-ec2","restart" --region us-east-2

フィルターの使用

Systems Manager の [Documents (ドキュメント)] ページの検索ボックスを選択すると、以下のフィルターが自動的に表示されます。

  • [Document name prefix (ドキュメント名のプレフィックス)]

  • [Platform types (プラットフォームタイプ)]

  • [Document type (ドキュメントタイプ)]

  • タグキー


                    SSM ドキュメントページのフィルターオプション

1 つのフィルターを使用して、SSM ドキュメントを検索できます。より具体的な SSM ドキュメントのセットを返す場合は、複数のフィルターを適用できます。次の図は、[Platform types (プラットフォームタイプ)] フィルターと [Document name prefix (ドキュメント名のプレフィックス)] フィルターを使用した検索の例を示しています。


                    SSM ドキュメントページで複数のフィルターオプションを適用します。

複数のフィルターを適用すると、Systems Manager は選択したフィルターに基づいて異なる検索ステートメントで検索します。

  • 同じフィルター ([Document name prefix (ドキュメント名のプレフィックス)] など) を複数回適用すると、Systems Manager は OR ステートメントを使用して検索します。例えば、1 つ目の [Document name prefix (ドキュメント名のプレフィックス)] フィルターに「AWS」を指定し、2 つ目の [Document name prefix (ドキュメント名のプレフィックス)] フィルターに「Lambda」を指定した場合、検索ではプレフィックスが「AWS」のすべてのドキュメントとプレフィックスが「Lambda」のすべてのドキュメントが返されます。

  • 異なるフィルター ([Document name prefix (ドキュメント名のプレフィックス)] と [Platform types (プラットフォームタイプ)] など) を適用すると、Systems Manager は AND ステートメントを使用して検索します。例えば、[Document name prefix (ドキュメント名のプレフィックス)] を AWS フィルターに指定し、[Platform types (プラットフォームタイプ)] を Linux フィルターに指定した場合、検索では Linux プラットフォームにあるプレフィックスが「AWS」のすべてのドキュメントが返されます。

注記

フィルターを使用する検索では、大文字と小文字は区別されます。