AWS snowball documentation change
Summary
Updated terminology from 'Snow Device Management' to 'Snowball Edge Device Management' throughout the document, including section headers, commands, and parameter references
Security assessment
The changes appear to be a branding/terminology update rather than addressing a security vulnerability. No security-related content was added or modified beyond name standardization.
Diff
diff --git a/snowball/latest/developer-guide/aws-sdm.md b/snowball/latest/developer-guide/aws-sdm.md index f05deeec6..3a01bc468 100644 --- a/snowball/latest/developer-guide/aws-sdm.md +++ b/snowball/latest/developer-guide/aws-sdm.md @@ -5 +5 @@ -Choosing the Snow Device Management state when ordering a Snowball EdgeActivating Snow Device Management on a Snowball EdgeAdding permissions for Snow Device Management to an IAM role on a Snowball EdgeSnow Device Management CLI commands +Choosing the Snowball Edge Device Management state when ordering a Snowball EdgeActivating Snowball Edge Device Management on a Snowball EdgeAdding permissions for Snowball Edge Device Management to an IAM role on a Snowball EdgeSnowball Edge Device Management CLI commands @@ -7 +7 @@ Choosing the Snow Device Management state when ordering a Snowball EdgeActivatin -# Using AWS Snow Device Management to manage Snowball Edge +# Using AWS Snowball Edge Device Management to manage Snowball Edge @@ -9 +9 @@ Choosing the Snow Device Management state when ordering a Snowball EdgeActivatin -AWS Snow Device Management allows you to manage your Snowball Edge and local AWS services remotely. All Snowball Edge support Snow Device Management, and it comes installed on new devices in most AWS Regions where Snowball Edge are available. +AWS Snowball Edge Device Management allows you to manage your Snowball Edge and local AWS services remotely. All Snowball Edge support Snowball Edge Device Management, and it comes installed on new devices in most AWS Regions where Snowball Edge are available. @@ -11 +11 @@ AWS Snow Device Management allows you to manage your Snowball Edge and local AWS -With Snow Device Management, you can perform the following tasks: +With Snowball Edge Device Management, you can perform the following tasks: @@ -46 +46 @@ With Snow Device Management, you can perform the following tasks: - * Choosing the Snow Device Management state when ordering a Snowball Edge + * Choosing the Snowball Edge Device Management state when ordering a Snowball Edge @@ -48 +48 @@ With Snow Device Management, you can perform the following tasks: - * Activating Snow Device Management on a Snowball Edge + * Activating Snowball Edge Device Management on a Snowball Edge @@ -50 +50 @@ With Snow Device Management, you can perform the following tasks: - * Adding permissions for Snow Device Management to an IAM role on a Snowball Edge + * Adding permissions for Snowball Edge Device Management to an IAM role on a Snowball Edge @@ -52 +52 @@ With Snow Device Management, you can perform the following tasks: - * Snow Device Management CLI commands + * Snowball Edge Device Management CLI commands @@ -57 +57 @@ With Snow Device Management, you can perform the following tasks: -## Choosing the Snow Device Management state when ordering a Snowball Edge +## Choosing the Snowball Edge Device Management state when ordering a Snowball Edge @@ -59 +59 @@ With Snow Device Management, you can perform the following tasks: -When you create a job to order a Snow device, you can choose which state Snow Device Management will be in when you receive the device: installed but not activated or installed and activated. If it is installed but not activated, you will need to use AWS OpsHub or the Snowball Edge client to activate it before using it. If it is installed and activated, you can use Snow Device Management after receiving the device and connecting it to your local network. You can choose the Snow Device Management state when creating a job to order a device through the AWS Snow Family Management Console, the Snowball Edge client, the AWS CLI, or the Snow job management API. +When you create a job to order a Snow device, you can choose which state Snowball Edge Device Management will be in when you receive the device: installed but not activated or installed and activated. If it is installed but not activated, you will need to use AWS OpsHub or the Snowball Edge client to activate it before using it. If it is installed and activated, you can use Snowball Edge Device Management after receiving the device and connecting it to your local network. You can choose the Snowball Edge Device Management state when creating a job to order a device through the AWS Snow Family Management Console, the Snowball Edge client, the AWS CLI, or the Snow job management API. @@ -61 +61 @@ When you create a job to order a Snow device, you can choose which state Snow De -###### To choose the Snow Device Management state from the AWS Snow Family Management Console +###### To choose the Snowball Edge Device Management state from the AWS Snow Family Management Console @@ -63 +63 @@ When you create a job to order a Snow device, you can choose which state Snow De - 1. To choose for Snow Device Management to be installed and activated, choose **Manage your Snow device remotely with AWS OpsHub or Snowball client**. + 1. To choose for Snowball Edge Device Management to be installed and activated, choose **Manage your Snow device remotely with AWS OpsHub or Snowball client**. @@ -65 +65 @@ When you create a job to order a Snow device, you can choose which state Snow De - 2. To choose for Snow Device Management to be installed but not activated, do not select **Manage your Snow device remotely with AWS OpsHub or Snowball client**. + 2. To choose for Snowball Edge Device Management to be installed but not activated, do not select **Manage your Snow device remotely with AWS OpsHub or Snowball client**. @@ -72 +72 @@ For more information, see [Step 3: Choose your features and options](https://doc -###### To choose the Snow Device Management state from the AWS CLI, Snowball Edge client, or Snow job management API: +###### To choose the Snowball Edge Device Management state from the AWS CLI, Snowball Edge client, or Snow job management API: @@ -74 +74 @@ For more information, see [Step 3: Choose your features and options](https://doc - * Use the `remote-management` parameter to specify the Snow Device Management state. The `INSTALLED_ONLY` value of the parameter means Snow Device Management is installed but not activated. The `INSTALLED_AUTOSTART` value of the parameter means Snow Device Management is installed and activated. If you don't specify a value for this parameter, `INSTALLED_ONLY` is the default value. + * Use the `remote-management` parameter to specify the Snowball Edge Device Management state. The `INSTALLED_ONLY` value of the parameter means Snowball Edge Device Management is installed but not activated. The `INSTALLED_AUTOSTART` value of the parameter means Snowball Edge Device Management is installed and activated. If you don't specify a value for this parameter, `INSTALLED_ONLY` is the default value. @@ -98 +98 @@ For more information, see [Job Management API Reference](https://docs.aws.amazon -## Activating Snow Device Management on a Snowball Edge +## Activating Snowball Edge Device Management on a Snowball Edge @@ -100 +100 @@ For more information, see [Job Management API Reference](https://docs.aws.amazon -Follow this procedure to activate Snow Device Management using the Snowball Edge client. +Follow this procedure to activate Snowball Edge Device Management using the Snowball Edge client. @@ -131 +131 @@ The Snowball Edge client returns the following when the command is successful. -## Adding permissions for Snow Device Management to an IAM role on a Snowball Edge +## Adding permissions for Snowball Edge Device Management to an IAM role on a Snowball Edge @@ -133 +133 @@ The Snowball Edge client returns the following when the command is successful. -On the AWS account from which the device was ordered, create an AWS Identity and Access Management (IAM) role, and add the following policy to the role. Then, assign the role to the IAM user who will log in to remotely manage your device with Snow Device Management. For more information, see [Creating IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) and [Creating an IAM user in your AWS account](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html). +On the AWS account from which the device was ordered, create an AWS Identity and Access Management (IAM) role, and add the following policy to the role. Then, assign the role to the IAM user who will log in to remotely manage your device with Snowball Edge Device Management. For more information, see [Creating IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) and [Creating an IAM user in your AWS account](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html). @@ -164 +164 @@ On the AWS account from which the device was ordered, create an AWS Identity and -## Snow Device Management CLI commands +## Snowball Edge Device Management CLI commands @@ -166 +166 @@ On the AWS account from which the device was ordered, create an AWS Identity and -This section describes the AWS CLI commands that you can use to manage your Snowball Edge remotely with Snow Device Management. You can also perform some remote management tasks using AWS OpsHub. For more information, see [Managing AWS services on your device](https://docs.aws.amazon.com/snowball/latest/developer-guide/manage-services.html). +This section describes the AWS CLI commands that you can use to manage your Snowball Edge remotely with Snowball Edge Device Management. You can also perform some remote management tasks using AWS OpsHub. For more information, see [Managing AWS services on your device](https://docs.aws.amazon.com/snowball/latest/developer-guide/manage-services.html). @@ -174 +174 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Creating a task to manage a Snowball Edge with Snow Device Management + * Creating a task to manage a Snowball Edge with Snowball Edge Device Management @@ -178 +178 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Checking information about a Snowball Edge using Snow Device Management + * Checking information about a Snowball Edge using Snowball Edge Device Management @@ -180 +180 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Checking states of Amazon EC2-compatible instances on Snowball Edge with Snow Device Management + * Checking states of Amazon EC2-compatible instances on Snowball Edge with Snowball Edge Device Management @@ -182 +182 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Viewing task metadata on Snowball Edge with Snow Device Management + * Viewing task metadata on Snowball Edge with Snowball Edge Device Management @@ -184 +184 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Canceling a task on a Snowball Edge with Snow Device Management + * Canceling a task on a Snowball Edge with Snowball Edge Device Management @@ -186 +186 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Listing Snow Device Management commands and syntax + * Listing Snowball Edge Device Management commands and syntax @@ -190 +190 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Listing status of Snow Device Management tasks across Snowball Edge + * Listing status of Snowball Edge Device Management tasks across Snowball Edge @@ -192 +192 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Listing available resources on Snowball Edge with Snow Device Management + * Listing available resources on Snowball Edge with Snowball Edge Device Management @@ -194 +194 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Listing tags for Snowball Edge or Snow Device Management tags + * Listing tags for Snowball Edge or Snowball Edge Device Management tags @@ -196 +196 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Listing Snow Device Management tasks by status + * Listing Snowball Edge Device Management tasks by status @@ -198 +198 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Appling tags to Snow Device Management tasks or Snowball Edge + * Appling tags to Snowball Edge Device Management tasks or Snowball Edge @@ -200 +200 @@ Before managing your device, make sure it is powered on, connected to your netwo - * Removing Snow Device Management tags from tasks or Snowball Edge + * Removing Snowball Edge Device Management tags from tasks or Snowball Edge @@ -205 +205 @@ Before managing your device, make sure it is powered on, connected to your netwo -### Creating a task to manage a Snowball Edge with Snow Device Management +### Creating a task to manage a Snowball Edge with Snowball Edge Device Management @@ -293 +293 @@ To check the status of a task, use the following command. Replace each ``user in -### Checking information about a Snowball Edge using Snow Device Management +### Checking information about a Snowball Edge using Snowball Edge Device Management @@ -324 +324 @@ To check device info, use the following command. Replace each ``user input place -### Checking states of Amazon EC2-compatible instances on Snowball Edge with Snow Device Management +### Checking states of Amazon EC2-compatible instances on Snowball Edge with Snowball Edge Device Management @@ -397 +397 @@ To check the state of the Amazon EC2-compatible instance, use the following comm -### Viewing task metadata on Snowball Edge with Snow Device Management +### Viewing task metadata on Snowball Edge with Snowball Edge Device Management @@ -453 +453 @@ To check a task's metadata, use the following command. Replace each ``user input -### Canceling a task on a Snowball Edge with Snow Device Management +### Canceling a task on a Snowball Edge with Snowball Edge Device Management @@ -489 +489 @@ To cancel a task, use the following command. Replace each ``user input placehold -### Listing Snow Device Management commands and syntax +### Listing Snowball Edge Device Management commands and syntax @@ -491 +491 @@ To cancel a task, use the following command. Replace each ``user input placehold -To return a list of all supported commands for the Snow Device Management API, use the `help` command. You can also use the `help` command to return detailed information about and syntax for a given command. +To return a list of all supported commands for the Snowball Edge Device Management API, use the `help` command. You can also use the `help` command to return detailed information about and syntax for a given command. @@ -511 +511 @@ To return detailed information and syntax for a command, use the following comma -To return a list of all devices on your account that have Snow Device Management enabled in the AWS Region where the command is run, use the `list-devices` command. `--max-results` and `--next-token` are optional. For more information, see [Using AWS CLI pagination options](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-pagination.html) in the "AWS Command Line Interface User Guide". +To return a list of all devices on your account that have Snowball Edge Device Management enabled in the AWS Region where the command is run, use the `list-devices` command. `--max-results` and `--next-token` are optional. For more information, see [Using AWS CLI pagination options](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-pagination.html) in the "AWS Command Line Interface User Guide". @@ -547 +547 @@ To list remote-manageable devices, use the following command. Replace each ``use -### Listing status of Snow Device Management tasks across Snowball Edge +### Listing status of Snowball Edge Device Management tasks across Snowball Edge @@ -606 +606 @@ To list task status across devices, use the following command. Replace each ``us -### Listing available resources on Snowball Edge with Snow Device Management +### Listing available resources on Snowball Edge with Snowball Edge Device Management @@ -645 +645 @@ To list the available resources for a device, use the following command. Replace -### Listing tags for Snowball Edge or Snow Device Management tags +### Listing tags for Snowball Edge or Snowball Edge Device Management tags @@ -677 +677 @@ To list the tags for a device, use the following command. Replace the example Am -### Listing Snow Device Management tasks by status +### Listing Snowball Edge Device Management tasks by status @@ -717 +717 @@ To list tasks by status, use the following command. Replace each ``user input pl -### Appling tags to Snow Device Management tasks or Snowball Edge +### Appling tags to Snowball Edge Device Management tasks or Snowball Edge @@ -740 +740 @@ To apply tags to a device, use the following command. Replace each ``user input -### Removing Snow Device Management tags from tasks or Snowball Edge +### Removing Snowball Edge Device Management tags from tasks or Snowball Edge