AWS snowball documentation change
Summary
Updated references from 'Snowball' to 'Snowball Edge' throughout the document, corrected product naming in IAM role sections, and updated console URLs.
Security assessment
Changes primarily involve product name standardization (Snowball Edge) and documentation accuracy updates. No specific security vulnerabilities, patches, or new security features are mentioned. IAM role content updates maintain existing security practices without introducing new security documentation.
Diff
diff --git a/snowball/latest/api-reference/api-reference.md b/snowball/latest/api-reference/api-reference.md index ae598486a..62e16155e 100644 --- a/snowball/latest/api-reference/api-reference.md +++ b/snowball/latest/api-reference/api-reference.md @@ -5 +5 @@ -API EndpointAPI VersionAPI Permission Policy ReferenceCreating an IAM Role for Snowball and Snowball Edge +API EndpointAPI VersionAPI Permission Policy ReferenceCreating an IAM Role for Snowball Edge and Snowball Edge @@ -9 +9 @@ API EndpointAPI VersionAPI Permission Policy ReferenceCreating an IAM Role for S -The job management API for AWS Snowball is a network protocol based on HTTP (RFC 2616). For more information on this RFC, see [HTTP (RFC 2616)](https://www.ietf.org/rfc/rfc2616.txt) on the IETF website. For each call to the job management API, you make an HTTP request to the region-specific job management API endpoint for the AWS Region where you want to manage jobs. The API uses JSON (RFC 4627) documents for HTTP request/response bodies. +The job management API for AWS Snowball Edge is a network protocol based on HTTP (RFC 2616). For more information on this RFC, see [HTTP (RFC 2616)](https://www.ietf.org/rfc/rfc2616.txt) on the IETF website. For each call to the job management API, you make an HTTP request to the region-specific job management API endpoint for the AWS Region where you want to manage jobs. The API uses JSON (RFC 4627) documents for HTTP request/response bodies. @@ -15 +15 @@ API calls made within the US regions for listing jobs or describing addresses re -The job management API for Snowball is an RPC model. In this model, there is a fixed set of operations and the syntax for each operation is known to clients without any previous interaction. Following, you can find a description of each API operation using an abstract RPC notation, with an operation name that does not appear on the wire. For each operation, the topic specifies the mapping to HTTP request elements. +The job management API for Snowball Edge is an RPC model. In this model, there is a fixed set of operations and the syntax for each operation is known to clients without any previous interaction. Following, you can find a description of each API operation using an abstract RPC notation, with an operation name that does not appear on the wire. For each operation, the topic specifies the mapping to HTTP request elements. @@ -17 +17 @@ The job management API for Snowball is an RPC model. In this model, there is a f -The specific job management operation to which a given request maps is determined by a combination of the request's method (GET, PUT, POST, or DELETE) and which of the various patterns its Request-URI matches. If the operation is PUT or POST, Snowball extracts call arguments from the Request-URI path segment, query parameters, and the JSON object in the request body. +The specific job management operation to which a given request maps is determined by a combination of the request's method (GET, PUT, POST, or DELETE) and which of the various patterns its Request-URI matches. If the operation is PUT or POST, Snowball Edge extracts call arguments from the Request-URI path segment, query parameters, and the JSON object in the request body. @@ -19 +19 @@ The specific job management operation to which a given request maps is determine -Although the operation name, such as `CreateJob`, doesn't appear on the wire, these operation names are meaningful in AWS Identity and Access Management (IAM) policies. The operation name is also used to name commands in command-line tools and elements of the AWS SDK APIs. For example, the AWS Command Line Interface (AWS CLI) command `create-job` maps to the `CreateJob` operation. The operation name also appears in CloudTrail logs for Snowball API calls. +Although the operation name, such as `CreateJob`, doesn't appear on the wire, these operation names are meaningful in AWS Identity and Access Management (IAM) policies. The operation name is also used to name commands in command-line tools and elements of the AWS SDK APIs. For example, the AWS Command Line Interface (AWS CLI) command `create-job` maps to the `CreateJob` operation. The operation name also appears in CloudTrail logs for Snowball Edge API calls. @@ -25 +25 @@ For information on installing and setting up the AWS CLI, including specifying w -The job management API provides a programmatic interface to the same functionality available in the [AWS Snowball Management Console](https://console.aws.amazon.com/importexport/home?region=us-west-2), that is to create and manage jobs for Snowball. To transfer data locally with a Snowball appliance, use the Snowball Edge Client or the S3 SDK Adapter for Snowball. For more information, see [Transferring Data with a Snowball](https://docs.aws.amazon.com/snowball/latest/ug/snowball-data-transfer.html) in the _AWS Snowball User Guide_. +The job management API provides a programmatic interface to the same functionality available in the [AWS Snowball Management Console](https://console.aws.amazon.com/importexport/home?region=us-west-2), that is to create and manage jobs for Snowball Edge. To transfer data locally with a Snowball appliance, use the Snowball Edge Client or the S3 SDK Adapter for Snowball Edge. For more information, see [Transferring Data with a Snowball](https://docs.aws.amazon.com/snowball/latest/ug/snowball-data-transfer.html) in the _AWS Snowball User Guide_. @@ -36 +36 @@ The API endpoint is the Domain Name Service (DNS) name used as a host in the HTT -For example, the Snowball API endpoint for the US West (Oregon) Region is the following. +For example, the Snowball Edge API endpoint for the US West (Oregon) Region is the following. @@ -41 +41 @@ For example, the Snowball API endpoint for the US West (Oregon) Region is the fo -For a list of AWS Regions that Snowball supports (where you can create and manage jobs), see [AWS Import/Export](https://docs.aws.amazon.com/general/latest/gr/rande.html#ie-region) in the _AWS General Reference_. +For a list of AWS Regions that Snowball Edge supports (where you can create and manage jobs), see [AWS Import/Export](https://docs.aws.amazon.com/general/latest/gr/rande.html#ie-region) in the _AWS General Reference_. @@ -43 +43 @@ For a list of AWS Regions that Snowball supports (where you can create and manag -The region-specific API endpoint defines the scope of the Snowball resources that are accessible when you make an API call. For example, when you call the `ListJobs` operation using the preceding endpoint, you get a list of jobs in the US West (Oregon) Region that have been created in your account. +The region-specific API endpoint defines the scope of the Snowball Edge resources that are accessible when you make an API call. For example, when you call the `ListJobs` operation using the preceding endpoint, you get a list of jobs in the US West (Oregon) Region that have been created in your account. @@ -51 +51 @@ The version of the API being used for a call is identified by the first path seg -The following policies are needed for creating jobs with the job management API for Snowball. +The following policies are needed for creating jobs with the job management API for Snowball Edge. @@ -154 +154 @@ Creating an export job requires the following role policy. -In some cases, the Amazon S3 buckets that you use with Snowball have bucket policies in place that require listing the role session name of the assumed role. In these cases, you need to specify a principal in those policies that identifies `AWSImportExport-Validation`. The following Amazon S3 bucket policy example demonstrates how to do so. +In some cases, the Amazon S3 buckets that you use with Snowball Edge have bucket policies in place that require listing the role session name of the assumed role. In these cases, you need to specify a principal in those policies that identifies `AWSImportExport-Validation`. The following Amazon S3 bucket policy example demonstrates how to do so. @@ -178 +178 @@ In this policy example, we deny access to all principals except the one named in -For jobs in AWS GovCloud (US), Snowball uses `AWSIEJob` as the role session name of the assumed role. +For jobs in AWS GovCloud (US), Snowball Edge uses `AWSIEJob` as the role session name of the assumed role. @@ -180 +180 @@ For jobs in AWS GovCloud (US), Snowball uses `AWSIEJob` as the role session name -## Creating an IAM Role for Snowball and Snowball Edge +## Creating an IAM Role for Snowball Edge and Snowball Edge @@ -182 +182 @@ For jobs in AWS GovCloud (US), Snowball uses `AWSIEJob` as the role session name -An IAM role policy must be created with read and write permissions for your Amazon S3 buckets. The IAM role must also have a trust relationship with Snowball. Having a trust relationship means that AWS can write the data in the Snowball and in your Amazon S3 buckets, depending on whether you're importing or exporting data. +An IAM role policy must be created with read and write permissions for your Amazon S3 buckets. The IAM role must also have a trust relationship with Snowball Edge. Having a trust relationship means that AWS can write the data in the Snowball and in your Amazon S3 buckets, depending on whether you're importing or exporting data. @@ -184 +184 @@ An IAM role policy must be created with read and write permissions for your Amaz -When you create a job in the AWS Snow Family Management Console, creating the necessary IAM role occurs in step 4 in the **Permission** section. This process is automatic. The IAM role that you allow Snowball to assume is only used to write your data to your bucket when the Snowball with your transferred data arrives at AWS. The following procedure outlines that process. +When you create a job in the AWS Snow Family Management Console, creating the necessary IAM role occurs in step 4 in the **Permission** section. This process is automatic. The IAM role that you allow Snowball Edge to assume is only used to write your data to your bucket when the Snowball with your transferred data arrives at AWS. The following procedure outlines that process. @@ -188 +188 @@ When you create a job in the AWS Snow Family Management Console, creating the ne - 1. Sign in to the AWS Management Console and open the AWS Snowball console at [https://console.aws.amazon.com/importexport/](https://console.aws.amazon.com/importexport/). + 1. Sign in to the AWS Management Console and open the AWS Snowball Edge console at [https://console.aws.amazon.com/importexport/](https://console.aws.amazon.com/importexport/).