Network.AWS.StorageGateway.DescribeGatewayInformation

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Creating a Request

describeGatewayInformation

Arguments

:: Text

dgiGatewayARN

-> DescribeGatewayInformation

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

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

• dgiGatewayARN - Undocumented member.

data DescribeGatewayInformation

A JSON object containing the id of the gateway.

See: describeGatewayInformation smart constructor.

Instances

Eq DescribeGatewayInformation

Methods

(==) :: DescribeGatewayInformation -> DescribeGatewayInformation -> Bool

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

Data DescribeGatewayInformation

Methods

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

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

toConstr :: DescribeGatewayInformation -> Constr

dataTypeOf :: DescribeGatewayInformation -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeGatewayInformation

Methods

readsPrec :: Int -> ReadS DescribeGatewayInformation

readList :: ReadS [DescribeGatewayInformation]

readPrec :: ReadPrec DescribeGatewayInformation

readListPrec :: ReadPrec [DescribeGatewayInformation]

Show DescribeGatewayInformation

Methods

showsPrec :: Int -> DescribeGatewayInformation -> ShowS

show :: DescribeGatewayInformation -> String

showList :: [DescribeGatewayInformation] -> ShowS

Generic DescribeGatewayInformation

Associated Types

type Rep DescribeGatewayInformation :: * -> *

Methods

from :: DescribeGatewayInformation -> Rep DescribeGatewayInformation x

to :: Rep DescribeGatewayInformation x -> DescribeGatewayInformation

Hashable DescribeGatewayInformation

Methods

hashWithSalt :: Int -> DescribeGatewayInformation -> Int

hash :: DescribeGatewayInformation -> Int

ToJSON DescribeGatewayInformation

Methods

toJSON :: DescribeGatewayInformation -> Value

toEncoding :: DescribeGatewayInformation -> Encoding

toJSONList :: [DescribeGatewayInformation] -> Value

toEncodingList :: [DescribeGatewayInformation] -> Encoding

NFData DescribeGatewayInformation

Methods

rnf :: DescribeGatewayInformation -> ()

AWSRequest DescribeGatewayInformation

Associated Types

type Rs DescribeGatewayInformation :: *

Methods

request :: DescribeGatewayInformation -> Request DescribeGatewayInformation

response :: MonadResource m => Logger -> Service -> Proxy * DescribeGatewayInformation -> ClientResponse -> m (Response DescribeGatewayInformation)

ToPath DescribeGatewayInformation

Methods

toPath :: DescribeGatewayInformation -> ByteString

ToHeaders DescribeGatewayInformation

Methods

toHeaders :: DescribeGatewayInformation -> [Header]

ToQuery DescribeGatewayInformation

Methods

toQuery :: DescribeGatewayInformation -> QueryString

type Rep DescribeGatewayInformation

type Rep DescribeGatewayInformation = D1 (MetaData "DescribeGatewayInformation" "Network.AWS.StorageGateway.DescribeGatewayInformation" "amazonka-storagegateway-1.4.5-GOGCrgFap1r59NptpacdAf" True) (C1 (MetaCons "DescribeGatewayInformation'" PrefixI True) (S1 (MetaSel (Just Symbol "_dgiGatewayARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs DescribeGatewayInformation

type Rs DescribeGatewayInformation = DescribeGatewayInformationResponse

Request Lenses

dgiGatewayARN :: Lens' DescribeGatewayInformation Text

Undocumented member.

Destructuring the Response

describeGatewayInformationResponse

Arguments

:: Int

dgirsResponseStatus

-> DescribeGatewayInformationResponse

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

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

• dgirsGatewayState - A value that indicates the operating state of the gateway.
• dgirsGatewayARN - Undocumented member.
• dgirsGatewayNetworkInterfaces - A NetworkInterface array that contains descriptions of the gateway network interfaces.
• dgirsNextUpdateAvailabilityDate - The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
• dgirsLastSoftwareUpdate - The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.
• dgirsGatewayName - The name you configured for your gateway.
• dgirsGatewayId - The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
• dgirsGatewayType - The type of the gateway.
• dgirsGatewayTimezone - A value that indicates the time zone configured for the gateway.
• dgirsResponseStatus - -- | The response status code.

data DescribeGatewayInformationResponse

A JSON object containing the following fields:

See: describeGatewayInformationResponse smart constructor.

Instances

Eq DescribeGatewayInformationResponse

Methods

(==) :: DescribeGatewayInformationResponse -> DescribeGatewayInformationResponse -> Bool

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

Data DescribeGatewayInformationResponse

Methods

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

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

toConstr :: DescribeGatewayInformationResponse -> Constr

dataTypeOf :: DescribeGatewayInformationResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeGatewayInformationResponse

Methods

readsPrec :: Int -> ReadS DescribeGatewayInformationResponse

readList :: ReadS [DescribeGatewayInformationResponse]

readPrec :: ReadPrec DescribeGatewayInformationResponse

readListPrec :: ReadPrec [DescribeGatewayInformationResponse]

Show DescribeGatewayInformationResponse

Methods

showsPrec :: Int -> DescribeGatewayInformationResponse -> ShowS

show :: DescribeGatewayInformationResponse -> String

showList :: [DescribeGatewayInformationResponse] -> ShowS

Generic DescribeGatewayInformationResponse

Associated Types

type Rep DescribeGatewayInformationResponse :: * -> *

Methods

from :: DescribeGatewayInformationResponse -> Rep DescribeGatewayInformationResponse x

to :: Rep DescribeGatewayInformationResponse x -> DescribeGatewayInformationResponse

NFData DescribeGatewayInformationResponse

Methods

rnf :: DescribeGatewayInformationResponse -> ()

type Rep DescribeGatewayInformationResponse

type Rep DescribeGatewayInformationResponse = D1 (MetaData "DescribeGatewayInformationResponse" "Network.AWS.StorageGateway.DescribeGatewayInformation" "amazonka-storagegateway-1.4.5-GOGCrgFap1r59NptpacdAf" False) (C1 (MetaCons "DescribeGatewayInformationResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dgirsGatewayState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dgirsGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dgirsGatewayNetworkInterfaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [NetworkInterface]))) ((:*:) (S1 (MetaSel (Just Symbol "_dgirsNextUpdateAvailabilityDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dgirsLastSoftwareUpdate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dgirsGatewayName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dgirsGatewayId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dgirsGatewayType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dgirsGatewayTimezone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dgirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))))

Response Lenses

dgirsGatewayState :: Lens' DescribeGatewayInformationResponse (Maybe Text)

A value that indicates the operating state of the gateway.

dgirsGatewayARN :: Lens' DescribeGatewayInformationResponse (Maybe Text)

Undocumented member.

dgirsGatewayNetworkInterfaces :: Lens' DescribeGatewayInformationResponse [NetworkInterface]

A NetworkInterface array that contains descriptions of the gateway network interfaces.

dgirsNextUpdateAvailabilityDate :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

dgirsLastSoftwareUpdate :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.

dgirsGatewayName :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The name you configured for your gateway.

dgirsGatewayId :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

dgirsGatewayType :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The type of the gateway.

dgirsGatewayTimezone :: Lens' DescribeGatewayInformationResponse (Maybe Text)

A value that indicates the time zone configured for the gateway.

dgirsResponseStatus :: Lens' DescribeGatewayInformationResponse Int

• - | The response status code.