@aws-sdk/client-snowball 3.287.0 → 3.289.0

package/dist-types/commands/CancelClusterCommand.d.ts

@@ -31,6 +31,17 @@ export interface CancelClusterCommandOutput extends CancelClusterResult, __Metad
  * @see {@link CancelClusterCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To cancel a cluster job
+ * ```javascript
+ * // This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status.
+ * const input = {
+ *   "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000"
+ * };
+ * const command = new CancelClusterCommand(input);
+ * await client.send(command);
+ * // example id: to-cancel-a-cluster-job-1482533760554
+ * ```
+ *
  */
 export declare class CancelClusterCommand extends $Command<CancelClusterCommandInput, CancelClusterCommandOutput, SnowballClientResolvedConfig> {
     readonly input: CancelClusterCommandInput;

package/dist-types/commands/CancelJobCommand.d.ts

@@ -32,6 +32,17 @@ export interface CancelJobCommandOutput extends CancelJobResult, __MetadataBeare
  * @see {@link CancelJobCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To cancel a job for a Snowball device
+ * ```javascript
+ * // This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance.
+ * const input = {
+ *   "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
+ * };
+ * const command = new CancelJobCommand(input);
+ * await client.send(command);
+ * // example id: to-cancel-a-job-for-a-snowball-device-1482534699477
+ * ```
+ *
  */
 export declare class CancelJobCommand extends $Command<CancelJobCommandInput, CancelJobCommandOutput, SnowballClientResolvedConfig> {
     readonly input: CancelJobCommandInput;

package/dist-types/commands/CreateAddressCommand.d.ts

@@ -32,6 +32,31 @@ export interface CreateAddressCommandOutput extends CreateAddressResult, __Metad
  * @see {@link CreateAddressCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To create an address for a job
+ * ```javascript
+ * // This operation creates an address for a job. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.
+ * const input = {
+ *   "Address": {
+ *     "City": "Seattle",
+ *     "Company": "My Company's Name",
+ *     "Country": "USA",
+ *     "Name": "My Name",
+ *     "PhoneNumber": "425-555-5555",
+ *     "PostalCode": "98101",
+ *     "StateOrProvince": "WA",
+ *     "Street1": "123 Main Street"
+ *   }
+ * };
+ * const command = new CreateAddressCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"
+ * }
+ * *\/
+ * // example id: to-create-an-address-for-a-job-1482535416294
+ * ```
+ *
  */
 export declare class CreateAddressCommand extends $Command<CreateAddressCommandInput, CreateAddressCommandOutput, SnowballClientResolvedConfig> {
     readonly input: CreateAddressCommandInput;

package/dist-types/commands/CreateClusterCommand.d.ts

@@ -30,6 +30,40 @@ export interface CreateClusterCommandOutput extends CreateClusterResult, __Metad
  * @see {@link CreateClusterCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To create a cluster
+ * ```javascript
+ * // Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.
+ * const input = {
+ *   "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
+ *   "Description": "MyCluster",
+ *   "JobType": "LOCAL_USE",
+ *   "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
+ *   "Notification": {
+ *     "JobStatesToNotify": [],
+ *     "NotifyAll": false
+ *   },
+ *   "Resources": {
+ *     "S3Resources": [
+ *       {
+ *         "BucketArn": "arn:aws:s3:::MyBucket",
+ *         "KeyRange": {}
+ *       }
+ *     ]
+ *   },
+ *   "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role",
+ *   "ShippingOption": "SECOND_DAY",
+ *   "SnowballType": "EDGE"
+ * };
+ * const command = new CreateClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000"
+ * }
+ * *\/
+ * // example id: to-create-a-cluster-1482864724077
+ * ```
+ *
  */
 export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, SnowballClientResolvedConfig> {
     readonly input: CreateClusterCommandInput;

package/dist-types/commands/CreateJobCommand.d.ts

@@ -156,6 +156,41 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare
  * @see {@link CreateJobCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To create a job
+ * ```javascript
+ * // Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.
+ * const input = {
+ *   "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
+ *   "Description": "My Job",
+ *   "JobType": "IMPORT",
+ *   "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
+ *   "Notification": {
+ *     "JobStatesToNotify": [],
+ *     "NotifyAll": false
+ *   },
+ *   "Resources": {
+ *     "S3Resources": [
+ *       {
+ *         "BucketArn": "arn:aws:s3:::MyBucket",
+ *         "KeyRange": {}
+ *       }
+ *     ]
+ *   },
+ *   "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role",
+ *   "ShippingOption": "SECOND_DAY",
+ *   "SnowballCapacityPreference": "T80",
+ *   "SnowballType": "STANDARD"
+ * };
+ * const command = new CreateJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
+ * }
+ * *\/
+ * // example id: to-create-a-job-1482864834886
+ * ```
+ *
  */
 export declare class CreateJobCommand extends $Command<CreateJobCommandInput, CreateJobCommandOutput, SnowballClientResolvedConfig> {
     readonly input: CreateJobCommandInput;

package/dist-types/commands/DescribeAddressCommand.d.ts

@@ -30,6 +30,32 @@ export interface DescribeAddressCommandOutput extends DescribeAddressResult, __M
  * @see {@link DescribeAddressCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To describe an address for a job
+ * ```javascript
+ * // This operation describes an address for a job.
+ * const input = {
+ *   "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"
+ * };
+ * const command = new DescribeAddressCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Address": {
+ *     "AddressId": "ADID5643ec50-3eec-4eb3-9be6-9374c10eb51b",
+ *     "City": "Seattle",
+ *     "Company": "My Company",
+ *     "Country": "US",
+ *     "Name": "My Name",
+ *     "PhoneNumber": "425-555-5555",
+ *     "PostalCode": "98101",
+ *     "StateOrProvince": "WA",
+ *     "Street1": "123 Main Street"
+ *   }
+ * }
+ * *\/
+ * // example id: to-describe-an-address-for-a-job-1482538608745
+ * ```
+ *
  */
 export declare class DescribeAddressCommand extends $Command<DescribeAddressCommandInput, DescribeAddressCommandOutput, SnowballClientResolvedConfig> {
     readonly input: DescribeAddressCommandInput;

package/dist-types/commands/DescribeAddressesCommand.d.ts

@@ -31,6 +31,32 @@ export interface DescribeAddressesCommandOutput extends DescribeAddressesResult,
  * @see {@link DescribeAddressesCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To describe all the addresses you've created for AWS Snowball
+ * ```javascript
+ * // This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.
+ * const input = {};
+ * const command = new DescribeAddressesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Addresses": [
+ *     {
+ *       "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
+ *       "City": "Seattle",
+ *       "Company": "My Company",
+ *       "Country": "US",
+ *       "Name": "My Name",
+ *       "PhoneNumber": "425-555-5555",
+ *       "PostalCode": "98101",
+ *       "StateOrProvince": "WA",
+ *       "Street1": "123 Main Street"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-all-the-addresses-youve-created-for-aws-snowball-1482538936603
+ * ```
+ *
  */
 export declare class DescribeAddressesCommand extends $Command<DescribeAddressesCommandInput, DescribeAddressesCommandOutput, SnowballClientResolvedConfig> {
     readonly input: DescribeAddressesCommandInput;

package/dist-types/commands/DescribeClusterCommand.d.ts

@@ -30,6 +30,44 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResult, __M
  * @see {@link DescribeClusterCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To describe a cluster
+ * ```javascript
+ * // Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
+ * const input = {
+ *   "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000"
+ * };
+ * const command = new DescribeClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ClusterMetadata": {
+ *     "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
+ *     "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000",
+ *     "ClusterState": "Pending",
+ *     "CreationDate": "1480475517.0",
+ *     "Description": "MyCluster",
+ *     "JobType": "LOCAL_USE",
+ *     "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
+ *     "Notification": {
+ *       "JobStatesToNotify": [],
+ *       "NotifyAll": false
+ *     },
+ *     "Resources": {
+ *       "S3Resources": [
+ *         {
+ *           "BucketArn": "arn:aws:s3:::MyBucket",
+ *           "KeyRange": {}
+ *         }
+ *       ]
+ *     },
+ *     "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role",
+ *     "ShippingOption": "SECOND_DAY"
+ *   }
+ * }
+ * *\/
+ * // example id: to-describe-a-cluster-1482864218396
+ * ```
+ *
  */
 export declare class DescribeClusterCommand extends $Command<DescribeClusterCommandInput, DescribeClusterCommandOutput, SnowballClientResolvedConfig> {
     readonly input: DescribeClusterCommandInput;

package/dist-types/commands/DescribeJobCommand.d.ts

@@ -30,6 +30,48 @@ export interface DescribeJobCommandOutput extends DescribeJobResult, __MetadataB
  * @see {@link DescribeJobCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To describe a job you've created for AWS Snowball
+ * ```javascript
+ * // This operation describes a job you've created for AWS Snowball.
+ * const input = {
+ *   "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
+ * };
+ * const command = new DescribeJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "JobMetadata": {
+ *     "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
+ *     "CreationDate": "1475626164",
+ *     "Description": "My Job",
+ *     "JobId": "JID123e4567-e89b-12d3-a456-426655440000",
+ *     "JobState": "New",
+ *     "JobType": "IMPORT",
+ *     "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
+ *     "Notification": {
+ *       "JobStatesToNotify": [],
+ *       "NotifyAll": false
+ *     },
+ *     "Resources": {
+ *       "S3Resources": [
+ *         {
+ *           "BucketArn": "arn:aws:s3:::MyBucket",
+ *           "KeyRange": {}
+ *         }
+ *       ]
+ *     },
+ *     "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role",
+ *     "ShippingDetails": {
+ *       "ShippingOption": "SECOND_DAY"
+ *     },
+ *     "SnowballCapacityPreference": "T80",
+ *     "SnowballType": "STANDARD"
+ *   }
+ * }
+ * *\/
+ * // example id: to-describe-a-job-youve-created-for-aws-snowball-1482539500180
+ * ```
+ *
  */
 export declare class DescribeJobCommand extends $Command<DescribeJobCommandInput, DescribeJobCommandOutput, SnowballClientResolvedConfig> {
     readonly input: DescribeJobCommandInput;

package/dist-types/commands/GetJobManifestCommand.d.ts

@@ -44,6 +44,28 @@ export interface GetJobManifestCommandOutput extends GetJobManifestResult, __Met
  * @see {@link GetJobManifestCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To get the manifest for a job you've created for AWS Snowball
+ * ```javascript
+ * // Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.
+ * //
+ * // The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.
+ * //
+ * // As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.
+ * //
+ * // The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
+ * const input = {
+ *   "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
+ * };
+ * const command = new GetJobManifestCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ManifestURI": "https://awsie-frosty-manifests-prod.s3.amazonaws.com/JID123e4567-e89b-12d3-a456-426655440000_manifest.bin?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161224T005115Z&X-Amz-SignedHeaders=..."
+ * }
+ * *\/
+ * // example id: to-get-the-manifest-for-a-job-youve-created-for-aws-snowball-1482540389246
+ * ```
+ *
  */
 export declare class GetJobManifestCommand extends $Command<GetJobManifestCommandInput, GetJobManifestCommandOutput, SnowballClientResolvedConfig> {
     readonly input: GetJobManifestCommandInput;

package/dist-types/commands/GetJobUnlockCodeCommand.d.ts

@@ -41,6 +41,26 @@ export interface GetJobUnlockCodeCommandOutput extends GetJobUnlockCodeResult, _
  * @see {@link GetJobUnlockCodeCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To get the unlock code for a job you've created for AWS Snowball
+ * ```javascript
+ * // Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.
+ * //
+ * // The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.
+ * //
+ * // As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.
+ * const input = {
+ *   "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
+ * };
+ * const command = new GetJobUnlockCodeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "UnlockCode": "12345-abcde-56789-fghij-01234"
+ * }
+ * *\/
+ * // example id: to-get-the-unlock-code-for-a-job-youve-created-for-aws-snowball-1482541987286
+ * ```
+ *
  */
 export declare class GetJobUnlockCodeCommand extends $Command<GetJobUnlockCodeCommandInput, GetJobUnlockCodeCommandOutput, SnowballClientResolvedConfig> {
     readonly input: GetJobUnlockCodeCommandInput;

package/dist-types/commands/GetSnowballUsageCommand.d.ts

@@ -32,6 +32,23 @@ export interface GetSnowballUsageCommandOutput extends GetSnowballUsageResult, _
  * @see {@link GetSnowballUsageCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To see your Snowball service limit and the number of Snowballs you have in use
+ * ```javascript
+ * // Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
+ * //
+ * // The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.
+ * const input = {};
+ * const command = new GetSnowballUsageCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SnowballLimit": 1,
+ *   "SnowballsInUse": 0
+ * }
+ * *\/
+ * // example id: to-see-your-snowball-service-limit-and-the-number-of-snowballs-you-have-in-use-1482863394588
+ * ```
+ *
  */
 export declare class GetSnowballUsageCommand extends $Command<GetSnowballUsageCommandInput, GetSnowballUsageCommandOutput, SnowballClientResolvedConfig> {
     readonly input: GetSnowballUsageCommandInput;

package/dist-types/commands/ListClusterJobsCommand.d.ts

@@ -31,6 +31,68 @@ export interface ListClusterJobsCommandOutput extends ListClusterJobsResult, __M
  * @see {@link ListClusterJobsCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To get a list of jobs in a cluster that you've created for AWS Snowball
+ * ```javascript
+ * // Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.
+ * const input = {
+ *   "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000"
+ * };
+ * const command = new ListClusterJobsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "JobListEntries": [
+ *     {
+ *       "CreationDate": "1480475524.0",
+ *       "Description": "MyClustrer-node-001",
+ *       "IsMaster": false,
+ *       "JobId": "JID123e4567-e89b-12d3-a456-426655440000",
+ *       "JobState": "New",
+ *       "JobType": "LOCAL_USE",
+ *       "SnowballType": "EDGE"
+ *     },
+ *     {
+ *       "CreationDate": "1480475525.0",
+ *       "Description": "MyClustrer-node-002",
+ *       "IsMaster": false,
+ *       "JobId": "JID123e4567-e89b-12d3-a456-426655440001",
+ *       "JobState": "New",
+ *       "JobType": "LOCAL_USE",
+ *       "SnowballType": "EDGE"
+ *     },
+ *     {
+ *       "CreationDate": "1480475525.0",
+ *       "Description": "MyClustrer-node-003",
+ *       "IsMaster": false,
+ *       "JobId": "JID123e4567-e89b-12d3-a456-426655440002",
+ *       "JobState": "New",
+ *       "JobType": "LOCAL_USE",
+ *       "SnowballType": "EDGE"
+ *     },
+ *     {
+ *       "CreationDate": "1480475525.0",
+ *       "Description": "MyClustrer-node-004",
+ *       "IsMaster": false,
+ *       "JobId": "JID123e4567-e89b-12d3-a456-426655440003",
+ *       "JobState": "New",
+ *       "JobType": "LOCAL_USE",
+ *       "SnowballType": "EDGE"
+ *     },
+ *     {
+ *       "CreationDate": "1480475525.0",
+ *       "Description": "MyClustrer-node-005",
+ *       "IsMaster": false,
+ *       "JobId": "JID123e4567-e89b-12d3-a456-426655440004",
+ *       "JobState": "New",
+ *       "JobType": "LOCAL_USE",
+ *       "SnowballType": "EDGE"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-a-list-of-jobs-in-a-cluster-that-youve-created-for-aws-snowball-1482863105773
+ * ```
+ *
  */
 export declare class ListClusterJobsCommand extends $Command<ListClusterJobsCommandInput, ListClusterJobsCommandOutput, SnowballClientResolvedConfig> {
     readonly input: ListClusterJobsCommandInput;

package/dist-types/commands/ListClustersCommand.d.ts

@@ -31,6 +31,27 @@ export interface ListClustersCommandOutput extends ListClustersResult, __Metadat
  * @see {@link ListClustersCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To get a list of clusters that you've created for AWS Snowball
+ * ```javascript
+ * // Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
+ * const input = {};
+ * const command = new ListClustersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ClusterListEntries": [
+ *     {
+ *       "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000",
+ *       "ClusterState": "Pending",
+ *       "CreationDate": "1480475517.0",
+ *       "Description": "MyCluster"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-a-list-of-clusters-that-youve-created-for-aws-snowball-1482862223003
+ * ```
+ *
  */
 export declare class ListClustersCommand extends $Command<ListClustersCommandInput, ListClustersCommandOutput, SnowballClientResolvedConfig> {
     readonly input: ListClustersCommandInput;

package/dist-types/commands/ListJobsCommand.d.ts

@@ -33,6 +33,30 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer
  * @see {@link ListJobsCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To get a list of jobs that you've created for AWS Snowball
+ * ```javascript
+ * // Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.
+ * const input = {};
+ * const command = new ListJobsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "JobListEntries": [
+ *     {
+ *       "CreationDate": "1460678186.0",
+ *       "Description": "MyJob",
+ *       "IsMaster": false,
+ *       "JobId": "JID123e4567-e89b-12d3-a456-426655440000",
+ *       "JobState": "New",
+ *       "JobType": "IMPORT",
+ *       "SnowballType": "STANDARD"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-a-list-of-jobs-that-youve-created-for-aws-snowball-1482542167627
+ * ```
+ *
  */
 export declare class ListJobsCommand extends $Command<ListJobsCommandInput, ListJobsCommandOutput, SnowballClientResolvedConfig> {
     readonly input: ListJobsCommandInput;

package/dist-types/commands/UpdateClusterCommand.d.ts

@@ -32,6 +32,19 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResult, __Metad
  * @see {@link UpdateClusterCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To update a cluster
+ * ```javascript
+ * // This action allows you to update certain parameters for a cluster. Once the cluster changes to a different state, usually within 60 minutes of it being created, this action is no longer available.
+ * const input = {
+ *   "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
+ *   "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000",
+ *   "Description": "updated-cluster-name"
+ * };
+ * const command = new UpdateClusterCommand(input);
+ * await client.send(command);
+ * // example id: to-update-a-cluster-1482863900595
+ * ```
+ *
  */
 export declare class UpdateClusterCommand extends $Command<UpdateClusterCommandInput, UpdateClusterCommandOutput, SnowballClientResolvedConfig> {
     readonly input: UpdateClusterCommandInput;

package/dist-types/commands/UpdateJobCommand.d.ts

@@ -31,6 +31,21 @@ export interface UpdateJobCommandOutput extends UpdateJobResult, __MetadataBeare
  * @see {@link UpdateJobCommandOutput} for command's `response` shape.
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
  *
+ * @example To update a job
+ * ```javascript
+ * // This action allows you to update certain parameters for a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.
+ * const input = {
+ *   "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
+ *   "Description": "updated-job-name",
+ *   "JobId": "JID123e4567-e89b-12d3-a456-426655440000",
+ *   "ShippingOption": "NEXT_DAY",
+ *   "SnowballCapacityPreference": "T100"
+ * };
+ * const command = new UpdateJobCommand(input);
+ * await client.send(command);
+ * // example id: to-update-a-job-1482863556886
+ * ```
+ *
  */
 export declare class UpdateJobCommand extends $Command<UpdateJobCommandInput, UpdateJobCommandOutput, SnowballClientResolvedConfig> {
     readonly input: UpdateJobCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-snowball",
   "description": "AWS SDK for JavaScript Snowball Client for Node.js, Browser and React Native",
-  "version": "3.287.0",
+  "version": "3.289.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.287.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.287.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.287.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/client-sts": "3.289.0",
+    "@aws-sdk/config-resolver": "3.289.0",
+    "@aws-sdk/credential-provider-node": "3.289.0",
+    "@aws-sdk/fetch-http-handler": "3.289.0",
+    "@aws-sdk/hash-node": "3.289.0",
+    "@aws-sdk/invalid-dependency": "3.289.0",
+    "@aws-sdk/middleware-content-length": "3.289.0",
+    "@aws-sdk/middleware-endpoint": "3.289.0",
+    "@aws-sdk/middleware-host-header": "3.289.0",
+    "@aws-sdk/middleware-logger": "3.289.0",
+    "@aws-sdk/middleware-recursion-detection": "3.289.0",
+    "@aws-sdk/middleware-retry": "3.289.0",
+    "@aws-sdk/middleware-serde": "3.289.0",
+    "@aws-sdk/middleware-signing": "3.289.0",
+    "@aws-sdk/middleware-stack": "3.289.0",
+    "@aws-sdk/middleware-user-agent": "3.289.0",
+    "@aws-sdk/node-config-provider": "3.289.0",
+    "@aws-sdk/node-http-handler": "3.289.0",
+    "@aws-sdk/protocol-http": "3.289.0",
+    "@aws-sdk/smithy-client": "3.289.0",
+    "@aws-sdk/types": "3.289.0",
+    "@aws-sdk/url-parser": "3.289.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.289.0",
+    "@aws-sdk/util-defaults-mode-node": "3.289.0",
+    "@aws-sdk/util-endpoints": "3.289.0",
+    "@aws-sdk/util-retry": "3.289.0",
+    "@aws-sdk/util-user-agent-browser": "3.289.0",
+    "@aws-sdk/util-user-agent-node": "3.289.0",
     "@aws-sdk/util-utf8": "3.254.0",
     "tslib": "^2.3.1"
   },