Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway . 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
.
- activateGateway :: Text -> Text -> Text -> Text -> ActivateGateway
- data ActivateGateway
- agMediumChangerType :: Lens' ActivateGateway (Maybe Text)
- agTapeDriveType :: Lens' ActivateGateway (Maybe Text)
- agGatewayType :: Lens' ActivateGateway (Maybe Text)
- agActivationKey :: Lens' ActivateGateway Text
- agGatewayName :: Lens' ActivateGateway Text
- agGatewayTimezone :: Lens' ActivateGateway Text
- agGatewayRegion :: Lens' ActivateGateway Text
- activateGatewayResponse :: Int -> ActivateGatewayResponse
- data ActivateGatewayResponse
- agrsGatewayARN :: Lens' ActivateGatewayResponse (Maybe Text)
- agrsResponseStatus :: Lens' ActivateGatewayResponse Int
Creating a Request
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> 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-VTLagTapeDriveType
- The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: IBM-ULT3580-TD5agGatewayType
- 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 isSTORED
. Valid Values: STORED, CACHED, VTL, FILE_S3agActivationKey
- 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 parameteractivationKey
. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to theActivateGateway
API call determine the actual configuration of your gateway.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 yourHost
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", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"
data ActivateGateway Source #
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.
Request Lenses
agMediumChangerType :: Lens' ActivateGateway (Maybe Text) Source #
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) Source #
The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: IBM-ULT3580-TD5
agActivationKey :: Lens' ActivateGateway Text Source #
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.
agGatewayName :: Lens' ActivateGateway Text Source #
The name you configured for your gateway.
agGatewayTimezone :: Lens' ActivateGateway Text Source #
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 Source #
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", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"
Destructuring the Response
activateGatewayResponse Source #
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 Source #
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.
Response Lenses
agrsGatewayARN :: Lens' ActivateGatewayResponse (Maybe Text) Source #
Undocumented member.
agrsResponseStatus :: Lens' ActivateGatewayResponse Int Source #
- - | The response status code.