Network.AWS.StorageGateway.ActivateGateway

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation .

Creating a Request

activateGateway

Arguments

:: Text

agActivationKey

-> Text

agGatewayName

-> Text

agGatewayTimezone

-> Text

agGatewayRegion

-> ActivateGateway

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

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

• agMediumChangerType - The value that indicates the type of medium changer to use for tape gateway. This field is optional. Valid Values: "STK-L700", "AWS-Gateway-VTL"
• agTapeDriveType - The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: "IBM-ULT3580-TD5"
• agGatewayType - A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is STORED . Valid Values: STORED, CACHED, VTL, FILE_S3
• agActivationKey - Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey . It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway. For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.
• agGatewayName - The name you configured for your gateway.
• agGatewayTimezone - A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
• agGatewayRegion - A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary . Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"

data ActivateGateway

A JSON object containing one or more of the following fields:

• 'ActivateGatewayInput$ActivationKey'
• 'ActivateGatewayInput$GatewayName'
• 'ActivateGatewayInput$GatewayRegion'
• 'ActivateGatewayInput$GatewayTimezone'
• 'ActivateGatewayInput$GatewayType'
• 'ActivateGatewayInput$TapeDriveType'
• 'ActivateGatewayInput$MediumChangerType'

See: activateGateway smart constructor.

Instances

Eq ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

(==) :: ActivateGateway -> ActivateGateway -> Bool

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

Data ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

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

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

toConstr :: ActivateGateway -> Constr

dataTypeOf :: ActivateGateway -> DataType

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

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

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

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

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

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

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

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

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

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

Read ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

readsPrec :: Int -> ReadS ActivateGateway

readList :: ReadS [ActivateGateway]

readPrec :: ReadPrec ActivateGateway

readListPrec :: ReadPrec [ActivateGateway]

Show ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

showsPrec :: Int -> ActivateGateway -> ShowS

show :: ActivateGateway -> String

showList :: [ActivateGateway] -> ShowS

Generic ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Associated Types

type Rep ActivateGateway :: Type -> Type

Methods

from :: ActivateGateway -> Rep ActivateGateway x

to :: Rep ActivateGateway x -> ActivateGateway

Hashable ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

hashWithSalt :: Int -> ActivateGateway -> Int

hash :: ActivateGateway -> Int

ToJSON ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

toJSON :: ActivateGateway -> Value

toEncoding :: ActivateGateway -> Encoding

toJSONList :: [ActivateGateway] -> Value

toEncodingList :: [ActivateGateway] -> Encoding

AWSRequest ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Associated Types

type Rs ActivateGateway :: Type

Methods

request :: ActivateGateway -> Request ActivateGateway

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ActivateGateway -> ClientResponse -> m (Response ActivateGateway)

ToHeaders ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

toHeaders :: ActivateGateway -> [Header]

ToPath ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

toPath :: ActivateGateway -> ByteString

ToQuery ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

toQuery :: ActivateGateway -> QueryString

NFData ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

rnf :: ActivateGateway -> ()

type Rep ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

type Rep ActivateGateway = D1 (MetaData "ActivateGateway" "Network.AWS.StorageGateway.ActivateGateway" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "ActivateGateway'" PrefixI True) ((S1 (MetaSel (Just "_agMediumChangerType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_agTapeDriveType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_agGatewayType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_agActivationKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_agGatewayName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_agGatewayTimezone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_agGatewayRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs ActivateGateway

Defined in Network.AWS.StorageGateway.ActivateGateway

type Rs ActivateGateway = ActivateGatewayResponse

Request Lenses

agMediumChangerType :: Lens' ActivateGateway (Maybe Text)

The value that indicates the type of medium changer to use for tape gateway. This field is optional. Valid Values: "STK-L700", "AWS-Gateway-VTL"

agTapeDriveType :: Lens' ActivateGateway (Maybe Text)

The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: "IBM-ULT3580-TD5"

agGatewayType :: Lens' ActivateGateway (Maybe Text)

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is STORED . Valid Values: STORED, CACHED, VTL, FILE_S3

agActivationKey :: Lens' ActivateGateway Text

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey . It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway. For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.

agGatewayName :: Lens' ActivateGateway Text

The name you configured for your gateway.

agGatewayTimezone :: Lens' ActivateGateway Text

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

agGatewayRegion :: Lens' ActivateGateway Text

A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary . Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"

Destructuring the Response

activateGatewayResponse

Arguments

:: Int

agrsResponseStatus

-> ActivateGatewayResponse

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

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

• agrsGatewayARN - Undocumented member.
• agrsResponseStatus - -- | The response status code.

data ActivateGatewayResponse

AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.

See: activateGatewayResponse smart constructor.

Instances

Eq ActivateGatewayResponse

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

(==) :: ActivateGatewayResponse -> ActivateGatewayResponse -> Bool

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

Data ActivateGatewayResponse

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

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

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

toConstr :: ActivateGatewayResponse -> Constr

dataTypeOf :: ActivateGatewayResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ActivateGatewayResponse

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

readsPrec :: Int -> ReadS ActivateGatewayResponse

readList :: ReadS [ActivateGatewayResponse]

readPrec :: ReadPrec ActivateGatewayResponse

readListPrec :: ReadPrec [ActivateGatewayResponse]

Show ActivateGatewayResponse

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

showsPrec :: Int -> ActivateGatewayResponse -> ShowS

show :: ActivateGatewayResponse -> String

showList :: [ActivateGatewayResponse] -> ShowS

Generic ActivateGatewayResponse

Defined in Network.AWS.StorageGateway.ActivateGateway

Associated Types

type Rep ActivateGatewayResponse :: Type -> Type

Methods

from :: ActivateGatewayResponse -> Rep ActivateGatewayResponse x

to :: Rep ActivateGatewayResponse x -> ActivateGatewayResponse

NFData ActivateGatewayResponse

Defined in Network.AWS.StorageGateway.ActivateGateway

Methods

rnf :: ActivateGatewayResponse -> ()

type Rep ActivateGatewayResponse

Defined in Network.AWS.StorageGateway.ActivateGateway

type Rep ActivateGatewayResponse = D1 (MetaData "ActivateGatewayResponse" "Network.AWS.StorageGateway.ActivateGateway" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "ActivateGatewayResponse'" PrefixI True) (S1 (MetaSel (Just "_agrsGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_agrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

agrsGatewayARN :: Lens' ActivateGatewayResponse (Maybe Text)

Undocumented member.

agrsResponseStatus :: Lens' ActivateGatewayResponse Int

• - | The response status code.