Amazonka.StorageGateway.UpdateGatewayInformation

Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

Creating a Request

data UpdateGatewayInformation

See: newUpdateGatewayInformation smart constructor.

Constructors

UpdateGatewayInformation'

Fields

• cloudWatchLogGroupARN :: Maybe Text

  The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

  For more information, see What is Amazon CloudWatch Logs?

• gatewayCapacity :: Maybe GatewayCapacity

  Specifies the size of the gateway's metadata cache.

• gatewayName :: Maybe Text
• gatewayTimezone :: Maybe Text

  A value that indicates the time zone of the gateway.

• gatewayARN :: Text

Instances

ToJSON UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

toJSON :: UpdateGatewayInformation -> Value

toEncoding :: UpdateGatewayInformation -> Encoding

toJSONList :: [UpdateGatewayInformation] -> Value

toEncodingList :: [UpdateGatewayInformation] -> Encoding

ToHeaders UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

toHeaders :: UpdateGatewayInformation -> [Header]

ToPath UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

toPath :: UpdateGatewayInformation -> ByteString

ToQuery UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

toQuery :: UpdateGatewayInformation -> QueryString

AWSRequest UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Associated Types

type AWSResponse UpdateGatewayInformation

Methods

request :: (Service -> Service) -> UpdateGatewayInformation -> Request UpdateGatewayInformation

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateGatewayInformation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGatewayInformation)))

Generic UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Associated Types

type Rep UpdateGatewayInformation :: Type -> Type

Methods

from :: UpdateGatewayInformation -> Rep UpdateGatewayInformation x

to :: Rep UpdateGatewayInformation x -> UpdateGatewayInformation

Read UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

readsPrec :: Int -> ReadS UpdateGatewayInformation

readList :: ReadS [UpdateGatewayInformation]

readPrec :: ReadPrec UpdateGatewayInformation

readListPrec :: ReadPrec [UpdateGatewayInformation]

Show UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

showsPrec :: Int -> UpdateGatewayInformation -> ShowS

show :: UpdateGatewayInformation -> String

showList :: [UpdateGatewayInformation] -> ShowS

NFData UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

rnf :: UpdateGatewayInformation -> ()

Eq UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

(==) :: UpdateGatewayInformation -> UpdateGatewayInformation -> Bool

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

Hashable UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

hashWithSalt :: Int -> UpdateGatewayInformation -> Int

hash :: UpdateGatewayInformation -> Int

type AWSResponse UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

type AWSResponse UpdateGatewayInformation = UpdateGatewayInformationResponse

type Rep UpdateGatewayInformation

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

type Rep UpdateGatewayInformation = D1 ('MetaData "UpdateGatewayInformation" "Amazonka.StorageGateway.UpdateGatewayInformation" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "UpdateGatewayInformation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cloudWatchLogGroupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "gatewayCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayCapacity))) :*: (S1 ('MetaSel ('Just "gatewayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "gatewayTimezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateGatewayInformation

Arguments

:: Text

UpdateGatewayInformation

-> UpdateGatewayInformation

Create a value of UpdateGatewayInformation 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:cloudWatchLogGroupARN:UpdateGatewayInformation', updateGatewayInformation_cloudWatchLogGroupARN - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

For more information, see What is Amazon CloudWatch Logs?

$sel:gatewayCapacity:UpdateGatewayInformation', updateGatewayInformation_gatewayCapacity - Specifies the size of the gateway's metadata cache.

UpdateGatewayInformation, updateGatewayInformation_gatewayName - Undocumented member.

$sel:gatewayTimezone:UpdateGatewayInformation', updateGatewayInformation_gatewayTimezone - A value that indicates the time zone of the gateway.

UpdateGatewayInformation, updateGatewayInformation_gatewayARN - Undocumented member.

Request Lenses

updateGatewayInformation_cloudWatchLogGroupARN :: Lens' UpdateGatewayInformation (Maybe Text)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

For more information, see What is Amazon CloudWatch Logs?

updateGatewayInformation_gatewayCapacity :: Lens' UpdateGatewayInformation (Maybe GatewayCapacity)

Specifies the size of the gateway's metadata cache.

updateGatewayInformation_gatewayName :: Lens' UpdateGatewayInformation (Maybe Text)

Undocumented member.

updateGatewayInformation_gatewayTimezone :: Lens' UpdateGatewayInformation (Maybe Text)

A value that indicates the time zone of the gateway.

updateGatewayInformation_gatewayARN :: Lens' UpdateGatewayInformation Text

Undocumented member.

Destructuring the Response

data UpdateGatewayInformationResponse

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.

See: newUpdateGatewayInformationResponse smart constructor.

Constructors

UpdateGatewayInformationResponse'

Fields

• gatewayARN :: Maybe Text
• gatewayName :: Maybe Text

  The name you configured for your gateway.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateGatewayInformationResponse

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Associated Types

type Rep UpdateGatewayInformationResponse :: Type -> Type

Methods

from :: UpdateGatewayInformationResponse -> Rep UpdateGatewayInformationResponse x

to :: Rep UpdateGatewayInformationResponse x -> UpdateGatewayInformationResponse

Read UpdateGatewayInformationResponse

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

readsPrec :: Int -> ReadS UpdateGatewayInformationResponse

readList :: ReadS [UpdateGatewayInformationResponse]

readPrec :: ReadPrec UpdateGatewayInformationResponse

readListPrec :: ReadPrec [UpdateGatewayInformationResponse]

Show UpdateGatewayInformationResponse

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

showsPrec :: Int -> UpdateGatewayInformationResponse -> ShowS

show :: UpdateGatewayInformationResponse -> String

showList :: [UpdateGatewayInformationResponse] -> ShowS

NFData UpdateGatewayInformationResponse

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

rnf :: UpdateGatewayInformationResponse -> ()

Eq UpdateGatewayInformationResponse

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

Methods

(==) :: UpdateGatewayInformationResponse -> UpdateGatewayInformationResponse -> Bool

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

type Rep UpdateGatewayInformationResponse

Defined in Amazonka.StorageGateway.UpdateGatewayInformation

type Rep UpdateGatewayInformationResponse = D1 ('MetaData "UpdateGatewayInformationResponse" "Amazonka.StorageGateway.UpdateGatewayInformation" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "UpdateGatewayInformationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "gatewayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateGatewayInformationResponse

Arguments

:: Int

$sel:httpStatus:UpdateGatewayInformationResponse'

-> UpdateGatewayInformationResponse

Create a value of UpdateGatewayInformationResponse 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:

UpdateGatewayInformation, updateGatewayInformationResponse_gatewayARN - Undocumented member.

UpdateGatewayInformation, updateGatewayInformationResponse_gatewayName - The name you configured for your gateway.

$sel:httpStatus:UpdateGatewayInformationResponse', updateGatewayInformationResponse_httpStatus - The response's http status code.

Response Lenses

updateGatewayInformationResponse_gatewayARN :: Lens' UpdateGatewayInformationResponse (Maybe Text)

Undocumented member.

updateGatewayInformationResponse_gatewayName :: Lens' UpdateGatewayInformationResponse (Maybe Text)

The name you configured for your gateway.

updateGatewayInformationResponse_httpStatus :: Lens' UpdateGatewayInformationResponse Int

The response's http status code.