Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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' {
- addressId :: Maybe Text
- description :: Maybe Text
- forwardingAddressId :: Maybe Text
- notification :: Maybe Notification
- onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration
- resources :: Maybe JobResource
- roleARN :: Maybe Text
- shippingOption :: Maybe ShippingOption
- clusterId :: Text
}
newUpdateCluster :: Text -> UpdateCluster
updateCluster_addressId :: Lens' UpdateCluster (Maybe Text)
updateCluster_description :: Lens' UpdateCluster (Maybe Text)
updateCluster_forwardingAddressId :: Lens' UpdateCluster (Maybe Text)
updateCluster_notification :: Lens' UpdateCluster (Maybe Notification)
updateCluster_onDeviceServiceConfiguration :: Lens' UpdateCluster (Maybe OnDeviceServiceConfiguration)
updateCluster_resources :: Lens' UpdateCluster (Maybe JobResource)
updateCluster_roleARN :: Lens' UpdateCluster (Maybe Text)
updateCluster_shippingOption :: Lens' UpdateCluster (Maybe ShippingOption)
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

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

Instances

Instances details

ToJSON UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods toJSON :: UpdateCluster -> Value # toEncoding :: UpdateCluster -> Encoding # toJSONList :: [UpdateCluster] -> Value # toEncodingList :: [UpdateCluster] -> Encoding #
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 #
AWSRequest UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Associated Types type AWSResponse UpdateCluster # Methods request :: (Service -> Service) -> UpdateCluster -> Request UpdateCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateCluster))) #
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 #
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 #
NFData UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods rnf :: UpdateCluster -> () #
Eq UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods (==) :: UpdateCluster -> UpdateCluster -> Bool # (/=) :: UpdateCluster -> UpdateCluster -> Bool #
Hashable UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods hashWithSalt :: Int -> UpdateCluster -> Int # hash :: UpdateCluster -> Int #
type AWSResponse UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster type AWSResponse UpdateCluster = UpdateClusterResponse
type Rep UpdateCluster Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster type Rep UpdateCluster = D1 ('MetaData "UpdateCluster" "Amazonka.Snowball.UpdateCluster" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "UpdateCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "addressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "forwardingAddressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Notification)))) :: ((S1 ('MetaSel ('Just "onDeviceServiceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnDeviceServiceConfiguration)) :: S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobResource))) :: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "shippingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShippingOption)) :: S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateCluster Source #

Arguments

:: Text	`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:

UpdateCluster, updateCluster_addressId - The ID of the updated Address object.

UpdateCluster, updateCluster_description - The updated description of this cluster.

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

UpdateCluster, updateCluster_notification - The new or updated Notification object.

UpdateCluster, updateCluster_onDeviceServiceConfiguration - Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).

UpdateCluster, updateCluster_resources - The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

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 Identity and Access Management (IAM).

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

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

Request Lenses

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

The ID of the updated Address object.

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

The updated description of this cluster.

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_notification :: Lens' UpdateCluster (Maybe Notification) Source #

The new or updated Notification object.

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. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).

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

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

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 Identity and Access Management (IAM).

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

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

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

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 #
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 #
NFData UpdateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods rnf :: UpdateClusterResponse -> () #
Eq UpdateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster Methods (==) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool # (/=) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool #
type Rep UpdateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateCluster type Rep UpdateClusterResponse = D1 ('MetaData "UpdateClusterResponse" "Amazonka.Snowball.UpdateCluster" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" '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.