Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Snowball.UpdateCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data UpdateCluster = UpdateCluster' {
- notification :: Maybe Notification
- forwardingAddressId :: Maybe Text
- addressId :: Maybe Text
- shippingOption :: Maybe ShippingOption
- resources :: Maybe JobResource
- onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration
- description :: Maybe Text
- roleARN :: Maybe Text
- clusterId :: Text
}
newUpdateCluster :: Text -> UpdateCluster
updateCluster_notification :: Lens' UpdateCluster (Maybe Notification)
updateCluster_forwardingAddressId :: Lens' UpdateCluster (Maybe Text)
updateCluster_addressId :: Lens' UpdateCluster (Maybe Text)
updateCluster_shippingOption :: Lens' UpdateCluster (Maybe ShippingOption)
updateCluster_resources :: Lens' UpdateCluster (Maybe JobResource)
updateCluster_onDeviceServiceConfiguration :: Lens' UpdateCluster (Maybe OnDeviceServiceConfiguration)
updateCluster_description :: Lens' UpdateCluster (Maybe Text)
updateCluster_roleARN :: Lens' UpdateCluster (Maybe Text)
updateCluster_clusterId :: Lens' UpdateCluster Text
data UpdateClusterResponse = UpdateClusterResponse' {
- httpStatus :: Int
}
newUpdateClusterResponse :: Int -> UpdateClusterResponse
updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int

Creating a Request

data UpdateCluster Source #

See: newUpdateCluster smart constructor.

Constructors

UpdateCluster'

Fields

notification :: Maybe Notification
The new or updated Notification object.
forwardingAddressId :: Maybe Text
The updated ID for the forwarding address for a cluster. This field is not supported in most regions.
addressId :: Maybe Text
The ID of the updated Address object.
shippingOption :: Maybe ShippingOption
The updated shipping option value of this cluster's ShippingDetails object.
resources :: Maybe JobResource
The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
description :: Maybe Text
The updated description of this cluster.
roleARN :: 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).
clusterId :: Text
The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

Instances

Instances details

Eq UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods (==) :: UpdateCluster -> UpdateCluster -> Bool # (/=) :: UpdateCluster -> UpdateCluster -> Bool #
Read UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods readsPrec :: Int -> ReadS UpdateCluster # readList :: ReadS [UpdateCluster] # readPrec :: ReadPrec UpdateCluster # readListPrec :: ReadPrec [UpdateCluster] #
Show UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods showsPrec :: Int -> UpdateCluster -> ShowS # show :: UpdateCluster -> String # showList :: [UpdateCluster] -> ShowS #
Generic UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Associated Types type Rep UpdateCluster :: Type -> Type # Methods from :: UpdateCluster -> Rep UpdateCluster x # to :: Rep UpdateCluster x -> UpdateCluster #
NFData UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods rnf :: UpdateCluster -> () #
Hashable UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods hashWithSalt :: Int -> UpdateCluster -> Int # hash :: UpdateCluster -> Int #
ToJSON UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods toJSON :: UpdateCluster -> Value # toEncoding :: UpdateCluster -> Encoding # toJSONList :: [UpdateCluster] -> Value # toEncodingList :: [UpdateCluster] -> Encoding #
AWSRequest UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Associated Types type AWSResponse UpdateCluster # Methods request :: UpdateCluster -> Request UpdateCluster # response :: MonadResource m => Logger -> Service -> Proxy UpdateCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateCluster))) #
ToHeaders UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods toHeaders :: UpdateCluster -> [Header] #
ToPath UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods toPath :: UpdateCluster -> ByteString #
ToQuery UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods toQuery :: UpdateCluster -> QueryString #
type Rep UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster type Rep UpdateCluster = D1 ('MetaData "UpdateCluster" "Amazonka.Snowball.UpdateCluster" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "UpdateCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Notification)) :: S1 ('MetaSel ('Just "forwardingAddressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "addressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "shippingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShippingOption)))) :: ((S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobResource)) :: S1 ('MetaSel ('Just "onDeviceServiceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnDeviceServiceConfiguration))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster type AWSResponse UpdateCluster = UpdateClusterResponse

newUpdateCluster Source #

Arguments

:: Text	`$sel:clusterId:UpdateCluster'`
-> UpdateCluster

Create a value of UpdateCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:notification:UpdateCluster', updateCluster_notification - The new or updated Notification object.

$sel:forwardingAddressId:UpdateCluster', updateCluster_forwardingAddressId - The updated ID for the forwarding address for a cluster. This field is not supported in most regions.

$sel:addressId:UpdateCluster', updateCluster_addressId - The ID of the updated Address object.

$sel:shippingOption:UpdateCluster', updateCluster_shippingOption - The updated shipping option value of this cluster's ShippingDetails object.

$sel:resources:UpdateCluster', updateCluster_resources - The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

$sel:onDeviceServiceConfiguration:UpdateCluster', updateCluster_onDeviceServiceConfiguration - Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

$sel:description:UpdateCluster', updateCluster_description - The updated description of this cluster.

$sel:roleARN:UpdateCluster', updateCluster_roleARN - 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).

$sel:clusterId:UpdateCluster', updateCluster_clusterId - The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

Request Lenses

updateCluster_notification :: Lens' UpdateCluster (Maybe Notification) Source #

The new or updated Notification object.

updateCluster_forwardingAddressId :: Lens' UpdateCluster (Maybe Text) Source #

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

updateCluster_addressId :: Lens' UpdateCluster (Maybe Text) Source #

The ID of the updated Address object.

updateCluster_shippingOption :: Lens' UpdateCluster (Maybe ShippingOption) Source #

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

updateCluster_resources :: Lens' UpdateCluster (Maybe JobResource) Source #

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

updateCluster_onDeviceServiceConfiguration :: Lens' UpdateCluster (Maybe OnDeviceServiceConfiguration) Source #

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

updateCluster_description :: Lens' UpdateCluster (Maybe Text) Source #

The updated description of this cluster.

updateCluster_roleARN :: Lens' UpdateCluster (Maybe Text) Source #

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).

updateCluster_clusterId :: Lens' UpdateCluster Text Source #

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

Destructuring the Response

data UpdateClusterResponse Source #

See: newUpdateClusterResponse smart constructor.

Constructors

UpdateClusterResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods (==) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool # (/=) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool #
Read UpdateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods readsPrec :: Int -> ReadS UpdateClusterResponse # readList :: ReadS [UpdateClusterResponse] # readPrec :: ReadPrec UpdateClusterResponse # readListPrec :: ReadPrec [UpdateClusterResponse] #
Show UpdateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods showsPrec :: Int -> UpdateClusterResponse -> ShowS # show :: UpdateClusterResponse -> String # showList :: [UpdateClusterResponse] -> ShowS #
Generic UpdateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Associated Types type Rep UpdateClusterResponse :: Type -> Type # Methods from :: UpdateClusterResponse -> Rep UpdateClusterResponse x # to :: Rep UpdateClusterResponse x -> UpdateClusterResponse #
NFData UpdateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods rnf :: UpdateClusterResponse -> () #
type Rep UpdateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster type Rep UpdateClusterResponse = D1 ('MetaData "UpdateClusterResponse" "Amazonka.Snowball.UpdateCluster" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "UpdateClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateClusterResponse'`
-> UpdateClusterResponse

Create a value of UpdateClusterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateClusterResponse', updateClusterResponse_httpStatus - The response's http status code.

Response Lenses

updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int Source #

The response's http status code.