ドキュメントの表記規則 - AWS Systems Manager

ドキュメントの表記規則

以下に、「AWS Systems Manager ユーザーガイド」の一般的な表記規則を示します。

ローカルオペレーティングシステムまたはコマンドライン言語のさまざまな例

タブを使用して、ユーザーのローカルオペレーティングシステムのタイプに基づいてさまざまなコマンドの例を示します。Linux および macOS の例では、バックスラッシュ (\) 文字を、長いコマンドを複数の行に分割するために使用します。Windows Server の例では、キャレット (^) 文字を使用してコマンドを複数行に分割します。

例：

Linux & macOS
aws ssm update-service-setting \
    --setting-id arn:aws:ssm:region:aws-account-id:servicesetting/ssm/managed-instance/activation-tier \
    --setting-value advanced
Windows
aws ssm update-service-setting ^
    --setting-id arn:aws:ssm:region:aws-account-id:servicesetting/ssm/managed-instance/activation-tier ^
    --setting-value advanced
ユーザーインターフェイス内の要素

フォーマット: 太字のテキスト

例: [ファイル]、[プロパティ] の順に選択します。

ユーザー入力 (ユーザーが入力するテキスト)

フォーマット: 等幅フォントのテキスト

例: 名前として、my-new-resource を入力します。

必要な値のプレースホルダーテキスト

フォーマット: 斜体のテキスト

例：

aws ec2 register-image --image-location amzn-s3-demo-bucket/image.manifest.xml