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

data DescribeGatewayInformation

A JSON object containing the ID of the gateway.

See: newDescribeGatewayInformation smart constructor.

Constructors

DescribeGatewayInformation'

Fields

• gatewayARN :: Text

Instances

ToJSON DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

toJSON :: DescribeGatewayInformation -> Value

toEncoding :: DescribeGatewayInformation -> Encoding

toJSONList :: [DescribeGatewayInformation] -> Value

toEncodingList :: [DescribeGatewayInformation] -> Encoding

ToHeaders DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

toHeaders :: DescribeGatewayInformation -> [Header]

ToPath DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

toPath :: DescribeGatewayInformation -> ByteString

ToQuery DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

toQuery :: DescribeGatewayInformation -> QueryString

AWSRequest DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Associated Types

type AWSResponse DescribeGatewayInformation

Methods

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

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

Generic DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Associated Types

type Rep DescribeGatewayInformation :: Type -> Type

Methods

from :: DescribeGatewayInformation -> Rep DescribeGatewayInformation x

to :: Rep DescribeGatewayInformation x -> DescribeGatewayInformation

Read DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

readsPrec :: Int -> ReadS DescribeGatewayInformation

readList :: ReadS [DescribeGatewayInformation]

readPrec :: ReadPrec DescribeGatewayInformation

readListPrec :: ReadPrec [DescribeGatewayInformation]

Show DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

showsPrec :: Int -> DescribeGatewayInformation -> ShowS

show :: DescribeGatewayInformation -> String

showList :: [DescribeGatewayInformation] -> ShowS

NFData DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

rnf :: DescribeGatewayInformation -> ()

Eq DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

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

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

Hashable DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

hashWithSalt :: Int -> DescribeGatewayInformation -> Int

hash :: DescribeGatewayInformation -> Int

type AWSResponse DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

type AWSResponse DescribeGatewayInformation = DescribeGatewayInformationResponse

type Rep DescribeGatewayInformation

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

type Rep DescribeGatewayInformation = D1 ('MetaData "DescribeGatewayInformation" "Amazonka.StorageGateway.DescribeGatewayInformation" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeGatewayInformation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeGatewayInformation

Arguments

:: Text

DescribeGatewayInformation

-> DescribeGatewayInformation

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

DescribeGatewayInformation, describeGatewayInformation_gatewayARN - Undocumented member.

Request Lenses

describeGatewayInformation_gatewayARN :: Lens' DescribeGatewayInformation Text

Undocumented member.

Destructuring the Response

data DescribeGatewayInformationResponse

A JSON object containing the following fields:

See: newDescribeGatewayInformationResponse smart constructor.

Constructors

DescribeGatewayInformationResponse'

Fields

• cloudWatchLogGroupARN :: Maybe Text

  The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

• deprecationDate :: Maybe Text

  Date after which this gateway will not receive software updates for new features and bug fixes.

• ec2InstanceId :: Maybe Text

  The ID of the Amazon EC2 instance that was used to launch the gateway.

• ec2InstanceRegion :: Maybe Text

  The Amazon Web Services Region where the Amazon EC2 instance is located.

• endpointType :: Maybe Text

  The type of endpoint for your gateway.

  Valid Values: STANDARD | FIPS

• gatewayARN :: Maybe Text
• gatewayCapacity :: Maybe GatewayCapacity

  Specifies the size of the gateway's metadata cache.

• gatewayId :: 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.

• gatewayName :: Maybe Text

  The name you configured for your gateway.

• gatewayNetworkInterfaces :: Maybe [NetworkInterface]

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

• gatewayState :: Maybe Text

  A value that indicates the operating state of the gateway.

• gatewayTimezone :: Maybe Text

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

• gatewayType :: Maybe Text

  The type of the gateway.

• hostEnvironment :: Maybe HostEnvironment

  The type of hardware or software platform on which the gateway is running.

• hostEnvironmentId :: Maybe Text

  A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

• lastSoftwareUpdate :: 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. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

• nextUpdateAvailabilityDate :: 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.

• softwareUpdatesEndDate :: Maybe Text

  Date after which this gateway will not receive software updates for new features.

• supportedGatewayCapacities :: Maybe [GatewayCapacity]

  A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

• tags :: Maybe [Tag]

  A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

• vPCEndpoint :: Maybe Text

  The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeGatewayInformationResponse

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Associated Types

type Rep DescribeGatewayInformationResponse :: Type -> Type

Methods

from :: DescribeGatewayInformationResponse -> Rep DescribeGatewayInformationResponse x

to :: Rep DescribeGatewayInformationResponse x -> DescribeGatewayInformationResponse

Read DescribeGatewayInformationResponse

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

readsPrec :: Int -> ReadS DescribeGatewayInformationResponse

readList :: ReadS [DescribeGatewayInformationResponse]

readPrec :: ReadPrec DescribeGatewayInformationResponse

readListPrec :: ReadPrec [DescribeGatewayInformationResponse]

Show DescribeGatewayInformationResponse

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

showsPrec :: Int -> DescribeGatewayInformationResponse -> ShowS

show :: DescribeGatewayInformationResponse -> String

showList :: [DescribeGatewayInformationResponse] -> ShowS

NFData DescribeGatewayInformationResponse

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

rnf :: DescribeGatewayInformationResponse -> ()

Eq DescribeGatewayInformationResponse

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

Methods

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

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

type Rep DescribeGatewayInformationResponse

Defined in Amazonka.StorageGateway.DescribeGatewayInformation

type Rep DescribeGatewayInformationResponse = D1 ('MetaData "DescribeGatewayInformationResponse" "Amazonka.StorageGateway.DescribeGatewayInformation" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeGatewayInformationResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "cloudWatchLogGroupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deprecationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "ec2InstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ec2InstanceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "gatewayCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayCapacity)) :*: S1 ('MetaSel ('Just "gatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "gatewayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "gatewayNetworkInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkInterface])) :*: S1 ('MetaSel ('Just "gatewayState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "gatewayTimezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "gatewayType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "hostEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HostEnvironment)) :*: (S1 ('MetaSel ('Just "hostEnvironmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastSoftwareUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "nextUpdateAvailabilityDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "softwareUpdatesEndDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "supportedGatewayCapacities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GatewayCapacity])))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "vPCEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeGatewayInformationResponse

Arguments

:: Int

$sel:httpStatus:DescribeGatewayInformationResponse'

-> DescribeGatewayInformationResponse

Create a value of DescribeGatewayInformationResponse 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:DescribeGatewayInformationResponse', describeGatewayInformationResponse_cloudWatchLogGroupARN - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

$sel:deprecationDate:DescribeGatewayInformationResponse', describeGatewayInformationResponse_deprecationDate - Date after which this gateway will not receive software updates for new features and bug fixes.

DescribeGatewayInformationResponse, describeGatewayInformationResponse_ec2InstanceId - The ID of the Amazon EC2 instance that was used to launch the gateway.

DescribeGatewayInformationResponse, describeGatewayInformationResponse_ec2InstanceRegion - The Amazon Web Services Region where the Amazon EC2 instance is located.

$sel:endpointType:DescribeGatewayInformationResponse', describeGatewayInformationResponse_endpointType - The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

DescribeGatewayInformation, describeGatewayInformationResponse_gatewayARN - Undocumented member.

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

DescribeGatewayInformationResponse, describeGatewayInformationResponse_gatewayId - 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.

DescribeGatewayInformationResponse, describeGatewayInformationResponse_gatewayName - The name you configured for your gateway.

$sel:gatewayNetworkInterfaces:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayNetworkInterfaces - A NetworkInterface array that contains descriptions of the gateway network interfaces.

$sel:gatewayState:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayState - A value that indicates the operating state of the gateway.

$sel:gatewayTimezone:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayTimezone - A value that indicates the time zone configured for the gateway.

DescribeGatewayInformationResponse, describeGatewayInformationResponse_gatewayType - The type of the gateway.

DescribeGatewayInformationResponse, describeGatewayInformationResponse_hostEnvironment - The type of hardware or software platform on which the gateway is running.

DescribeGatewayInformationResponse, describeGatewayInformationResponse_hostEnvironmentId - A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

$sel:lastSoftwareUpdate:DescribeGatewayInformationResponse', describeGatewayInformationResponse_lastSoftwareUpdate - 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. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

$sel:nextUpdateAvailabilityDate:DescribeGatewayInformationResponse', describeGatewayInformationResponse_nextUpdateAvailabilityDate - 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.

$sel:softwareUpdatesEndDate:DescribeGatewayInformationResponse', describeGatewayInformationResponse_softwareUpdatesEndDate - Date after which this gateway will not receive software updates for new features.

$sel:supportedGatewayCapacities:DescribeGatewayInformationResponse', describeGatewayInformationResponse_supportedGatewayCapacities - A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

DescribeGatewayInformationResponse, describeGatewayInformationResponse_tags - A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

$sel:vPCEndpoint:DescribeGatewayInformationResponse', describeGatewayInformationResponse_vPCEndpoint - The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

$sel:httpStatus:DescribeGatewayInformationResponse', describeGatewayInformationResponse_httpStatus - The response's http status code.

Response Lenses

describeGatewayInformationResponse_cloudWatchLogGroupARN :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

describeGatewayInformationResponse_deprecationDate :: Lens' DescribeGatewayInformationResponse (Maybe Text)

Date after which this gateway will not receive software updates for new features and bug fixes.

describeGatewayInformationResponse_ec2InstanceId :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The ID of the Amazon EC2 instance that was used to launch the gateway.

describeGatewayInformationResponse_ec2InstanceRegion :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The Amazon Web Services Region where the Amazon EC2 instance is located.

describeGatewayInformationResponse_endpointType :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

describeGatewayInformationResponse_gatewayARN :: Lens' DescribeGatewayInformationResponse (Maybe Text)

Undocumented member.

describeGatewayInformationResponse_gatewayCapacity :: Lens' DescribeGatewayInformationResponse (Maybe GatewayCapacity)

Specifies the size of the gateway's metadata cache.

describeGatewayInformationResponse_gatewayId :: 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.

describeGatewayInformationResponse_gatewayName :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The name you configured for your gateway.

describeGatewayInformationResponse_gatewayNetworkInterfaces :: Lens' DescribeGatewayInformationResponse (Maybe [NetworkInterface])

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

describeGatewayInformationResponse_gatewayState :: Lens' DescribeGatewayInformationResponse (Maybe Text)

A value that indicates the operating state of the gateway.

describeGatewayInformationResponse_gatewayTimezone :: Lens' DescribeGatewayInformationResponse (Maybe Text)

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

describeGatewayInformationResponse_gatewayType :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The type of the gateway.

describeGatewayInformationResponse_hostEnvironment :: Lens' DescribeGatewayInformationResponse (Maybe HostEnvironment)

The type of hardware or software platform on which the gateway is running.

describeGatewayInformationResponse_hostEnvironmentId :: Lens' DescribeGatewayInformationResponse (Maybe Text)

A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

describeGatewayInformationResponse_lastSoftwareUpdate :: 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. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

describeGatewayInformationResponse_nextUpdateAvailabilityDate :: 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.

describeGatewayInformationResponse_softwareUpdatesEndDate :: Lens' DescribeGatewayInformationResponse (Maybe Text)

Date after which this gateway will not receive software updates for new features.

describeGatewayInformationResponse_supportedGatewayCapacities :: Lens' DescribeGatewayInformationResponse (Maybe [GatewayCapacity])

A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

describeGatewayInformationResponse_tags :: Lens' DescribeGatewayInformationResponse (Maybe [Tag])

A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

describeGatewayInformationResponse_vPCEndpoint :: Lens' DescribeGatewayInformationResponse (Maybe Text)

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

describeGatewayInformationResponse_httpStatus :: Lens' DescribeGatewayInformationResponse Int

The response's http status code.