Network.AWS.Snowball.UpdateCluster

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.

Creating a Request

updateCluster

Arguments

:: Text

ucClusterId

-> UpdateCluster

Creates a value of UpdateCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ucNotification - The new or updated Notification object.
• ucForwardingAddressId - The updated ID for the forwarding address for a cluster. This field is not supported in most regions.
• ucAddressId - The ID of the updated Address object.
• ucShippingOption - The updated shipping option value of this cluster's ShippingDetails object.
• ucResources - The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
• ucDescription - The updated description of this cluster.
• ucRoleARN - The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).
• ucClusterId - The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000 .

data UpdateCluster

See: updateCluster smart constructor.

Instances

Eq UpdateCluster

Methods

(==) :: UpdateCluster -> UpdateCluster -> Bool

(/=) :: UpdateCluster -> UpdateCluster -> Bool

Data UpdateCluster

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateCluster -> c UpdateCluster

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateCluster

toConstr :: UpdateCluster -> Constr

dataTypeOf :: UpdateCluster -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateCluster)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateCluster)

gmapT :: (forall b. Data b => b -> b) -> UpdateCluster -> UpdateCluster

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateCluster -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateCluster -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateCluster -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateCluster -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateCluster -> m UpdateCluster

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateCluster -> m UpdateCluster

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateCluster -> m UpdateCluster

Read UpdateCluster

Methods

readsPrec :: Int -> ReadS UpdateCluster

readList :: ReadS [UpdateCluster]

readPrec :: ReadPrec UpdateCluster

readListPrec :: ReadPrec [UpdateCluster]

Show UpdateCluster

Methods

showsPrec :: Int -> UpdateCluster -> ShowS

show :: UpdateCluster -> String

showList :: [UpdateCluster] -> ShowS

Generic UpdateCluster

Associated Types

type Rep UpdateCluster :: * -> *

Methods

from :: UpdateCluster -> Rep UpdateCluster x

to :: Rep UpdateCluster x -> UpdateCluster

Hashable UpdateCluster

Methods

hashWithSalt :: Int -> UpdateCluster -> Int

hash :: UpdateCluster -> Int

ToJSON UpdateCluster

Methods

toJSON :: UpdateCluster -> Value

toEncoding :: UpdateCluster -> Encoding

toJSONList :: [UpdateCluster] -> Value

toEncodingList :: [UpdateCluster] -> Encoding

NFData UpdateCluster

Methods

rnf :: UpdateCluster -> ()

AWSRequest UpdateCluster

Associated Types

type Rs UpdateCluster :: *

Methods

request :: UpdateCluster -> Request UpdateCluster

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateCluster -> ClientResponse -> m (Response UpdateCluster)

ToHeaders UpdateCluster

Methods

toHeaders :: UpdateCluster -> [Header]

ToPath UpdateCluster

Methods

toPath :: UpdateCluster -> ByteString

ToQuery UpdateCluster

Methods

toQuery :: UpdateCluster -> QueryString

type Rep UpdateCluster

type Rep UpdateCluster = D1 * (MetaData "UpdateCluster" "Network.AWS.Snowball.UpdateCluster" "amazonka-snowball-1.6.0-EVw2rNABl7usxqGiRGMj3" False) (C1 * (MetaCons "UpdateCluster'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ucNotification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Notification))) (S1 * (MetaSel (Just Symbol "_ucForwardingAddressId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ucAddressId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ucShippingOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ShippingOption))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ucResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobResource))) (S1 * (MetaSel (Just Symbol "_ucDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ucRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ucClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs UpdateCluster

type Rs UpdateCluster = UpdateClusterResponse

Request Lenses

ucNotification :: Lens' UpdateCluster (Maybe Notification)

The new or updated Notification object.

ucForwardingAddressId :: Lens' UpdateCluster (Maybe Text)

The updated ID for the forwarding address for a cluster. This field is not supported in most regions.

ucAddressId :: Lens' UpdateCluster (Maybe Text)

The ID of the updated Address object.

ucShippingOption :: Lens' UpdateCluster (Maybe ShippingOption)

The updated shipping option value of this cluster's ShippingDetails object.

ucResources :: Lens' UpdateCluster (Maybe JobResource)

The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

ucDescription :: Lens' UpdateCluster (Maybe Text)

The updated description of this cluster.

ucRoleARN :: Lens' UpdateCluster (Maybe Text)

The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).

ucClusterId :: Lens' UpdateCluster Text

The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000 .

Destructuring the Response

updateClusterResponse

Arguments

:: Int

ucrsResponseStatus

-> UpdateClusterResponse

Creates a value of UpdateClusterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ucrsResponseStatus - -- | The response status code.

data UpdateClusterResponse

See: updateClusterResponse smart constructor.

Instances

Eq UpdateClusterResponse

Methods

(==) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool

(/=) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool

Data UpdateClusterResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateClusterResponse -> c UpdateClusterResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateClusterResponse

toConstr :: UpdateClusterResponse -> Constr

dataTypeOf :: UpdateClusterResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateClusterResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateClusterResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateClusterResponse -> UpdateClusterResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateClusterResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateClusterResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateClusterResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateClusterResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateClusterResponse -> m UpdateClusterResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateClusterResponse -> m UpdateClusterResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateClusterResponse -> m UpdateClusterResponse

Read UpdateClusterResponse

Methods

readsPrec :: Int -> ReadS UpdateClusterResponse

readList :: ReadS [UpdateClusterResponse]

readPrec :: ReadPrec UpdateClusterResponse

readListPrec :: ReadPrec [UpdateClusterResponse]

Show UpdateClusterResponse

Methods

showsPrec :: Int -> UpdateClusterResponse -> ShowS

show :: UpdateClusterResponse -> String

showList :: [UpdateClusterResponse] -> ShowS

Generic UpdateClusterResponse

Associated Types

type Rep UpdateClusterResponse :: * -> *

Methods

from :: UpdateClusterResponse -> Rep UpdateClusterResponse x

to :: Rep UpdateClusterResponse x -> UpdateClusterResponse

NFData UpdateClusterResponse

Methods

rnf :: UpdateClusterResponse -> ()

type Rep UpdateClusterResponse

type Rep UpdateClusterResponse = D1 * (MetaData "UpdateClusterResponse" "Network.AWS.Snowball.UpdateCluster" "amazonka-snowball-1.6.0-EVw2rNABl7usxqGiRGMj3" True) (C1 * (MetaCons "UpdateClusterResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_ucrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses

ucrsResponseStatus :: Lens' UpdateClusterResponse Int

• - | The response status code.