StorageGateway / Client / activate_gateway

activate_gateway#

StorageGateway.Client.activate_gateway(**kwargs)#

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the Amazon Web Services Region that 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.

Note

You must turn on the gateway VM before you can activate your gateway.

See also: AWS API Documentation

Request Syntax

response = client.activate_gateway(
    ActivationKey='string',
    GatewayName='string',
    GatewayTimezone='string',
    GatewayRegion='string',
    GatewayType='string',
    TapeDriveType='string',
    MediumChangerType='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ActivationKey (string) –

    [REQUIRED]

    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 Getting activation key in the Storage Gateway User Guide.

  • GatewayName (string) –

    [REQUIRED]

    The name you configured for your gateway.

  • GatewayTimezone (string) –

    [REQUIRED]

    A value that indicates the time zone you want to set for the gateway. The time zone is of the format “GMT”, “GMT-hr:mm”, or “GMT+hr:mm”. For example, GMT indicates Greenwich Mean Time without any offset. 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.

  • GatewayRegion (string) –

    [REQUIRED]

    A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

    Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

  • GatewayType (string) –

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

    Warning

    Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.

    Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB

  • TapeDriveType (string) –

    The value that indicates the type of tape drive to use for tape gateway. This field is optional.

    Valid Values: IBM-ULT3580-TD5

  • MediumChangerType (string) –

    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 | IBM-03584L32-0402

  • Tags (list) –

    A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

    Note

    Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256 characters.

    • (dict) –

      A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

      • Key (string) – [REQUIRED]

        Tag key. The key can’t start with aws:.

      • Value (string) – [REQUIRED]

        Value of the tag key.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

  • (dict) –

    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 Amazon Web Services Region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.

    Note

    For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.

    • GatewayARN (string) –

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Exceptions

Examples

Activates the gateway you previously deployed on your host.

response = client.activate_gateway(
    ActivationKey='29AV1-3OFV9-VVIUB-NKT0I-LRO6V',
    GatewayName='My_Gateway',
    GatewayRegion='us-east-1',
    GatewayTimezone='GMT-12:00',
    GatewayType='STORED',
    MediumChangerType='AWS-Gateway-VTL',
    TapeDriveType='IBM-ULT3580-TD5',
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
    'ResponseMetadata': {
        '...': '...',
    },
}