AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateClusterAsync.

Namespace: Amazon.Snowball
Assembly: AWSSDK.Snowball.dll
Version: 3.x.y.z

Syntax

C#
public abstract UpdateClusterResponse UpdateCluster(
         UpdateClusterRequest request
)

Parameters

request
Type: Amazon.Snowball.Model.UpdateClusterRequest

Container for the necessary parameters to execute the UpdateCluster service method.

Return Value


The response from the UpdateCluster service method, as returned by Snowball.

Exceptions

ExceptionCondition
Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
KMSRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

Examples

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.

To update a cluster


var client = new AmazonSnowballClient();
var response = client.UpdateCluster(new UpdateClusterRequest 
{
    AddressId = "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
    ClusterId = "CID123e4567-e89b-12d3-a456-426655440000",
    Description = "updated-cluster-name"
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also